README

ArrayKit is a modern PHP 8.4+ library for elegant, high-performance array manipulation, dot notation utilities, dynamic configuration, hookable collections, and more. From shallow single arrays to deeply nested data structures — ArrayKit provides a fluent, reliable toolkit for real-world PHP projects.

📦 Features at a Glance

Single-Dimensional Helpers
Multi-Dimensional Helpers
Dot Notation Get/Set/Flatten
Dynamic Config with Hooks
Collection & Hooked Collection
Unified Facade (ArrayKit)
Traits for DTO & Hooking
Pipeline for Collection Ops
Global Helpers (functions.php)

📚 Modules

➤ Array Helpers

Helper	Description
ArraySingle	Helpers for single-dimensional arrays (detect list/assoc, filter, paginate, duplicates, averages).
ArrayMulti	Helpers for multi-dimensional arrays (flatten, collapse, depth, recursive sort, filter).
DotNotation	Get/set/remove values using dot keys; flatten & expand nested arrays with dot keys.
BaseArrayHelper	Internal shared base for consistent API across helpers.

➤ Config System

Class	Description
Config	Dot-access configuration loader with explicit hook-aware variants (`getWithHooks`, `setWithHooks`, `fillWithHooks`).
LazyFileConfig	First-segment lazy loader (`db.host` loads `db.php` on demand) for lower memory usage on large config trees.
BaseConfigTrait	Shared config logic.

➤ Collections

Class	Description
Collection	OOP array wrapper implementing `ArrayAccess`, `Iterator`, `Countable`, `JsonSerializable`.
HookedCollection	Extends `Collection` with on-get/on-set hooks for real-time transformation of values.
Pipeline	Functional-style pipeline for chaining operations on collections.
BaseCollectionTrait	Shared collection behavior.

➤ Traits

Trait	Description
HookTrait	Generic hook system for on-get/on-set callbacks. Used by `Config`, `LazyFileConfig`, and `HookedCollection`.
DTOTrait	Utility trait for DTO-like behavior: populate, extract, cast arrays/objects easily.

➤ Global Helpers

File	Description
functions.php	Global shortcut functions for frequent array/config tasks.

➤ Facade

Class	Description
ArrayKit	Single entry point for arrays, dot tools, config, and collections (`single()`, `multi()`, etc.).

✅ Requirements

PHP 8.4 or higher

⚡ Installation

composer require infocyph/arraykit

🚀 Quick Examples

🔹 One Facade Entry Point

use Infocyph\ArrayKit\ArrayKit;

$isList = ArrayKit::single()->isList([1, 2, 3]);            // true
$flat = ArrayKit::multi()->flatten([[1], [2, [3]]]);        // [1, 2, 3]
$name = ArrayKit::dot()->get(['user' => ['n' => 'A']], 'user.n'); // A

$config = ArrayKit::config(['app' => ['env' => 'local']]);
$env = $config->get('app.env');                            // local

🔹 Single-Dimensional Helpers

use Infocyph\ArrayKit\Array\ArraySingle;

$list = [1, 2, 3, 2];

// Is it a list?
$isList = ArraySingle::isList($list); // true

// Duplicates
$dupes = ArraySingle::duplicates($list); // [2]

// Pagination
$page = ArraySingle::paginate($list, page:1, perPage:2); // [1, 2]

🔹 Multi-Dimensional Helpers

use Infocyph\ArrayKit\Array\ArrayMulti;

$data = [ [1, 2], [3, [4, 5]] ];

// Flatten to one level
$flat = ArrayMulti::flatten($data); // [1, 2, 3, 4, 5]

// Collapse one level
$collapsed = ArrayMulti::collapse($data); // [1, 2, 3, [4, 5]]

// Nesting depth
$depth = ArrayMulti::depth($data); // 3

// Recursive sort
$sorted = ArrayMulti::sortRecursive($data);

🔹 Dot Notation

use Infocyph\ArrayKit\Array\DotNotation;

$user = [
    'profile' => ['name' => 'Alice']
];

// Get value
$name = DotNotation::get($user, 'profile.name'); // Alice

// Set value
DotNotation::set($user, 'profile.email', 'alice@example.com');

// Flatten
$flat = DotNotation::flatten($user);
// [ 'profile.name' => 'Alice', 'profile.email' => 'alice@example.com' ]

🔹 Config Hooks (Explicit)

use Infocyph\ArrayKit\Config\Config;

$config = new Config();

// Load from file
$config->loadFile(__DIR__.'/config.php');

// Hook: auto-hash password when set
$config->onSet('auth.password', fn($v) => password_hash($v, PASSWORD_BCRYPT));

// Hook: decrypt when getting 'secure.key'
$config->onGet('secure.key', fn($v) => decrypt($v));

// Use it
$config->setWithHooks('auth.password', 'secret123');
$hashed = $config->getWithHooks('auth.password');

🔹 Hooked Collection

use Infocyph\ArrayKit\Collection\HookedCollection;

$collection = new HookedCollection(['name' => 'alice']);

// Hook on-get: uppercase
$collection->onGet('name', fn($v) => strtoupper($v));

// Hook on-set: prefix
$collection->onSet('role', fn($v) => "Role: $v");

echo $collection['name']; // ALICE

$collection['role'] = 'admin';
echo $collection['role']; // Role: admin

🔹 DTO Trait Example

use Infocyph\ArrayKit\traits\DTOTrait;

class UserDTO {
    use DTOTrait;

    public string $name;
    public string $email;
}

$user = new UserDTO();
$user->fromArray(['name' => 'Alice', 'email' => 'alice@example.com']);
$array = $user->toArray();

🤝 Support

Have a bug or feature idea? Please open an issue.

📄 License

Licensed under the MIT License — use it freely for personal or commercial projects. See LICENSE for details.

infocyph / arraykit

Maintainers

Package info

Statistics

Security