Service Manager jest oparty o wzorzec
Service Locator i jest to mechanizm slużący do pobierania innych obiektów. Używa się go w module.config.php lub Module.php i składa się z 7 typów(kategorii).
1.
abstract_factories pod tym kluczem definiuje się klasy, które muszą implementować
ZendServiceManagerAbstractFactoryInterface. Rzadko używane.
2.
aliases nadaje klasie alias, np:
'translator' => 'MvcTranslator',
),
Teraz jesteśmy w stanie się odwołać za pomocą
$this->getServiceLocator()->get('translator')
3.
factories deklaruje klasy, które powinny implementować
Zend/ServiceManager/FactoryInterface. Dość często używane. Np:
'UserTable' => function($sm) {
$tableGateway = $sm->get('UserTableGateway');
$table = new UserTable($tableGateway);
return $table;
},
Jeżeli klasa ma konstruktor lub jeśli potrzebujemy dodać do klasy obiekty innej klasy to używamy do tego celu właśnie klucza
factories. Obiekt jest inicjowany od razu- w momencie kiedy jest wczytywany do Service Managera.
4.
invokables definiujemy klasy, które nie mają konstruktora lub jeśli nie musimy z niego(konstruktora) skorzystać. Również dość często używane, jak chociażby dla naszych klas kontrolera. Np:
'Application\Controller\Index' => 'Application\Controller\IndexController',
)
Klasy pod tym kluczem są inicjowane dopiero w momencie odwołania się do danego klucza, a nie w momencie 'pobrania' przez ServiceManager5.
services służy głównie do deklarowania 'service'ów' lub klas, które są już zainicjowane. Np:
'name' => $zmienna,
),
6.
initializers nie miałem okazji jeszcze z tego korzystać. Ten klucz definiuje callback, który jest uruchamiany za każdym razem gdy jest tworzony obiekt, w ten sposób jeśli obiekt spełnia wymagania(np. implementuje konkretny interfejs) jeśtemy w stanie 'wstrzepić' inny obiekt.
function ($instance, $sm) {
if ($instance instanceof AuthorizeAwareInterface) {
$instance->setAuthorizeService($sm->get('auth_service'));
}
}
)
7.
shared domyślnie wszystkie service'y od ServiceManagera są 'shared', czyli pracujemy na tym samym obiekcie. Tutaj jesteśmy w stanie to zmienić, gdy np. chcemy żeby za każdym razem był tworzony nowy obiekt.
$table1 = $this->getServiceLocator()->get('UserTable');
$table2 = $this->getServiceLocator()->get('UserTable');
// table1 i table2 to ten sam obiekt
Gdy dodamy:
'UserTable' => false,
),
$table1 = $this->getServiceLocator()->get('UserTable');
$table2 = $this->getServiceLocator()->get('UserTable');
// table1 i table2 to różne obiekty
Jak napisałem na początku, Service Manager służy do łatwego dostępu do obiektów. Np. wyobraźmy sobie że tylko dla pewnej akcji chcesz dodać jakiś plik js, możesz to zrobić tak:
public function addAction()
{
$this->getServiceLocator()
->get('viewhelpermanager')
->get('HeadScript')
->appendFile('/js/ckeditor/ckeditor.js','text/javascript');
}
Tutaj za pomocą Service Managera dostajemy się do obiektu
HeadScript i dzięki temu jesteśmy w stanie dodać plik js z poziomu akcji kontrolera
Najczęśniej używane są
factories i
invokables. Co to są factories to napisałem wyżej, ale może dodam jeszcze jeden przykład żeby lepiej zobrazować co robi.
Mamy klasę:
class HelloService
{
public function sayHello()
{
return 'Hello World';
}
}
I załóżmy że chcemy wyświetlić w widoku to co zwraca metoda sayHello().
Możemy to zrobić na dwa sposoby.
1.
InvokablesW pliku Module.php dodajemy:
public function getServiceConfig()
{
'HelloService'
=> 'Helloworld\Service\HelloService'
)
);
}
I teraz w akcji:
public function indexAction()
{
$hello = $this->getServiceLocator()
->get('HelloService');
return new ViewModel(
array('hello' => $hello->sayHello()) );
}
Najpierw dodajmy do ServiceManagera klasę HelloService, później w akcji pobieramy z Service Managera i odwołujemy się do metody sayHello(). Trochę to toporne i niewydajne.
2.
Factories
'Helloworld\Controller\Index' => function($sm) {
$controller = new Helloworld\Controller\IndexController();
$controller->setHelloService(
$sm->getServiceLocator()
->get('HelloService')
);
return $controller;
}
)
I w akcji:
class IndexController extends AbstractActionController
{
private $helloService;
public function indexAction()
{
return new ViewModel(
'hello' => $this->helloService->sayHello()
)
);
}
public function setHelloService($service)
{
$this->helloService = $service;
}
}
Tym sposobem dodajemy obiekt klasy HelloService do kontrolera w Service Managerze i teraz w akcji nie musimy pobierać tego obiektu, tylko bezpośrednio możemy na nim pracować. Bardziej czytelniejsze rozwiązanie, wydajne i zalecane.
?)?