thomasvargiu / pami-module

src/Service/AbstractFactory.php

<?php

namespace PamiModule\Service;

use Interop\Container\ContainerInterface;
use RuntimeException;
use Zend\ServiceManager\FactoryInterface;

/**
 * Class AbstractFactory.
 */
abstract class AbstractFactory implements FactoryInterface

The interface Zend\ServiceManager\FactoryInterface has been deprecated with message: Use Zend\ServiceManager\Factory\FactoryInterface instead.

{
    /**
     * Service name.
     *
     * @var string
     */
    protected $name;

    /**
     * Constructor.
     *
     * @param string $name Service name
     */
    public function __construct($name)
    {
        $this->name = $name;
    }

    /**
     * Gets options from configuration based on name.
     *
     * @param ContainerInterface $container Service locator
     * @param string             $key       Service type
     * @param null|string        $name      Service name
     *
     * @throws \RuntimeException
     *
     * @return \Zend\Stdlib\AbstractOptions
     */
    public function getOptions(ContainerInterface $container, $key, $name = null)
    {
        if ($name === null) {
            $name = $this->getName();
        }

        if (!$this->hasOptions($container, $key, $name)) {
            // @codeCoverageIgnoreStart
            throw new RuntimeException(
                sprintf(
                    'Options with name "%s" could not be found in "pami_module.%s".',
                    $name,
                    $key
                )
            );
            // @codeCoverageIgnoreEnd
        }

        $options = $container->get('config');
        $options = $options['pami_module'];
        $options = isset($options[$key][$name]) ? $options[$key][$name] : null;

        $optionsClass = $this->getOptionsClass();

        return new $optionsClass($options);
    }

    /**
     * Return if options exists in configuration.
     *
     * @param ContainerInterface $container Service locator
     * @param string             $key       Service type
     * @param string             $name      Service name
     *
     * @return bool
     */
    public function hasOptions(ContainerInterface $container, $key, $name)
    {
        $options = $container->get('config');
        $options = $options['pami_module'];

        return isset($options[$key][$name]);
    }

    /**
     * Service name.
     *
     * @return string
     */
    public function getName()
    {
        return $this->name;
    }

    /**
     * Get the class name of the options associated with this factory.
     *
     * @abstract
     *
     * @return string
     */
    abstract public function getOptionsClass();
}