PHP's Array Extension in JavaScript (v1.1, 2017-03-03)
GD Productions | Support Forum

This JavaScript library lets you deal with arrays in a similar way than the PHP's array extension.

In PHP, you can use integers or strings to define the keys of an array. Here is an example.

$array1 = ["Hello", "World"]; // $array1[0] is "Hello", $array1[1] is "World"
$array2 = ["Hello" => 0, "World" => 1]; // $array2['Hello'] is 0, $array2['World'] is 1

In JavaScript, the situation is a bit different.

var array1 = ["Hello", "World"]; // array1[0] is "Hello", array1[1] is "World"
var array2 = {"Hello": 0, "World": 1}; // array2['Hello'] is 0, array2['World'] is 1

Have you noticed the differences?

array1 is treated as an array object (indexed array) in both PHP and JavaScript.
array2 is treated as an array object (associative array) in PHP and as a standard object in JavaScript.

It is possible to create sorts of associative arrays with this library, however arrays cannot contain integer and string keys at the same time, unlike the PHP's extension.

Getting started

Please wait...

Then upload the .js file to your server and embed it by using the <script> tag in your HTML code.

You are ready!

Notable changes

Added array_count().
Added array_key_exists().
Added array_keys().
Added support for start and end parameters in array_copy() with associative arrays.
Fixed in_array() did not work with array values.
Changed default in_array() strict check to ARRAY_CHECK_STRICT_YES.

Constants

The following constants can be used in several functions.

ARRAY_BEHAVIOR_JS
This constant is useful in functions that have two implementations. This one lets you use a behavior specific to this library.

ARRAY_BEHAVIOR_PHP
This constant is useful in functions that have two implementations. This one lets you use the PHP standard behavior.

ARRAY_KEY_ALL
This constant is useful to check if a value is an indexed or an associative array, indifferently.

ARRAY_KEY_INT
This constant is useful to create or check if a value is an indexed array (integer keys).

ARRAY_KEY_STRING
This constant is useful to create or check if a value is an associative array (string keys).

ARRAY_CHECK_STRICT_YES
This constant is useful to check if the types between two values are the same.

ARRAY_CHECK_STRICT_NO
This constant is useful to not take into account the types when comparing two values.

The following constants can be used in specific functions only.

ARRAY_KEY_OVERWRITE_YES, in array_push().
ARRAY_KEY_OVERWRITE_NO, in array_push().
ARRAY_KEY_UNSET_ALL, in array_unset().
ARRAY_COUNT_NORMAL, in array_count().
ARRAY_COUNT_RECURSIVE, in array_count().

Standard functions

is_array ( mixed array [, constant key_type = ARRAY_KEY_ALL ] )
This function finds whether the given variable is an array.

array is the variable that has to be evaluated.
key_type can be ARRAY_KEY_ALL or one of the constants ARRAY_KEY_INT or ARRAY_KEY_STRING to check for a particular type of array.

This function returns true if array is an array, false otherwise.

var array = array_create(ARRAY_KEY_INT, "Hello", "World"); // creates an indexed array with 2 values
var check_array_1 = is_array(array); // returns true
var check_array_2 = is_array(array, ARRAY_KEY_INT); // returns true
var check_array_3 = is_array(array, ARRAY_KEY_STRING); // returns false ("array" is not an associative array)

array_create ( constant key_type [, mixed value_1 [, mixed value_n ] ] )
This function creates an indexed or an associative array.

key_type is one of the constants ARRAY_KEY_INT or ARRAY_KEY_STRING.
value_1 and value_n are optional. The length of the array increases by the number of variables pushed. For indexed arrays, you just have to type the values one after another. For associative arrays, each value has to be an indexed array that maintains the order key: value (the key MUST be a string!).

This function returns an array on success, false on failure.

var array1 = array_create(ARRAY_KEY_INT); // creates an empty indexed array
var array2 = array_create(ARRAY_KEY_INT, "I am", 4, "years old"); // creates an indexed array with 3 values
var array3 = array_create(ARRAY_KEY_STRING); // creates an empty associative array
var array4 = array_create(ARRAY_KEY_STRING, ["lives", 3], ["health", 100]); // creates an associative array with 2 values
var array5 = array_create(ARRAY_KEY_STRING, ["lives", 3], ["health"]); // returns false ("health" is a key with no value assigned)

array_push ( array array , constant overwrite = ARRAY_KEY_OVERWRITE_NO [, mixed value_1 [, mixed value_n ] ] )
This function pushes one or more elements onto the end of an array.

array is the input array.
overwrite is only required for associative arrays and must NOT be typed for indexed arrays. For associative arrays, the constants ARRAY_KEY_OVERWRITE_YES and ARRAY_KEY_OVERWRITE_NO can be used whether you want to allow the existing keys to be overwritten or not.
value_1 and value_n are the values to push onto the end of the array. For indexed arrays, you just have to type the values one after another. For associative arrays, each value has to be an indexed array that maintains the order key: value (the key MUST be a string!).

This function returns an integer which is the number of elements that have been pushed, with overwritten keys not being counted. It can also return false on failure.

var array = array_create(ARRAY_KEY_STRING); // creates an empty associative array
array_push(array, ARRAY_KEY_OVERWRITE_YES, ["lives", 3], ["health", 100]); // returns 2
array_push(array, ARRAY_KEY_OVERWRITE_YES, ["health", 80], ["money", 500]); // returns 1 ("health" has been overwritten)
array_push(array, ARRAY_KEY_OVERWRITE_NO, ["items", 15], ["money", 50]); // returns false (fail, "money" cannot be overwritten)

array_set ( array array , int|string key , mixed value )
This function sets the value to a given key, in an array.

array is the input array.
key is the key to push or overwrite. It must be an integer for indexed arrays and a string for associative arrays.
value is the value that is associated to the key.

This function returns true on success, false on failure.

var array = array_create(ARRAY_KEY_INT, 10, 20); // creates an indexed array with 2 values
array_set(array, 2, 30); // returns true (array[2] is 30)
array_set(array, 4, 40); // returns true (array[4] is 40 and array[3] is undefined)
array_set(array, 0, 50); // returns true (array[0] is now 50)

array_unset ( array array [, int|string|constant key = ARRAY_KEY_UNSET_ALL ] )
This function unsets an entire array or a specific key only.

array is the input array.
key can be the constant ARRAY_KEY_UNSET_ALL to unset the entire array or a specific key (an integer for indexed arrays and a string for associative arrays).

This function returns true on success, false on failure which is the case if nothing is unset.

var array = array_create(ARRAY_KEY_INT, 10, 20, 30, 40, 50); // creates an indexed array with 5 values
array_unset(array, 2); // returns true (array's length is now 4)
array_unset(array); // returns true (array's length is now 0)

array_get ( array array , int|string key )
This function returns the value for a given key, in an array.

array is the input array.
key is the key to get the value from.

This function returns a mixed type if the key exists or undefined if it does not.

var array = array_create(ARRAY_KEY_STRING, ["lives", 3], ["health", 100]); // creates an associative array with 2 values
var health = array_get(array, "health"); // returns 100
var money = array_get(array, "money"); // returns undefined

array_copy ( array array [, int|string start = 0 [, int|string end = -1 ] ] )
This function copies all or part of an array and returns it as a new array.

array is the input array to be copied.
start is the initial position to copy from. This can be 0, an integer for indexed arrays or a string for associative arrays.
end is the last position to copy from. This can be -1 (calculation to the end of the array is automatic), an integer in the range of the array's length -1 for indexed arrays, or a string for associative arrays.

This function returns an array on success, false on failure.

var array = array_create(ARRAY_KEY_INT, 10, 20, 30, 40, 50); // creates an indexed array with 5 values
var new_array_1 = array_copy(array); // copies the entire array
var new_array_2 = array_copy(array, 2); // copies the first three values
var new_array_3 = array_copy(array, 3, 3); // copies the fourth value only

array_count ( array array [, constant mode = ARRAY_COUNT_NORMAL [, constant behavior = ARRAY_BEHAVIOR_JS ] ] )
This function counts all elements in an array.

array is the input array.
If mode is set to ARRAY_COUNT_NORMAL, the array is counted in depth 0. ARRAY_COUNT_RECURSIVE additionally counts the array in depth 1, if this is relevant.
behavior can be one of the constants ARRAY_BEHAVIOR_JS (undefined values are counted) or ARRAY_BEHAVIOR_PHP (undefined values are excluded from the count).

This function returns an integer which is the number of elements in the array, or false on failure.

var array = array_create(ARRAY_KEY_INT, 10, 20, 30, [40, 50], 60); // creates an indexed array with 5 values
array_set(array, 10, 110); // sets index 10 of "array" to 110
var count_array_1 = array_count(array); // returns 11 
var count_array_2 = array_count(array, ARRAY_COUNT_RECURSIVE); // returns 12
var count_array_3 = array_count(array, ARRAY_COUNT_NORMAL, ARRAY_BEHAVIOR_PHP); // returns 6
var count_array_4 = array_count(array, ARRAY_COUNT_RECURSIVE, ARRAY_BEHAVIOR_PHP); // returns 7

Split and join functions

explode ( string string , string delimiter [, int limit = ARRAY_INTERNAL_MAX_INT [, constant behavior = ARRAY_BEHAVIOR_JS ] ] )
This function splits a string by string.

string is the input string.
delimiter is the boundary string.
If limit is positive, the returned array will contain a maximum of limit elements with the last element containing the rest of string; if it is negative and behavior set to ARRAY_BEHAVIOR_JS, then the operation is performed in the reverse way; with ARRAY_BEHAVIOR_PHP, all components except the last -limit are returned.
behavior is one of the constants ARRAY_BEHAVIOR_JS or ARRAY_BEHAVIOR_PHP. This parameter has an impact on the limit action.

This function returns an indexed array on success, false on failure.

var array1 = explode("Hello World", " "); // returns ["Hello", "World"]
var array2 = explode("10|20|30|40|50", "|", 3); // returns ["10", "20", "30|40|50"]
var array3 = explode("10|20|30|40|50", "|", -3, ARRAY_BEHAVIOR_JS); // returns ["10|20|30", "40", "50"]
var array4 = explode("10|20|30|40|50", "|", -3, ARRAY_BEHAVIOR_PHP); // returns ["10", "20"]

implode ( array array [, string glue = "," ] )
This function joins array elements with a string.

array is the input array to implode.
glue is the delimiter string to add between each element.

This function returns a string on success, false on failure.

var array1 = array_create(ARRAY_KEY_INT, "I", "am", 4, "years", "old"); // creates an indexed array with 5 values
var string1 = implode(array1, " "); // returns "I am 4 years old"
var array2 = array_create(ARRAY_KEY_STRING, ["food", "pizza"], ["drink", "water"], ["money", 500]); // creates an associative array with 3 values
var string2 = implode(array2); // returns "pizza,water,500"

Key-related functions

array_key_exists ( array array , int|string key [, constant strict = ARRAY_CHECK_STRICT_YES ] )
This function checks if a given key exists in an array.

array is the array with keys to check.
key is the value to check. This is an integer for indexed arrays and a string for associative arrays.
If strict is set to ARRAY_CHECK_STRICT_YES, the function checks the types of the key in the array. This is not the case if the constant ARRAY_CHECK_STRICT_NO is specified.

This function returns true on success, false on failure.

var array = array_create(ARRAY_KEY_INT, "Hello, "World"); // creates an indexed array with 2 values
array_set(array, 10, "Earth"); // sets index 10 of "array" to "Earth"
var key_exists_array_1 = array_key_exists(array, 0); // returns true
var key_exists_array_2 = array_key_exists(array, "10", ARRAY_CHECK_STRICT_NO); // returns true
var key_exists_array_3 = array_key_exists(array, 8); // returns false

array_keys ( array array [, mixed value [, constant strict = ARRAY_CHECK_STRICT_YES ] ] )
This function returns all the keys or a subset of the keys of an array.

array is the array containing keys to return.
If value is specified, then only keys containing these values are returned.
If strict is set to ARRAY_CHECK_STRICT_YES, the function checks the types of the value in the array. This is not the case if the constant ARRAY_CHECK_STRICT_NO is specified and the function additionally acts in a recursive way (depth 1 only).

This function returns an indexed array that can be empty if the specified value is not matched, or false on failure.

var array = array_create(ARRAY_KEY_STRING, ["firstname", "Bart"], ["lastname", "Simpson"], ["firstname_father", "Homer"], ["lastname_father", "Simpson"]); // creates an associative array with 4 values
var keys_array_1 = array_keys(array); // returns ["firstname", "lastname", "firstname_father", "lastname_father"]
var keys_array_2 = array_keys(array, "Simpson"); // returns ["lastname", "lastname_father"]
var keys_array_3 = array_keys(array, "Marge"); // returns []

Value-related functions

in_array ( array array , mixed value [, constant strict = ARRAY_CHECK_STRICT_YES ] )
This function checks if a value exists in an array.

array is the array.
value is the searched value.
If strict is set to ARRAY_CHECK_STRICT_YES, the function checks the types of the value in the array. This is not the case if the constant ARRAY_CHECK_STRICT_NO is specified and the function additionally acts in a recursive way (depth 1 only).

This function returns true if value is found in array, false otherwise.

var array = array_create(ARRAY_KEY_STRING, ["food", "pizza"], ["drink", "water"], ["money", 500]); // creates an associative array with 3 values
var in_array_1 = in_array(array, "pizza"); // returns true
var in_array_2 = in_array(array, "500", ARRAY_CHECK_STRICT_NO); // returns true
var in_array_3 = in_array(array, "500"); // returns false ("500" as a string is not 500 as an integer)
var in_array_4 = in_array(array, "drink"); // returns false ("drink" is a key, not a value)

PHP's Array Extension in JavaScript (v1.1, 2017-03-03) GD Productions | Support Forum