Class ArrayTool

Array function class.

Namespace: Kotchasan
Author: Goragod Wiriya admin@goragod.com
Since: 1.0
Located at Kotchasan/ArrayTool.php

Methods summary
`public static array`	# `columns( array $array, string $column_key, mixed $index_key = null )` คืนค่ารายการที่มีคอลัมน์ตามที่กำหนด. คืนค่ารายการที่มีคอลัมน์ตามที่กำหนด. Parameters `$array` `$column_key` ชื่อคอลัมน์ที่ต้องการ `$index_key` null คืนค่า index ของ $array, string คืนค่า index จากคอลัมน์ที่กำหนด Returns array Assert (array(array('id' => 1, 'name' => 'one'), array('id' => 2, 'name' => 'two'), array('id' => 3, 'name' => 'three')), 'name') [==] array(0 => 'one', 1 => 'two', 2 => 'three') (array(array('id' => 1, 'name' => 'one'), array('id' => 2, 'name' => 'two'), array('id' => 3, 'name' => 'three')), 'name', 'id') [==] array(1 => 'one', 2 => 'two', 3 => 'three')
`public static array`	# `delete( array $array, string $ids )` ลบรายการที่ id สามารถลบได้หลายรายการโดยคั่นแต่ละรายการด้วย , รักษาคีย์ของรายการเดิมไว้ คืนค่า array ใหม่หลังจากลบแล้ว. ลบรายการที่ id สามารถลบได้หลายรายการโดยคั่นแต่ละรายการด้วย , รักษาคีย์ของรายการเดิมไว้ คืนค่า array ใหม่หลังจากลบแล้ว. Parameters `$array` `$ids` รายการที่ต้องการลบ 1 หรือ 1,2,3 Returns array Assert (array(0, 1, 2, 3, 4, 5), '0,2') [==] array(1 => 1, 3 => 3, 4 => 4, 5 => 5)
`public static`	# `extract( array $array, array & $keys, array & $values )` ฟังก์ชั่นแยก $key และ $value ออกจาก array รองรับข้อมูลรูปแบบแอเรย์ย่อยๆ. ฟังก์ชั่นแยก $key และ $value ออกจาก array รองรับข้อมูลรูปแบบแอเรย์ย่อยๆ. Parameters `$array` array('key1' => 'value1', 'key2' => 'value2', array('key3' => 'value3', 'key4' => 'value4')) `$keys` คืนค่า $key Array ( [0] => key1 [1] => key2 [2] => key3 [3] => key4 ) `$values` คืนค่า $value Array ( [0] => value1 [1] => value2 [2] => value3 [3] => value4 )
`public static array`	# `filter( array $array, string $search )` เลือกรายการ array ที่มีข้อมูลที่กำหนด. เลือกรายการ array ที่มีข้อมูลที่กำหนด. Parameters `$array` `$search` ข้อมูลที่ต้องการ Returns array Assert (array('one', 'One', 'two'), 'one') [==] array('one', 'One')
`public static mix`	# `get( array $array, string\|integer $key, mix $default = '' )` คืนค่าข้อมูลแอเรย์ที่ $key ไม่พบคืนค่า $default คืนค่าข้อมูลแอเรย์ที่ $key ไม่พบคืนค่า $default Parameters `$array` `$key` `$default` $array Returns mix Assert (array('one', 'two', 'three'), 0, '') [==] 'one' (array('one', 'two', 'three'), 4, '') [==] ''
`public static mixed`	# `getFirstKey( array $array )` อ่านคีย์รายการแรก ไม่พบ คืนค่า null อ่านคีย์รายการแรก ไม่พบ คืนค่า null Parameters `$array` Returns mixed
`public static array`	# `insertAfter( array $source, integer\|string $find, integer\|string $key, mixed $value )` แทรกข้อมูลลงในแอเรย์ ข้อมูลที่จะนำมาแทรกอยู่ถัดไป ถ้าไม่พบ $find ข้อมูลจะแทรกรายการสุดท้าย. แทรกข้อมูลลงในแอเรย์ ข้อมูลที่จะนำมาแทรกอยู่ถัดไป ถ้าไม่พบ $find ข้อมูลจะแทรกรายการสุดท้าย. Parameters `$source` แอเรย์ต้นฉบับ `$find` คีย์ของแอเรย์ต้นฉบับจุดที่จะแทรก ข้อมูลต้องเป็นชนิดเดียวกันกับคีย์ของแอเรย์ต้นฉบับ `$key` คีย์ของข้อมูลที่จะนำมาแทรก `$value` ข้อมูลที่จะนำมาแทรก Returns array Assert (array('one' => 1, 'two' => 2), 'two', 'three', 3) [==] array('one' => 1, 'two' => 2, 'three' => 3) (array(1 => 'one', 2 => 'two'), 2, 3, 'three') [==] array(1 => 'one', 2 => 'two', 3 => 'three') (array(1 => 'one', 2 => 'two'), 3, 3, 'three') [==] array(1 => 'one', 2 => 'two', 3 => 'three')
`public static array`	# `insertBefore( array $source, integer\|string $find, integer\|string $key, mixed $value )` แทรกข้อมูลลงในแอเรย์ ข้อมูลที่จะนำมาแทรกอยู่ก่อน ถ้าไม่พบ $find ข้อมูลจะแทรกรายการสุดท้าย. แทรกข้อมูลลงในแอเรย์ ข้อมูลที่จะนำมาแทรกอยู่ก่อน ถ้าไม่พบ $find ข้อมูลจะแทรกรายการสุดท้าย. Parameters `$source` แอเรย์ต้นฉบับ `$find` คีย์ของแอเรย์ต้นฉบับจุดที่จะแทรก ข้อมูลต้องเป็นชนิดเดียวกันกับคีย์ของแอเรย์ต้นฉบับ `$key` คีย์ของข้อมูลที่จะนำมาแทรก `$value` ข้อมูลที่จะนำมาแทรก Returns array Assert (array('one' => 1, 'three' => 3), 'three', 'two', 2) [==] array('one' => 1, 'two' => 2, 'three' => 3) (array(1 => 'one', 3 => 'three'), 3, 2, 'two') [==] array(1 => 'one', 2 => 'two', 3 => 'three') (array(1 => 'one', 3 => 'three'), 2, 2, 'two') [==] array(1 => 'one', 3 => 'three', 2 => 'two')
`public static array`	# `replace( array $source, array\|object $replace )` ฟังก์ชั่นรวมแอเรย์ รักษาแอเรย์ต้นฉบับไว้ และแทนที่ข้อมูลด้วยข้อมูลใหม่. ฟังก์ชั่นรวมแอเรย์ รักษาแอเรย์ต้นฉบับไว้ และแทนที่ข้อมูลด้วยข้อมูลใหม่. Parameters `$source` แอเร์ยต้นฉบับ `$replace` ข้อมูลที่จะนำมาแทนที่ลงในแอเร์ยต้นฉบับ Returns array Assert (array(1 => 1, 2 => 2, 3 => 'three'), array(1 => 'one', 2 => 'two')) [==] array(1 => 'one', 2 => 'two', 3 => 'three')
`public static array`	# `search( array $input, mixed $key, mixed $search )` ค้นหาแอเรย์ จากคอลัมน์ คืนค่าทุกรายการที่พบ รักษา index ตาม array ของต้นฉบับและ คืนค่าแอเรย์ว่างถ้าไม่พบ. ค้นหาแอเรย์ จากคอลัมน์ คืนค่าทุกรายการที่พบ รักษา index ตาม array ของต้นฉบับและ คืนค่าแอเรย์ว่างถ้าไม่พบ. Parameters `$input` ข้อมูลแอเรย์ `$key` คอลัมน์ที่ต้องการค้นหา `$search` ข้อความค้นหา Returns array Assert (array(array('id' => 1, 'name' => 'one'), array('id' => 2, 'name' => 'two'), array('id' => 3, 'name' => 'one')), 'name', 'one') [==] array(0 => array('id' => 1, 'name' => 'one'), 2 => array('id' => 3, 'name' => 'one')) (array(array('id' => 1, 'name' => 'one'), array('id' => 2, 'name' => 'two'), array('id' => 3, 'name' => 'one')), 'id', 'one') [==] array()
`public static array`	# `shift( array $source, string\|integer $key )` ตัดแอเรย์ตั้งแต่เริ่มต้นจนถึงตำแหน่งที่กำหนด คืนค่าแอเรย์ถัดจากรายการที่ตัด ไม่พบคืนค่าเดิม ตัดแอเรย์ตั้งแต่เริ่มต้นจนถึงตำแหน่งที่กำหนด คืนค่าแอเรย์ถัดจากรายการที่ตัด ไม่พบคืนค่าเดิม Parameters `$source` แอเรย์ต้นฉบับ `$key` คีย์ของ $source ตำแหน่งที่ต้องการตัด Returns array Assert (array('one' => 1, 'two' => 2, 'three' => 3), 'two') [==] array('three' => 3) (array('one' => 1, 'two' => 2, 'three' => 3), 1) [==] array('one' => 1, 'two' => 2, 'three' => 3)
`public static array`	# `sort( array $array, string $sort_key = 'id', boolean $sort_desc = false )` ฟังก์ชั่น เรียงลำดับ array ตามชื่อฟิลด์. ฟังก์ชั่น เรียงลำดับ array ตามชื่อฟิลด์. Parameters `$array` แอเรย์ที่ต้องการเรียงลำดับ `$sort_key` (optional) คืย์ของ $array ที่ต้องการในการเรียง (default id) `$sort_desc` true=เรียงจากมากไปหาน้อย, false=เรียงจากน้อยไปหามาก (default false) Returns array Assert (array(array('id' => 2, 'value' => 'two'), array('id' => 3, 'value' => 'three'), array('id' => 1, 'value' => 'one'))) [==] array(array('id' => 1, 'value' => 'one'), array('id' => 2, 'value' => 'two'), array('id' => 3, 'value' => 'three'))
`public static string`	# `toString( string $glue, array $array )` แปลงแอเรย์ $array เป็น string คั่นด้วย $glue. แปลงแอเรย์ $array เป็น string คั่นด้วย $glue. Parameters `$glue` ตัวคั่นข้อมูล `$array` แอเรย์ที่ต้องการนำมาเชื่อม Returns string Assert ('\|', array('a' => 'A', 'b' => array('b', 'B'), 'c' => array('c' => array('c', 'C')))) [==] "A\|b\|B\|c\|C"
`public static array`	# `unserialize( string $str, array $source = array(), boolean $replace = true )` ฟังก์ชั่นแปลงข้อความ serialize เป็นแอเรย์ และรวมข้อมูลเข้ากับ $source. ฟังก์ชั่นแปลงข้อความ serialize เป็นแอเรย์ และรวมข้อมูลเข้ากับ $source. Parameters `$str` ข้อมูล serialize `$source` ข้อมูลตั้งต้น ถ้าใช้ฟังก์ชั่นนี้ในการแปลงข้อมูล ค่านี้จะเป็นแอเรย์ว่าง (ค่าเริ่มต้น) `$replace` true (default) แทนที่ข้อมูลเดิม, false เก็บข้อมูลเดิมไว้ Returns array Assert ('') [==] array() (serialize(array(1, 2, 3))) [==] array(1, 2, 3) (serialize(array(1 => 'One', 2 => 'Two', 3 => 'Three')), array(3 => 3, 4 => 'Four'), true) [==] array(3 => 'Three', 4 => 'Four', 1 => 'One', 2 => 'Two') (serialize(array(1 => 'One', 2 => 'Two', 3 => 'Three')), array(3 => 3, 4 => 'Four'), false) [==] array(3 => 3, 4 => 'Four', 1 => 'One', 2 => 'Two')
`public static boolean`	# `in_array( array $needle, array $haystack )` ตรวจสอบว่ามี $needle ใน $haystack หรือไม่ ถ้ามีคืนค่า true ถ้าไม่มีคืนค่า false ตรวจสอบว่ามี $needle ใน $haystack หรือไม่ ถ้ามีคืนค่า true ถ้าไม่มีคืนค่า false Parameters `$needle` แอเรย์ที่ต้องการตรวจสอบ `$haystack` แอเรย์ต้นฉบับ Returns boolean Assert (array(1, 2), array(1, 2)) [==] true (array(2), array(1, 2, 3)) [==] true (array(1, 2), array(3, 4)) [==] false (array(), array(3, 4)) [==] false (array(), array()) [==] false