Source Code Documentation


Field Summary | Method Summary | Field Detail | Method Detail

Package s2Member\Utilities

s2member\includes\classes\utils-arrays.inc.php at line #28

Class c_ws_plugin__s2member_utils_arrays

c_ws_plugin__s2member_utils_arrays

public class c_ws_plugin__s2member_utils_arrays

Array utilities.

Since:

3.5


( 8 Methods )
Method Summary
public static array

array_unique(array $array)

Extends array_unique() to support multi-dimensional arrays.

public static array

force_integers(array $array)

Forces integer values on each array value (also supports multi-dimensional arrays).

public static array

force_strings(array $array)

Forces string values on each array value (also supports multi-dimensional arrays).

public static bool

in_regex_array(str $string, array $array)

Searches an array (or even a multi-dimensional array) of regular expressions, to match against a string value.

public Unlike

ksort_deep(array $array, int $flags)

Sorts arrays (also supports multi-dimensional arrays) by key, low to high.

public static bool

regex_in_array(str $regex, bool $array)

Searches an array (or even a multi-dimensional array) using a regular expression match against array values.

public static array

remove_0b_strings(array $array)

Removes all 0-byte strings from an array (or even a multi-dimensional array).

public static array

remove_nulls(array $array)

Removes all null values from an array (or even a multi-dimensional array).

( 8 Methods )
Method Detail

s2member\includes\classes\utils-arrays.inc.php at line #39

array_unique()

public static array array_unique(array $array)

Extends array_unique() to support multi-dimensional arrays.

Since:

3.5

Parameters:

array $array - Expects an incoming array.

Returns:

array - Returns the $array after having reduced it to a unique set of values.

[ back to top ]

s2member\includes\classes\utils-arrays.inc.php at line #194

force_integers()

public static array force_integers(array $array)

Forces integer values on each array value (also supports multi-dimensional arrays).

Since:

111101

Parameters:

array $array - An input array.

Returns:

array - Returns the $array after having forced it to set of integer values.

[ back to top ]

s2member\includes\classes\utils-arrays.inc.php at line #171

force_strings()

public static array force_strings(array $array)

Forces string values on each array value (also supports multi-dimensional arrays).

Since:

111101

Parameters:

array $array - An input array.

Returns:

array - Returns the $array after having forced it to set of string values.

[ back to top ]

s2member\includes\classes\utils-arrays.inc.php at line #94

in_regex_array()

public static bool in_regex_array(str $string, array $array)

Searches an array (or even a multi-dimensional array) of regular expressions, to match against a string value.

Since:

3.5

Parameters:

str $string - A string to test against.

array $array - An array of regex patterns to match against $string.

Returns:

bool - True if at least one regular expression in the $array matched $string, else false.

[ back to top ]

s2member\includes\classes\utils-arrays.inc.php at line #219

ksort_deep()

public Unlike ksort_deep(array $array, int $flags)

Sorts arrays (also supports multi-dimensional arrays) by key, low to high.

Since:

111205

Parameters:

array $array - An input array.

int $flags - Optional. Can be used to modify the sorting behavior. See: http://www.php.net/manual/en/function.ksort.php

Returns:

Unlike - PHP's ksort(), this function returns the array, and does NOT work on a reference.

[ back to top ]

s2member\includes\classes\utils-arrays.inc.php at line #62

regex_in_array()

public static bool regex_in_array(str $regex, bool $array)

Searches an array (or even a multi-dimensional array) using a regular expression match against array values.

Since:

3.5

Parameters:

str $regex - A regular expression to look for inside the array.

Returns:

bool - True if the regular expression matched at least one value in the array, else false.

[ back to top ]

s2member\includes\classes\utils-arrays.inc.php at line #148

remove_0b_strings()

public static array remove_0b_strings(array $array)

Removes all 0-byte strings from an array (or even a multi-dimensional array).

Since:

111216

Parameters:

array $array - An input array.

Returns:

array - Returns the $array after having reduced its set of values.

[ back to top ]

s2member\includes\classes\utils-arrays.inc.php at line #125

remove_nulls()

public static array remove_nulls(array $array)

Removes all null values from an array (or even a multi-dimensional array).

Since:

111101

Parameters:

array $array - An input array.

Returns:

array - Returns the $array after having reduced its set of values.

[ back to top ]

Source Code Documentation


Field Summary | Method Summary | Field Detail | Method Detail