ntentan / honam

src/TemplateFileResolver.php

Doc Comments +16 added lines

@@ -33,6 +33,11 @@ 
         array_unshift($this->pathHierarchy, $path);
     }
 
+    /**
+     * @param string $testTemplate
+     * @param string[] $paths
+     * @param string $extension
+     */
     private function testTemplateFile($testTemplate, $paths, $extension)
     {
         $templateFile = '';
@@ -46,6 +51,10 @@ 
         return $templateFile;
     }
 
+    /**
+     * @param string $testTemplate
+     * @param string[] $paths
+     */
     private function testNoEngineTemplateFile($testTemplate, $paths)
     {
         $templateFile = '';
@@ -53,6 +62,10 @@ 
             $newTemplateFile = "$testTemplate.*";
             $files = array_filter(
                 scandir($path),
+
+                /**
+                 * @param string $file
+                 */
                 function($file) use($newTemplateFile) {
                     return fnmatch($newTemplateFile, $file);
                 });
@@ -67,6 +80,9 @@ 
         return $templateFile;
     }
 
+    /**
+     * @param string $template
+     */
     private function searchTemplateDirectory($template, $ignoreEngine = false)
     {
         $templateFile = '';

src/engines/php/helpers/form/Element.php

Doc Comments +19 added lines, -1 removed lines

@@ -126,6 +126,9 @@ 
         $this->setId($id);
     }
     
+    /**
+     * @param string $id
+     */
     public function setId($id)
     {
         $this->id = str_replace(".","_",$id);
@@ -141,7 +144,7 @@ 
     /**
      * Public accessor for setting the name property of the field.
      *
-     * @param  $name The name to assign to the form element.
+     * @param  string $name The name to assign to the form element.
      * @return Element
      */
     public function setName($name)
@@ -161,6 +164,10 @@ 
     }
 
     //! Sets the label which is attached to this element.
+
+    /**
+     * @param string $label
+     */
     public function setLabel($label)
     {
         $this->label = $label;
@@ -188,6 +195,7 @@ 
      * Sets the description which is attached to this element. The description
      * is normally displayed under the element when rendering HTML.
      *
+     * @param string $description
      * @return Element
      */
     public function setDescription($description)
@@ -249,6 +257,10 @@ 
     //! This method internally creates a new Attribute object and appends
     //! it to the list of attributes.
     //! \see Attribute
+
+    /**
+     * @param string $attribute
+     */
     public function setAttribute($attribute,$value,$scope = Element::SCOPE_ELEMENT)
     {
         // Force the setting of the attribute.
@@ -278,6 +290,9 @@ 
         return $attributes;
     }
     
+    /**
+     * @param string $attribute
+     */
     public function getAttribute($attribute, $scope = Element::SCOPE_ELEMENT)
     {
         $attributes = $this->getAttributes($scope);
@@ -295,6 +310,9 @@ 
         return $this->renderLabel;
     }
     
+    /**
+     * @param boolean $renderLabel
+     */
     public function setRenderLabel($renderLabel)
     {
         $this->renderLabel = $renderLabel;

src/engines/php/helpers/form/Field.php

Doc Comments +1 added lines, -1 removed lines

@@ -76,7 +76,7 @@
     /**
      * Get the value of the field.
      *
-     * @return unknown
+     * @return string
      */
     public function getValue()
     {

src/TemplateRenderer.php

Doc Comments +1 added lines, -1 removed lines

@@ -110,7 +110,7 @@
      * Load and cache an instance of the a template engine.
      *
      * @param $extension
-     * @return mixed
+     * @return AbstractEngine
      * @throws exceptions\TemplateEngineNotFoundException
      * @throws exceptions\FactoryException
      */