libraries/di/Container.php

   1 <?php
   2 /* vim: set expandtab sw=4 ts=4 sts=4: */
   3 /**
   4  * Holds the PMA\libraries\di\Container class
   5  *
   6  * @package PMA
   7  */
   8 namespace PMA\libraries\di;
   9
  10 use Psr\Container\ContainerInterface;
  11
  12 /**
  13  * Class Container
  14  *
  15  * @package PMA\libraries\di
  16  */
  17 class Container implements ContainerInterface
  18 {
  19     /**
  20      * @var Item[] $content
  21      */
  22     protected $content = array();
  23
  24     /**
  25      * @var Container
  26      */
  27     protected static $defaultContainer;
  28
  29     /**
  30      * Create a dependency injection container
  31      *
  32      * @param Container $base Container
  33      */
  34     public function __construct(Container $base = null)
  35     {
  36         if (isset($base)) {
  37             $this->content = $base->content;
  38         } else {
  39             $this->alias('container', 'Container');
  40         }
  41         $this->set('Container', $this);
  42     }
  43
  44     /**
  45      * Get an object with given name and parameters
  46      *
  47      * @param string $name   Name
  48      * @param array  $params Parameters
  49      *
  50      * @throws NotFoundException  No entry was found for **this** identifier.
  51      * @throws ContainerException Error while retrieving the entry.
  52      *
  53      * @return mixed
  54      */
  55     public function get($name, $params = array())
  56     {
  57         if (!$this->has($name)) {
  58             throw new NotFoundException("No entry was found for $name identifier.");
  59         }
  60
  61         if (isset($this->content[$name])) {
  62             return $this->content[$name]->get($params);
  63         } else if (isset($GLOBALS[$name])) {
  64             return $GLOBALS[$name];
  65         } else {
  66             throw new ContainerException("Error while retrieving the entry.");
  67         }
  68     }
  69
  70     /**
  71      * Returns true if the container can return an entry for the given identifier.
  72      * Returns false otherwise.
  73      *
  74      * `has($name)` returning true does not mean that `get($name)` will not throw an exception.
  75      * It does however mean that `get($name)` will not throw a `NotFoundException`.
  76      *
  77      * @param string $name Identifier of the entry to look for.
  78      *
  79      * @return bool
  80      */
  81     public function has($name)
  82     {
  83         return isset($this->content[$name]) || isset($GLOBALS[$name]);
  84     }
  85
  86     /**
  87      * Remove an object from container
  88      *
  89      * @param string $name Name
  90      *
  91      * @return void
  92      */
  93     public function remove($name)
  94     {
  95         unset($this->content[$name]);
  96     }
  97
  98     /**
  99      * Rename an object in container
 100      *
 101      * @param string $name    Name
 102      * @param string $newName New name
 103      *
 104      * @return void
 105      */
 106     public function rename($name, $newName)
 107     {
 108         $this->content[$newName] = $this->content[$name];
 109         $this->remove($name);
 110     }
 111
 112     /**
 113      * Set values in the container
 114      *
 115      * @param string|array $name  Name
 116      * @param mixed        $value Value
 117      *
 118      * @return void
 119      */
 120     public function set($name, $value = null)
 121     {
 122         if (is_array($name)) {
 123             foreach ($name as $key => $val) {
 124                 $this->set($key, $val);
 125             }
 126             return;
 127         }
 128         $this->content[$name] = new ValueItem($value);
 129     }
 130
 131     /**
 132      * Register a service in the container
 133      *
 134      * @param string $name    Name
 135      * @param mixed  $service Service
 136      *
 137      * @return void
 138      */
 139     public function service($name, $service = null)
 140     {
 141         if (!isset($service)) {
 142             $service = $name;
 143         }
 144         $this->content[$name] = new ServiceItem($this, $service);
 145     }
 146
 147     /**
 148      * Register a factory in the container
 149      *
 150      * @param string $name    Name
 151      * @param mixed  $factory Factory
 152      *
 153      * @return void
 154      */
 155     public function factory($name, $factory = null)
 156     {
 157         if (!isset($factory)) {
 158             $factory = $name;
 159         }
 160         $this->content[$name] = new FactoryItem($this, $factory);
 161     }
 162
 163     /**
 164      * Register an alias in the container
 165      *
 166      * @param string $name   Name
 167      * @param string $target Target
 168      *
 169      * @return void
 170      */
 171     public function alias($name, $target)
 172     {
 173         // The target may be not defined yet
 174         $this->content[$name] = new AliasItem($this, $target);
 175     }
 176
 177     /**
 178      * Get the global default container
 179      *
 180      * @return Container
 181      */
 182     public static function getDefaultContainer()
 183     {
 184         if (!isset(static::$defaultContainer)) {
 185             static::$defaultContainer = new Container();
 186         }
 187         return static::$defaultContainer;
 188     }
 189 }