Burzum\CakeServiceLayer\Service\ServiceAwareTrait

Complexity

Total Complexity

8

Size/Duplication

Total Lines	73
Duplicated Lines	0 %

Test Coverage

Coverage

0%

Importance

Changes

0

3 Methods

Rating	Name	Duplication	Size	Complexity
A	setServiceLocator()	0	3	1
A	getServiceLocator()	0	8	2
A	loadService()	0	21	5

<?php
/**
 * Copyright (c) Florian Krämer
 *
 * Licensed under The MIT License
 * For full copyright and license information, please see the LICENSE.txt
 * Redistributions of files must retain the above copyright notice.
 *
 * @copyright     Copyright (c) Florian Krämer
 * @link          https://github.com/burzum/cakephp-service-layer
 * @since         1.0.0
 * @license       https://opensource.org/licenses/mit-license.php MIT License
 */
declare(strict_types = 1);

namespace Burzum\CakeServiceLayer\Service;

use Cake\Core\ObjectRegistry;

/**
 * Service Aware Trait
 *
 * CakePHP style locator to load service classes
 */
trait ServiceAwareTrait
{
    /**
     * Service Locator Registry
     *
     * @var \Cake\Core\ObjectRegistry
     */
    protected $serviceLocator;

    /**
     * Default Service Locator Class
     *
     * @var string
     */
    protected $defaultServiceLocator = ServiceLocator::class;

    /**
     * Load a service
     *
     * If the service is in a subfolder, this folder name will be stripped for the property name when assigned.
     *
     * @param string $service Service Name
     * @param array $constructorArgs Constructor Args
     * @param bool $assignProperty Assigns the service to a class property of the same name as  the service
     * @return object
     */
    public function loadService($service, array $constructorArgs = [], $assignProperty = true)
    {
        list(, $name) = pluginSplit($service);

        if (strpos($name, '/') !== false) {
            $name = substr($name, strrpos($name, '/') + 1);
        }

        if ($assignProperty && isset($this->{$name})) {
            return $this->{$name};
        }

        $serviceInstance = $this->getServiceLocator()->load($service, $constructorArgs);

        if (!$assignProperty) {
            return $serviceInstance;
        }

        $this->{$name} = $serviceInstance;

        return $serviceInstance;
    }

    /**
     * Get the service locator
     *
     * @return \Cake\Core\ObjectRegistry
     */
    public function getServiceLocator()
    {
        if (empty($this->serviceLocator)) {
            $class = $this->defaultServiceLocator;
            $this->serviceLocator = new $class();
        }

        return $this->serviceLocator;
    }

    /**
     * Sets the service locator
     *
     * @param \Cake\Core\ObjectRegistry $locator Locator
     * @return void
     */
    public function setServiceLocator(ObjectRegistry $locator)
    {
        $this->serviceLocator = $locator;
    }
}