ntentan / honam

src/engines/php/Helper.php

Doc Comments +1 added lines, -1 removed lines

@@ -41,7 +41,7 @@
     /**
      * A sort of constructor or entry point for helpers.
      * @param mixed $arguments
-     * @return \ntentan\honam\Helper
+     * @return Helper
      */
     public function help($arguments)
     {

src/engines/php/helpers/feed/generators/RssFeed.php

Doc Comments +3 added lines

@@ -98,6 +98,9 @@
         return $properties[$property];
     }
     
+    /**
+     * @param string $property
+     */
     private function formatProperty($property, $value)
     {
         switch($property)

src/engines/php/helpers/form/CheckableField.php

Doc Comments +1 added lines, -1 removed lines

@@ -62,7 +62,7 @@
     /**
      * Sets the value that should be assigned as the checked value for
      * this check box.
-     * @param $checkedValue The value to be assigned.
+     * @param string $checkedValue The value to be assigned.
      * @return Checkbox
      */
     public function setCheckedValue($checkedValue)

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

Unused Use Statements -1 removed lines

@@ -31,7 +31,6 @@
 
 namespace ntentan\honam\helpers\form;
 
-use ntentan\honam\helpers\FormHelper;
 use ntentan\honam\TemplateEngine;
 
 /**

Doc Comments +21 added lines, -3 removed lines

@@ -133,6 +133,9 @@ 
         $this->setId($id);
     }
     
+    /**
+     * @param string $id
+     */
     public function setId($id)
     {
         $this->id = str_replace(".","_",$id);
@@ -148,7 +151,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.
      */
     public function setName($name)
     {
@@ -159,7 +162,7 @@ 
     /**
      * Public accessor for getting the name property of the field.
      *
-     * @return The name of the form field.
+     * @return string name of the form field.
      */
     public function getName()
     {
@@ -167,6 +170,10 @@ 
     }
 
     //! Sets the label which is attached to this element.
+
+    /**
+     * @param string $label
+     */
     public function setLabel($label)
     {
         $this->label = $label;
@@ -194,7 +201,8 @@ 
      * Sets the description which is attached to this element. The description
      * is normally displayed under the element when rendering HTML.
      *
-     * @return string
+     * @param string $description
+     * @return Element
      */
     public function setDescription($description)
     {
@@ -253,6 +261,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.
@@ -282,6 +294,9 @@ 
         return $attributes;
     }
     
+    /**
+     * @param string $attribute
+     */
     public function getAttribute($attribute, $scope = Element::SCOPE_ELEMENT)
     {
         $attributes = $this->getAttributes($scope);
@@ -299,6 +314,9 @@ 
         return $this->renderLabel;
     }
     
+    /**
+     * @param boolean $renderLabel
+     */
     public function setRenderLabel($renderLabel)
     {
         $this->renderLabel = $renderLabel;

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

Doc Comments +2 added lines, -2 removed lines

@@ -76,7 +76,7 @@ 
     /**
      * Get the value of the field.
      *
-     * @return unknown
+     * @return string
      */
     public function getValue()
     {
@@ -97,7 +97,7 @@ 
     /**
      * Returns the required status of the field.
      *
-     * @return The required status of the field.
+     * @return boolean required status of the field.
      */
     public function getRequired()
     {

src/engines/php/helpers/ImagesHelper.php

Doc Comments +4 added lines, -1 removed lines

@@ -30,6 +30,10 @@ 
         return $image;
     }
     
+    /**
+     * @param resource $image
+     * @param string $path
+     */
     private function writeImage($image, $path)
     {
     	$array = explode(".", $path);
@@ -115,7 +119,6 @@ 
     /**
      * A smart thumbnailing function. Generates thumbnail images without
      * distorting the output of the final image.
-     * @param string $file
      * @param string $width
      * @param string $height
      * @param string $head

src/engines/PhpEngine.php

Unused Use Statements -1 removed lines

@@ -28,7 +28,6 @@
 
 use ntentan\honam\engines\php\HelpersLoader;
 use ntentan\honam\engines\php\Janitor;
-use ntentan\honam\TemplateEngine;
 use ntentan\honam\engines\php\Variable;
 
 /**

src/factories/MustacheEngineFactory.php

Unused Use Statements +1 added lines, -1 removed lines

@@ -3,9 +3,9 @@
 namespace ntentan\honam\factories;
 
 use ntentan\honam\template_engines\AbstractEngine;
+use ntentan\honam\template_engines\MustacheEngine;
 use ntentan\honam\template_engines\mustache\MustacheLoader;
 use ntentan\honam\template_engines\mustache\MustachePartialsLoader;
-use ntentan\honam\template_engines\MustacheEngine;
 
 
 class MustacheEngineFactory implements EngineFactoryInterface

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 = '';