EventMediator\PimpleContainerMediator

Complexity

Total Complexity

6

Size/Duplication

Total Lines	74
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	2

Test Coverage

Coverage

100%

Importance

Changes

0

4 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	4	1
A	getServiceByName()	0	4	1
A	setServiceContainer()	0	15	3
A	getServiceContainer()	0	4	1

<?php
declare(strict_types = 1);
/**
 * Contains PimpleContainerMediator class.
 *
 * PHP version 7.0
 *
 * LICENSE:
 * This file is part of Event Mediator - A general event mediator (dispatcher)
 * which has minimal dependencies so it is easy to drop in and use.
 * Copyright (C) 2015-2016 Michael Cummings
 *
 * 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; version 2 of the License.
 *
 * 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, you may write to
 *
 * Free Software Foundation, Inc.
 * 59 Temple Place, Suite 330
 * Boston, MA 02111-1307 USA
 *
 * or find a electronic copy at
 * <http://spdx.org/licenses/GPL-2.0.html>.
 *
 * You should also be able to find a copy of this license in the included
 * LICENSE file.
 *
 * @author    Michael Cummings <mgcummings@yahoo.com>
 * @copyright 2015-2016 Michael Cummings
 * @license   GPL-2.0
 */
namespace EventMediator;

use Pimple\Container;

/**
 * Class PimpleContainerMediator
 *
 * @link http://pimple.sensiolabs.org/ Pimple
 */
class PimpleContainerMediator extends AbstractContainerMediator
{
    /**
     * @param Container|null $serviceContainer
     *
     * @throws \InvalidArgumentException
     */
    public function __construct(Container $serviceContainer = \null)
    {
        $this->setServiceContainer($serviceContainer);
    }
    /** @noinspection GenericObjectTypeUsageInspection */
    /**
     * This method is used any time the mediator need to get the actual instance
     * of the class for an event.
     *
     * Normal will only be called during actual trigger of an event since lazy
     * loading is used.
     *
     * @param string $serviceName
     *
     * @return object
     * @throws \LogicException
     */
    public function getServiceByName(string $serviceName)
    {
        return $this->getServiceContainer()[$serviceName];
    }
    /**
     * This is used to bring in the service container that will be used.
     *
     * Though not required it would be considered best practice for this method
     * to create a new instance of the container when given null. Another good
     * practice is to call this method from the class constructor to allow
     * easier testing.
     *
     * @param Container|null $value
     *
     * @return ContainerMediatorInterface Fluent interface.
     * @throws \InvalidArgumentException
     *
     * @link http://pimple.sensiolabs.org/ Pimple
     */
    public function setServiceContainer($value = \null): ContainerMediatorInterface
    {
        if (\null === $value) {
            $value = new Container();
        }
        if (!$value instanceof Container) {
            $mess = \sprintf(
                'Must be an instance of Pimple Container but given %s',
                \gettype($value)
            );
            throw new \InvalidArgumentException($mess);
        }
        $this->serviceContainer = $value;
        return $this;
    }
    /**
     * Used to get the service container.
     *
     * @return mixed
     */
    private function getServiceContainer()
    {
        return $this->serviceContainer;
    }
    /**
     * Holds the container instance to be used.
     *
     * @var mixed $serviceContainer
     */
    private $serviceContainer;
}