phptal / PHPTAL

classes/PHPTAL.php

Doc Comments +3 added lines, -3 removed lines

@@ -360,7 +360,7 @@ 
      * Get output mode
      * @see setOutputMode()
      *
-     * @return output mode constant
+     * @return integer mode constant
      */
     public function getOutputMode()
     {
@@ -389,9 +389,8 @@ 
     /**
      * Get input and ouput encoding.
      *
-     * @param string $enc example: 'UTF-8'
      *
-     * @return $this
+     * @return string
      */
     public function getEncoding()
     {
@@ -743,6 +742,7 @@ 
      *
      * @param PHPTAL $local_tpl is PHPTAL instance of the file in which macro is defined
      *                          (it will be different from $this if it's external macro call)
+     * @param string $path
      * @access private
      */
     final public function _executeMacroOfTemplate($path, PHPTAL $local_tpl)

Braces +22 added lines, -13 removed lines

@@ -379,7 +379,9 @@ 
         $enc = strtoupper($enc);
         if ($enc != $this->_encoding) {
             $this->_encoding = $enc;
-            if ($this->_translator) $this->_translator->setEncoding($enc);
+            if ($this->_translator) {
+                $this->_translator->setEncoding($enc);
+            }
 
             $this->resetPrepared();
         }
@@ -666,8 +668,7 @@ 
                 ob_start();
                 $templateFunction($this, $this->_context);
                 $res = ob_get_clean();
-            }
-            catch (Exception $e)
+            } catch (Exception $e)
             {
                 ob_end_clean();
                 throw $e;
@@ -686,8 +687,7 @@ 
             if ($this->_postfilter) {
                 return $this->_postfilter->filter($res);
             }
-        }
-        catch (Exception $e)
+        } catch (Exception $e)
         {
             PHPTAL_ExceptionHandler::handleException($e, $this->getEncoding());
         }
@@ -717,8 +717,7 @@ 
 
             $templateFunction = $this->getFunctionName();
             $templateFunction($this, $this->_context);
-        }
-        catch (Exception $e)
+        } catch (Exception $e)
         {
             PHPTAL_ExceptionHandler::handleException($e, $this->getEncoding());
         }
@@ -835,8 +834,7 @@ 
                 ob_start();
                 try {
                     eval("?>\n".$result);
-                }
-                catch(Exception $e) {
+                } catch(Exception $e) {
                     ob_end_clean();
                     throw $e;
                 }
@@ -845,7 +843,11 @@ 
                     $msg = str_replace('eval()\'d code', $this->getCodePath(), ob_get_clean());
 
                     // greedy .* ensures last match
-                    if (preg_match('/.*on line (\d+)$/m', $msg, $m)) $line=$m[1]; else $line=0;
+                    if (preg_match('/.*on line (\d+)$/m', $msg, $m)) {
+                        $line=$m[1];
+                    } else {
+                        $line=0;
+                    }
                     throw new PHPTAL_TemplateException(trim($msg), $this->getCodePath(), $line);
                 }
                 ob_end_clean();
@@ -939,7 +941,10 @@ 
         $cacheFiles = glob($filename . '?*');
         if ($cacheFiles) {
             foreach ($cacheFiles as $file) {
-                if (substr($file, 0, strlen($filename)) !== $filename) continue; // safety net
+                if (substr($file, 0, strlen($filename)) !== $filename) {
+                    continue;
+                }
+                // safety net
                 @unlink($file);
             }
         }
@@ -956,7 +961,9 @@ 
      */
     public function getCodePath()
     {
-        if (!$this->_codeFile) $this->setCodeFile();
+        if (!$this->_codeFile) {
+            $this->setCodeFile();
+        }
         return $this->_codeFile;
     }
 
@@ -1187,7 +1194,9 @@ 
             $class = strtr($class, '\\', '_');
         }
 
-        if (substr($class, 0, 7) !== 'PHPTAL_') return;
+        if (substr($class, 0, 7) !== 'PHPTAL_') {
+            return;
+        }
 
         $path = dirname(__FILE__) . strtr("_".$class, "_", DIRECTORY_SEPARATOR) . '.php';
 

classes/PHPTAL/Context.php

Doc Comments +4 added lines, -2 removed lines

@@ -64,7 +64,7 @@ 
     /**
      * save current execution context
      *
-     * @return Context (new)
+     * @return PHPTAL_Context (new)
      */
     public function pushContext()
     {
@@ -76,7 +76,7 @@ 
     /**
      * get previously saved execution context
      *
-     * @return Context (old)
+     * @return PHPTAL_Context (old)
      */
     public function popContext()
     {
@@ -263,6 +263,7 @@ 
     /**
      * Context setter.
      *
+     * @param string $varname
      * @return void
      */
     public function __set($varname, $value)
@@ -312,6 +313,7 @@ 
      * helper method for PHPTAL_Context::path()
      *
      * @access private
+     * @param string $path
      */
     private static function pathError($base, $path, $current, $basename)
     {

Braces +14 added lines, -10 removed lines

@@ -116,8 +116,7 @@ 
             } else {
                 throw new PHPTAL_ConfigurationException("Executed macro in file with DOCTYPE when using echoExecute(). This is not supported yet. Remove DOCTYPE or use PHPTAL->execute().");
             }
-        }
-        else if (!$this->_docType) {
+        } else if (!$this->_docType) {
             $this->_docType = $doctype;
         }
     }
@@ -317,7 +316,9 @@ 
     {
         if ($current !== $path) {
             $pathinfo = " (in path '.../$path')";
-        } else $pathinfo = '';
+        } else {
+            $pathinfo = '';
+        }
 
         if (!empty($basename)) {
             $basename = "'" . $basename . "' ";
@@ -353,7 +354,9 @@ 
     public static function path($base, $path, $nothrow=false)
     {
         if ($base === null) {
-            if ($nothrow) return null;
+            if ($nothrow) {
+                return null;
+            }
             PHPTAL_Context::pathError($base, $path, $path, $path);
         }
 
@@ -413,8 +416,7 @@ 
                     {
                         $base = $base->__call($current, array());
                         continue;
-                    }
-                    catch(BadMethodCallException $e) {}
+                    } catch(BadMethodCallException $e) {}
                 }
 
                 if (is_callable($base)) {
@@ -444,8 +446,9 @@ 
                     continue;
                 }
 
-                if ($nothrow)
-                    return null;
+                if ($nothrow) {
+                                    return null;
+                }
 
                 PHPTAL_Context::pathError($base, $path, $current, $prev);
             }
@@ -467,8 +470,9 @@ 
 
             // if this point is reached, then the part cannot be resolved
 
-            if ($nothrow)
-                return null;
+            if ($nothrow) {
+                            return null;
+            }
 
             PHPTAL_Context::pathError($base, $path, $current, $prev);
         }

classes/PHPTAL/Dom/Attr.php

Doc Comments +1 added lines, -1 removed lines

@@ -82,7 +82,7 @@
     /**
      * Returns true if this attribute is ns declaration (xmlns="...")
      *
-     * @return bool
+     * @return integer
      */
     function isNamespaceDeclaration()
     {

classes/PHPTAL/Dom/Defs.php

Doc Comments -1 removed lines

@@ -52,7 +52,6 @@
      * true if it's empty in XHTML (e.g. <img/>)
      * it will assume elements with no namespace may be XHTML too.
      *
-     * @param string $tagName local name of the tag
      *
      * @return bool
      */

Braces +3 added lines, -1 removed lines

@@ -119,7 +119,9 @@
      */
     public function isValidAttributeNS($namespace_uri, $local_name)
     {
-        if (!$this->isHandledNamespace($namespace_uri)) return false;
+        if (!$this->isHandledNamespace($namespace_uri)) {
+            return false;
+        }
 
         $attrs = $this->namespaces_by_uri[$namespace_uri]->getAttributes();
         return isset($attrs[$local_name]);

classes/PHPTAL/Dom/Element.php

Doc Comments +8 added lines, -1 removed lines

@@ -40,7 +40,7 @@ 
      * @param string $qname           qualified name of the element, e.g. "tal:block"
      * @param string $namespace_uri   namespace of this element
      * @param array  $attribute_nodes array of PHPTAL_Dom_Attr elements
-     * @param object $xmlns           object that represents namespaces/prefixes known in element's context
+     * @param PHPTAL_Dom_XmlnsState $xmlns           object that represents namespaces/prefixes known in element's context
      */
     public function __construct($qname, $namespace_uri, array $attribute_nodes, PHPTAL_Dom_XmlnsState $xmlns)
     {
@@ -229,6 +229,10 @@ 
         return null;
     }
 
+    /**
+     * @param string $ns_uri
+     * @param string $localname
+     */
     public function removeAttributeNS($ns_uri, $localname)
     {
         foreach ($this->attribute_nodes as $k => $attr) {
@@ -239,6 +243,9 @@ 
         }
     }
 
+    /**
+     * @return PHPTAL_Php_CodeWriter
+     */
     public function getAttributeNode($qname)
     {
         foreach($this->attribute_nodes as $attr) if ($attr->getQualifiedName() === $qname) return $attr;

Braces +55 added lines, -28 removed lines

@@ -94,7 +94,9 @@ 
         $value = '';
         foreach ($this->childNodes as $node) {
             // leave it alone if there is CDATA, comment, or anything else.
-            if (!$node instanceof PHPTAL_Dom_Text) return;
+            if (!$node instanceof PHPTAL_Dom_Text) {
+                return;
+            }
 
             $value .= $node->getValue();
             $valueEscaped .= $node->getValueEscaped();
@@ -118,7 +120,9 @@ 
 
     public function appendChild(PHPTAL_Dom_Node $child)
     {
-        if ($child->parentNode) $child->parentNode->removeChild($child);
+        if ($child->parentNode) {
+            $child->parentNode->removeChild($child);
+        }
         $child->parentNode = $this;
         $this->childNodes[] = $child;
     }
@@ -141,7 +145,9 @@ 
             if ($node === $oldElement) {
                 $oldElement->parentNode = NULL;
 
-                if ($newElement->parentNode) $newElement->parentNode->removeChild($child);
+                if ($newElement->parentNode) {
+                    $newElement->parentNode->removeChild($child);
+                }
                 $newElement->parentNode = $this;
 
                 $this->childNodes[$k] = $newElement;
@@ -182,8 +188,7 @@ 
             }
 
             $this->generateSurroundFoot($codewriter);
-        }
-        catch(PHPTAL_TemplateException $e) {
+        } catch(PHPTAL_TemplateException $e) {
             $e->hintSrcPosition($this->getSourceFile(), $this->getSourceLine());
             throw $e;
         }
@@ -212,7 +217,9 @@ 
     /** Returns true if the element contains specified PHPTAL attribute. */
     public function hasAttribute($qname)
     {
-        foreach($this->attribute_nodes as $attr) if ($attr->getQualifiedName() == $qname) return true;
+        foreach($this->attribute_nodes as $attr) {
+            if ($attr->getQualifiedName() == $qname) return true;
+        }
         return false;
     }
 
@@ -224,7 +231,9 @@ 
     public function getAttributeNodeNS($ns_uri, $localname)
     {
         foreach ($this->attribute_nodes as $attr) {
-            if ($attr->getNamespaceURI() === $ns_uri && $attr->getLocalName() === $localname) return $attr;
+            if ($attr->getNamespaceURI() === $ns_uri && $attr->getLocalName() === $localname) {
+                return $attr;
+            }
         }
         return null;
     }
@@ -241,7 +250,9 @@ 
 
     public function getAttributeNode($qname)
     {
-        foreach($this->attribute_nodes as $attr) if ($attr->getQualifiedName() === $qname) return $attr;
+        foreach($this->attribute_nodes as $attr) {
+            if ($attr->getQualifiedName() === $qname) return $attr;
+        }
         return null;
     }
 
@@ -252,7 +263,9 @@ 
      */
     public function getOrCreateAttributeNode($qname)
     {
-        if ($attr = $this->getAttributeNode($qname)) return $attr;
+        if ($attr = $this->getAttributeNode($qname)) {
+            return $attr;
+        }
 
         $attr = new PHPTAL_Dom_Attr($qname, "", null, 'UTF-8'); // FIXME: should find namespace and encoding
         $this->attribute_nodes[] = $attr;
@@ -294,19 +307,27 @@ 
      */
     public function hasRealContent()
     {
-        if (count($this->contentAttributes) > 0) return true;
+        if (count($this->contentAttributes) > 0) {
+            return true;
+        }
 
         foreach ($this->childNodes as $node) {
-            if (!$node instanceof PHPTAL_Dom_Text || $node->getValueEscaped() !== '') return true;
+            if (!$node instanceof PHPTAL_Dom_Text || $node->getValueEscaped() !== '') {
+                return true;
+            }
         }
         return false;
     }
 
     public function hasRealAttributes()
     {
-        if ($this->hasAttributeNS('http://xml.zope.org/namespaces/tal', 'attributes')) return true;
+        if ($this->hasAttributeNS('http://xml.zope.org/namespaces/tal', 'attributes')) {
+            return true;
+        }
         foreach ($this->attribute_nodes as $attr) {
-            if ($attr->getReplacedState() !== PHPTAL_Dom_Attr::HIDDEN) return true;
+            if ($attr->getReplacedState() !== PHPTAL_Dom_Attr::HIDDEN) {
+                return true;
+            }
         }
         return false;
     }
@@ -322,7 +343,9 @@ 
 
     public function generateHead(PHPTAL_Php_CodeWriter $codewriter)
     {
-        if ($this->headFootDisabled) return;
+        if ($this->headFootDisabled) {
+            return;
+        }
         if ($this->headPrintCondition) {
             $codewriter->doIf($this->headPrintCondition);
         }
@@ -355,9 +378,10 @@ 
                 foreach($this->childNodes as $child) {
                     $child->generateCode($codewriter);
                 }
-            }
-            else foreach($this->contentAttributes as $att) {
+            } else {
+                foreach($this->contentAttributes as $att) {
                 $att->before($codewriter);
+            }
                 $att->after($codewriter);
             }
         }
@@ -365,10 +389,12 @@ 
 
     public function generateFoot(PHPTAL_Php_CodeWriter $codewriter)
     {
-        if ($this->headFootDisabled)
-            return;
-        if ($this->isEmptyNode($codewriter->getOutputMode()))
-            return;
+        if ($this->headFootDisabled) {
+                    return;
+        }
+        if ($this->isEmptyNode($codewriter->getOutputMode())) {
+                    return;
+        }
 
         if ($this->footPrintCondition) {
             $codewriter->doIf($this->footPrintCondition);
@@ -481,15 +507,16 @@ 
             $handler = $nsattr->createAttributeHandler($this, $domattr->getValue());
             $this->talHandlers[$prio] = $handler;
 
-            if ($nsattr instanceof PHPTAL_NamespaceAttributeSurround)
-                $this->surroundAttributes[] = $handler;
-            else if ($nsattr instanceof PHPTAL_NamespaceAttributeReplace)
-                $this->replaceAttributes[] = $handler;
-            else if ($nsattr instanceof PHPTAL_NamespaceAttributeContent)
-                $this->contentAttributes[] = $handler;
-            else
-                throw new PHPTAL_ParserException("Unknown namespace attribute class ".get_class($nsattr),
+            if ($nsattr instanceof PHPTAL_NamespaceAttributeSurround) {
+                            $this->surroundAttributes[] = $handler;
+            } else if ($nsattr instanceof PHPTAL_NamespaceAttributeReplace) {
+                            $this->replaceAttributes[] = $handler;
+            } else if ($nsattr instanceof PHPTAL_NamespaceAttributeContent) {
+                            $this->contentAttributes[] = $handler;
+            } else {
+                            throw new PHPTAL_ParserException("Unknown namespace attribute class ".get_class($nsattr),
                             $this->getSourceFile(), $this->getSourceLine());
+            }
 
         }
     }

classes/PHPTAL/Dom/SaxXmlParser.php

Doc Comments +4 added lines

@@ -80,6 +80,10 @@
     );
 
     private $input_encoding;
+
+    /**
+     * @param string $input_encoding
+     */
     public function __construct($input_encoding)
     {
         $this->input_encoding = $input_encoding;

Braces +27 added lines, -11 removed lines

@@ -124,7 +124,9 @@ 
             for (; $i<$len; $i++) {
                 $c = $src[$i]; // Change to substr($src, $i, 1); if you want to use mb_string.func_overload
 
-                if ($c === "\n") $builder->setSource($this->_file, ++$this->_line);
+                if ($c === "\n") {
+                    $builder->setSource($this->_file, ++$this->_line);
+                }
 
                 switch ($state) {
                     case self::ST_ROOT:
@@ -174,7 +176,9 @@ 
                     case self::ST_TAG_NAME:
                         if (self::isWhiteChar($c) || $c === '/' || $c === '>') {
                             $tagname = substr($src, $mark, $i-$mark);
-                            if (!$this->isValidQName($tagname)) $this->raiseError("Invalid tag name '$tagname'");
+                            if (!$this->isValidQName($tagname)) {
+                                $this->raiseError("Invalid tag name '$tagname'");
+                            }
 
                             if ($c === '/') {
                                 $state = self::ST_TAG_SINGLE;
@@ -220,7 +224,9 @@ 
                         } elseif ($state === self::ST_TAG_ATTRIBUTES && $this->isValidQName($c)) {
                             $mark = $i; // mark attribute key start
                             $state = self::ST_ATTR_KEY;
-                        } else $this->raiseError("Unexpected character '$c' between attributes of < $tagname >");
+                        } else {
+                            $this->raiseError("Unexpected character '$c' between attributes of < $tagname >");
+                        }
                         break;
 
                     case self::ST_COMMENT:
@@ -287,8 +293,11 @@ 
                                 $this->raiseError("Attribute $attribute in < $tagname > is defined more than once");
                             }
 
-                            if ($c === '=') $state = self::ST_ATTR_VALUE;
-                            else /* white char */ $state = self::ST_ATTR_EQ;
+                            if ($c === '=') {
+                                $state = self::ST_ATTR_VALUE;
+                            } else {
+                                /* white char */ $state = self::ST_ATTR_EQ;
+                            }
                         } elseif ($c === '/' || $c==='>') {
                             $attribute = substr($src, $mark, $i-$mark);
                             if (!$this->isValidQName($attribute)) {
@@ -330,11 +339,15 @@ 
                 }
             }
 
-            if ($state === self::ST_TEXT) // allows text past root node, which is in violation of XML spec
+            if ($state === self::ST_TEXT) {
+                // allows text past root node, which is in violation of XML spec
             {
                 if ($i > $mark) {
                     $text = substr($src, $mark, $i-$mark);
-                    if (!ctype_space($text)) $this->raiseError("Characters found after end of the root element (wrap document in < tal:block > to avoid this error)");
+            }
+                    if (!ctype_space($text)) {
+                        $this->raiseError("Characters found after end of the root element (wrap document in < tal:block > to avoid this error)");
+                    }
                 }
             } else {
                 if ($state === self::ST_ROOT) {
@@ -346,8 +359,7 @@ 
             }
 
             $builder->onDocumentEnd();
-        }
-        catch(PHPTAL_TemplateException $e)
+        } catch(PHPTAL_TemplateException $e)
         {
             $e->hintSrcPosition($this->_file, $this->_line);
             throw $e;
@@ -363,7 +375,9 @@ 
 
     private function checkEncoding($str)
     {
-        if ($str === '') return '';
+        if ($str === '') {
+            return '';
+        }
 
         if ($this->input_encoding === 'UTF-8') {
 
@@ -454,7 +468,9 @@ 
     private static function convertPHPBlockToTALES($m)
     {
         list(, $type, $code) = $m;
-        if ($type === '=') $code = 'echo '.$code;
+        if ($type === '=') {
+            $code = 'echo '.$code;
+        }
         return '${structure phptal-internal-php-block:'.rawurlencode($code).'}';
     }
 

classes/PHPTAL/ExceptionHandler.php

Doc Comments +1 added lines

@@ -27,6 +27,7 @@
      * Doesn't change exception handler if non-default one is set.
      *
      * @param Exception e exception to re-throw and display
+     * @param string $encoding
      *
      * @return void
      * @throws Exception

classes/PHPTAL/Keywords.php

Doc Comments +3 added lines

@@ -21,6 +21,9 @@
  */
 interface PHPTAL_Keywords extends Countable
 {
+    /**
+     * @return string
+     */
     public function __toString();
 }
 ?>

classes/PHPTAL/NamespaceAttribute.php

Doc Comments +1 added lines, -1 removed lines

@@ -71,8 +71,8 @@
     private $_namespace;
 
     /**
-     * @param string $name The attribute name
      * @param int $priority Attribute execution priority
+     * @param string $local_name
      */
     public function __construct($local_name, $priority)
     {