FuelPHP, a PHP 5.3 Framework Documentation

// Single array
$arr = array('one' => 1, 'two' => 2);
echo Arr::is_multi($arr);
// 実行結果: false

// 多次元配列
$arr = array('one' => array('test' => 1), 'two' => array('test' => 2), 'three' => array('test' => 3));
echo Arr::is_multi($arr);
// 実行結果: true

// 多次元配列で全ての要素をチェック
$arr = array('one' => array('test' => 1), 'two' => array('test' => 2), 'three' => 3);

echo Arr::is_multi($arr, false); // 実行結果: true
echo Arr::is_multi($arr, true);  // 実行結果: false

$arr = array('foo', 'bar', 'baz', 'yay');
echo Arr::is_assoc($arr);
// 実行結果: false

$arr = array('foo' => 'foo', 'bar' => 'bar', 'baz' => 'baz', 'yay' => 'yay');
echo Arr::is_assoc($arr);
// 実行結果: true

/*
 * たとえもし '2' が string で定義されていたとしても、PHPは内部的に integer として保管するため、
 * 連想配列とは認識されません!
 */
$arr = array(0 => 'foo', 1 => 'bar', '2' => 'baz', 3 => 'yay');
echo Arr::is_assoc($arr);
// 実行結果: false!

$arr = array('foo', 'bar', 'baz', 'yay');
print_r(Arr::to_assoc($arr));

// 実行結果:
Array
(
    ["foo"] => 'bar'
    ["baz"] => 'yay'
)

$arr = array('foo', 'bar', 'baz');
echo Arr::to_assoc($arr);
// 実行結果: null

$people = array(
	array(
		"name" => "Jack",
		"age" => 21
	),
	array(
		"name" => "Jill",
		"age" => 23
	)
);

print_r(Arr::assoc_to_keyval($people, 'name', 'age'));

// 実行結果:
Array
(
	["Jack"] => 21
	["Jill"] => 23
)

echo Arr::average(array('1', 2, 4, '8'));
// 実行結果: 3.75

$indexed = array(
	array("a"),
	array("b"),
	array("c"),
);

print_r(Arr::flatten($indexed, '_'));

// Result:
Array
(
	[0_0] => a
	[0_1] => b
	[0_2] => c
)

$people = array(
	array(
		"name" => "Jack",
		"age"  => 21
	),
	array(
		"name" => "Jill",
		"age"  => 23
	)
);

print_r(Arr::flatten_assoc($people));

// Result:
Array
(
	[0:name] => Jack
	[0:age]  => 21
	[1:name] => Jill
	[1:age]  => 23
)

// Let's flatten another array on top
print_r(Arr::flatten_assoc(array(array("name" => "Humpty", "age" => 11)), ":", false));

// Result:
Array
(
	[0:name] => Humpty
	[0:age]  => 11
	[1:name] => Jill
	[1:age]  => 23
)

$flattened = array(
	'0_name' => 'James',
	'0_age'  => 24,
	'1_name' => 'John',
	'1_age'  => 34,
);

print_r(Arr::reverse_flatten($flattened, '_'));

// Result:
Array
(
	[0] => Array
		(
			[name] => James
			[age]  => 24
		)

	[1] => Array
		(
			[name] => John
			[age]  => 34
		)
)

$arr = array(
	"user_name" => "John",
	"user_surname" => "Lastname",
	"project_name" => "Fuel",
	"project_type" => "Framework",
);

print_r(Arr::filter_prefixed($arr, "user_"));

// Result:
Array
(
	[name] => John
	[surname] => Lastname
)

// Let's keep the prefix
print_r(Arr::filter_prefixed($arr, "project_", false);

// Result:
Array
(
	[project_name] => Fuel
	[project_type] => Framework
)

$arr = array(
	"user_name" => "John",
	"user_surname" => "Lastname",
	"project_name" => "Fuel",
	"project_type" => "Framework",
);

print_r(Arr::remove_prefixed($arr, "project"));

// Result:
Array
(
	[user_name] => John
	[user_surname] => Lastname
)

$arr = array(
                                "name_1" => "John",
                                "surname_1" => "Lastname",
                                "name_2" => "Ted",
                                "surname_2" => "Surname",
                                );

                                print_r(Arr::filter_suffixed($arr, "_1"));

                                // Result:
                                Array
                                (
                                [name] => John
                                [surname] => Lastname
                                )

                                // Let's keep the suffix
                                print_r(Arr::filter_suffixed($arr, "_1", false);

                                // Result:
                                Array
                                (
                                [name_1] => John
                                [surname_1] => Lastname
                                )
                            

$arr = array(
                                "name_1" => "John",
                                "surname_1" => "Lastname",
                                "name_2" => "Ted",
                                "surname_2" => "Bear",
                                );

                                print_r(Arr::remove_suffixed($arr, "_1"));

                                // Result:
                                Array
                                (
                                [name_2] => Ted
                                [surname_2] => Surname
                                )
                            

$arr = array(
	"user_name" => "John",
	"user_surname" => "Lastname",
	"project_name" => "Fuel",
	"project_type" => "Framework",
);

print_r(Arr::filter_keys($arr, array('project_name', 'user_name')));

// Result:
Array
(
	[project_name] => Fuel
	[user_name] => John
)

// Let's remove some keys
print_r(Arr::filter_keys($arr, array('user_name', 'user_surname'), true));

// Result:
Array
(
	[project_name] => Fuel
	[project_type] => Framework
)

$arr = array(
	"user_name" => "John",
	"user_surname" => "Lastname",
	"info" => array(
		0 => array(
			"data" = "a value",
		),
		1 => array(
			"data" = "",
		),
		2 => array(
			"data" = 0,
		),
	),
);

print_r(Arr::filter_recursive($arr));

// Result:
Array
(
	[project_name] => Fuel
	[user_name] => John
	[info] => Array
	(
		[0] => Array
		(
			[data] => a value
		)
	)
)

// Let's use a callback
print_r(Arr::filter_recursive($arr, function($item){ return $item !== ""; });

// Result:
Array
(
	[project_name] => Fuel
	[user_name] => John
	[info] => Array
	(
		[0] => Array
		(
			[data] => a value
		)
		[2] => Array
		(
			[data] => 0
		)
	)
)

$person = array(
	"name" => "Jack",
	"age" => "21",
	"location" => array(
		"city" => "Pittsburgh",
		"state" => "PA",
		"country" => "US"
	)
);

echo Arr::get($person, "name", "Unknown Name");
// Result: "Jack"

echo Arr::get($person, "job", "Unknown job");
// Result: "Unknown job"

// This method can also dive into arrays by using a dot to separate between keys
echo Arr::get($person, "location.city", "Unknown City");
// Result: "Pittsburgh"

$person = array(
	"name" => "Jack",
	"age" => "21",
	"location" => array(
		"city" => "Pittsburgh",
		"state" => "PA",
		"country" => "US"
	)
);

Arr::set($person, "name", "John");
// $person['name'] には "John" がセットされます。

// This method can also dive into arrays by using a dot to separate between keys
Arr::set($person, "location.city", "Philadelphia");
// $person['location']['city'] には "Philadelphia" がセットされます。

// また、一度に複数の値をセットすることも出来ます。
Arr::set($person, array("name" => "John", "location.city" => "Philadelphia"));

$collection = array(
	array(
		'id' => 2,
		'name' => 'Bill',
		'surname' => 'Cosby',
	),
	array(
		'id' => 5,
		'name' => 'Chris',
		'surname' => 'Rock',
	),
	array(
		'id' => 7,
		'name' => 'Bert',
		'surname' => 'Visser',
	),
);

// Get an array of id's
$ids = \Arr::pluck($collection, 'id');
// array(2, 5, 7);

// Get an array of names with the id as the index
$names = \Arr::pluck($collection, 'name', 'id');
// array(2 => 'Bill', 5 => 'Chris', 7 => 'Bert');

$person = array(
	"name" => "Jack",
	"age" => "21",
	"location" => array(
		"city" => "Pittsburgh",
		"state" => "PA",
		"country" => "US"
	)
);

$result = Arr::delete($person, "name");
// $person['name'] は配列から削除され、 true が返されます。

// このメソッドは、キーの間に ドット (.) を入れることで、より深い配列に潜ることができます。
$result = Arr::delete($person, "location.city");
// $person['location']['city'] は配列から削除され、 true が返されます。

// また、一度に複数の値を削除する事もできます。
$result = Arr::delete($person, array("name", "location.doesnotexist"));
// $person['name'] は削除され、 array('name' => true, 'location.doesnotexist' => false) が返されます。

$people = array("Jack", "Jill");

// Add one value
Arr::insert($people, "Humpty", 0);
print_r($people);
// Result:
Array
(
	[0] => Humpty
	[1] => Jack
	[2] => Jill
)

// Add multiple values
Arr::insert($people, array("Hansel", "Gretel"), 1);
print_r($people);
// Result:
Array
(
	[0] => Humpty
	[1] => Hansel
	[2] => Gretel
	[3] => Jack
	[4] => Jill
)

// Add an array
Arr::insert($people, array( array("name" => "Wolf", "teeth" => "sharp")), 0);
print_r($people);

// Result:
Array
(
	[0] => Array
		(
			[name] => Wolf
			[teeth] => sharp
		)

	[1] => Humpty
	[2] => Hansel
	[3] => Gretel
	[4] => Jack
	[5] => Jill
)

$people = array("Jack", "Jill");

Arr::insert_before_key($people, "Humpty", 1);
print_r($people);

// Result:
Array
(
	[0] => Jack
	[1] => Humpty
	[2] => Jill
)

$people = array("Jack", "Jill");

Arr::insert_after_key($people, "Humpty", 1);
print_r($people);

// Result:
Array
(
	[0] => Jack
	[1] => Jill
	[2] => Humpty
)

$people = array("Jack", "Jill");

Arr::insert_after_value($people, "Humpty", "Jack");
print_r($people);

// Result:
Array
(
	[0] => Jack
	[1] => Humpty
	[2] => Jill
)

$data = array(
	array(
		'info' => array(
			'pet' => array(
				'type' => 'dog'
			)
		),
	),
	array(
		'info' => array(
			'pet' => array(
				'type' => 'fish'
			)
		),
	),
	array(
		'info' => array(
			'pet' => array(
				'type' => 'cat'
			)
		),
	),
);

$data = Arr::sort($data, 'info.pet.type');
// Result:
array(
	array(
		'info' => array(
			'pet' => array(
				'type' => 'cat'
			)
		),
	),
	array(
		'info' => array(
			'pet' => array(
				'type' => 'dog'
			)
		),
	),
	array(
		'info' => array(
			'pet' => array(
				'type' => 'fish'
			)
		),
	),
);

$collection = array(
	'i5' => array(
		'name' => 'Carl',
		'age' => 17,
		'points' => 30,
		'arr' => array(
			'key' => 10,
		),
	),
	'i7' => array(
		'name' => 'carl',
		'age' => 17,
		'points' => 20,
		'arr' => array(
			'key' => 10,
		),
	),
	'i2' => array(
		'name' => 'Bert',
		'age' => 20,
		'points' => 30,
		'arr' => array(
			'key' => 10,
		),
	),
);

$collection = \Arr::multisort($collection, array(
	'name' => SORT_ASC,
	'points' => array(SORT_ASC, SORT_NUMERIC),
	'age' => array(SORT_ASC, SORT_NUMERIC),
), true);
print_r($collection);

// Result
Array
(
    [i2] => Array
        (
            [name] => Bert
            [age] => 20
            [points] => 30
            [arr] => Array
                (
                    [key] => 10
                )

        )

    [i7] => Array
        (
            [name] => carl
            [age] => 17
            [points] => 20
            [arr] => Array
                (
                    [key] => 10
                )

        )

    [i5] => Array
        (
            [name] => Carl
            [age] => 17
            [points] => 30
            [arr] => Array
                (
                    [key] => 10
                )

        )
)

$arr = array('one' => 1, 2, 3, array(56), 87);

echo Arr::in_array_recursive('56', $arr);
// Result: true

echo Arr::in_array_recursive('87', $arr, true);
// Result: false

echo Arr::in_array_recursive(87, $arr, true);
// Result: true

$arr1 = array(
	'one' => 1,
	2,
	3,
	array(
		56
		),
	87
);

$arr2 = array(
	27,
	90,
	array(
		'give_me' => 'bandwidth'
		),
	'90',
	'php',
);

print_r( Arr::merge($arr1, $arr2) );
// Result:
Array
(
	[one] => 1
	[0] => 2
	[1] => 3
	[2] => Array (
			[0] => 56
				)
	[3] => 87
	[4] => 27
	[5] => 90
	[6] => Array (
			[give_me] => bandwidth
				)
	[7] => 90
	[8] => php
)

$arr = array(
	'one' => 1,
	'two' => 2,
	'three' => array(
		'a' => 4,
		'b' => 'foo'
	),
	'four',
	array(
			null,
			array(
				null,
				null,
				null,
				array(
					'deep'
				)
			)
		),
	);
);

echo Arr::search($arr, 1);
// one

echo Arr::search($arr, 'four');
// 0

var_dump(Arr::search($arr, 5));
// NULL

echo Arr::search($arr, 4, null, true);
// three.a

echo Arr::search($arr, 'deep', null, true);
// 1.1.3.0

$array = array(
	'val1' => 'test', 'val2' => 'test', 'val1' => 'dup',
);

// Result: array('val1' => 'test', 'val2' => 'test')
$result = Arr::unique($array);

$collection = array(
	array(
		'age' => 20,
		'name' => 'Bill',
		'scores' => array(
			'math' => 10,
		),
	),
	array(
		'age' => 25,
		'name' => 'Chris',
		'scores' => array(
			'math' => 15,
		),
	),
	array(
		'age' => 38,
		'name' => 'Bert',
		'scores' => array(
			'math' => 5,
		),
	),
);

// Calculate sum of an array of age's
$total_age = Arr::sum($collection, 'age'); // 83

// Calculate sum of an array plucked by 'scores.math'
$total_score = Arr::sum($collection, 'scores.math'); // 30

// array to lookup in
$arr = array(2 => 'A', 4 => '2', 6 => 'C');

// returns false, there is no key 1 in the array
$result = Arr::previous_by_key($arr, 1);

// returns null, there is no previous key
$result = Arr::previous_by_key($arr, 2);

// returns false, there is no key '2' in the array
$result = Arr::previous_by_key($arr, '2', false, true);

// returns 2, it's the key in the array before key 4
$result = Arr::previous_by_key($arr, 4);

// returns 'A', it's the value the previous key in the array points to
$result = Arr::previous_by_key($arr, 4, true);

// array to lookup in
$arr = array(2 => 'A', 4 => '2', 6 => 'C');

// returns false, there is no key 1 in the array
$result = Arr::next_by_key($arr, 1);

// returns null, there is no next key
$result = Arr::next_by_key($arr, 6);

// returns false, there is no key '2' in the array
$result = Arr::next_by_key($arr, '2', false, true);

// returns 6, it's the key in the array after key 4
$result = Arr::next_by_key($arr, 4);

// returns 'C', it's the value the next key in the array points to
$result = Arr::next_by_key($arr, 4, true);

// array to lookup in
$arr = array(2 => 'A', 4 => '2', 6 => 'C');

// returns false, there is no value 'Z' in the array
$result = Arr::previous_by_value($arr, 'Z');

// returns null, there is no previous value
$result = Arr::previous_by_value($arr, 'A');

// returns false, there is no value 2 in the array, only '2'
$result = Arr::previous_by_value($arr, 2, false, true);

// returns 'A', it's the value the previous key in the array points to
$result = Arr::previous_by_value($arr, '2');

// returns 2, it's the key of the previous array element
$result = Arr::previous_by_value($arr, '2', false);

// array to lookup in
$arr = array(2 => 'A', 4 => '2', 6 => 'C');

// returns false, there is no value 'Z' in the array
$result = Arr::next_by_value($arr, 'Z');

// returns null, there is no next value
$result = Arr::next_by_value($arr, 'C');

// returns false, there is no value 2 in the array, only '2'
$result = Arr::next_by_value($arr, 2, false, true);

// returns 'C', it's the value the next key in the array points to
$result = Arr::next_by_value($arr, '2');

// returns 6, it's the key of the next array element
$result = Arr::next_by_value($arr, '2', false);

echo in_arrayi('This', array('something','tHis'));
// Result: true

echo in_arrayi('Thi', array('something','tHis'));
// Result: false