class ServiceManager in Backup and Migrate 8.4

A very simple service locator. Does not handle dependency injection but could be replaced by a more complex application specific version which does.

Class ServiceManager.

@package BackupMigrate\Core\Service

Hierarchy

• class \BackupMigrate\Core\Service\ServiceManager implements ServiceManagerInterface

3 files declare their use of ServiceManager

BackupMigrate.php in lib/backup_migrate_core/src/Main/BackupMigrate.php

BackupMigrateInterface.php in lib/backup_migrate_core/src/Main/BackupMigrateInterface.php

PluginManager.php in lib/backup_migrate_core/src/Plugin/PluginManager.php

File

lib/backup_migrate_core/src/Service/ServiceManager.php, line 13

Namespace

BackupMigrate\Core\Service

class ServiceManager implements ServiceManagerInterface {

  /**
   * @var array
   */
  protected $services;

  /**
   * @var array
   */
  protected $clients;

  /**
   * The constructor. Initialise the list of services.
   */
  function __construct() {
    $this->services = [];

    // Allow the locator to inject itself.
    $this->services['ServiceManager'] = $this;
  }

  /**
   * Add a fully configured service to the service locator.
   *
   * @param string $type
   *  The service type identifier.
   * @param mixed $service
   *
   * @return null
   */
  public function add($type, $service) {
    $this->services[$type] = $service;

    // Add this service as a client so it can have dependencies injected.
    $this
      ->addClient($service);

    // Update any plugins that have already had this service injected.
    if (isset($this->clients[$type])) {
      foreach ($this->clients[$type] as $client) {
        $client
          ->{'set' . $type}($service);
      }
    }
  }

  /**
   * Retrieve a service from the locator.
   *
   * @param string $type
   *  The service type identifier
   *
   * @return mixed
   */
  public function get($type) {
    return $this->services[$type];
  }

  /**
   * Get an array of keys for all available services.
   *
   * @return array
   */
  public function keys() {
    return array_keys($this->services);
  }

  /**
   * Inject all available services into the give plugin.
   *
   * @param object $client
   *
   * @return mixed|void
   */
  public function addClient($client) {

    // Inject available services.
    foreach ($this
      ->keys() as $type) {
      if (method_exists($client, 'set' . $type) && ($service = $this
        ->get($type))) {

        // Save the plugin so it can be updated if this service is updated.
        $this->clients[$type][] = $client;
        $client
          ->{'set' . $type}($service);
      }
    }
  }

}

Members

Name	Modifiers	Type	Description	Overrides
ServiceManager::$clients	protected	property
ServiceManager::$services	protected	property
ServiceManager::add	public	function	Add a fully configured service to the service locator.
ServiceManager::addClient	public	function	Inject all available services into the give plugin. Overrides ServiceManagerInterface::addClient
ServiceManager::get	public	function	Retrieve a service from the locator. Overrides ServiceManagerInterface::get
ServiceManager::keys	public	function	Get an array of keys for all available services. Overrides ServiceManagerInterface::keys
ServiceManager::__construct		function	The constructor. Initialise the list of services.