Merge branch 'master' into hotfix/translator-caching

zendframework · Sep 20, 2012 · fa89036 · fa89036
commit fa89036
Show file tree

Hide file tree

Showing 33 changed files with 110 additions and 83 deletions.
diff --git a/src/Helper/BasePath.php b/src/Helper/BasePath.php
@@ -33,6 +33,7 @@ class BasePath extends AbstractHelper
      * $file is appended to the base path for simplicity.
      *
      * @param  string|null $file
+     * @throws Exception\RuntimeException
      * @return string
      */
     public function __invoke($file = null)

diff --git a/src/Helper/Cycle.php b/src/Helper/Cycle.php
@@ -99,7 +99,6 @@ public function setName($name = self::DEFAULT_NAME)
     /**
      * Gets actual name of cycle
      *
-     * @param $name
      * @return string
      */
     public function getName()

diff --git a/src/Helper/Escaper/AbstractHelper.php b/src/Helper/Escaper/AbstractHelper.php
@@ -60,7 +60,8 @@ public function getEscaper()
      * Set the encoding to use for escape operations
      *
      * @param  string $encoding
-     * @return AbstractEscaper
+     * @throws Exception\InvalidArgumentException
+     * @return AbstractHelper
      */
     public function setEncoding($encoding)
     {

diff --git a/src/Helper/HeadLink.php b/src/Helper/HeadLink.php
@@ -10,6 +10,7 @@
 
 namespace Zend\View\Helper;
 
+use stdClass;
 use Zend\View;
 use Zend\View\Exception;
 
@@ -52,6 +53,8 @@ public function __construct()
      * Returns current object instance. Optionally, allows passing array of
      * values to build link.
      *
+     * @param array $attributes
+     * @param string $placement
      * @return \Zend\View\Helper\HeadLink
      */
     public function __invoke(array $attributes = null, $placement = Placeholder\Container\AbstractContainer::APPEND)
@@ -161,7 +164,7 @@ public function __call($method, $args)
      */
     protected function isValid($value)
     {
-        if (!$value instanceof \stdClass) {
+        if (!$value instanceof stdClass) {
             return false;
         }
 
@@ -216,7 +219,7 @@ public function offsetSet($index, $value)
      * prepend()
      *
      * @param  array $value
-     * @return Zend_Layout_ViewHelper_HeadLink
+     * @return HeadLink
      * @throws Exception\InvalidArgumentException
      */
     public function prepend($value)
@@ -234,7 +237,7 @@ public function prepend($value)
      * set()
      *
      * @param  array $value
-     * @return Zend_Layout_ViewHelper_HeadLink
+     * @return HeadLink
      * @throws Exception\InvalidArgumentException
      */
     public function set($value)
@@ -255,7 +258,7 @@ public function set($value)
      * @param  stdClass $item
      * @return string
      */
-    public function itemToString(\stdClass $item)
+    public function itemToString(stdClass $item)
     {
         $attributes = (array) $item;
         $link       = '<link ';

diff --git a/src/Helper/HeadMeta.php b/src/Helper/HeadMeta.php
@@ -10,6 +10,7 @@
 
 namespace Zend\View\Helper;
 
+use stdClass;
 use Zend\View;
 use Zend\View\Exception;
 
@@ -80,7 +81,7 @@ public function __invoke($content = null, $keyValue = null, $keyType = 'name', $
     /**
      * Normalize type attribute of meta
      *
-     * @param $type type in CamelCase
+     * @param string $type type in CamelCase
      * @return string
      * @throws Exception\DomainException
      */
@@ -171,7 +172,7 @@ public function __call($method, $args)
      */
     public function setCharset($charset)
     {
-        $item = new \stdClass;
+        $item = new stdClass;
         $item->type = 'charset';
         $item->charset = $charset;
         $item->content = null;
@@ -188,7 +189,7 @@ public function setCharset($charset)
      */
     protected function isValid($item)
     {
-        if ((!$item instanceof \stdClass)
+        if ((!$item instanceof stdClass)
             || !isset($item->type)
             || !isset($item->modifiers))
         {
@@ -307,14 +308,11 @@ public function set($value)
     /**
      * Build meta HTML string
      *
-     * @param  string $type
-     * @param  string $typeValue
-     * @param  string $content
-     * @param  array $modifiers
-     * @return string
+     * @param  stdClass $item
      * @throws Exception\InvalidArgumentException
+     * @return string
      */
-    public function itemToString(\stdClass $item)
+    public function itemToString(stdClass $item)
     {
         if (!in_array($item->type, $this->typeKeys)) {
             throw new Exception\InvalidArgumentException(sprintf(
@@ -409,7 +407,7 @@ public function toString($indent = null)
      */
     public function createData($type, $typeValue, $content, array $modifiers)
     {
-        $data            = new \stdClass;
+        $data            = new stdClass;
         $data->type      = $type;
         $data->$type     = $typeValue;
         $data->content   = $content;

diff --git a/src/Helper/HeadScript.php b/src/Helper/HeadScript.php
@@ -10,6 +10,7 @@
 
 namespace Zend\View\Helper;
 
+use stdClass;
 use Zend\View;
 use Zend\View\Exception;
 
@@ -275,7 +276,7 @@ protected function isDuplicate($file)
      */
     protected function isValid($value)
     {
-        if ((!$value instanceof \stdClass)
+        if ((!$value instanceof stdClass)
             || !isset($value->type)
             || (!isset($value->source) && !isset($value->attributes)))
         {
@@ -485,7 +486,7 @@ public function toString($indent = null)
      */
     public function createData($type, array $attributes, $content = null)
     {
-        $data             = new \stdClass();
+        $data             = new stdClass();
         $data->type       = $type;
         $data->attributes = $attributes;
         $data->source     = $content;

diff --git a/src/Helper/HeadStyle.php b/src/Helper/HeadStyle.php
@@ -10,6 +10,7 @@
 
 namespace Zend\View\Helper;
 
+use stdClass;
 use Zend\View;
 use Zend\View\Exception;
 
@@ -162,12 +163,11 @@ public function __call($method, $args)
      * Determine if a value is a valid style tag
      *
      * @param  mixed $value
-     * @param  string $method
      * @return boolean
      */
     protected function isValid($value)
     {
-        if ((!$value instanceof \stdClass)
+        if ((!$value instanceof stdClass)
             || !isset($value->content)
             || !isset($value->attributes))
         {
@@ -251,8 +251,8 @@ public function set($value)
     /**
      * Start capture action
      *
-     * @param  mixed $captureType
-     * @param  string $typeOrAttrs
+     * @param string $type
+     * @param string $attrs
      * @return void
      * @throws Exception\RuntimeException
      */
@@ -301,7 +301,7 @@ public function captureEnd()
      * @param  string $indent Indentation to use
      * @return string
      */
-    public function itemToString(\stdClass $item, $indent)
+    public function itemToString(stdClass $item, $indent)
     {
         $attrString = '';
         if (!empty($item->attributes)) {
@@ -337,8 +337,8 @@ public function itemToString(\stdClass $item, $indent)
             }
         }
 
-        $escapeStart = $indent . '<!--'. PHP_EOL;
-        $escapeEnd = $indent . '-->'. PHP_EOL;
+        $escapeStart = $indent . '<!--' . PHP_EOL;
+        $escapeEnd = $indent . '-->' . PHP_EOL;
         if (isset($item->attributes['conditional'])
             && !empty($item->attributes['conditional'])
             && is_string($item->attributes['conditional'])
@@ -399,7 +399,7 @@ public function createData($content, array $attributes)
             $attributes['media'] = implode(',', $attributes['media']);
         }
 
-        $data = new \stdClass();
+        $data = new stdClass();
         $data->content    = $content;
         $data->attributes = $attributes;
 

diff --git a/src/Helper/HeadTitle.php b/src/Helper/HeadTitle.php
@@ -90,7 +90,7 @@ public function __invoke($title = null, $setType = null)
      * Set a default order to add titles
      *
      * @param string $setType
-     * @return void
+     * @return HeadTitle
      * @throws Exception\DomainException
      */
     public function setDefaultAttachOrder($setType)

diff --git a/src/Helper/HtmlList.php b/src/Helper/HtmlList.php
@@ -25,6 +25,7 @@ class HtmlList extends AbstractHtmlElement
      * @param array   $items   Array with the elements of the list
      * @param boolean $ordered Specifies ordered/unordered list; default unordered
      * @param array   $attribs Attributes for the ol/ul tag.
+     * @param boolean $escape Escape the items.
      * @return string The list XHTML.
      */
     public function __invoke(array $items, $ordered = false, $attribs = false, $escape = true)

diff --git a/src/Helper/Layout.php b/src/Helper/Layout.php
@@ -70,6 +70,7 @@ public function __invoke($template = null)
     /**
      * Get the root view model
      *
+     * @throws Exception\RuntimeException
      * @return null|Model
      */
     protected function getRoot()

diff --git a/src/Helper/Navigation/AbstractHelper.php b/src/Helper/Navigation/AbstractHelper.php
@@ -83,7 +83,7 @@ abstract class AbstractHelper extends View\Helper\AbstractHtmlElement implements
     /**
      * ACL role to use when iterating pages
      *
-     * @var string|Acl\Role
+     * @var string|Acl\Role\RoleInterface
      */
     protected $role;
 
@@ -127,7 +127,7 @@ abstract class AbstractHelper extends View\Helper\AbstractHtmlElement implements
      * Default ACL role to use when iterating pages if not explicitly set in the
      * instance by calling {@link setRole()}
      *
-     * @var string|Acl\Role
+     * @var string|Acl\Role\RoleInterface
      */
     protected static $defaultRole;
 
@@ -485,7 +485,7 @@ public function __toString()
      *                                          {@link getMinDepth()}. A
      *                                          null value means no minimum
      *                                          depth required.
-     * @param  int|null             $minDepth   [optional] maximum depth
+     * @param  int|null             $maxDepth   [optional] maximum depth
      *                                          a page can have to be
      *                                          valid. Default is to use
      *                                          {@link getMaxDepth()}. A

diff --git a/src/Helper/Navigation/Breadcrumbs.php b/src/Helper/Navigation/Breadcrumbs.php
@@ -56,7 +56,7 @@ class Breadcrumbs extends AbstractHelper
      * Helper entry point
      *
      * @param  string|AbstractContainer $container container to operate on
-     * @return Navigation
+     * @return Breadcrumbs
      */
     public function __invoke($container = null)
     {

diff --git a/src/Helper/Navigation/Links.php b/src/Helper/Navigation/Links.php
@@ -208,6 +208,7 @@ public function getRenderFlag()
      * </code>
      *
      * @param  AbstractPage $page  page to find links for
+     * @param null|int $flag
      * @return array related pages
      */
     public function findAllRelations(AbstractPage $page, $flag = null)
@@ -728,7 +729,7 @@ public function renderLink(AbstractPage $page, $attrib, $relation)
      *
      * Implements {@link HelperInterface::render()}.
      *
-     * @param  AbstractContainer string|$container [optional] container to render.
+     * @param  AbstractContainer|string|null $container [optional] container to render.
      *                                         Default is to render the
      *                                         container registered in the
      *                                         helper.

diff --git a/src/Helper/Navigation/Menu.php b/src/Helper/Navigation/Menu.php
@@ -314,13 +314,13 @@ protected function normalizeOptions(array $options = array())
      * Renders the deepest active menu within [$minDepth, $maxDepth], (called
      * from {@link renderMenu()})
      *
-     * @param  AbstractContainer         $container  container to render
-     * @param  array                     $active     active page and depth
-     * @param  string                    $ulClass    CSS class for first UL
-     * @param  string                    $indent     initial indentation
-     * @param  int|null                  $minDepth   minimum depth
-     * @param  int|null                  $maxDepth   maximum depth
-     * @return string                                rendered menu
+     * @param  AbstractContainer         $container    container to render
+     * @param  string                    $ulClass      CSS class for first UL
+     * @param  string                    $indent       initial indentation
+     * @param  int|null                  $minDepth     minimum depth
+     * @param  int|null                  $maxDepth     maximum depth
+     * @param  bool                      $escapeLabels Whether or not to escape the labels
+     * @return string                                  rendered menu
      */
     protected function renderDeepestMenu(AbstractContainer $container,
                                          $ulClass,
@@ -367,12 +367,13 @@ protected function renderDeepestMenu(AbstractContainer $container,
     /**
      * Renders a normal menu (called from {@link renderMenu()})
      *
-     * @param  AbstractContainer                 $container   container to render
-     * @param  string                    $ulClass     CSS class for first UL
-     * @param  string                    $indent      initial indentation
-     * @param  int|null                  $minDepth    minimum depth
-     * @param  int|null                  $maxDepth    maximum depth
-     * @param  bool                      $onlyActive  render only active branch?
+     * @param  AbstractContainer         $container    container to render
+     * @param  string                    $ulClass      CSS class for first UL
+     * @param  string                    $indent       initial indentation
+     * @param  int|null                  $minDepth     minimum depth
+     * @param  int|null                  $maxDepth     maximum depth
+     * @param  bool                      $onlyActive   render only active branch?
+     * @param  bool                      $escapeLabels Whether or not to escape the labels
      * @return string
      */
     protected function renderNormalMenu(AbstractContainer $container,

diff --git a/src/Helper/Navigation/Sitemap.php b/src/Helper/Navigation/Sitemap.php
@@ -90,7 +90,7 @@ class Sitemap extends AbstractHelper
      * Helper entry point
      *
      * @param  string|AbstractContainer $container container to operate on
-     * @return Navigation
+     * @return Sitemap
      */
     public function __invoke($container = null)
     {
@@ -444,10 +444,10 @@ public function getDomSitemap(AbstractContainer $container = null)
      *
      * Implements {@link HelperInterface::render()}.
      *
-     * @param  link|AbstractContainer $container [optional] container to render. Default is
-     *                              to render the container registered in the
-     *                              helper.
-     * @return string               helper output
+     * @param  AbstractContainer $container [optional] container to render. Default is
+     *                           to render the container registered in the
+     *                           helper.
+     * @return string            helper output
      */
     public function render($container = null)
     {

diff --git a/src/Helper/PaginationControl.php b/src/Helper/PaginationControl.php
@@ -67,7 +67,7 @@ public static function getDefaultScrollingStyle()
     /**
      * Sets the default Scrolling Style
      *
-     * @param type $style string 'all' | 'elastic' | 'sliding' | 'jumping'
+     * @param string $style string 'all' | 'elastic' | 'sliding' | 'jumping'
      */
     public static function setDefaultScrollingStyle($style)
     {

diff --git a/src/Helper/Placeholder/Container/AbstractContainer.php b/src/Helper/Placeholder/Container/AbstractContainer.php
@@ -241,7 +241,8 @@ public function getWhitespace($indent)
     /**
      * Start capturing content to push into placeholder
      *
-     * @param  int $type How to capture content into placeholder; append, prepend, or set
+     * @param  string $type How to capture content into placeholder; append, prepend, or set
+     * @param  mixed $key Key to which to capture content
      * @return void
      * @throws Exception\RuntimeException if nested captures detected
      */
@@ -337,6 +338,7 @@ public function nextIndex()
     /**
      * Render the placeholder
      *
+     * @param null|int|string $indent
      * @return string
      */
     public function toString($indent = null)