README

A lightweight and modular core library for modern PHP development. Designed for clarity, extensibility, and performance, with a consistent, functional-style API.

📚 Documentation

Full project documentation is available at: 👉 https://bcommebois.github.io/oihana-php-core

Changelog: CHANGELOG.md
License: MPL-2.0

📦️ Installation

Requires PHP 8.4+

Install via Composer:

composer require oihana/php-core

✨ Features

The oihana/php-core library provides pure utility functions (no side effects), organized into logical, reusable packages:

🧾 Accessors (oihana\core\accessors)

Unified access for both arrays and objects:

Read: getKeyValue()
Write: setKeyValue()
Delete: deleteKeyValue() (supports wildcards: , foo.bar.)
Exists: hasKeyValue()
Validation and traversal: assertDocumentKeyValid(), resolveReferencePath()

Designed for safely accessing and modifying deep nested structures with dot notation support and automatic path creation.

🔢 Arrays (oihana\core\arrays)

Advanced array utilities:

Access and mutation: get(), set(), delete(), exists()
Transformations: flatten(), tail(), unique(), shuffle(), swap(), toArray(), stub()
Structure detection: isIndexed(), hasIntKeys(), hasStringKeys()

📅 Date (oihana\core\date)

Date manipulation and validation:

formatDateTime()
isDate(), isValidTimezone()

➗ Maths (oihana\core\maths)

Smart numeric rounding helpers:

ceilValue(), floorValue(), roundValue()

🔢 Numbers (oihana\core\numbers)

Range clamping: clip()

🧱 Objects (oihana\core\objects)

Lightweight object manipulation:

compress() — remove null/empty values
set() — deep set a value in a nested structure

✍️ Strings (oihana\core\strings)

String formatting, case conversions, and utilities:

Case & slug: camel(), snake(), kebab(), hyphenate(), lower(), latinize()
Format & identifiers: fastFormat(), formatRequestArgs(), urlencode(), toString()
Validation: isRegexp(), luhn()
Random generation: randomKey()

⚙️ Utils

ifNull() — return a fallback if a value is null

🚀 Quick Start

Most helpers are loaded via Composer autoload. You can import functions directly using use function and call them.

<?php
require __DIR__ . '/vendor/autoload.php';

use function oihana\core\strings\camel;
use function oihana\core\strings\fastFormat;
use function oihana\core\arrays\get;
use function oihana\core\accessors\getKeyValue;
use function oihana\core\accessors\setKeyValue;

// Strings
echo camel('hello_world');                 // helloWorld
echo fastFormat('Hello {0}', 'World');     // Hello World

// Arrays (dot-notation path)
$profile = ['user' => ['name' => 'Alice', 'city' => 'Paris']];
echo get($profile, 'user.name');           // Alice

// Accessors work with arrays and objects
$doc = (object)['user' => (object)['email' => 'a@b.c']];
echo getKeyValue($doc, 'user.email');      // a@b.c
$doc = setKeyValue($doc, 'user.age', 30);  // adds nested property safely

🧪 Examples

Accessors: work with arrays and objects

use function oihana\core\accessors\getKeyValue;
use function oihana\core\accessors\setKeyValue;

$doc = ['user' => ['name' => 'Alice']];
echo getKeyValue($doc, 'user.name');            // Alice
$doc = setKeyValue($doc, 'user.age', 30);       // ['user' => ['name' => 'Alice', 'age' => 30]]

$obj = (object)['user' => (object)['email' => 'a@b.c']];
echo getKeyValue($obj, 'user.email');           // a@b.c
$obj = setKeyValue($obj, 'user.active', true);  // adds nested object structure

Arrays: reading and transforming

use function oihana\core\arrays\get;
use function oihana\core\arrays\flatten;
use function oihana\core\arrays\unique;

$data = ['a' => 1, 'b' => ['c' => 2, 'd' => [3, 4]]];
echo get($data, 'b.c');               // 2
print_r(flatten($data));              // ['a' => 1, 'b.c' => 2, 'b.d.0' => 3, 'b.d.1' => 4]
print_r(unique([1,1,2,3,3]));         // [1,2,3]

Strings: formatting and cases

use function oihana\core\strings\camel;
use function oihana\core\strings\fastFormat;

echo camel('foo-bar_baz');                        // fooBarBaz
echo fastFormat('User {0} has {1} points', 'Alice', 1500);
// User Alice has 1500 points

✅ Running Unit Tests

To run all tests:

$ composer test

To run a specific test file:

$ composer test tests/oihana/core/arrays/FlattenTest.php

🧾 License

This project is licensed under the Mozilla Public License 2.0 (MPL-2.0).

👤 About the author

Author : Marc ALCARAZ (aka eKameleon)
Mail : marc@ooop.fr
Website : http://www.ooop.fr

oihana / php-core

Maintainers

Details