Source for file html_format.php

Documentation is available at html_format.php

  1. <?php
  2.  
  3. /**
  4.  * Formats any html output (must be valid xml where every tag opened is closed)
  5.  * using a single tab for indenting. 'pre' and other whitespace sensitive
  6.  * tags should not be affected.
  7.  *
  8.  * It is not recommended to use this on every template if you render multiple
  9.  * templates per page, you should only use it once on the main page template so that
  10.  * everything is formatted in one pass.
  11.  *
  12.  * This software is provided 'as-is', without any express or implied warranty.
  13.  * In no event will the authors be held liable for any damages arising from the use of this software.
  14.  *
  15.  * This file is released under the LGPL
  16.  * "GNU Lesser General Public License"
  17.  * More information can be found here:
  18.  * {@link http://www.gnu.org/copyleft/lesser.html}
  19.  *
  20.  * @author     Jordi Boggiano <j.boggiano@seld.be>
  21.  * @copyright  Copyright (c) 2008, Jordi Boggiano
  22.  * @license    http://www.gnu.org/copyleft/lesser.html  GNU Lesser General Public License
  23.  * @link       http://dwoo.org/
  24.  * @version    0.9.1
  25.  * @date       2008-05-30
  26.  * @package    Dwoo
  27.  */
  28. class Dwoo_Filter_html_format extends Dwoo_Filter
  29. {
  30.     /**
  31.      * tab count to auto-indent the source
  32.      *
  33.      * @var int 
  34.      */
  35.     protected static $tabCount = -1;
  36.  
  37.     /**
  38.      * stores the additional data (following a tag) of the last call to open/close/singleTag
  39.      *
  40.      * @var string 
  41.      */
  42.     protected static $lastCallAdd = '';
  43.  
  44.     /**
  45.      * formats the input using the singleTag/closeTag/openTag functions
  46.      *
  47.      * It is auto indenting the whole code, excluding <textarea>, <code> and <pre> tags that must be kept intact.
  48.      * Those tags must however contain only htmlentities-escaped text for everything to work properly.
  49.      * Inline tags are presented on a single line with their content
  50.      *
  51.      * @param Dwoo $dwoo the dwoo instance rendering this
  52.      * @param string $input the xhtml to format
  53.      * @return string formatted xhtml
  54.      */
  55.     public function process($input)
  56.     {
  57.         self::$tabCount = -1;
  58.  
  59.         // auto indent all but textareas & pre (or we have weird tabs inside)
  60.         $input = preg_replace_callback("#(<[^>]+>)(\s*)([^<]*)#", array('self', 'tagDispatcher'), $input);
  61.  
  62.         return $input;
  63.     }
  64.  
  65.     /**
  66.      * helper function for format()'s preg_replace call
  67.      *
  68.      * @param array    $input    array of matches (1=>tag, 2=>whitespace(optional), 3=>additional non-html content)
  69.      * @return string the indented tag
  70.      */
  71.     protected static function tagDispatcher($input)
  72.     {
  73.         // textarea, pre, code tags and comments are to be left alone to avoid any non-wanted whitespace inside them so it just outputs them as they were
  74.         if (substr($input[1],0,9) == "<textarea" || substr($input[1],0,4) == "<pre" || substr($input[1],0,5) == "<code" || substr($input[1],0,4) == "<!--" || substr($input[1],0,9) == "<![CDATA[") {
  75.             return $input[1] . $input[3];
  76.         }
  77.         // closing textarea, code and pre tags and self-closed tags (i.e. <br />) are printed as singleTags because we didn't use openTag for the formers and the latter is a single tag
  78.         if (substr($input[1],0,10) == "</textarea" || substr($input[1],0,5) == "</pre" || substr($input[1],0,6) == "</code" || substr($input[1],-2) == "/>") {
  79.             return self::singleTag($input[1],$input[3],$input[2]);
  80.         }
  81.         // it's the closing tag
  82.         if ($input[0][1]=="/"){
  83.             return self::closeTag($input[1],$input[3],$input[2]);
  84.         }
  85.         // opening tag
  86.         return self::openTag($input[1],$input[3],$input[2]);
  87.     }
  88.  
  89.     /**
  90.      * returns an open tag and adds a tab into the auto indenting
  91.      *
  92.      * @param string $tag content of the tag
  93.      * @param string $add additional data (anything before the following tag)
  94.      * @param string $whitespace white space between the tag and the additional data
  95.      * @return string 
  96.      */
  97.     protected static function openTag($tag,$add,$whitespace)
  98.     {
  99.         $tabs = str_pad('',self::$tabCount++,"\t");
  100.  
  101.         if (preg_match('#^<(a|label|option|textarea|h1|h2|h3|h4|h5|h6|strong|b|em|i|abbr|acronym|cite|span|sub|sup|u|s|title)(?: [^>]*|)>#', $tag)) {
  102.             // if it's one of those tag it's inline so it does not require a leading line break
  103.             $result = $tag . $whitespace . str_replace("\n","\n".$tabs,$add);
  104.         } elseif (substr($tag,0,9) == '<!DOCTYPE') {
  105.             // it's the doctype declaration so no line break here either
  106.             $result = $tabs . $tag;
  107.         } else {
  108.             // normal block tag
  109.             $result = "\n".$tabs . $tag;
  110.  
  111.             if (!empty($add)) {
  112.                 $result .= "\n".$tabs."\t".str_replace("\n","\n\t".$tabs,$add);
  113.             }
  114.         }
  115.  
  116.         self::$lastCallAdd = $add;
  117.  
  118.         return $result;
  119.     }
  120.  
  121.     /**
  122.      * returns a closing tag and removes a tab from the auto indenting
  123.      *
  124.      * @param string $tag content of the tag
  125.      * @param string $add additional data (anything before the following tag)
  126.      * @param string $whitespace white space between the tag and the additional data
  127.      * @return string 
  128.      */
  129.     protected static function closeTag($tag,$add,$whitespace)
  130.     {
  131.         $tabs = str_pad('',--self::$tabCount,"\t");
  132.  
  133.         // if it's one of those tag it's inline so it does not require a leading line break
  134.         if (preg_match('#^</(a|label|option|textarea|h1|h2|h3|h4|h5|h6|strong|b|em|i|abbr|acronym|cite|span|sub|sup|u|s|title)>#', $tag)) {
  135.             $result = $tag . $whitespace . str_replace("\n","\n".$tabs,$add);
  136.         } else {
  137.             $result = "\n".$tabs.$tag;
  138.  
  139.             if (!empty($add)) {
  140.                 $result .= "\n".$tabs."\t".str_replace("\n","\n\t".$tabs,$add);
  141.             }
  142.         }
  143.  
  144.         self::$lastCallAdd = $add;
  145.  
  146.         return $result;
  147.     }
  148.  
  149.     /**
  150.      * returns a single tag with auto indenting
  151.      *
  152.      * @param string $tag content of the tag
  153.      * @param string $add additional data (anything before the following tag)
  154.      * @return string 
  155.      */
  156.     protected static function singleTag($tag,$add,$whitespace)
  157.     {
  158.         $tabs = str_pad('',self::$tabCount,"\t");
  159.  
  160.         // if it's img, br it's inline so it does not require a leading line break
  161.         // if it's a closing textarea, code or pre tag, it does not require a leading line break either or it creates whitespace at the end of those blocks
  162.         if (preg_match('#^<(img|br|/textarea|/pre|/code)(?: [^>]*|)>#', $tag)) {
  163.             $result = $tag.$whitespace;
  164.  
  165.             if (!empty($add)) {
  166.                 $result .= str_replace("\n","\n".$tabs,$add);
  167.             }
  168.         } else {
  169.             $result = "\n".$tabs.$tag;
  170.  
  171.             if (!empty($add)) {
  172.                 $result .= "\n".$tabs.str_replace("\n","\n".$tabs,$add);
  173.             }
  174.         }
  175.  
  176.         self::$lastCallAdd = $add;
  177.  
  178.         return $result;
  179.     }
  180. }

Documentation generated on Sat, 28 Jun 2008 01:38:26 +0200 by phpDocumentor 1.4.0