Browse Source

Updated Zend_View_Helper_RenderToPlaceholder::renderToPlaceholder() method description - fixes ZF-5299

git-svn-id: http://framework.zend.com/svn/framework/standard/trunk@18208 44c647ce-9c0f-0410-b52a-842ac1e357ba
padraic 16 years ago
parent
commit
a325ad1713
1 changed files with 10 additions and 1 deletions
  1. 10 1
      library/Zend/View/Helper/RenderToPlaceholder.php

+ 10 - 1
library/Zend/View/Helper/RenderToPlaceholder.php

@@ -24,7 +24,8 @@
 require_once 'Zend/View/Helper/Abstract.php';
 
 /**
- * Helper for making easy links and getting urls that depend on the routes and router
+ * Renders a template and stores the rendered output as a placeholder
+ * variable for later use.
  *
  * @package    Zend_View
  * @subpackage Helper
@@ -35,6 +36,14 @@ require_once 'Zend/View/Helper/Abstract.php';
 class Zend_View_Helper_RenderToPlaceholder extends Zend_View_Helper_Abstract
 {
 
+    /**
+     * Renders a template and stores the rendered output as a placeholder
+     * variable for later use.
+     *
+     * @param $script The template script to render
+     * @param $placeholder The placeholder variable name in which to store the rendered output
+     * @return void
+     */
     public function renderToPlaceholder($script, $placeholder)
     {
         $this->view->placeholder($placeholder)->captureStart();