ZF2 traits example: UserServiceAwareTrait

zf2-traits-sampleservice-controller

<?php

namespace SampleService\Controller;

use Zend\Mvc\Controller\AbstractActionController;
use Zend\View\Model\ViewModel;

// Each 'AwareTrait' is expected to be configured by the controllers factory
use SampleService\Service\Feature\UserServiceAwareTrait;
use SampleService\Service\Feature\UserFilterServiceAwareTrait;
use SampleService\Form\Feature\FilterFormAwareTrait;

class UserController extends AbstractActionController
{
    use UserServiceAwareTrait; // a.k.a. This controller uses the UserService
    use UserFilterServiceAwareTrait;
    use FilterFormAwareTrait;

    // Some action methods go here
}

zf2-traits-sampleservice-controllerfactory

<?php

namespace SampleService\Controller\Service;

use Zend\ServiceManager\FactoryInterface;
use Zend\ServiceManager\ServiceLocatorInterface;

use SampleService\Controller\Usercontroller;

class UserControllerFactory implements FactoryInterface
{
    public function createService(ServiceLocatorInterface $serviceLocator)
    {
        /** @var ServiceLocatorInterface $serviceLocator */
        $serviceLocator = $serviceLocator->getServiceLocator();
        
        $controller = new UserController();
        
        // The factory is responsible for initialising (via the SL)
        //      each of the controllers dependencies.
        
        $controller->setFilterForm(
                $serviceLocator->get('FormElementManager')->get('SampleService\Form\FilterForm')
            );
        $controller->setUserService(
                $serviceLocator->get('SampleService\Service\UserService')
            );
        $controller->setUserFilterService(
                $serviceLocator->get('SampleService\Service\UserFilterService')
            );
        
        return $controller;
    }
}

zf2-traits-sampleservice-trait

<?php

namespace SampleService\Service\Feature;

use SampleService\Service\UserService;
use Zend\Stdlib\Exception\LogicException;

// This trait exposes the UserService to any 'aware' class.
// Controllers will most commonly use this trait.
trait UserServiceAwareTrait {

    /**
     * @var UserService
     */
    protected $userService;

    public function setUserService($userService)
    {
        $this->userService = $userService;
    }

    public function getUserService()
    {
        if(null === $this->userService) {
            throw new LogicException("User service must be defined");
        }

        return $this->userService;
    }

}