Dhii/di-abstract

<?php

namespace Dhii\Di;

use Interop\Container\ContainerInterface as BaseContainerInterface;

/**
 * Functionality that facilitates parent awareness of a container.
 *
 * @since 0.1
 */
abstract class AbstractParentAwareContainer extends AbstractContainer
{
    /**
     * The parent container instance.
     *
     * @since 0.1
     *
     * @var BaseContainerInterface
     */
    protected $parentContainer;

    /**
     * Retrieves the parent container instance.
     *
     * @since 0.1
     *
     * @return BaseContainerInterface|null The parent container or null if this container has no parent.
     */
    protected function _getParentContainer()
    {
        return ($this->_hasParentContainer())
            ? $this->parentContainer
            : null;
    }

    /**
     * Checks if this container has a parent container.
     *
     * @since 0.1
     *
     * @return bool True if this container has a parent; false otherwise.
     */
    protected function _hasParentContainer()
    {
        return $this->parentContainer instanceof BaseContainerInterface;
    }

    /**
     * Sets the parent container instance.
     *
     * @since 0.1
     *
     * @param BaseContainerInterface|null $container The parent container or null to remove the parent. Default: null
     *
     * @return $this This instance.
     */
    protected function _setParentContainer(BaseContainerInterface $container = null)
    {
        $this->parentContainer = $container;

        return $this;
    }

    /**
     * Retrieves the container at the root of the hierarchy.
     *
     * @since 0.1
     *
     * @return BaseContainerInterface|null The top-most container in the chain, if exists;
     *                                     null otherwise.
     */
    protected function _getRootContainer()
    {
        $parent = $this->_getParentContainer();
        do {
            $root = $parent;

            $parent = ($parent instanceof ParentAwareContainerInterface)
                ? $parent->getParentContainer()
                : null;
        } while ($parent);

        return $root;
    }

    /**
     * {@inheritdoc}
     *
     * This is what does the magic.
     *
     * @since 0.1
     * @see AbstractContainer::_resolveDefinition()
     */
    protected function _resolveDefinition($definition, $config)
    {
        $root      = $this->_getRootContainer();
        $container = $root ? $root : $this;

        return call_user_func_array($definition, array($container, null, $config));
    }
}