PHPackages ixaya/manager - PHPackages - PHPackages [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register) 1. [Directory](/) 2. / 3. [Framework](/categories/framework) 4. / 5. ixaya/manager ActiveLibrary[Framework](/categories/framework) ixaya/manager ============= An HMVC Framework, Superset of CodeIgniter 2.3.0(2w ago)23.0k↓28.6%3MITPHPPHP ^8.2CI failing Since Sep 14Pushed 1w ago3 watchersCompare [ Source](https://github.com/Ixaya/Manager)[ Packagist](https://packagist.org/packages/ixaya/manager)[ RSS](/packages/ixaya-manager/feed)WikiDiscussions master Synced 1w ago READMEChangelog (10)Dependencies (19)Versions (27)Used By (0) Manager — by [Ixaya](https://www.ixaya.com) =========================================== [](#manager--by-ixaya) HMVC CodeIgniter 3 based Framework for creating backends About this package ------------------ [](#about-this-package) **Ixaya Manager** extends CodeIgniter 3 with HMVC module loading, a typed base model, a REST framework with API-key auth, and a cross-engine migration builder. The framework is **always consumed as a Composer dependency**: your project bootstraps once from the included scaffold, and from then on the framework lives in `vendor/ixaya/manager` and upgrades with `composer update`. Framework code is never copied into or edited inside a project — see `docs/development/upgrading.md` in your project to learn how to update your project's files after an upgrade. ### Features [](#features) - CodeIgniter base upgradeable through Composer - HMVC, organize your code into self-contained modules, each with its own controllers, models and views - Modern, typed PHP (8.2+) codebase — enums, `match`, named parameters, readonly value objects - Support for MySQL/MariaDB, PostgreSQL, SQL Server, SQLite, or any database supported by CodeIgniter 3 - Different Database connection/technology per Model. (you can have a model that loads a Database from Postgres and another Model that loads a Database from MySQL) - Typed base model (`MY_Model`) with soft deletes, audit history, tenant scoping, and a dynamic query builder - REST framework with API-key auth, group/level permissions, and content-negotiated JSON errors - Cross-engine migration builder — one migration runs on MySQL/MariaDB, PostgreSQL, SQL Server, and SQLite - Per-module migration versioning with plan/dry-run tooling - Redis-augmented cache (lists, sets, hashes, pub/sub) and a WebSocket server for real-time notifications - Login protected Admin module - Examples to create a REST API - Agent skills included (`system/skills/`) so coding agents follow the framework conventions - Framework-level exception handling: uncaught errors return proper JSON responses with the right HTTP status and CORS headers - Application code kept outside the public web root --- How to Install -------------- [](#how-to-install) This is the quick version. If you want a more in depth guide follow `SETUP.md` instead, which covers this setup in full. ### Requirements [](#requirements) - PHP 8.2+ - Composer ### 1. Install via Composer [](#1-install-via-composer) ``` composer require ixaya/manager ``` ### 2. Scaffold your project (one time) [](#2-scaffold-your-project-one-time) Copy the sample application structure from the package into your project root. This is a one-time bootstrap — it copies your application's starting structure (controllers, models, views, config, and entry points), not the framework itself: ``` cp -r vendor/ixaya/manager/sample/. . ``` This gives you a complete working structure — controllers, models, views, config, and entry points — ready to customize. The sample ships `composer.json.sample`, a template, so this never overwrites your own `composer.json`; integrate its `require-dev` block into yours, then run `composer update` (not `install`). ### 3. Configure environment [](#3-configure-environment) ``` cp .env.sample .env cp .env.sample.priv .env.priv ``` Open both files and fill in the required fields: - `.env` — general settings: app name, base URL, environment, database credentials, cache, mail. - `.env.priv` — sensitive secrets: API keys, tokens, private credentials. **Never commit this file.** ### Suggested packages [](#suggested-packages) Depending on the features you need, install one or more of the following: **Optional — core extensions:** ``` composer require aws/aws-sdk-php # AWS S3, Textract, Bedrock integration composer require phpoffice/phpspreadsheet # Excel export/import ``` **Optional — WebSocket server:** ``` composer require amphp/websocket-server # Built-in WebSocket server composer require amphp/redis # Redis-backed WebSocket scaling composer require amphp/log # Structured logging for async services composer require adhocore/jwt # WebSocket authentication ``` --- Agent skills ------------ [](#agent-skills) The package ships its coding conventions as agent skills (open `SKILL.md` format, usable by any coding agent) in `system/skills/`. They cover the whole development surface — code style, database models, REST endpoints and auth, web controllers and theming, migrations, CLI and background jobs, helpers and libraries, caching and WebSockets, and live runtime testing — and each skill describes when to use it. The scaffold's `AGENTS.md` carries the per-skill routing table for agents working in your project. Link them into your project (run from the project root; re-run after major framework updates): ``` for skill in vendor/ixaya/manager/system/skills/*/; do name=$(basename "$skill") rm -rf ".claude/skills/$name" ln -s "../../vendor/ixaya/manager/system/skills/$name" ".claude/skills/$name" done ``` Project-wide agent instructions belong in your project's `AGENTS.md` (the cross-tool standard); tools that read `CLAUDE.md` can use a one-line `@AGENTS.md` import. --- PHP Validations --------------- [](#php-validations) ### PHP Static Code Analysis [](#php-static-code-analysis) Run using PHPStan: **First time, install PHPStan:** ``` composer require --dev phpstan/phpstan ``` **Standard analysis:** ``` ./vendor/bin/phpstan analyse ``` **With increased memory limit:** ``` ./vendor/bin/phpstan analyse --memory-limit=512M ``` > **Tip:** Use the memory limit option if you encounter out-of-memory errors during analysis. ### PHP Unit Testing [](#php-unit-testing) Run using PHPUnit. For DB-backed suites, copy `.env.sample.testing.priv` to `.env.testing.priv` and fill in a DB profile first — review your project's documentation for the full setup. **First time, install PHPUnit:** ``` composer require --dev phpunit/phpunit ``` **Run all tests:** ``` ./vendor/bin/phpunit ``` **Run one testsuite (as named in phpunit.xml):** ``` ./vendor/bin/phpunit --testsuite Auth ``` **Run a specific test file** (absolute path — the framework's CLI boot changes the working directory, so relative file arguments don't resolve): ``` ./vendor/bin/phpunit "$PWD/tests/unit/auth/LoginTest.php" ``` **Run tests matching a class or method name:** ``` ./vendor/bin/phpunit --filter LoginTest ./vendor/bin/phpunit --filter test_login_fails ``` > **Tip:** Use `--testdox` flag for readable test output, or `--stop-on-failure` to halt execution on the first failed test. **Note:** Run it through the docker `tools` service — see `docs/development/docker.md`. This is the supported path regardless of what's installed on the host. ### PHP Code Formatting [](#php-code-formatting) Fix using PHP CS Fixer **First time, install PHP CS Fixer:** ``` composer require --dev php-cs-fixer/shim ``` **Fix code formatting:** ``` ./vendor/bin/php-cs-fixer fix ``` **Dry run (preview changes without applying):** ``` ./vendor/bin/php-cs-fixer fix --dry-run ``` **Dry run with diff (preview exact changes):** ``` ./vendor/bin/php-cs-fixer fix --dry-run --diff ``` --- Docker Setup ------------ [](#docker-setup) The scaffold ships a complete Docker stack under `docker/`: PHP-FPM + Nginx for the website, plus Valkey (cache/sessions), and optional WebSocket, cron, and database (MySQL/MariaDB/PostgreSQL) containers behind profiles. All operations go through the wrapper script — never `docker compose` directly, since it wires the per-instance env files and secrets the compose file needs: ``` # Build the images ./docker_manage.sh -e build # Development: full stack with a local database ./docker_manage.sh -e --profile up -d # Server / deployment: WebSocket + cron enabled, database is external/managed ./docker_manage.sh -e --profile ws --profile cron up -d # Useful commands ./docker_manage.sh -e logs -f php ./docker_manage.sh -e exec php bash /var/www/html/bin/cli_run.sh manager/health_checks ``` `` selects the env files, secrets, and published ports, so multiple instances can run side by side. First-time setup (creating your instance's env files, secrets, and picking a database engine) is documented in the scaffold's `docs/development/docker.md`. --- MsgPack Support --------------- [](#msgpack-support) This package can use MsgPack for faster cache and payload serialization. While the native PHP MsgPack extension (installed via `pecl` or system packages) offers the best performance, not all servers have it available. ### Install the PHP MsgPack Fallback Library [](#install-the-php-msgpack-fallback-library) Add the pure PHP implementation to your project, along the composer patcher: ``` composer require rybakit/msgpack composer require cweagans/composer-patches ``` ### Apply the PHP 8.1+ Compatibility Patch [](#apply-the-php-81-compatibility-patch) Add the following configuration to your root `composer.json`: ``` { ... "extra": { "patches": { "rybakit/msgpack": { "Fix PHP 8.1 chr() deprecation": "vendor/ixaya/manager/patches/msgpack-php81-fix.patch" } } } ... } ``` ### Apply the Changes [](#apply-the-changes) Run the following command to install dependencies and apply patches: ``` composer install ``` --- Application Structure --------------------- [](#application-structure) ### Project Setup [](#project-setup) Create a root folder named `app` and upload the project inside it — on a server that is where the project lives, in place of `public_html` or similar. The framework follows an HMVC (Hierarchical Model-View-Controller) architecture based on CodeIgniter. ### Root Directory [](#root-directory) ``` app/ ├── composer.json ├── application/ ├── public/ ├── private/ ├── bin/ └── patches/ ``` ### Public Directory [](#public-directory) The `public/` folder contains all publicly accessible files served by the web server. ``` public/ ├── index.php # Application entry point (all HTTP + CLI requests) ├── media/ # User-uploaded files └── assets/ # Static assets organized by module └── {module}/ ├── js/ # JavaScript files ├── css/ # Stylesheets ├── images/ # Images └── videos/ # Video files ``` ### Application Directory [](#application-directory) The `application/` folder contains the core application code and global resources. ``` application/ ├── cache/ # Application cache ├── config/ # Application configuration files ├── controllers/ # Global controllers ├── core/ # MY_/APP_ base classes (thin aliases of the framework's MGR_ classes) ├── database/ │ ├── migrations/{connection}/ # App-level migrations (legacy history — new migrations live in their module) │ └── seeds/ # Database seeds ├── helpers/ # Global helper functions ├── hooks/ # Global hooks ├── language/ # Global language files ├── libraries/ # Global libraries ├── models/ # Global models ├── modules/ # HMVC modules (see below) ├── third_party/ # Third-party libraries └── views/ # Global views ``` ### Modules (HMVC Structure) [](#modules-hmvc-structure) The framework uses HMVC architecture, allowing you to organize code into self-contained modules. Each module can have its own MVC structure and resources. ``` application/modules/ └── {module}/ ├── controllers/ # Module-specific controllers + controllers/api/ for REST endpoints ├── models/ # Module-specific models ├── migrations/{connection}/ # Module-specific migrations, versioned independently per module ├── views/ # Module-specific views ├── libraries/ # Module-specific libraries ├── helpers/ # Module-specific helpers ├── language/ # Module-specific language files └── config/ # Module-specific configuration ``` **Benefits of HMVC:** - **Modularity**: Each module is self-contained and reusable - **Organization**: Better code organization for large applications - **Separation**: Modules can be developed and tested independently - **Scalability**: Easy to add, remove, or replace modules **Example Module Structure:** ``` application/modules/blog/ ├── controllers/ │ ├── Blog.php # extends MY_Controller │ └── api/ │ └── Posts.php # extends APP_Rest_Controller ├── models/ │ └── Post.php # extends MY_Model ├── libraries/ │ └── Blog_lib.php ├── migrations/default/ │ └── 20260707120000_Post.php # extends MGR_Migration_builder └── views/ ├── index.php └── detail.php ``` ### Additional Directories [](#additional-directories) - **`bin/`** - Command-line scripts and utilities - **`private/`** - Private files not accessible via web - **`patches/`** - Compatibility patches for dependencies ### Health Score 60 — FairBetter than 98% of packages Maintenance97 Actively maintained with recent releases Popularity26 Limited adoption so far Community17 Small or concentrated contributor base Maturity85 Battle-tested with a long release history Bus Factor1 Top contributor holds 65% of commits — single point of failure How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window. **Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores. **Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement. **Maturity (30%)** — Project age, version count, PHP version support, and release stability. ### Release Activity Cadence Every ~125 days Recently: every ~4 days Total 24 Last Release 16d ago Major Versions 0.5.5 → 1.0.02024-08-27 1.x-dev → 2.0.02026-06-28 PHP version history (4 changes)0.1PHP ^5.4 || ^7.0 0.5.4PHP ^5.4 || ^7.0 || ^8.0 1.0.0PHP ^7.4 || ^8.0 1.4.0PHP ^8.2 ### Community Maintainers ![](https://www.gravatar.com/avatar/ef058e6a0a80078f558d66b794c7e6c82e5c31f87a5d69e583f5c4bd895b2277?d=identicon)[gumoz](/maintainers/gumoz) ![](https://www.gravatar.com/avatar/c82e7e555c24417b77a3216019b35c5be442b72e328297d2449220c3201e32f7?d=identicon)[humole](/maintainers/humole) --- Top Contributors [![humole](https://avatars.githubusercontent.com/u/221601?v=4)](https://github.com/humole "humole (240 commits)")[![gumoz](https://avatars.githubusercontent.com/u/48006?v=4)](https://github.com/gumoz "gumoz (66 commits)")[![dependabot[bot]](https://avatars.githubusercontent.com/in/29110?v=4)](https://github.com/dependabot[bot] "dependabot[bot] (55 commits)")[![kmartinezabarca](https://avatars.githubusercontent.com/u/78579850?v=4)](https://github.com/kmartinezabarca "kmartinezabarca (6 commits)")[![ArgelOrtiz](https://avatars.githubusercontent.com/u/34045316?v=4)](https://github.com/ArgelOrtiz "ArgelOrtiz (2 commits)") ### Code Quality TestsPHPUnit Static AnalysisPHPStan Code StylePHP CS Fixer Type Coverage Yes ### Embed Badge ![Health badge](/badges/ixaya-manager/health.svg) ``` [![Health](https://phpackages.com/badges/ixaya-manager/health.svg)](https://phpackages.com/packages/ixaya-manager) ``` ### Alternatives [nineinchnick/edatatables Grid widget for the Yii Framework, wrapper for the DataTables jQuery plugin 173.2k](/packages/nineinchnick-edatatables) PHPackages © 2026 [Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)