tao-test/app/generis/common/oatbox/service/ConfigurableService.php

<?php

/**
 * This program is free software; you can redistribute it and/or
 * modify it under the terms of the GNU General Public License
 * as published by the Free Software Foundation; under version 2
 * of the License (non-upgradable).
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
 *
 * Copyright (c) 2015-2021 (original work) Open Assessment Technologies SA;
 */

namespace oat\oatbox\service;

use oat\oatbox\Configurable;
use oat\oatbox\service\exception\InvalidService;
use oat\oatbox\service\exception\InvalidServiceManagerException;
use Zend\ServiceManager\ServiceLocatorAwareInterface;

/**
 * Configurable base service
 *
 * inspired by Solarium\Core\Configurable by Bas de Nooijer
 * https://github.com/basdenooijer/solarium/blob/master/library/Solarium/Core/Configurable.php
 *
 * @author Joel Bout <joel@taotesting.com>
 * @deprecated New services must be registered using Dependency Injection Container
 */
abstract class ConfigurableService extends Configurable implements ServiceLocatorAwareInterface
{
    use ServiceManagerAwareTrait;

    /** @var string Documentation header */
    protected $header = null;

    /** @var object[]  */
    private $subServices = [];

    /**
     * Get the service manager
     *
     * @deprecated Use $this->propagate instead
     *
     * @param $serviceManager
     */
    public function setServiceManager($serviceManager)
    {
        $this->setServiceLocator($serviceManager);
    }

    /**
     * Get a subservice from the current service $options
     *
     * @param $id
     * @param string $interface
     * @return mixed
     * @throws InvalidService
     * @throws InvalidServiceManagerException
     * @deprecated New services must be registered using Dependency Injection Container
     */
    public function getSubService($id, $interface = null)
    {
        if (! isset($this->subServices[$id])) {
            if ($this->hasOption($id)) {
                $service = $this->buildService($this->getOption($id), $interface);
                if ($service) {
                    $this->subServices[$id] = $service;
                } else {
                    throw new ServiceNotFoundException($id);
                }
            } else {
                throw new ServiceNotFoundException($id);
            }
        }
        return $this->subServices[$id];
    }

    /**
     * Set the documentation header uses into config file
     *
     * @param $header
     * @deprecated New services must be registered using Dependency Injection Container
     */
    public function setHeader($header)
    {
        $this->header = $header;
    }

    /**
     * Return the documentation header
     *
     * @return string
     * @deprecated New services must be registered using Dependency Injection Container
     */
    public function getHeader()
    {
        if (is_null($this->header)) {
            return $this->getDefaultHeader();
        } else {
            return $this->header;
        }
    }

    /**
     * Get the documentation header
     *
     * @return string
     * @deprecated New services must be registered using Dependency Injection Container
     */
    protected function getDefaultHeader()
    {
        return '<?php' . PHP_EOL
            . '/**' . PHP_EOL
            . ' * Default config header created during install' . PHP_EOL
            . ' */' . PHP_EOL;
    }

    /**
     * Build a sub service from current service $options
     *
     * @param $serviceDefinition
     * @param string $interfaceName
     * @return mixed
     * @throws InvalidService
     * @throws InvalidServiceManagerException
     * @deprecated New services must be registered using Dependency Injection Container
     */
    protected function buildService($serviceDefinition, $interfaceName = null)
    {
        if ($serviceDefinition instanceof ConfigurableService) {
            if (is_null($interfaceName) || is_a($serviceDefinition, $interfaceName)) {
                $this->propagate($serviceDefinition);
                return $serviceDefinition;
            } else {
                throw new InvalidService('Service must implements ' . $interfaceName);
            }
        } elseif (is_array($serviceDefinition) && isset($serviceDefinition['class'])) {
            $classname = $serviceDefinition['class'];
            $options = isset($serviceDefinition['options']) ? $serviceDefinition['options'] : [];
            if (is_null($interfaceName) || is_a($classname, $interfaceName, true)) {
                return $this->getServiceManager()->build($classname, $options);
            } else {
                throw new InvalidService('Service must implements ' . $interfaceName);
            }
        } else {
            throw new InvalidService();
        }
    }
}