Migration from ZF2 to ZF 3 without getServicelocator();

Question

I am new at ZF3 and I need your help. In ZF3 there is no service Locator any more. So I created a Factory class to replace the service Locator in my code.

Here is my code with service Locator in my AbstractController.php file:

protected function getService()
{
    return $this->getServiceLocator()->get($service); //remove from ZF3
    return $this->service = $service;
}

Now I replaced the service Locator in AbstractController.php:

protected function getService($service)
{
    $service = $this->service;
    return $this->service = $service;
}

And in Module.Config.php I added the following lines:

return [
    'controllers' => [
        'factories' => [
            Controller\AbstactController::class => Controller\AbstactControllerFactory::class,
        ],
],

And I created a AbstractControllerFactory file with the following lines:

<?php

namespace Application\Controller;

use Application\Controller\AbstractController;
use Interop\Container\ContainerInterface;
use Zend\ServiceManager\Factory\FactoryInterface;

    class AbstractControllerFactory implements FactoryInterface
    {
        protected function __invoke(ContainerInterface $container, $requestedName, array $options = null)
        {
            return new AbstractController($container->get(service::class));
        }
    }

I need to know if this is a correct migration from ZF2 to ZF3?

Answer 1

In ZF3 the first thing you do is create your Service and a Factory for it. Let's take in this example UserManager.php in Services folder.

So we have in folder Service -> UserManager.php and in Service -> Factory -> UserManagerFactory.php

UserManagerFactory.php:

<?php
namespace User\Service\Factory;

use Interop\Container\ContainerInterface;
use User\Service\UserManager;

/**
 * This is the factory class for UserManager service. The purpose of the factory
 * is to instantiate the service and pass it dependencies (inject dependencies).
 */
class UserManagerFactory
{
    /**
     * This method creates the UserManager service and returns its instance. 
     */
    public function __invoke(ContainerInterface $container, $requestedName, array $options = null)
    {        
        $entityManager = $container->get('doctrine.entitymanager.orm_default');

        return new UserManager($entityManager);
    }
}

UserManager.php:

<?php
namespace User\Service;

use User\Entity\User;

/**
 * This service is responsible for adding/editing users
 * and changing user password.
 */
class UserManager
{
    /**
     * Doctrine entity manager.
     * @var Doctrine\ORM\EntityManager
     */
    private $entityManager;  

    /**
     * Constructs the service.
     */
    public function __construct($entityManager) 
    {
        $this->entityManager = $entityManager;
    }

// REST OF YOUR CODE

}

Now that we have our service, we go into User\\config\\modules.config.php :

'service_manager' => [
    'factories' => [
        Service\UserManager::class => Service\Factory\UserManagerFactory::class,
    ],
],

Well that's basically it, we can inject the service in our controller and job done:

<?php
namespace User\Controller;

use Zend\Mvc\Controller\AbstractActionController;

/**
 * This controller is responsible for user management (adding, editing, 
 * viewing users and changing user's password).
 */
class UserController extends AbstractActionController 
{
    /**
     * User manager.
     * @var User\Service\UserManager 
     */
    private $userManager;

    /**
     * Constructor. 
     */
    public function __construct($userManager)
    {
        $this->userManager = $userManager;
    }

   // REST OF YOUR CODE
}

I really hope this helps you understand how to use Service in ZF3.

Good Luck!