Source for file Html.class.php

Documentation is available at Html.class.php

  1. <?php
  2. /**
  3.  * Gumbo Library Framework
  4.  *
  5.  * LICENSE
  6.  * This library is being released under the terms of the New BSD License.  A
  7.  * copy of the license is packaged with the software (LICENSE.txt).  If no
  8.  * copy is found, a copy of the license template can be found at:
  9.  * http://www.opensource.org/licenses/bsd-license.php
  10.  * 
  11.  * @category Gumbo
  12.  * @package Converter
  13.  * @copyright Copyright (c) 2007, iBayou, Michael Luster
  14.  * @license http://www.opensource.org/licenses/bsd-license.php New BSD License
  15.  * @author Michael Luster <mluster79@yahoo.com>
  16.  * @link http://sourceforge.net/projects/phpgumbo
  17.  * @version 0.0.1
  18.  */
  19.  
  20. /**
  21.  * HTML Encode/Decode Converter Class
  22.  *
  23.  * @category Gumbo
  24.  * @package Converter
  25.  * @copyright Copyright (c) 2007, iBayou, Michael Luster
  26.  * @license http://www.opensource.org/licenses/bsd-license.php New BSD License
  27.  * @author Michael Luster <mluster79@yahoo.com>
  28.  * @link http://sourceforge.net/projects/phpgumbo
  29.  * @desc HTML Encode/Decode Converter Class
  30.  * @version 0.0.1
  31.  */
  32.  
  33. gumbo_load ("Converter_Abstract");
  34.  
  35. class Gumbo_Converter_Html extends Gumbo_Converter_Abstract {
  36.     
  37.     /** @var int $_quote_style ENT_COMPAT, ENT_QUOTES, ENT_NOQUOTES */
  38.     private $_quote_style = ENT_QUOTES;
  39.     /** @var string $_charset character set */
  40.     private $_charset;
  41.     
  42.     
  43.     
  44.     /**
  45.      * Constructor
  46.      * @param int $quote_style 
  47.      * @param string $charset 
  48.      */
  49.     public function __construct ($quote_style=null, $charset=null) {
  50.         if (!is_null ($quote_style)) { $this->setQuoteStyle ($quote_style); }
  51.         if (!is_null ($charset)) { $this->setCharset ($charset); }
  52.     }
  53.     
  54.     
  55.     
  56.     /** ACTION METHODS **/
  57.     /**
  58.      * Encodes the HTML string
  59.      * @param string $txt 
  60.      * @return string 
  61.      * @throws Gumbo_Exception
  62.      */
  63.     public function toEncode ($txt) {
  64.         try {
  65.             // verify precondition
  66.             if (!is_string ($txt)) {
  67.                 throw new Gumbo_Exception ("Invalid Argument 'txt:str' => {$txt}:" . gettype ($txt));
  68.             }
  69.             
  70.             return htmlentities ($this->decode ($txt), $this->getQuoteStyle (), $this->getCharset ());
  71.         } catch (Gumbo_Exception $e) {
  72.             $e->setFunction (__METHOD__);
  73.             gumbo_trigger ($e);
  74.         }
  75.         return null;
  76.     }
  77.     
  78.     /**
  79.      * Decodes the HTML string
  80.      * @param string $txt 
  81.      * @return string 
  82.      * @throws Gumbo_Exception
  83.      */
  84.     public function toDecode ($txt) {
  85.         try {
  86.             // verify precondition
  87.             if (!is_string ($txt)) {
  88.                 throw new Gumbo_Exception ("Invalid Argument 'txt:str' => {$txt}:" . gettype ($txt));
  89.             }
  90.             
  91.             return html_entity_decode ($txt, $this->getQuoteStyle (), $this->getCharset ());
  92.         } catch (Gumbo_Exception $e) {
  93.             $e->setFunction (__METHOD__);
  94.             gumbo_trigger ($e);
  95.         }
  96.     }
  97.     
  98.     
  99.     
  100.     /** MUTATOR METHODS **/
  101.     /**
  102.      * Sets the Quote Style
  103.      * @param int $style ENT_QUOTES, ENT_COMPAT, ENT_NOQUOTES
  104.      * @throws Gumbo_Exception
  105.      */
  106.     public function setQuoteStyle ($style) {
  107.         try {
  108.             if (!is_int ($style)) {
  109.                 throw new Gumbo_Exception ("Invalid Argument 'style:int' => {$style}:" . gettype ($style));
  110.             }
  111.             
  112.             switch ($style) {
  113.                 case ENT_COMPAT : break;
  114.                 case ENT_QUOTES : break;
  115.                 case ENT_NOQUOTES : break;
  116.                 default : throw new Gumbo_Exception ("Invalid Argument ENT_* Value: {$style}");
  117.             }
  118.             
  119.             $this->_quote_style = $style;
  120.         } catch (Gumbo_Exception $e) {
  121.             $e->setFunction (__METHOD__);
  122.             gumbo_trigger ($e);
  123.         }
  124.     }
  125.     
  126.     /**
  127.      * Sets the character set
  128.      * @param string $charset 
  129.      * @throws Gumbo_Exception
  130.      */
  131.     public function setCharset ($charset) {
  132.         try {
  133.             // verify precondition
  134.             if (!is_string ($charset)) {
  135.                 throw new Gumbo_Exception ("Invalid Argument 'charset:str' => {$charset}:" . gettype ($charset));
  136.             }
  137.             
  138.             $this->_charset = $charset;
  139.         } catch (Gumbo_Exception $e) {
  140.             $e->setFunction (__METHOD__);
  141.             gumbo_trigger ($e);
  142.         }
  143.     }
  144.     
  145.     
  146.     
  147.     /** ACCESSOR METHODS **/
  148.     /**
  149.      * Returns the Quote Style
  150.      * @return int 
  151.      */
  152.     public function getQuoteStyle () {
  153.         return $this->_quote_style;
  154.     }
  155.     
  156.     /**
  157.      * Returns the Character Set
  158.      * @return string 
  159.      */
  160.     public function getCharset () {
  161.         return $this->_charset;
  162.     }
  163.     
  164. }
  165.  
  166. ?>