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)

Indentation +4 added lines, -4 removed lines

@@ -966,10 +966,10 @@ 
      */
     public function getFunctionName()
     {
-       // function name is used as base for caching, so it must be unique for
-       // every combination of settings that changes code in compiled template
+        // function name is used as base for caching, so it must be unique for
+        // every combination of settings that changes code in compiled template
 
-       if (!$this->_functionName) {
+        if (!$this->_functionName) {
 
             // just to make tempalte name recognizable
             $basename = preg_replace('/\.[a-z]{3,5}$/', '', basename($this->_source->getRealPath()));
@@ -989,7 +989,7 @@ 
             $hash = strtr(rtrim(base64_encode($hash),"="),"+/=","_A_");
 
             $this->_functionName = $this->getFunctionNamePrefix($this->_source->getLastModifiedTime()) .
-                                   $basename . '__' . $hash;
+                                    $basename . '__' . $hash;
         }
         return $this->_functionName;
     }

Braces +23 added lines, -15 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(ParseError $parseError) {
+                } catch(ParseError $parseError) {
                     ob_end_clean();
                     throw new PHPTAL_TemplateException(
                         'Parse error: ' . $parseError->getMessage(),
@@ -844,8 +842,7 @@ 
                         $parseError->getLine(),
                         $parseError
                     );
-                }
-                catch(Exception $e) {
+                } catch(Exception $e) {
                     ob_end_clean();
                     throw $e;
                 }
@@ -854,7 +851,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();
@@ -948,7 +949,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);
             }
         }
@@ -965,7 +969,9 @@ 
      */
     public function getCodePath()
     {
-        if (!$this->_codeFile) $this->setCodeFile();
+        if (!$this->_codeFile) {
+            $this->setCodeFile();
+        }
         return $this->_codeFile;
     }
 
@@ -1196,7 +1202,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';
 

Spacing +33 added lines, -33 removed lines

@@ -175,7 +175,7 @@ 
      *
      * @param string $path Template file path.
      */
-    public function __construct($path=false)
+    public function __construct($path = false)
     {
         $this->_path = $path;
         $this->_globalContext = new stdClass();
@@ -203,7 +203,7 @@ 
      *
      * @return PHPTAL
      */
-    public static function create($path=false)
+    public static function create($path = false)
     {
         return new PHPTAL($path);
     }
@@ -408,7 +408,7 @@ 
      */
     public function setPhpCodeDestination($path)
     {
-        $this->_phpCodeDestination = rtrim($path, DIRECTORY_SEPARATOR) . DIRECTORY_SEPARATOR;
+        $this->_phpCodeDestination = rtrim($path, DIRECTORY_SEPARATOR).DIRECTORY_SEPARATOR;
         $this->resetPrepared();
         return $this;
     }
@@ -548,7 +548,7 @@ 
     private function getPreFiltersCacheId()
     {
         $cacheid = '';
-        foreach($this->getPreFilters() as $key => $prefilter) {
+        foreach ($this->getPreFilters() as $key => $prefilter) {
             if ($prefilter instanceof PHPTAL_PreFilter) {
                 $cacheid .= $key.$prefilter->getCacheId();
             } elseif ($prefilter instanceof PHPTAL_Filter) {
@@ -569,7 +569,7 @@ 
     {
         $prefilters = $this->getPreFilters();
 
-        foreach($prefilters as $prefilter) {
+        foreach ($prefilters as $prefilter) {
             if ($prefilter instanceof PHPTAL_PreFilter) {
                 $prefilter->setPHPTAL($this);
             }
@@ -675,12 +675,12 @@ 
 
             // unshift doctype
             if ($this->_context->_docType) {
-                $res = $this->_context->_docType . $res;
+                $res = $this->_context->_docType.$res;
             }
 
             // unshift xml declaration
             if ($this->_context->_xmlDeclaration) {
-                $res = $this->_context->_xmlDeclaration . "\n" . $res;
+                $res = $this->_context->_xmlDeclaration."\n".$res;
             }
 
             if ($this->_postfilter) {
@@ -768,7 +768,7 @@ 
                 $this->externalMacroTemplatesCache[$file] = $tpl;
             }
 
-            $fun = $tpl->getFunctionName() . '_' . strtr($macroName, "-", "_");
+            $fun = $tpl->getFunctionName().'_'.strtr($macroName, "-", "_");
             if (!function_exists($fun)) {
                 throw new PHPTAL_MacroMissingException("Macro '$macroName' is not defined in $file", $this->_source->getRealPath());
             }
@@ -777,11 +777,11 @@ 
 
         } else {
             // call local macro
-            $fun = $local_tpl->getFunctionName() . '_' . strtr($path, "-", "_");
+            $fun = $local_tpl->getFunctionName().'_'.strtr($path, "-", "_");
             if (!function_exists($fun)) {
                 throw new PHPTAL_MacroMissingException("Macro '$path' is not defined", $local_tpl->_source->getRealPath());
             }
-            $fun( $local_tpl, $this);
+            $fun($local_tpl, $this);
         }
     }
 
@@ -791,7 +791,7 @@ 
     private function setCodeFile()
     {
         $this->findTemplate();
-        $this->_codeFile = $this->getPhpCodeDestination() . $this->getFunctionName() . '.' . $this->getPhpCodeExtension();
+        $this->_codeFile = $this->getPhpCodeDestination().$this->getFunctionName().'.'.$this->getPhpCodeExtension();
     }
 
     protected function resetPrepared()
@@ -819,7 +819,7 @@ 
 
                 // i'm not sure where that belongs, but not in normal path of execution
                 // because some sites have _a lot_ of files in temp
-                if ($this->getCachePurgeFrequency() && mt_rand()%$this->getCachePurgeFrequency() == 0) {
+                if ($this->getCachePurgeFrequency() && mt_rand() % $this->getCachePurgeFrequency() == 0) {
                     $this->cleanUpGarbage();
                 }
 
@@ -836,16 +836,16 @@ 
                 try {
                     eval("?>\n".$result);
                 }
-                catch(ParseError $parseError) {
+                catch (ParseError $parseError) {
                     ob_end_clean();
                     throw new PHPTAL_TemplateException(
-                        'Parse error: ' . $parseError->getMessage(),
+                        'Parse error: '.$parseError->getMessage(),
                         $this->getCodePath(),
                         $parseError->getLine(),
                         $parseError
                     );
                 }
-                catch(Exception $e) {
+                catch (Exception $e) {
                     ob_end_clean();
                     throw $e;
                 }
@@ -854,7 +854,7 @@ 
                     $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();
@@ -895,7 +895,7 @@ 
      */
     public function setCachePurgeFrequency($n)
     {
-        $this->_cachePurgeFrequency = (int)$n;
+        $this->_cachePurgeFrequency = (int) $n;
         return $this;
     }
 
@@ -915,14 +915,14 @@ 
      */
     public function cleanUpGarbage()
     {
-        $cacheFilesExpire = time() - $this->getCacheLifetime() * 3600 * 24;
+        $cacheFilesExpire = time()-$this->getCacheLifetime() * 3600 * 24;
 
         // relies on templates sorting order being related to their modification dates
-        $upperLimit = $this->getPhpCodeDestination() . $this->getFunctionNamePrefix($cacheFilesExpire) . '_';
-        $lowerLimit = $this->getPhpCodeDestination() . $this->getFunctionNamePrefix(0);
+        $upperLimit = $this->getPhpCodeDestination().$this->getFunctionNamePrefix($cacheFilesExpire).'_';
+        $lowerLimit = $this->getPhpCodeDestination().$this->getFunctionNamePrefix(0);
 
         // second * gets phptal:cache
-        $cacheFiles = glob($this->getPhpCodeDestination() . 'tpl_????????_*.' . $this->getPhpCodeExtension() . '*');
+        $cacheFiles = glob($this->getPhpCodeDestination().'tpl_????????_*.'.$this->getPhpCodeExtension().'*');
 
         if ($cacheFiles) {
             foreach ($cacheFiles as $index => $file) {
@@ -945,7 +945,7 @@ 
     public function cleanUpCache()
     {
         $filename = $this->getCodePath();
-        $cacheFiles = glob($filename . '?*');
+        $cacheFiles = glob($filename.'?*');
         if ($cacheFiles) {
             foreach ($cacheFiles as $file) {
                 if (substr($file, 0, strlen($filename)) !== $filename) continue; // safety net
@@ -984,7 +984,7 @@ 
             $basename = preg_replace('/\.[a-z]{3,5}$/', '', basename($this->_source->getRealPath()));
             $basename = substr(trim(preg_replace('/[^a-zA-Z0-9]+/', '_', $basename), "_"), 0, 20);
 
-            $hash = md5(PHPTAL_VERSION . PHP_VERSION
+            $hash = md5(PHPTAL_VERSION.PHP_VERSION
                     . $this->_source->getRealPath()
                     . $this->getEncoding()
                     . $this->getPrefiltersCacheId()
@@ -995,10 +995,10 @@ 
             // uses base64 rather than hex to make filename shorter.
             // there is loss of some bits due to name constraints and case-insensivity,
             // but that's still over 110 bits in addition to basename and timestamp.
-            $hash = strtr(rtrim(base64_encode($hash),"="),"+/=","_A_");
+            $hash = strtr(rtrim(base64_encode($hash), "="), "+/=", "_A_");
 
-            $this->_functionName = $this->getFunctionNamePrefix($this->_source->getLastModifiedTime()) .
-                                   $basename . '__' . $hash;
+            $this->_functionName = $this->getFunctionNamePrefix($this->_source->getLastModifiedTime()).
+                                   $basename.'__'.$hash;
         }
         return $this->_functionName;
     }
@@ -1015,7 +1015,7 @@ 
     {
         // tpl_ prefix and last modified time must not be changed,
         // because cache cleanup relies on that
-        return 'tpl_' . sprintf("%08x", $timestamp) .'_';
+        return 'tpl_'.sprintf("%08x", $timestamp).'_';
     }
 
     /**
@@ -1045,7 +1045,7 @@ 
      */
     public function addError(Exception $error)
     {
-        $this->_errors[] =  $error;
+        $this->_errors[] = $error;
     }
 
     /**
@@ -1101,7 +1101,7 @@ 
         $data = $this->_source->getData();
 
         $prefilters = $this->getPreFilterInstances();
-        foreach($prefilters as $prefilter) {
+        foreach ($prefilters as $prefilter) {
             $data = $prefilter->filter($data);
         }
 
@@ -1111,7 +1111,7 @@ 
         $builder = new PHPTAL_Dom_PHPTALDocumentBuilder();
         $tree = $parser->parseString($builder, $data, $realpath)->getResult();
 
-        foreach($prefilters as $prefilter) {
+        foreach ($prefilters as $prefilter) {
             if ($prefilter instanceof PHPTAL_PreFilter) {
                 if ($prefilter->filterDOM($tree) !== NULL) {
                     throw new PHPTAL_ConfigurationException("Don't return value from filterDOM()");
@@ -1198,7 +1198,7 @@ 
 
         if (substr($class, 0, 7) !== 'PHPTAL_') return;
 
-        $path = dirname(__FILE__) . strtr("_".$class, "_", DIRECTORY_SEPARATOR) . '.php';
+        $path = dirname(__FILE__).strtr("_".$class, "_", DIRECTORY_SEPARATOR).'.php';
 
         require $path;
     }
@@ -1223,9 +1223,9 @@ 
         // Prepending PHPTAL's autoloader helps if there are other autoloaders
         // that throw/die when file is not found. Only >5.3 though.
         if (version_compare(PHP_VERSION, '5.3', '>=')) {
-            @spl_autoload_register(array(__CLASS__,'autoload'), false, true);
+            @spl_autoload_register(array(__CLASS__, 'autoload'), false, true);
         } else {
-            spl_autoload_register(array(__CLASS__,'autoload'));
+            spl_autoload_register(array(__CLASS__, 'autoload'));
         }
 
         if ($uses_autoload) {

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)
     {

Spacing +10 added lines, -10 removed lines

@@ -101,7 +101,7 @@ 
      *
      * @return void
      */
-    public function setDocType($doctype,$called_from_macro)
+    public function setDocType($doctype, $called_from_macro)
     {
         // FIXME: this is temporary workaround for problem of DOCTYPE disappearing in cloned PHPTAL object (because clone keeps _parentContext)
         if (!$this->_docType) {
@@ -246,7 +246,7 @@ 
      */
     public function pushSlots()
     {
-        $this->_slotsStack[] =  $this->_slots;
+        $this->_slotsStack[] = $this->_slots;
         $this->_slots = array();
     }
 
@@ -320,7 +320,7 @@ 
         } else $pathinfo = '';
 
         if (!empty($basename)) {
-            $basename = "'" . $basename . "' ";
+            $basename = "'".$basename."' ";
         }
 
         if (is_array($base)) {
@@ -350,7 +350,7 @@ 
      * @access private
      * @return mixed
      */
-    public static function path($base, $path, $nothrow=false)
+    public static function path($base, $path, $nothrow = false)
     {
         if ($base === null) {
             if ($nothrow) return null;
@@ -414,7 +414,7 @@ 
                         $base = $base->__call($current, array());
                         continue;
                     }
-                    catch(BadMethodCallException $e) {}
+                    catch (BadMethodCallException $e) {}
                 }
 
                 if (is_callable($base)) {
@@ -433,7 +433,7 @@ 
             // array handling
             if (is_array($base)) {
                 // key or index
-                if (array_key_exists((string)$current, $base)) {
+                if (array_key_exists((string) $current, $base)) {
                     $base = $base[$current];
                     continue;
                 }
@@ -481,7 +481,7 @@ 
  * @see PHPTAL_Context::path()
  * @deprecated
  */
-function phptal_path($base, $path, $nothrow=false)
+function phptal_path($base, $path, $nothrow = false)
 {
     return PHPTAL_Context::path($base, $path, $nothrow);
 }
@@ -496,7 +496,7 @@ 
 function phptal_isempty($var)
 {
     return $var === null || $var === false || $var === ''
-           || ((is_array($var) || $var instanceof Countable) && count($var)===0);
+           || ((is_array($var) || $var instanceof Countable) && count($var) === 0);
 }
 
 /**
@@ -535,7 +535,7 @@ 
     if (is_string($var)) {
         return $var;
     } elseif (is_bool($var)) {
-        return (int)$var;
+        return (int) $var;
     } elseif (is_array($var)) {
         return implode(', ', array_map('phptal_tostring', $var));
     } elseif ($var instanceof SimpleXMLElement) {
@@ -549,7 +549,7 @@ 
             return $xml;
         }
     }
-    return (string)phptal_unravel_closure($var);
+    return (string) phptal_unravel_closure($var);
 }
 
 /**

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;

Indentation +4 added lines, -4 removed lines

@@ -466,10 +466,10 @@
             $nsattr = PHPTAL_Dom_Defs::getInstance()->getNamespaceAttribute($domattr->getNamespaceURI(), $domattr->getLocalName());
             if (array_key_exists($nsattr->getPriority(), $temp)) {
                 throw new PHPTAL_TemplateException(sprintf("Attribute conflict in < %s > '%s' cannot appear with '%s'",
-                               $this->qualifiedName,
-                               $key,
-                               $temp[$nsattr->getPriority()][0]->getNamespace()->getPrefix() . ':' . $temp[$nsattr->getPriority()][0]->getLocalName()
-                               ), $this->getSourceFile(), $this->getSourceLine());
+                                $this->qualifiedName,
+                                $key,
+                                $temp[$nsattr->getPriority()][0]->getNamespace()->getPrefix() . ':' . $temp[$nsattr->getPriority()][0]->getLocalName()
+                                ), $this->getSourceFile(), $this->getSourceLine());
             }
             $temp[$nsattr->getPriority()] = array($nsattr, $domattr);
         }

Spacing +8 added lines, -8 removed lines

@@ -183,7 +183,7 @@ 
 
             $this->generateSurroundFoot($codewriter);
         }
-        catch(PHPTAL_TemplateException $e) {
+        catch (PHPTAL_TemplateException $e) {
             $e->hintSrcPosition($this->getSourceFile(), $this->getSourceLine());
             throw $e;
         }
@@ -212,7 +212,7 @@ 
     /** 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;
     }
 
@@ -241,7 +241,7 @@ 
 
     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;
     }
 
@@ -348,15 +348,15 @@ 
         }
     }
 
-    public function generateContent(PHPTAL_Php_CodeWriter $codewriter = null, $realContent=false)
+    public function generateContent(PHPTAL_Php_CodeWriter $codewriter = null, $realContent = false)
     {
         if (!$this->isEmptyNode($codewriter->getOutputMode())) {
             if ($realContent || !count($this->contentAttributes)) {
-                foreach($this->childNodes as $child) {
+                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);
             }
@@ -434,7 +434,7 @@ 
     private function isEmptyNode($mode)
     {
         return (($mode === PHPTAL::XHTML || $mode === PHPTAL::HTML5) && PHPTAL_Dom_Defs::getInstance()->isEmptyTagNS($this->getNamespaceURI(), $this->getLocalName())) ||
-               ( $mode === PHPTAL::XML   && !$this->hasContent());
+               ($mode === PHPTAL::XML && !$this->hasContent());
     }
 
     private function hasContent()
@@ -468,7 +468,7 @@ 
                 throw new PHPTAL_TemplateException(sprintf("Attribute conflict in < %s > '%s' cannot appear with '%s'",
                                $this->qualifiedName,
                                $key,
-                               $temp[$nsattr->getPriority()][0]->getNamespace()->getPrefix() . ':' . $temp[$nsattr->getPriority()][0]->getLocalName()
+                               $temp[$nsattr->getPriority()][0]->getNamespace()->getPrefix().':'.$temp[$nsattr->getPriority()][0]->getLocalName()
                                ), $this->getSourceFile(), $this->getSourceLine());
             }
             $temp[$nsattr->getPriority()] = array($nsattr, $domattr);

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;

Indentation +26 added lines, -26 removed lines

@@ -60,23 +60,23 @@ 
 
 
     static $state_names = array(
-      self::ST_ROOT => 'root node',
-      self::ST_TEXT => 'text',
-      self::ST_LT   => 'start of tag',
-      self::ST_TAG_NAME => 'tag name',
-      self::ST_TAG_CLOSE => 'closing tag',
-      self::ST_TAG_SINGLE => 'self-closing tag',
-      self::ST_TAG_ATTRIBUTES => 'tag',
-      self::ST_TAG_BETWEEN_ATTRIBUTE => 'tag attributes',
-      self::ST_CDATA => 'CDATA',
-      self::ST_COMMENT => 'comment',
-      self::ST_DOCTYPE => 'doctype',
-      self::ST_XMLDEC => 'XML declaration',
-      self::ST_PREPROC => 'preprocessor directive',
-      self::ST_ATTR_KEY => 'attribute name',
-      self::ST_ATTR_EQ => 'attribute value',
-      self::ST_ATTR_QUOTE => 'quoted attribute value',
-      self::ST_ATTR_VALUE => 'unquoted attribute value',
+        self::ST_ROOT => 'root node',
+        self::ST_TEXT => 'text',
+        self::ST_LT   => 'start of tag',
+        self::ST_TAG_NAME => 'tag name',
+        self::ST_TAG_CLOSE => 'closing tag',
+        self::ST_TAG_SINGLE => 'self-closing tag',
+        self::ST_TAG_ATTRIBUTES => 'tag',
+        self::ST_TAG_BETWEEN_ATTRIBUTE => 'tag attributes',
+        self::ST_CDATA => 'CDATA',
+        self::ST_COMMENT => 'comment',
+        self::ST_DOCTYPE => 'doctype',
+        self::ST_XMLDEC => 'XML declaration',
+        self::ST_PREPROC => 'preprocessor directive',
+        self::ST_ATTR_KEY => 'attribute name',
+        self::ST_ATTR_EQ => 'attribute value',
+        self::ST_ATTR_QUOTE => 'quoted attribute value',
+        self::ST_ATTR_VALUE => 'unquoted attribute value',
     );
 
     private $input_encoding;
@@ -381,15 +381,15 @@ 
 
             // http://www.w3.org/International/questions/qa-forms-utf-8
             $match = '[\x09\x0A\x0D\x20-\x7F]'        // ASCII
-               . '|[\xC2-\xDF][\x80-\xBF]'            // non-overlong 2-byte
-               . '|\xE0[\xA0-\xBF][\x80-\xBF]'        // excluding overlongs
-               . '|[\xE1-\xEC\xEE\xEE][\x80-\xBF]{2}' // straight 3-byte (exclude FFFE and FFFF)
-               . '|\xEF[\x80-\xBE][\x80-\xBF]'        // straight 3-byte
-               . '|\xEF\xBF[\x80-\xBD]'               // straight 3-byte
-               . '|\xED[\x80-\x9F][\x80-\xBF]'        // excluding surrogates
-               . '|\xF0[\x90-\xBF][\x80-\xBF]{2}'     // planes 1-3
-               . '|[\xF1-\xF3][\x80-\xBF]{3}'         // planes 4-15
-               . '|\xF4[\x80-\x8F][\x80-\xBF]{2}';    // plane 16
+                . '|[\xC2-\xDF][\x80-\xBF]'            // non-overlong 2-byte
+                . '|\xE0[\xA0-\xBF][\x80-\xBF]'        // excluding overlongs
+                . '|[\xE1-\xEC\xEE\xEE][\x80-\xBF]{2}' // straight 3-byte (exclude FFFE and FFFF)
+                . '|\xEF[\x80-\xBE][\x80-\xBF]'        // straight 3-byte
+                . '|\xEF\xBF[\x80-\xBD]'               // straight 3-byte
+                . '|\xED[\x80-\x9F][\x80-\xBF]'        // excluding surrogates
+                . '|\xF0[\x90-\xBF][\x80-\xBF]{2}'     // planes 1-3
+                . '|[\xF1-\xF3][\x80-\xBF]{3}'         // planes 4-15
+                . '|\xF4[\x80-\x8F][\x80-\xBF]{2}';    // plane 16
 
             if (!preg_match('/^(?:(?>'.$match.'))+$/s',$str)) {
                 $res = preg_split('/((?>'.$match.')+)/s',$str,null,PREG_SPLIT_DELIM_CAPTURE);

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).'}';
     }
 

Spacing +15 added lines, -15 removed lines

@@ -116,12 +116,12 @@ 
             $builder->setSource($this->_file, $this->_line);
             $builder->onDocumentStart();
 
-            $i=0;
+            $i = 0;
             // remove BOM (UTF-8 byte order mark)...
             if (substr($src, 0, 3) === self::BOM_STR) {
-                $i=3;
+                $i = 3;
             }
-            for (; $i<$len; $i++) {
+            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);
@@ -201,7 +201,7 @@ 
                         if ($c !== '>') {
                             $this->raiseError("Expected '/>', but found '/$c' inside tag < $tagname >");
                         }
-                        $mark = $i+1;   // mark text start
+                        $mark = $i+1; // mark text start
                         $state = self::ST_TEXT;
                         $builder->onElementStart($tagname, $attributes);
                         $builder->onElementClose($tagname);
@@ -210,7 +210,7 @@ 
                     case self::ST_TAG_BETWEEN_ATTRIBUTE:
                     case self::ST_TAG_ATTRIBUTES:
                         if ($c === '>') {
-                            $mark = $i+1;   // mark text start
+                            $mark = $i+1; // mark text start
                             $state = self::ST_TEXT;
                             $builder->onElementStart($tagname, $attributes);
                         } elseif ($c === '/') {
@@ -226,7 +226,7 @@ 
                     case self::ST_COMMENT:
                         if ($c === '>' && $i > $mark+4 && substr($src, $i-2, 2) === '--') {
 
-                            if (preg_match('/^-|--|-$/', substr($src, $mark +4, $i-$mark+1 -7))) {
+                            if (preg_match('/^-|--|-$/', substr($src, $mark+4, $i-$mark+1-7))) {
                                 $this->raiseError("Ill-formed comment. XML comments are not allowed to contain '--' or start/end with '-': ".substr($src, $mark+4, $i-$mark+1-7));
                             }
 
@@ -289,7 +289,7 @@ 
 
                             if ($c === '=') $state = self::ST_ATTR_VALUE;
                             else /* white char */ $state = self::ST_ATTR_EQ;
-                        } elseif ($c === '/' || $c==='>') {
+                        } elseif ($c === '/' || $c === '>') {
                             $attribute = substr($src, $mark, $i-$mark);
                             if (!$this->isValidQName($attribute)) {
                                 $this->raiseError("Invalid attribute name '$attribute'");
@@ -323,7 +323,7 @@ 
 
                             // PHPTAL's code generator assumes input is escaped for double-quoted strings. Single-quoted attributes need to be converted.
                             // FIXME: it should be escaped at later stage.
-                            $attributes[$attribute] = str_replace('"',"&quot;", $attributes[$attribute]);
+                            $attributes[$attribute] = str_replace('"', "&quot;", $attributes[$attribute]);
                             $state = self::ST_TAG_BETWEEN_ATTRIBUTE;
                         }
                         break;
@@ -347,7 +347,7 @@ 
 
             $builder->onDocumentEnd();
         }
-        catch(PHPTAL_TemplateException $e)
+        catch (PHPTAL_TemplateException $e)
         {
             $e->hintSrcPosition($this->_file, $this->_line);
             throw $e;
@@ -370,7 +370,7 @@ 
             // $match expression below somehow triggers quite deep recurrency and stack overflow in preg
             // to avoid this, check string bit by bit, omitting ASCII fragments.
             if (strlen($str) > 200) {
-                $chunks = preg_split('/(?>[\x09\x0A\x0D\x20-\x7F]+)/',$str,null,PREG_SPLIT_NO_EMPTY);
+                $chunks = preg_split('/(?>[\x09\x0A\x0D\x20-\x7F]+)/', $str, null, PREG_SPLIT_NO_EMPTY);
                 foreach ($chunks as $chunk) {
                     if (strlen($chunk) < 200) {
                         $this->checkEncoding($chunk);
@@ -389,11 +389,11 @@ 
                . '|\xED[\x80-\x9F][\x80-\xBF]'        // excluding surrogates
                . '|\xF0[\x90-\xBF][\x80-\xBF]{2}'     // planes 1-3
                . '|[\xF1-\xF3][\x80-\xBF]{3}'         // planes 4-15
-               . '|\xF4[\x80-\x8F][\x80-\xBF]{2}';    // plane 16
+               . '|\xF4[\x80-\x8F][\x80-\xBF]{2}'; // plane 16
 
-            if (!preg_match('/^(?:(?>'.$match.'))+$/s',$str)) {
-                $res = preg_split('/((?>'.$match.')+)/s',$str,null,PREG_SPLIT_DELIM_CAPTURE);
-                for($i=0; $i < count($res); $i+=2)
+            if (!preg_match('/^(?:(?>'.$match.'))+$/s', $str)) {
+                $res = preg_split('/((?>'.$match.')+)/s', $str, null, PREG_SPLIT_DELIM_CAPTURE);
+                for ($i = 0; $i < count($res); $i += 2)
                 {
                     $res[$i] = self::convertBytesToEntities(array(1=>$res[$i]));
                 }
@@ -426,7 +426,7 @@ 
     {
         $m = $m[1];
         $out = "";
-        for($i=0; $i < strlen($m); $i++)
+        for ($i = 0; $i < strlen($m); $i++)
         {
             $out .= '&#X'.strtoupper(dechex(ord($m[$i]))).';';
         }

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

Spacing +2 added lines, -2 removed lines

@@ -64,11 +64,11 @@
 
         if (ini_get('display_errors')) {
             $title = get_class($e).': '.htmlspecialchars($e->getMessage());
-            $body = "<p><strong>\n".htmlspecialchars($e->getMessage()).'</strong></p>' .
+            $body = "<p><strong>\n".htmlspecialchars($e->getMessage()).'</strong></p>'.
                     '<p>In '.htmlspecialchars($line)."</p><pre>\n".htmlspecialchars($e->getTraceAsString()).'</pre>';
         } else {
             $title = "PHPTAL Exception";
-            $body = "<p>This page cannot be displayed.</p><hr/>" .
+            $body = "<p>This page cannot be displayed.</p><hr/>".
                     "<p><small>Enable <code>display_errors</code> to see detailed message.</small></p>";
         }
 

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)
     {