Download the PHP package maatify/common without Composer

📦 maatify/common

🏁 Stable Release v2.0.0 — Architectural Cleanup & Scope Stabilization

The core foundational library of the Maatify.dev ecosystem providing standardized DTOs, validation, sanitization, date/time, text utilities, and shared core helpers.

📦 This is the stable version (v1.0.10) of maatify/common, released on 2025-12-09. 🔗 بالعربي 🇸🇦

🧭 Version Information

🧩 Overview

This library provides reusable, framework-agnostic building blocks (DTOs, helpers, traits, enums, validators) shared across the Maatify ecosystem.

📘 Documentation & Release Files

Core Modules:

• 🧮 Pagination Helpers — PaginationHelper, PaginationDTO, PaginationResultDTO Unified pagination structures for API responses and MySQL queries.

• 🧼 Security Sanitization — InputSanitizer, SanitizesInputTrait Clean and escape user input safely with internal HTMLPurifier integration.

• 🧠 Core Traits — SingletonTrait, SanitizesInputTrait Reusable traits for singleton pattern, safe input handling, and shared helpers.

• ✨ Text & Placeholder Utilities — TextFormatter, PlaceholderRenderer, RegexHelper, SecureCompare Powerful text formatting, placeholder rendering, and secure string comparison tools.

• 🕒 Date & Time Utilities — DateFormatter, DateHelper Humanized difference, timezone conversion, and localized date rendering (EN/AR/FR).

• 🧩 Validation & Filtering Tools — Validator, Filter, ArrayHelper Email/URL/UUID/Slug validation, input detection, and advanced array cleanup utilities.

• ⚙️ Enums & Constants Standardization — TextDirectionEnum, MessageTypeEnum, ErrorCodeEnum, PlatformEnum, AppEnvironmentEnum, CommonPaths, CommonLimits, CommonHeaders, Defaults, EnumHelper Centralized enum and constant definitions ensuring consistent standards, reusable helpers, and unified configuration across all Maatify libraries.

⚠️ Design Scope Notice

maatify/common is intentionally limited to pure helpers, DTOs, traits, enums, and shared utilities.

It contains no adapters, repositories, drivers, storage contracts, or IO-related abstractions. Any such responsibilities belong to dedicated infrastructure packages.

⚙️ Installation

`

📦 Dependencies

This library directly relies on:

maatify/common integrates these open-source libraries to deliver a consistent and secure foundation for all other Maatify components.

🧠 Note: maatify/common automatically configures HTMLPurifier to use an internal cache directory at storage/purifier_cache for optimized performance. This ensures faster sanitization on subsequent calls without requiring manual setup.

If you wish to override the cache path, set the environment variable:

or modify it programmatically via:

🧠 SingletonTrait

A clean, PSR-friendly Singleton implementation to manage single-instance service classes safely.

🔹 Example Usage

✅ Features

• Prevents direct construction, cloning, and unserialization.
• Provides static obj() to access the global instance.
• Includes reset() for testing or reinitialization.

📚 Example Usage

🔹 Paginate Array Data

Output:

🔹 Working with PaginationDTO

🧩 Helpers

🧱 TapHelper

A lightweight, fluent utility for executing a callback on a given value (usually an object) and returning that same value unchanged —
perfect for cleaner object initialization and inline setup.

⚙️ Class

Maatify\Common\Helpers\TapHelper

✅ Features

• Executes a callback on a passed object or value.
• Returns the same value (object, scalar, array, etc.).
• Useful for chaining and fluent API style.
• 100% pure function — no side effects unless your callback modifies the object.

🧠 Example Usage

`

🧾 Functional Philosophy

TapHelper follows a simple, expressive pattern inspired by functional programming:

🧪 Unit Test Reference

tests/Helpers/TapHelperTest.php

Covers:

• Returning the same object instance.
• Callback execution correctness.
• Compatibility with scalars and arrays.

🧱 Code Reference

Executes $callback($value) then returns $value.

🧩 Architectural Benefits within the Maatify Ecosystem

📘 Full Documentation: docs/enums.md

🗂 Directory Structure

📚 Built Upon

maatify/common proudly builds upon several mature and battle-tested open-source foundations:

Huge thanks to the open-source community for their contributions, making the Maatify ecosystem secure, reliable, and extensible. ❤️

✅ 📊 Updated Phase Summary Table (Phases 1 → 18)

✅ Verified Test Results

PHPUnit 10.5.58 — PHP 8.4.4
• Tests: 66 • Assertions: 150 • Coverage: ~98 %
• Runtime: 0.076 s • Memory: 12 MB
• Warnings: 1 (No coverage driver available — safe to ignore)

All files have been verified and finalized as part of v2.0.0 Stable Release.

• ✅ /docs/README.full.md – full documentation merged
• ✅ /docs/enums.md – enums and constants reference
• ✅ /docs/phases/README.phase7.md – phase documentation
• ✅ CHANGELOG.md – release history initialized
• ✅ CONTRIBUTING.md – contributor guide added
• ✅ VERSION – version 2.0.0 confirmed

🔗 Full documentation & release notes: see /docs/README.full.md

🪪 License

Maatify.dev
You’re free to use, modify, and distribute this library with attribution.