Usephul

usephul

Table of Contents

Namespaces

Enumerations
generators
Math
Path
Sorting
Type
Var

Constants

E_EVERYTHING  = 0x7fffffff
This mask matches every possible past and future PHP error level.
undefined  = \empaphy\usephul\Type\Undefined::undefined
Represents an undefined value.
ZEND_KNOWN_STRINGS  = [ZEND_STR_FILE => ZEND_STR_FILE, ZEND_STR_LINE => ZEND_STR_LINE, ZEND_STR_FUNCTION => ZEND_STR_FUNCTION, ZEND_STR_CLASS => ZEND_STR_CLASS, ZEND_STR_OBJECT => ZEND_STR_OBJECT, ZEND_STR_TYPE => ZEND_STR_TYPE, ZEND_STR_OBJECT_OPERATOR => ZEND_STR_OBJECT_OPERATOR, ZEND_STR_PAAMAYIM_NEKUDOTAYIM => ZEND_STR_PAAMAYIM_NEKUDOTAYIM, ZEND_STR_ARGS => ZEND_STR_ARGS, ZEND_STR_UNKNOWN => ZEND_STR_UNKNOWN, ZEND_STR_UNKNOWN_CAPITALIZED => ZEND_STR_UNKNOWN_CAPITALIZED, ZEND_STR_EXIT => ZEND_STR_EXIT, ZEND_STR_EVAL => ZEND_STR_EVAL, ZEND_STR_INCLUDE => ZEND_STR_INCLUDE, ZEND_STR_REQUIRE => ZEND_STR_REQUIRE, ZEND_STR_INCLUDE_ONCE => ZEND_STR_INCLUDE_ONCE, ZEND_STR_REQUIRE_ONCE => ZEND_STR_REQUIRE_ONCE, ZEND_STR_SCALAR => ZEND_STR_SCALAR, ZEND_STR_ERROR_REPORTING => ZEND_STR_ERROR_REPORTING, ZEND_STR_STATIC => ZEND_STR_STATIC, ZEND_STR_THIS => ZEND_STR_THIS, ZEND_STR_VALUE => ZEND_STR_VALUE, ZEND_STR_KEY => ZEND_STR_KEY, ZEND_STR_MAGIC_INVOKE => ZEND_STR_MAGIC_INVOKE, ZEND_STR_PREVIOUS => ZEND_STR_PREVIOUS, ZEND_STR_CODE => ZEND_STR_CODE, ZEND_STR_MESSAGE => ZEND_STR_MESSAGE, ZEND_STR_SEVERITY => ZEND_STR_SEVERITY, ZEND_STR_STRING => ZEND_STR_STRING, ZEND_STR_TRACE => ZEND_STR_TRACE, ZEND_STR_SCHEME => ZEND_STR_SCHEME, ZEND_STR_HOST => ZEND_STR_HOST, ZEND_STR_PORT => ZEND_STR_PORT, ZEND_STR_USER => ZEND_STR_USER, ZEND_STR_PASS => ZEND_STR_PASS, ZEND_STR_PATH => ZEND_STR_PATH, ZEND_STR_QUERY => ZEND_STR_QUERY, ZEND_STR_FRAGMENT => ZEND_STR_FRAGMENT, ZEND_STR_NULL => ZEND_STR_NULL, ZEND_STR_BOOLEAN => ZEND_STR_BOOLEAN, ZEND_STR_INTEGER => ZEND_STR_INTEGER, ZEND_STR_DOUBLE => ZEND_STR_DOUBLE, ZEND_STR_ARRAY => ZEND_STR_ARRAY, ZEND_STR_RESOURCE => ZEND_STR_RESOURCE, ZEND_STR_CLOSED_RESOURCE => ZEND_STR_CLOSED_RESOURCE, ZEND_STR_NAME => ZEND_STR_NAME, ZEND_STR_ARGV => ZEND_STR_ARGV, ZEND_STR_ARGC => ZEND_STR_ARGC, ZEND_STR_ARRAY_CAPITALIZED => ZEND_STR_ARRAY_CAPITALIZED, ZEND_STR_BOOL => ZEND_STR_BOOL, ZEND_STR_INT => ZEND_STR_INT, ZEND_STR_FLOAT => ZEND_STR_FLOAT, ZEND_STR_CALLABLE => ZEND_STR_CALLABLE, ZEND_STR_ITERABLE => ZEND_STR_ITERABLE, ZEND_STR_VOID => ZEND_STR_VOID, ZEND_STR_NEVER => ZEND_STR_NEVER, ZEND_STR_FALSE => ZEND_STR_FALSE, ZEND_STR_TRUE => ZEND_STR_TRUE, ZEND_STR_NULL_LOWERCASE => ZEND_STR_NULL_LOWERCASE, ZEND_STR_MIXED => ZEND_STR_MIXED, ZEND_STR_TRAVERSABLE => ZEND_STR_TRAVERSABLE, ZEND_STR_SLEEP => ZEND_STR_SLEEP, ZEND_STR_WAKEUP => ZEND_STR_WAKEUP, ZEND_STR_CASES => ZEND_STR_CASES, ZEND_STR_FROM => ZEND_STR_FROM, ZEND_STR_TRYFROM => ZEND_STR_TRYFROM, ZEND_STR_TRYFROM_LOWERCASE => ZEND_STR_TRYFROM_LOWERCASE, ZEND_STR_AUTOGLOBAL_SERVER => ZEND_STR_AUTOGLOBAL_SERVER, ZEND_STR_AUTOGLOBAL_ENV => ZEND_STR_AUTOGLOBAL_ENV, ZEND_STR_AUTOGLOBAL_REQUEST => ZEND_STR_AUTOGLOBAL_REQUEST, ZEND_STR_COUNT => ZEND_STR_COUNT, ZEND_STR_SENSITIVEPARAMETER => ZEND_STR_SENSITIVEPARAMETER, ZEND_STR_CONST_EXPR_PLACEHOLDER => ZEND_STR_CONST_EXPR_PLACEHOLDER, ZEND_STR_DEPRECATED_CAPITALIZED => ZEND_STR_DEPRECATED_CAPITALIZED, ZEND_STR_SINCE => ZEND_STR_SINCE, ZEND_STR_GET => ZEND_STR_GET, ZEND_STR_SET => ZEND_STR_SET]
ZEND_STR_ARGC  = 'argc'
ZEND_STR_ARGS  = 'args'
ZEND_STR_ARGV  = 'argv'
ZEND_STR_ARRAY  = 'array'
ZEND_STR_ARRAY_CAPITALIZED  = 'Array'
ZEND_STR_AUTOGLOBAL_ENV  = '_ENV'
ZEND_STR_AUTOGLOBAL_REQUEST  = '_REQUEST'
ZEND_STR_AUTOGLOBAL_SERVER  = '_SERVER'
ZEND_STR_BOOL  = 'bool'
ZEND_STR_BOOLEAN  = 'boolean'
ZEND_STR_CALLABLE  = 'callable'
ZEND_STR_CASES  = 'cases'
ZEND_STR_CLASS  = 'class'
ZEND_STR_CLOSED_RESOURCE  = 'resource (closed)'
ZEND_STR_CODE  = 'code'
ZEND_STR_CONST_EXPR_PLACEHOLDER  = '[constant expression]'
ZEND_STR_COUNT  = 'count'
ZEND_STR_DEPRECATED_CAPITALIZED  = 'Deprecated'
ZEND_STR_DOUBLE  = 'double'
ZEND_STR_ERROR_REPORTING  = 'error_reporting'
ZEND_STR_EVAL  = 'eval'
ZEND_STR_EXIT  = 'exit'
ZEND_STR_FALSE  = 'false'
ZEND_STR_FILE  = 'file'
ZEND_STR_FLOAT  = 'float'
ZEND_STR_FRAGMENT  = 'fragment'
ZEND_STR_FROM  = 'from'
ZEND_STR_FUNCTION  = 'function'
ZEND_STR_GET  = 'get'
ZEND_STR_HOST  = 'host'
ZEND_STR_INCLUDE  = 'include'
ZEND_STR_INCLUDE_ONCE  = 'include_once'
ZEND_STR_INT  = 'int'
ZEND_STR_INTEGER  = 'integer'
ZEND_STR_ITERABLE  = 'iterable'
ZEND_STR_KEY  = 'key'
ZEND_STR_LINE  = 'line'
ZEND_STR_MAGIC_INVOKE  = '__invoke'
ZEND_STR_MESSAGE  = 'message'
ZEND_STR_MIXED  = 'mixed'
ZEND_STR_NAME  = 'name'
ZEND_STR_NEVER  = 'never'
ZEND_STR_NULL  = 'NULL'
ZEND_STR_NULL_LOWERCASE  = 'null'
ZEND_STR_OBJECT  = 'object'
ZEND_STR_OBJECT_OPERATOR  = '->'
ZEND_STR_PAAMAYIM_NEKUDOTAYIM  = '::'
ZEND_STR_PASS  = 'pass'
ZEND_STR_PATH  = 'path'
ZEND_STR_PORT  = 'port'
ZEND_STR_PREVIOUS  = 'previous'
ZEND_STR_QUERY  = 'query'
ZEND_STR_REQUIRE  = 'require'
ZEND_STR_REQUIRE_ONCE  = 'require_once'
ZEND_STR_RESOURCE  = 'resource'
ZEND_STR_SCALAR  = 'scalar'
ZEND_STR_SCHEME  = 'scheme'
ZEND_STR_SENSITIVEPARAMETER  = 'SensitiveParameter'
ZEND_STR_SET  = 'set'
ZEND_STR_SEVERITY  = 'severity'
ZEND_STR_SINCE  = 'since'
ZEND_STR_SLEEP  = '__sleep'
ZEND_STR_STATIC  = 'static'
ZEND_STR_STRING  = 'string'
ZEND_STR_THIS  = 'this'
ZEND_STR_TRACE  = 'trace'
ZEND_STR_TRAVERSABLE  = 'Traversable'
ZEND_STR_TRUE  = 'true'
ZEND_STR_TRYFROM  = 'tryFrom'
ZEND_STR_TRYFROM_LOWERCASE  = 'tryfrom'
ZEND_STR_TYPE  = 'type'
ZEND_STR_UNKNOWN  = 'unknown'
ZEND_STR_UNKNOWN_CAPITALIZED  = 'Unknown'
ZEND_STR_USER  = 'user'
ZEND_STR_VALUE  = 'value'
ZEND_STR_VOID  = 'void'
ZEND_STR_WAKEUP  = '__wakeup'

Functions

array_exclude()  : array<string|int, mixed>
Exclude from an array all the elements that match the provided values.
array_extract()  : array<string|int, mixed>
Extract from an array all the elements of the input array matching the provided values.
array_get()  : TArray : mixed)
Retrieve an element from an array that can be located several levels deep.
array_interchange()  : array<string|int, mixed>
Interchange the values of two elements in an array.
array_key_types()  : ($array is array{} ? array{} : ($array is array ? array{integer: true} : ($array is array ? array{string: true} : array{integer: true, string: true})))
Inspects the types of keys used in an array.
array_omit()  : array<string|int, mixed>
Create a copy of the input array while omiting specific keys.
array_pick()  : array<string|int, mixed>
Create a new array by picking elements from the input array corresponding to a specific set of keys.
array_remap()  : array<string|int, mixed>
Applies a (generator) callback to the elements of a given array, allowing the remapping of its keys in the process.
array_split()  : TArray> : array[]))
Split an array by a value.
array_zip()  : array<int, TValue}>
Perform a zip operation on multiple arrays.
debug_backtrace_depth()  : int
Returns the current stack trace depth.
class_parents_uses()  : array<string, class-string>|false
Return the traits used by the parent classes of the given class.
class_parents_traits_uses()  : array<string, class-string>|false
Return the traits used by the parent classes of the given class, recursively.
class_traits_uses()  : array<string, class-string>|false
Return the traits used by the given class or trait, recursively.

Constants

E_EVERYTHING

This mask matches every possible past and future PHP error level.

public mixed E_EVERYTHING = 0x7fffffff

undefined

Represents an undefined value.

public mixed undefined = \empaphy\usephul\Type\Undefined::undefined

This can be used to explicitly indicate that a variable or parameter may be undefined, differentiating it from null or other values.

You can use this as a default value to safely check that no valid value was provided:

$value = config('some_key', undefined);

This is useful in cases where null is a valid value, and you need to distinguish between "no value provided" and "value explicitly set to null".

This constant maps to the singleton case of the Undefined enum, so you can use the Undefined enum as a type hint:

function example(string|null|Undefined $param = undefined): void }

ZEND_KNOWN_STRINGS

public mixed ZEND_KNOWN_STRINGS = [ZEND_STR_FILE => ZEND_STR_FILE, ZEND_STR_LINE => ZEND_STR_LINE, ZEND_STR_FUNCTION => ZEND_STR_FUNCTION, ZEND_STR_CLASS => ZEND_STR_CLASS, ZEND_STR_OBJECT => ZEND_STR_OBJECT, ZEND_STR_TYPE => ZEND_STR_TYPE, ZEND_STR_OBJECT_OPERATOR => ZEND_STR_OBJECT_OPERATOR, ZEND_STR_PAAMAYIM_NEKUDOTAYIM => ZEND_STR_PAAMAYIM_NEKUDOTAYIM, ZEND_STR_ARGS => ZEND_STR_ARGS, ZEND_STR_UNKNOWN => ZEND_STR_UNKNOWN, ZEND_STR_UNKNOWN_CAPITALIZED => ZEND_STR_UNKNOWN_CAPITALIZED, ZEND_STR_EXIT => ZEND_STR_EXIT, ZEND_STR_EVAL => ZEND_STR_EVAL, ZEND_STR_INCLUDE => ZEND_STR_INCLUDE, ZEND_STR_REQUIRE => ZEND_STR_REQUIRE, ZEND_STR_INCLUDE_ONCE => ZEND_STR_INCLUDE_ONCE, ZEND_STR_REQUIRE_ONCE => ZEND_STR_REQUIRE_ONCE, ZEND_STR_SCALAR => ZEND_STR_SCALAR, ZEND_STR_ERROR_REPORTING => ZEND_STR_ERROR_REPORTING, ZEND_STR_STATIC => ZEND_STR_STATIC, ZEND_STR_THIS => ZEND_STR_THIS, ZEND_STR_VALUE => ZEND_STR_VALUE, ZEND_STR_KEY => ZEND_STR_KEY, ZEND_STR_MAGIC_INVOKE => ZEND_STR_MAGIC_INVOKE, ZEND_STR_PREVIOUS => ZEND_STR_PREVIOUS, ZEND_STR_CODE => ZEND_STR_CODE, ZEND_STR_MESSAGE => ZEND_STR_MESSAGE, ZEND_STR_SEVERITY => ZEND_STR_SEVERITY, ZEND_STR_STRING => ZEND_STR_STRING, ZEND_STR_TRACE => ZEND_STR_TRACE, ZEND_STR_SCHEME => ZEND_STR_SCHEME, ZEND_STR_HOST => ZEND_STR_HOST, ZEND_STR_PORT => ZEND_STR_PORT, ZEND_STR_USER => ZEND_STR_USER, ZEND_STR_PASS => ZEND_STR_PASS, ZEND_STR_PATH => ZEND_STR_PATH, ZEND_STR_QUERY => ZEND_STR_QUERY, ZEND_STR_FRAGMENT => ZEND_STR_FRAGMENT, ZEND_STR_NULL => ZEND_STR_NULL, ZEND_STR_BOOLEAN => ZEND_STR_BOOLEAN, ZEND_STR_INTEGER => ZEND_STR_INTEGER, ZEND_STR_DOUBLE => ZEND_STR_DOUBLE, ZEND_STR_ARRAY => ZEND_STR_ARRAY, ZEND_STR_RESOURCE => ZEND_STR_RESOURCE, ZEND_STR_CLOSED_RESOURCE => ZEND_STR_CLOSED_RESOURCE, ZEND_STR_NAME => ZEND_STR_NAME, ZEND_STR_ARGV => ZEND_STR_ARGV, ZEND_STR_ARGC => ZEND_STR_ARGC, ZEND_STR_ARRAY_CAPITALIZED => ZEND_STR_ARRAY_CAPITALIZED, ZEND_STR_BOOL => ZEND_STR_BOOL, ZEND_STR_INT => ZEND_STR_INT, ZEND_STR_FLOAT => ZEND_STR_FLOAT, ZEND_STR_CALLABLE => ZEND_STR_CALLABLE, ZEND_STR_ITERABLE => ZEND_STR_ITERABLE, ZEND_STR_VOID => ZEND_STR_VOID, ZEND_STR_NEVER => ZEND_STR_NEVER, ZEND_STR_FALSE => ZEND_STR_FALSE, ZEND_STR_TRUE => ZEND_STR_TRUE, ZEND_STR_NULL_LOWERCASE => ZEND_STR_NULL_LOWERCASE, ZEND_STR_MIXED => ZEND_STR_MIXED, ZEND_STR_TRAVERSABLE => ZEND_STR_TRAVERSABLE, ZEND_STR_SLEEP => ZEND_STR_SLEEP, ZEND_STR_WAKEUP => ZEND_STR_WAKEUP, ZEND_STR_CASES => ZEND_STR_CASES, ZEND_STR_FROM => ZEND_STR_FROM, ZEND_STR_TRYFROM => ZEND_STR_TRYFROM, ZEND_STR_TRYFROM_LOWERCASE => ZEND_STR_TRYFROM_LOWERCASE, ZEND_STR_AUTOGLOBAL_SERVER => ZEND_STR_AUTOGLOBAL_SERVER, ZEND_STR_AUTOGLOBAL_ENV => ZEND_STR_AUTOGLOBAL_ENV, ZEND_STR_AUTOGLOBAL_REQUEST => ZEND_STR_AUTOGLOBAL_REQUEST, ZEND_STR_COUNT => ZEND_STR_COUNT, ZEND_STR_SENSITIVEPARAMETER => ZEND_STR_SENSITIVEPARAMETER, ZEND_STR_CONST_EXPR_PLACEHOLDER => ZEND_STR_CONST_EXPR_PLACEHOLDER, ZEND_STR_DEPRECATED_CAPITALIZED => ZEND_STR_DEPRECATED_CAPITALIZED, ZEND_STR_SINCE => ZEND_STR_SINCE, ZEND_STR_GET => ZEND_STR_GET, ZEND_STR_SET => ZEND_STR_SET]

ZEND_STR_ARGC

public mixed ZEND_STR_ARGC = 'argc'

ZEND_STR_ARGS

public mixed ZEND_STR_ARGS = 'args'

ZEND_STR_ARGV

public mixed ZEND_STR_ARGV = 'argv'

ZEND_STR_ARRAY

public mixed ZEND_STR_ARRAY = 'array'

ZEND_STR_ARRAY_CAPITALIZED

public mixed ZEND_STR_ARRAY_CAPITALIZED = 'Array'

ZEND_STR_AUTOGLOBAL_ENV

public mixed ZEND_STR_AUTOGLOBAL_ENV = '_ENV'

ZEND_STR_AUTOGLOBAL_REQUEST

public mixed ZEND_STR_AUTOGLOBAL_REQUEST = '_REQUEST'

ZEND_STR_AUTOGLOBAL_SERVER

public mixed ZEND_STR_AUTOGLOBAL_SERVER = '_SERVER'

ZEND_STR_BOOL

public mixed ZEND_STR_BOOL = 'bool'

ZEND_STR_BOOLEAN

public mixed ZEND_STR_BOOLEAN = 'boolean'

ZEND_STR_CALLABLE

public mixed ZEND_STR_CALLABLE = 'callable'

ZEND_STR_CASES

public mixed ZEND_STR_CASES = 'cases'

ZEND_STR_CLASS

public mixed ZEND_STR_CLASS = 'class'

ZEND_STR_CLOSED_RESOURCE

public mixed ZEND_STR_CLOSED_RESOURCE = 'resource (closed)'

ZEND_STR_CODE

public mixed ZEND_STR_CODE = 'code'

ZEND_STR_CONST_EXPR_PLACEHOLDER

public mixed ZEND_STR_CONST_EXPR_PLACEHOLDER = '[constant expression]'

ZEND_STR_COUNT

public mixed ZEND_STR_COUNT = 'count'

ZEND_STR_DEPRECATED_CAPITALIZED

public mixed ZEND_STR_DEPRECATED_CAPITALIZED = 'Deprecated'

ZEND_STR_DOUBLE

public mixed ZEND_STR_DOUBLE = 'double'

ZEND_STR_ERROR_REPORTING

public mixed ZEND_STR_ERROR_REPORTING = 'error_reporting'

ZEND_STR_EVAL

public mixed ZEND_STR_EVAL = 'eval'

ZEND_STR_EXIT

public mixed ZEND_STR_EXIT = 'exit'

ZEND_STR_FALSE

public mixed ZEND_STR_FALSE = 'false'

ZEND_STR_FILE

public mixed ZEND_STR_FILE = 'file'

ZEND_STR_FLOAT

public mixed ZEND_STR_FLOAT = 'float'

ZEND_STR_FRAGMENT

public mixed ZEND_STR_FRAGMENT = 'fragment'

ZEND_STR_FROM

public mixed ZEND_STR_FROM = 'from'

ZEND_STR_FUNCTION

public mixed ZEND_STR_FUNCTION = 'function'

ZEND_STR_GET

public mixed ZEND_STR_GET = 'get'

ZEND_STR_HOST

public mixed ZEND_STR_HOST = 'host'

ZEND_STR_INCLUDE

public mixed ZEND_STR_INCLUDE = 'include'

ZEND_STR_INCLUDE_ONCE

public mixed ZEND_STR_INCLUDE_ONCE = 'include_once'

ZEND_STR_INT

public mixed ZEND_STR_INT = 'int'

ZEND_STR_INTEGER

public mixed ZEND_STR_INTEGER = 'integer'

ZEND_STR_ITERABLE

public mixed ZEND_STR_ITERABLE = 'iterable'

ZEND_STR_KEY

public mixed ZEND_STR_KEY = 'key'

ZEND_STR_LINE

public mixed ZEND_STR_LINE = 'line'

ZEND_STR_MAGIC_INVOKE

public mixed ZEND_STR_MAGIC_INVOKE = '__invoke'

ZEND_STR_MESSAGE

public mixed ZEND_STR_MESSAGE = 'message'

ZEND_STR_MIXED

public mixed ZEND_STR_MIXED = 'mixed'

ZEND_STR_NAME

public mixed ZEND_STR_NAME = 'name'

ZEND_STR_NEVER

public mixed ZEND_STR_NEVER = 'never'

ZEND_STR_NULL

public mixed ZEND_STR_NULL = 'NULL'

ZEND_STR_NULL_LOWERCASE

public mixed ZEND_STR_NULL_LOWERCASE = 'null'

ZEND_STR_OBJECT

public mixed ZEND_STR_OBJECT = 'object'

ZEND_STR_OBJECT_OPERATOR

public mixed ZEND_STR_OBJECT_OPERATOR = '->'

ZEND_STR_PAAMAYIM_NEKUDOTAYIM

public mixed ZEND_STR_PAAMAYIM_NEKUDOTAYIM = '::'

ZEND_STR_PASS

public mixed ZEND_STR_PASS = 'pass'

ZEND_STR_PATH

public mixed ZEND_STR_PATH = 'path'

ZEND_STR_PORT

public mixed ZEND_STR_PORT = 'port'

ZEND_STR_PREVIOUS

public mixed ZEND_STR_PREVIOUS = 'previous'

ZEND_STR_QUERY

public mixed ZEND_STR_QUERY = 'query'

ZEND_STR_REQUIRE

public mixed ZEND_STR_REQUIRE = 'require'

ZEND_STR_REQUIRE_ONCE

public mixed ZEND_STR_REQUIRE_ONCE = 'require_once'

ZEND_STR_RESOURCE

public mixed ZEND_STR_RESOURCE = 'resource'

ZEND_STR_SCALAR

public mixed ZEND_STR_SCALAR = 'scalar'

ZEND_STR_SCHEME

public mixed ZEND_STR_SCHEME = 'scheme'

ZEND_STR_SENSITIVEPARAMETER

public mixed ZEND_STR_SENSITIVEPARAMETER = 'SensitiveParameter'

ZEND_STR_SET

public mixed ZEND_STR_SET = 'set'

ZEND_STR_SEVERITY

public mixed ZEND_STR_SEVERITY = 'severity'

ZEND_STR_SINCE

public mixed ZEND_STR_SINCE = 'since'

ZEND_STR_SLEEP

public mixed ZEND_STR_SLEEP = '__sleep'

ZEND_STR_STATIC

public mixed ZEND_STR_STATIC = 'static'

ZEND_STR_STRING

public mixed ZEND_STR_STRING = 'string'

ZEND_STR_THIS

public mixed ZEND_STR_THIS = 'this'

ZEND_STR_TRACE

public mixed ZEND_STR_TRACE = 'trace'

ZEND_STR_TRAVERSABLE

public mixed ZEND_STR_TRAVERSABLE = 'Traversable'

ZEND_STR_TRUE

public mixed ZEND_STR_TRUE = 'true'

ZEND_STR_TRYFROM

public mixed ZEND_STR_TRYFROM = 'tryFrom'

ZEND_STR_TRYFROM_LOWERCASE

public mixed ZEND_STR_TRYFROM_LOWERCASE = 'tryfrom'

ZEND_STR_TYPE

public mixed ZEND_STR_TYPE = 'type'

ZEND_STR_UNKNOWN

public mixed ZEND_STR_UNKNOWN = 'unknown'

ZEND_STR_UNKNOWN_CAPITALIZED

public mixed ZEND_STR_UNKNOWN_CAPITALIZED = 'Unknown'

ZEND_STR_USER

public mixed ZEND_STR_USER = 'user'

ZEND_STR_VALUE

public mixed ZEND_STR_VALUE = 'value'

ZEND_STR_VOID

public mixed ZEND_STR_VOID = 'void'

ZEND_STR_WAKEUP

public mixed ZEND_STR_WAKEUP = '__wakeup'

Functions

array_exclude()

Exclude from an array all the elements that match the provided values.

array_exclude(array<string|int, TValue> $array, TValue ...$values) : array<string|int, mixed>
Parameters
$array : array<string|int, TValue>

The input array.

$values : TValue

The values to be excluded from array.

Tags
see
array_extract()
  • Extract values from an array
see
array_omit()
  • Omit keys from an array
see
array_pick()
  • Pick keys from an array
Return values
array<string|int, mixed> —

Returns a new array containing all the elements in array except for those with values present in values.

array_extract()

Extract from an array all the elements of the input array matching the provided values.

array_extract(array<string|int, mixed> $array, TValue ...$values) : array<string|int, mixed>
Parameters
$array : array<string|int, mixed>
$values : TValue

The values to be extracted from array.

Tags
see
array_exclude()
  • Exclude values from an array
see
array_omit()
  • Omit keys from an array
see
array_pick()
  • Pick keys from an array
Return values
array<string|int, mixed>

array_get()

Retrieve an element from an array that can be located several levels deep.

array_get(TArray $array, string ...$keys) : TArray : mixed)

For example:

$data = [ 'foo' => [ 'bar' => [ 'baz' => 'BAZ', 'qux' => ['QUX'] ] ] ];

array_get($data, 'foo', 'bar', 'baz'); // Returns 'BAZ' array_get($data, 'foo', 'bar', 'qux'); // Returns ['QUX'] array_get($data, 'foo', 'bar', 'qux', 0); // Returns 'QUX' array_get($data, 'foo', 'bar'); // Returns $data['foo']['bar'] array_get($data, 'foo'); // Returns $data['foo'] array_get($data); // Returns $data

Parameters
$array : TArray

The array to retrieve the element from.

$keys : string

You can provide a path of keys, where each successive key should be a key on the value of the previous key.

Return values
TArray : mixed) —

Returns the value of the desired element, or null if it's not found. If no keys are provided, array is returned.

array_interchange()

Interchange the values of two elements in an array.

array_interchange(array<string|int, mixed> $array, TKey $key1, TKey $key2) : array<string|int, mixed>

If either of the keys doesn't exist in array, then the other key will be set to null, and a PHP Warning will be emitted.

Parameters
$array : array<string|int, mixed>
$key1 : TKey
$key2 : TKey
Return values
array<string|int, mixed>

array_key_types()

Inspects the types of keys used in an array.

array_key_types(array<int|string, mixed> $array) : ($array is array{} ? array{} : ($array is array ? array{integer: true} : ($array is array ? array{string: true} : array{integer: true, string: true})))
Parameters
$array : array<int|string, mixed>

The array to inspect.

Return values
($array is array{} ? array{} : ($array is array ? array{integer: true} : ($array is array ? array{string: true} : array{integer: true, string: true}))) —

Returns an array whose keys are strings representing the types of keys used in array. The values are always true.

array_omit()

Create a copy of the input array while omiting specific keys.

array_omit(array<string|int, mixed> $array, TKey ...$keys) : array<string|int, mixed>
Parameters
$array : array<string|int, mixed>
$keys : TKey

The keys of the elements to be omitted from array.

Tags
see
array_exclude()
  • Exclude values from an array
see
array_extract()
  • Extract values from an array
see
array_pick()
  • Pick keys from an array
Return values
array<string|int, mixed> —

Returns a new array containing all the elements in array except for those with keys present in keys.

array_pick()

Create a new array by picking elements from the input array corresponding to a specific set of keys.

array_pick(array<string|int, mixed> $array, TKey ...$keys) : array<string|int, mixed>
Parameters
$array : array<string|int, mixed>
$keys : TKey

The keys of the elements to pick from array.

Tags
see
array_exclude()
  • Exclude values from an array
see
array_extract()
  • Extract values from an array
see
array_omit()
  • Omit keys from an array
Return values
array<string|int, mixed>

array_remap()

Applies a (generator) callback to the elements of a given array, allowing the remapping of its keys in the process.

array_remap(callable(TKey $key, TValue $value): mixed $callback, array<string|int, mixed> $array) : array<string|int, mixed>

array_remap() returns an array containing the results of applying a callback with the corresponding key and value of array used as arguments.

If callback is a generator function, then it's possible to provide a new key for the resulting array element using yield from $key => $value.

If the same key is yielded more than once, then the later yield will override the previous one.

Parameters
$callback : callable(TKey $key, TValue $value): mixed

A callable to run for each key-value pair in the array.

$array : array<string|int, mixed>
Return values
array<string|int, mixed> —

Returns an array containing the results of applying the callback function to the corresponding key-value pair of array used as arguments for the callback.

array_split()

Split an array by a value.

array_split(TArray $array, TValue $separator[, int $limit = PHP_INT_MAX ][, bool $strict = true ]) : TArray> : array[]))

Returns a list of arrays, each of which is a subset of array formed by splitting it on boundaries formed by the value separator.

Keys are preserved in the resulting arrays.

Note:

For the ordering of the elements, PHP's array iteration order is used.

Parameters
$array : TArray

The input array.

$separator : TValue

The boundary value.

$limit : int = PHP_INT_MAX

If limit is set and positive, the returned list will contain a maximum of limit arrays with the last array containing the rest of array.

If the limit parameter is negative, all arrays except the last -limit are returned.

If the limit parameter is zero, then this is treated as 1.

$strict : bool = true

By default array_split() will use strict comparisons (===) to match separator against the values of array. If strict is set to false then non-strict comparisons (==) will be used instead.

Return values
TArray> : array[])) —

Returns a list of arrays created by splitting the array parameter on boundaries formed by the separator.

If separator contains a value that is not contained in array and a negative limit is used, then an empty list will be returned, otherwise a list containing array will be returned. If separator values appear at the start or end of array, said values will be added as an empty array either in the first or last position of the returned list respectively.

array_zip()

Perform a zip operation on multiple arrays.

array_zip(array<string|int, TValue> $array, array<string|int, TValue> ...$arrays) : array<int, TValue}>
Parameters
$array : array<string|int, TValue>

An array to zip.

$arrays : array<string|int, TValue>

Supplementary list of array arguments to zip.

Return values
array<int, TValue}> —

Returns an array whose elements are each an array holding the elements of the input arrays at the same index.

debug_backtrace_depth()

Returns the current stack trace depth.

debug_backtrace_depth([int $limit = 0 ]) : int
Parameters
$limit : int = 0

This parameter can be used to limit the number of stack frames scanned. The default value of 0 will scan all stack frames.

Return values
int —

The depth of the current stack trace, optionally limited by limit.

class_parents_uses()

Return the traits used by the parent classes of the given class.

class_parents_uses(object|string $object_or_class[, bool $autoload = true ]) : array<string, class-string>|false

This function returns an array with the names of the traits that the parents of the given object_or_class use.

Parameters
$object_or_class : object|string

An object or class name.

$autoload : bool = true

Whether to autoload if not already loaded.

Return values
array<string, class-string>|false —

An array on success, or false when the class doesn't exist.

class_parents_traits_uses()

Return the traits used by the parent classes of the given class, recursively.

class_parents_traits_uses(object|class-string $object_or_class[, bool $autoload = true ]) : array<string, class-string>|false

This function returns an array with the names of the traits that the parent classes of the given object_or_class uses, including traits used within those traits.

Parameters
$object_or_class : object|class-string

An object or class name.

$autoload : bool = true

Whether to autoload if not already loaded.

Return values
array<string, class-string>|false —

An array on success, or false when the class doesn't exist.

class_traits_uses()

Return the traits used by the given class or trait, recursively.

class_traits_uses(object|class-string $object_or_class[, bool $autoload = true ]) : array<string, class-string>|false

This function returns an array with the names of the traits that the given object_or_class uses, including traits used by those traits, recursively. This does, however, not include any traits used by a parent class.

Parameters
$object_or_class : object|class-string

An object, class name or trait name.

$autoload : bool = true

Whether to autoload if not already loaded.

Return values
array<string, class-string>|false —

An array on success, or false when the class doesn't exist.


        

        
    




    

    

                                

                

                            
    

        On this page

        
    


                

                            

            

    

        

            
Search results