interface/modules/zend_modules/library/Zend/View/Helper/Partial.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-2013 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;
  13 use Zend\View\Model\ModelInterface;
  14
  15 /**
  16  * Helper for rendering a template fragment in its own variable scope.
  17  */
  18 class Partial extends AbstractHelper
  19 {
  20     /**
  21      * Variable to which object will be assigned
  22      *
  23      * @var string
  24      */
  25     protected $objectKey;
  26
  27     /**
  28      * Renders a template fragment within a variable scope distinct from the
  29      * calling View object. It proxies to view's render function
  30      *
  31      * @param  string|ModelInterface $name   Name of view script, or a view model
  32      * @param  array|object          $values Variables to populate in the view
  33      * @throws Exception\RuntimeException
  34      * @return string|Partial
  35      */
  36     public function __invoke($name = null, $values = null)
  37     {
  38         if (0 == func_num_args()) {
  39             return $this;
  40         }
  41
  42         // If we were passed only a view model, just render it.
  43         if ($name instanceof ModelInterface) {
  44             return $this->getView()->render($name);
  45         }
  46
  47         if (is_scalar($values)) {
  48             $values = array();
  49         } elseif ($values instanceof ModelInterface) {
  50             $values = $values->getVariables();
  51         } elseif (is_object($values)) {
  52             if (null !== ($objectKey = $this->getObjectKey())) {
  53                 $values = array($objectKey => $values);
  54             } elseif (method_exists($values, 'toArray')) {
  55                 $values = $values->toArray();
  56             } else {
  57                 $values = get_object_vars($values);
  58             }
  59         }
  60
  61         return $this->getView()->render($name, $values);
  62     }
  63
  64     /**
  65      * Set object key
  66      *
  67      * @param  string $key
  68      * @return Partial
  69      */
  70     public function setObjectKey($key)
  71     {
  72         if (null === $key) {
  73             $this->objectKey = null;
  74             return $this;
  75         }
  76
  77         $this->objectKey = (string) $key;
  78
  79         return $this;
  80     }
  81
  82     /**
  83      * Retrieve object key
  84      *
  85      * The objectKey is the variable to which an object in the iterator will be
  86      * assigned.
  87      *
  88      * @return null|string
  89      */
  90     public function getObjectKey()
  91     {
  92         return $this->objectKey;
  93     }
  94 }