Download the PHP package mordilion/mutils without Composer

MUtils

A PHP utility library providing helpful array, string, bitwise, and reflection functions — plus stable-sort and string backports so PHP 7.1+ projects can use PHP 8.0+ behaviour today.

Dual API: Every function is available as a namespaced function (MUtils\Arrays\sort()) and as a static method (MUtils\Arrays::sort()). Use whichever style fits your codebase.

Table of Contents

• Installation
• Quick Start
• API Reference: Arrays
  • Sorting (PHP 8.0+ Backports)
  • Utility Functions
• API Reference: Bits
• API Reference: Strings
• API Reference: Objects
• PHP Version Compatibility
• Development
• License

Installation

Quick Start

Arrays

Array sorting with stable-sort guarantees (PHP 8.0+ backport) and utility functions for grouping, moving, and prefix operations.

Sorting (PHP 8.0+ Backports)

On PHP 8.0+ these pass through to the native implementation. On PHP < 8.0 they use a Schwartzian transform to guarantee stable sorting — equal elements retain their original order.

Note: The backport implementation is slower than native sorting. On PHP 8.0+ there is no performance penalty.

Utility Functions

array_group_by(array $array, bool $preserveKeys, $column, ...$columns): array

Static: Arrays::groupBy()

Groups array elements by a column key, object property, or callable. Pass additional $column arguments for nested grouping.

The $column parameter accepts:

• string or int — array key or object property name
• callable — receives the element, returns the group key

Throws: InvalidArgumentException if $column is not a string, integer, float, or callable.

array_move_element(array &$array, int $fromIndex, int $toIndex): void

Static: Arrays::moveElement()

Moves an element from one position to another within an indexed array.

Throws: OutOfBoundsException if either index is out of range or the array is empty.

array_prefix_add(array $array, string $prefix, int $options = ARRAY_PREFIX_KEY): array

Static: Arrays::addPrefix()

Adds a prefix to array keys or values.

array_prefix_remove(array $array, string $prefix, int $options = ARRAY_PREFIX_KEY): array

Static: Arrays::removePrefix()

Removes a prefix from array keys or values. Keys/values that do not start with the prefix are left unchanged.

Prefix Constants

Since these are bitmask values, you can combine them: ARRAY_PREFIX_KEY | ARRAY_PREFIX_VALUE (= 3) applies the operation to both keys and values.

array_compare_flags($a, $b, int $flags): int

Static: Arrays::compareFlags()

Compares two values using PHP sort flag semantics. Primarily used internally by the stable-sort backport, but available as a public API.

Supported flags: SORT_REGULAR, SORT_NUMERIC, SORT_STRING, SORT_STRING | SORT_FLAG_CASE, SORT_NATURAL, SORT_NATURAL | SORT_FLAG_CASE, SORT_LOCALE_STRING.

Bits

Bitwise utility functions for working with sets of bit flags.

Strings

PHP 8.0+ string function backports. On PHP 8.0+ these pass through to the native implementation. On PHP < 8.0 they use mb_* functions as the implementation.

Note: On PHP < 8.0, the mbstring extension is required.

Objects

Reflection utility functions that traverse the class inheritance chain. Unlike PHP's built-in ReflectionClass::getMethod() and ReflectionClass::getProperty(), these functions walk up through parent classes to find methods and properties defined anywhere in the hierarchy.

All functions accept an object instance, a class name string, or a ReflectionClass instance as the first parameter. Returns null if the target is not found (or if null is passed).

Throws: InvalidArgumentException if the first argument is not an object, string, or null. get_reflection_class may also throw ReflectionException if the class does not exist.

PHP Version Compatibility

Development

License

MIT