This library provides utility functions to help simplify menial tasks.
Where possible, this library provides some wrappers around some built-in functions. Our code should always throw exceptions instead of triggering errors/warnings/notices (excluding deprecation warnings).
Table of Contents:
Functions to deal with arrays.
Additional assertions built on Webmozart\Assert.
Throws InvalidArgumentException if $value is not an array or object
implementing ArrayAccess.
isArrayAccessible($value, string $message = ''): voidThrows InvalidArgumentException if $value is not an instance of one of the
given classes/interfaces.
isInstanceOfAny($value, string[] $classes, string $message = ''): voidThrows InvalidArgumentException if $value is not an iterable. Same as
isTraversable(), just a better name.
isIterable($value, string $message = ''): voidHelper methods for triggering deprecation warnings.
Shortcut for triggering a deprecation warning for something.
warn(string $subject, string|float $since = null, string $suggest = ''): voidExamples:
// Triggers warning: "Doing foo is deprecated."
Deprecated::warn('Doing foo');
// Triggers warning: "Doing foo is deprecated since 3.3 and will be removed in 4.0."
Deprecated::warn('Doing foo', 3.3);
// Triggers warning: "Doing foo is deprecated since 3.3 and will be removed in 4.0. Do bar instead."
Deprecated::warn('Doing foo', 3.3, 'Do bar instead');Shortcut for triggering a deprecation warning for a method.
method(string|float $since = null, string $suggest = '', string $method = null): void$suggest can be a sentence describing what to use instead. Or it can be a
method name or class::method which will be converted to a sentence.
$method defaults to the method/function it was called from.
- If called from constructor, warning message says the class is deprecated.
- If called from magic method, warning message says the method/property called with is deprecated.
Example:
class Foo
{
public function world()
{
// Triggers warning: "Foo::world() is deprecated since 3.3 and will be removed in 4.0. Use hello() instead."
Deprecated::method(3.3, 'hello');
}
}Shortcut for triggering a deprecation warning for a class.
cls(string $class, string|float $since = null, string $suggest = null): void$suggest can be a sentence describing what to use instead. Or it can be a
class name which will be converted to a sentence.
Examples:
// Triggers warning: "Foo\Bar is deprecated."
Deprecated::cls('Foo\Bar');
// Triggers warning: "Foo\Bar is deprecated. Use Bar\Baz instead."
Deprecated::cls('Foo\Bar', null, 'Bar\Baz');Handles setting and retrieving values from PHP's configuration.
Checks whether the key exists.
has(string $key): boolGet a string value. The default is returned if the key does not exist or the value is empty.
getStr(string $key, string $default = null): ?stringGet a boolean value. False is returned if the key does not exist or the value is empty.
getBool(string $key): boolGet a numeric value. The default is returned if the key does not exist or the value is empty.
getNumeric(string $key, int|float $default = null): int|float|nullGet a memory size value, such as memory_limit, and convert it to an integer.
The default is returned if the key does not exist or the value is empty.
getBytes(string $key, int $default = null): ?intSet a new value for the given key.
Throws RuntimeException if the key does not exist, it is not editable, or
something goes wrong.
set(string $key, ?scalar $value): voidHandles JSON parsing/dumping with error handling.
Parses JSON string to array or scalar.
Throws ParseException if anything goes wrong.
parse(string $json, int $options = 0, int $depth = 512): stringWe use seld/jsonlint to determine why
the parsing failed and include it in the exception message.
Dumps mixed to JSON string. Throws DumpException if anything goes wrong.
dump(mixed $data, int $options = JSON_PRETTY_PRINT | JSON_UNESCAPED_SLASHES | JSON_UNESCAPED_UNICODE, int $depth = 512): stringIf input contains invalid UTF-8 characters we try to convert these for you before failing.
Returns whether the string is valid JSON.
test(string $json): boolHandles PHP serialization parsing/dumping with error handling.
Parses PHP serialized string.
Throws ParseException if a serialized class cannot be found or anything else
goes wrong.
parse(string $value, array $options = []): mixedNote: $options parameter is ignored on PHP 5.
See unserialize() for
details.
Dumps anything to a PHP serialized string.
Throws DumpException if the input is not serializable or anything else goes
wrong.
dump(mixed $value): stringCommon string methods.
Replaces the first occurrence of the $search text on the $subject.
replaceFirst(string $subject, string $search, string $replace, bool $caseSensitive = true): stringReplaces the last occurrence of the $search text on the $subject.
replaceLast(string $subject, string $search, string $replace, bool $caseSensitive = true): stringRemoves the first occurrence of the $search text on the $subject.
removeFirst(string $subject, string $search, bool $caseSensitive = true): stringRemoves the last occurrence of the $search text on the $subject.
removeLast(string $subject, string $search, bool $caseSensitive = true): stringSplits a $subject on the $delimiter and returns the first part.
splitFirst(string $subject, string $delimiter): stringSplits a $subject on the $delimiter and returns the last part.
splitLast(string $subject, string $delimiter): stringReturns whether the subjects ends with the search string.
endsWith(string $subject, string $search, bool $caseSensitive = true): boolReturns the class name without the namespace, of a string FQCN, or object.
className(string|object $class): stringConverts a string from camel case and snake case to a human readable string.
humanize(string $text): stringConverts a string from snake case to camel case.
camelCase(string $text, bool $lowercaseFirstChar = false): stringConverts a string from camel case to snake case.
snakeCase(string $text): string