PHPackages                             naucon/command - 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. [CLI &amp; Console](/categories/cli)
4. /
5. naucon/command

ActiveLibrary[CLI &amp; Console](/categories/cli)

naucon/command
==============

description\_text

1.0.0(8y ago)112.4k—5.6%MITPHPPHP &gt;=5.5.0

Since Dec 18Pushed 8y ago1 watchersCompare

[ Source](https://github.com/naucon/command)[ Packagist](https://packagist.org/packages/naucon/command)[ Docs](https://github.com/naucon/Command)[ RSS](/packages/naucon-command/feed)WikiDiscussions master Synced 1mo ago

READMEChangelog (1)Dependencies (3)Versions (2)Used By (0)

naucon Command Package
======================

[](#naucon-command-package)

About
-----

[](#about)

This package provides a generic command pattern to execute actions or tasks. The goal is to split large business logic into smaller actions/task which are loosely decoupled, more readable, easy to maintain and quick to replace.

### Compatibility

[](#compatibility)

- PHP5.5+

Installation
------------

[](#installation)

install the latest version via composer

```
composer require naucon/command

```

Usage
-----

[](#usage)

create CommandManager instance

```
$manager = new CommandManager();

```

register commands to the manager instance

```
$manager->register('foo', new FooAction());
$manager->register('bar', new BarAction());

```

execute command

```
$request = new FooRequest();

$response = $manager->execute($request)

```

create a request

```
class MyRequest
{

}

```

create a action (command)

```
use Naucon\Command\CommandInterface;

class MyAction implements CommandInterface
{
    /**
     * @param mixed $request
     * @return mixed response
     */
    public function execute($request)
    {
        // do something ....

        return true;
    }

    /**
     *
     * @param mixed $request
     * @return bool     returns true if request is support, else false
     */
    public function support($request)
    {
        return $model instanceof MyRequest;
    }
}

```

Data should be generally passed through the `Request` to the `Action`.

```
class PowerOnRequest
{
    /**
     * @var Light
     */
    protected $light;

    /**
     * Constructor
     *
     * @param Light $light
     */
    public function __construct(Light $light)
    {
        $this->light = $light;
    }

    /**
     * @return Light
     */
    public function getLight()
    {
        return $this->light;
    }
}

```

To execute an `Action` within a `Action` the class requires an instance of the `CommandManager`. To inject the `CommandManager` implement the `CommandManagerAwareInterface` to the `Action`. The interface triggers the `CommandHydrator` to inject the `CommandManager` into the `Action` by calling `setCommandManager()`. The `CommandManagerAwareTrait` can be used to add property and setter.

```
class MyAction implements CommandInterface, CommandManagerAwareInterface
{
    use CommandManagerAwareTrait;

    ...

    public function execute($request)
    {
        $request = new MySubRequest();
        $response = $this->commandManager->execute($request);
        return $response;
    }

```

To inject other types of data into actions you can add custom processors to the `CommandHydrator`. Processor must implement the `ProcessorInterface`. Add a custom processor by calling `CustomerManager::addProcessor()`. Second argument is an optional `$priority` (`default = 0`).

```
$manager = new CommandManager();
$manager->addProcessor(new MyProcessor());

```

In some rare cases with nested sub requests it can be necessary to break the workflow and immediately send a http response or redirect (generally not recommended). Therefore a `LogicException` that implements `ResponseInterface` can be thrown within the action (command).

```
use Naucon\Command\CommandInterface;
use Naucon\Command\Response\HttpRedirect;

class MyAction implements CommandInterface
{
    /**
     * @param mixed $request
     * @return mixed response
     */
    public function execute($request)
    {
        // do something ....

        throw new HttpRedirect($url, $statusCode, $headers);

        // or

        throw new HttpResponse($content, $statusCode, $headers);
    }
...

```

Example
-------

[](#example)

Start the build-in webserver to see the examples in action:

```
cd examples
php -S 127.0.0.1:3000

```

open url in browser

```
http://127.0.0.1:3000/index.html

```

Credits
-------

[](#credits)

This implementation was heavily inspired by the payum payment processing library. The modular and decoupled architecture can not only be used for processing payment it is also useful in many other use cases.

License
-------

[](#license)

The MIT License (MIT)

Copyright (c) 2015 Sven Sanzenbacher

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

###  Health Score

31

—

LowBetter than 68% of packages

Maintenance20

Infrequent updates — may be unmaintained

Popularity26

Limited adoption so far

Community7

Small or concentrated contributor base

Maturity58

Maturing project, gaining track record

 Bus Factor1

Top contributor holds 100% 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

Unknown

Total

1

Last Release

3073d ago

### Community

Maintainers

![](https://www.gravatar.com/avatar/a1342e3921a59ade40b08d9db1ad9ef0b47ff8ed86714aad2894f9f2ada270ee?d=identicon)[naucon](/maintainers/naucon)

---

Top Contributors

[![naucon](https://avatars.githubusercontent.com/u/1407477?v=4)](https://github.com/naucon "naucon (1 commits)")

---

Tags

commandpattern

###  Code Quality

TestsPHPUnit

### Embed Badge

![Health badge](/badges/naucon-command/health.svg)

```
[![Health](https://phpackages.com/badges/naucon-command/health.svg)](https://phpackages.com/packages/naucon-command)
```

###  Alternatives

[league/climate

PHP's best friend for the terminal. CLImate allows you to easily output colored text, special formats, and more.

1.9k14.0M273](/packages/league-climate)[league/tactician

A small, flexible command bus. Handy for building service layers.

86415.4M127](/packages/league-tactician)[nategood/commando

PHP CLI Commando Style

8123.3M38](/packages/nategood-commando)[helhum/typo3-console

A reliable and powerful command line interface for TYPO3 CMS

2939.0M192](/packages/helhum-typo3-console)[jmose/command-scheduler-bundle

This Symfony bundle will allow you to schedule all your commands just like UNIX crontab

3361.4M1](/packages/jmose-command-scheduler-bundle)[adhocore/cli

Command line interface library for PHP

3501.2M50](/packages/adhocore-cli)

PHPackages © 2026

[Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)
