thefrozenfire/zf2-command-module

命令对象模式实现

维护者

详细信息

github.com/TheFrozenFire/ZF2-Command-Module

源代码

问题

安装: 210

依赖项: 0

建议者: 0

安全: 0

星标: 0

关注者: 2

分支: 0

开放问题: 0

1.0.2 2015-04-30 19:00 UTC

Requires (Dev)

MIT e259efddcdb72875c82a9622f7c05c151d07396c

  • Justin Martin <frozenfire.woop@thefrozenfire.com>

This package is not auto-updated.

Last update: 2024-09-14 17:06:00 UTC

README

此模块为 ZF2 提供了命令对象模式的基本实现，以及聚合命令对象。命令对象通常用于在应用服务中替代将多个不相关的服务方法的结果串联起来，尽管你也可以从命令对象中调用应用服务。在一个非面向服务的架构中，你可能将命令对象视为控制器动作中逻辑的封装，在一个可移植的合约中。

命令对象的主要目的是封装可以在应用级别调用的离散“命令”的依赖项和参数。

基本用法

命令对象

<?php
$addToFieldOnFoo = $serviceLocator->get('Application\Command\AddToFieldOnFoo');
$addToFieldOnFoo->setFooId(1);
$addToFieldOnFoo->setFieldToAddTo('bar')
    ->setAmountToAdd(5);

$changedFoo = $addToFieldOnFoo->execute();
<?php
namespace Foo;

use Command\AbstractCommand;
use Application\Service;

class AddToFieldOnFoo extends AbstractCommand
{
    protected $fooService;
    
    protected $fooId;
    
    protected $fieldToAddTo;
    
    protected $amountToAdd;
    
    public function __construct(Service\FooService $fooService)
    {
        $this->setFooService($fooService);
    }
    
    public function execute()
    {
        $fooService = $this->getFooService();
        
        $fooId = $this->getFooId();
        $fieldToAddTo = $this->getFieldToAddTo();
        $amountToAdd = $this->getAmountToAdd();
        
        $foo = $fooService->findById($fooId);
        
        $fieldValue = $foo->getField($fieldToAddTo);
        $fieldValue += $amountToAdd;
        
        $foo->setField($fieldToAddTo, $fieldValue);
        
        $fooService->persist($foo);
        
        return $foo;
    }
    
    public function getFooService()
    {
        return $this->fooService;
    }
    
    public function setFooService(Service\FooService $fooService)
    {
        $this->fooService = $fooService;
        return $this;
    }
    
    public function getFooId()
    {
        return $this->fooId;
    }
    
    public function setFooId($fooId)
    {
        $this->fooId = $fooId;
        return $this;
    }
    
    public function getFieldToAddTo()
    {
        return $this->fieldToAddTo;
    }
    
    public function setFieldToAddTo($fieldToAddTo)
    {
        $this->fieldToAddTo = $fieldToAddTo;
        return $this;
    }
    
    public function getAmountToAdd()
    {
        return $this->amountToAdd;
    }
    
    public function setAmountToAdd($amountToAdd)
    {
        $this->amountToAdd = $amountToAdd;
        return $this;
    }
    
}

聚合命令对象

$addToFieldOnFoo = $serviceLocator->get('Application\Command\AddToFieldOnFoo');
$addToFieldOnFoo->getFindFoo()
    ->setFooId(1);
$addToFieldOnFoo->getAddValueToFooField()
    ->setFieldToAddTo('bar')
    ->setAmountToAdd(5);

$addFieldOnFoo->getEventManager()->attach($addFieldOnFoo::guessEventName($addFieldOnFoo->getFindFoo()),
    function($event) {
        echo "Found Foo with name {$event->getResult()->getName()}".PHP_EOL;
    }, 100);

$addFieldOnFoo->getEventManager()->attach($addFieldOnFoo::guessEventName($addFieldOnFoo->getAddValueToFooField()),
    function($event) {
        $name = $event->getResult()->getName();
        $fieldToAddTo = $event->getTarget()->getFieldToAddTo();
        $newValue = $event->getResult()->getField($fieldToAddTo);
        echo "Foo with name {$name} now has '{$fieldToAddTo}' with value {$newValue}".PHP_EOL;
    }, 100);

$addFieldOnFoo->getEventManager()->attach($addFieldOnFoo::guessEventName($addFieldOnFoo->getPersistFoo()),
    function($event) {
        $name = $event->getResult()->getName();
        echo "Foo with name {$name} has been persisted".PHP_EOL;
    }, 100);

$changedFoo = $addToFieldOnFoo->execute();
<?php
namespace Foo;

use Command\AbstractAggregateCommand;
use Command\CommandEvent;
use Application\Command;

class AddToFieldOnFoo extends AbstractAggregateCommand
{
    protected $findFoo;
    
    protected $addValueToFooField;
    
    protected $saveFoo;
    
    public function __construct(Command\FindFoo $findFoo, Command\AddValueToFooField $addValueToFooField, Command\PersistFoo $persistFoo)
    {
        $this->setFindFoo($findFoo);
        $this->setAddValueToFooField($addValueToFooField);
        $this->setPersistFoo($persistFoo);
    }
    
    public function execute()
    {
        $findFoo = $this->getFindFoo();
        $addValueToFooField = $this->getAddValueToFooField();
        $persistFoo = $this->getPersistFoo();
        
        $foo = $this->executeChild($findFoo);
        
        $addValueToFooField->setFoo($foo);
        $foo = $this->executeChild($addValueToFooField);
        
        $persistFoo->setFoo($foo);
        $foo = $this->executeChild($persistFoo);
        
        return $foo;
    }
    
    public function getFindFoo()
    {
        return $this->findFoo;
    }
    
    public function setFindFoo($findFoo)
    {
        $this->findFoo = $findFoo;
        return $this;
    }
    
    public function getAddValueToFooField()
    {
        return $this->addValueToFooField;
    }
    
    public function setAddValueToFooField($addValueToFooField)
    {
        $this->addValueToFooField = $addValueToFooField;
        return $this;
    }
    
    public function getPeristFoo()
    {
        return $this->peristFoo;
    }
    
    public function setPeristFoo($peristFoo)
    {
        $this->peristFoo = $peristFoo;
        return $this;
    }
    
}

具有事件串联的聚合命令对象

<?php
namespace Foo;

use Command\AbstractAggregateCommand;
use Command\CommandEvent;
use Application\Command;

class AddToFieldOnFoo extends AbstractAggregateCommand
{
    protected $findFoo;
    
    protected $addValueToFooField;
    
    protected $saveFoo;
    
    public function __construct(Command\FindFoo $findFoo, Command\AddValueToFooField $addValueToFooField, Command\PersistFoo $persistFoo)
    {
        $this->setFindFoo($findFoo);
        $this->setAddValueToFooField($addValueToFooField);
        $this->setPersistFoo($persistFoo);
    }
    
    public function execute()
    {
        $command = $this;
        $result = null;
    
        $findFoo = $this->getFindFoo();
        $addValueToFooField = $this->getAddValueToFooField();
        $persistFoo = $this->getPersistFoo();
        
        $command->getEventManager()->attach(static::guessEventName($findFoo), function(CommandEvent $event) use ($command, $addValueToFooField) {
            $foo = $event->getResult();
            $addValueToFooField->setFoo($foo);
            
            $command->executeChild($addValueToFooField);
        }, 10);
        
        $command->getEventManager()->attach(static::guessEventName($addValueToFooField), function(CommandEvent $event) use ($command, $persistFoo) {
            $foo = $event->getResult();
            $persistFoo->setFoo($foo);
            
            $command->executeChild($persistFoo);
        }, 10);
        
        $command->getEventManager()->attach(static::guessEventName($persistFoo), function(CommandEvent $event) use ($command, &$result) {
            $result = $event->getResult();
        }, 10);
        
        $this->executeChild($findFoo);
        
        return $foo;
    }
    
    public function getFindFoo()
    {
        return $this->findFoo;
    }
    
    public function setFindFoo($findFoo)
    {
        $this->findFoo = $findFoo;
        return $this;
    }
    
    public function getAddValueToFooField()
    {
        return $this->addValueToFooField;
    }
    
    public function setAddValueToFooField($addValueToFooField)
    {
        $this->addValueToFooField = $addValueToFooField;
        return $this;
    }
    
    public function getPersistFoo()
    {
        return $this->persistFoo;
    }
    
    public function setPersistFoo($persistFoo)
    {
        $this->persistFoo = $persistFoo;
        return $this;
    }
    
}

重构控制器方法

无命令对象

<?php
namespace Foo;

use Zend\Mvc\Controller\AbstractActionController;
use Application\Service;

class FooController extends AbstractActionController
{
    protected $fooService;
    
    public function __construct(Service\FooService $fooService) {
        $this->setFooService($fooService);
    }
    
    public function addValueToFieldOnFoo()
    {
        $fooService = $this->getFooService();
    
        $fooId = $this->params('foo_id');
        $fieldToAddTo = $this->params()->fromPost('field_to_add_to');
        $amountToAdd = $this->params()->fromPost('amount_to_add');
        
        $foo = $fooService->findById($fooId);
        
        $fieldValue = $foo->getField($fieldToAddTo);
        $fieldValue += $amountToAdd;
        
        $foo->setField($fieldToAddTo, $fieldValue);
        
        $fooService->persist($foo);
    }
    
    public function getFooService()
    {
        return $this->fooService;
    }
    
    public function setFooService($fooService)
    {
        $this->fooService = $fooService;
        return $this;
    }
    
}

有命令对象

<?php
namespace Foo;

use Zend\Mvc\Controller\AbstractActionController;
use Application\Command;

class FooController extends AbstractActionController
{
    protected $addToFieldOnFoo;
    
    public function __construct(Command\AddToFieldOnFoo $addToFieldOnFoo) {
        $this->setAddToFieldOnFoo($addToFieldOnFoo);
    }
    
    public function addValueToFieldOnFoo()
    {
        $addToFieldOnFoo = $this->getAddToFieldOnFoo();
    
        $fooId = $this->params('foo_id');
        $fieldToAddTo = $this->params()->fromPost('field_to_add_to');
        $amountToAdd = $this->params()->fromPost('amount_to_add');
        
        $addToFieldOnFoo->getFindFoo()->getFooId($fooId);
        $addToFieldOnFoo->getAddValueToFooField()
            ->setFieldToAddTo('bar')
            ->setAmountToAdd(5);
            
        $addToFieldOnFoo->execute();
    }
    
    public function getAddToFieldOnFoo()
    {
        return $this->addToFieldOnFoo;
    }
    
    public function setAddToFieldOnFoo($addToFieldOnFoo)
    {
        $this->addToFieldOnFoo = $addToFieldOnFoo;
        return $this;
    }
    
}