interface/modules/zend_modules/library/Zend/View/Helper/Placeholder.php

   1 <?php
   2 /**
   3  * Zend Framework (http://framework.zend.com/)
   4  *
   5  * @link      http://github.com/zendframework/zf2 for the canonical source repository
   6  * @copyright Copyright (c) 2005-2015 Zend Technologies USA Inc. (http://www.zend.com)
   7  * @license   http://framework.zend.com/license/new-bsd New BSD License
   8  */
   9
  10 namespace Zend\View\Helper;
  11
  12 use Zend\View\Exception\InvalidArgumentException;
  13 use Zend\View\Helper\Placeholder\Container;
  14
  15 /**
  16  * Helper for passing data between otherwise segregated Views. It's called
  17  * Placeholder to make its typical usage obvious, but can be used just as easily
  18  * for non-Placeholder things. That said, the support for this is only
  19  * guaranteed to effect subsequently rendered templates, and of course Layouts.
  20  */
  21 class Placeholder extends AbstractHelper
  22 {
  23     /**
  24      * Placeholder items
  25      *
  26      * @var array
  27      */
  28     protected $items = array();
  29
  30     /**
  31      * Default container class
  32      * @var string
  33      */
  34     protected $containerClass = 'Zend\View\Helper\Placeholder\Container';
  35
  36     /**
  37      * Placeholder helper
  38      *
  39      * @param  string $name
  40      * @throws InvalidArgumentException
  41      * @return Placeholder\Container\AbstractContainer
  42      */
  43     public function __invoke($name = null)
  44     {
  45         if ($name === null) {
  46             throw new InvalidArgumentException(
  47                 'Placeholder: missing argument. $name is required by placeholder($name)'
  48             );
  49         }
  50
  51         $name = (string) $name;
  52         return $this->getContainer($name);
  53     }
  54
  55     /**
  56      * createContainer
  57      *
  58      * @param  string $key
  59      * @param  array $value
  60      * @return Container\AbstractContainer
  61      */
  62     public function createContainer($key, array $value = array())
  63     {
  64         $key = (string) $key;
  65
  66         $this->items[$key] = new $this->containerClass($value);
  67         return $this->items[$key];
  68     }
  69
  70     /**
  71      * Retrieve a placeholder container
  72      *
  73      * @param  string $key
  74      * @return Container\AbstractContainer
  75      */
  76     public function getContainer($key)
  77     {
  78         $key = (string) $key;
  79         if (isset($this->items[$key])) {
  80             return $this->items[$key];
  81         }
  82
  83         $container = $this->createContainer($key);
  84
  85         return $container;
  86     }
  87
  88     /**
  89      * Does a particular container exist?
  90      *
  91      * @param  string $key
  92      * @return bool
  93      */
  94     public function containerExists($key)
  95     {
  96         $key = (string) $key;
  97         $return =  array_key_exists($key, $this->items);
  98         return $return;
  99     }
 100 }