Source for file NewLineBreak.class.php

Documentation is available at NewLineBreak.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.  * New Line to BR 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 New Line to BR Converter Class
  30.  * @version 0.0.1
  31.  */
  32.  
  33. gumbo_load ("Converter_Abstract");
  34.  
  35. class Gumbo_Converter_NewLineBreak extends Gumbo_Converter_Abstract {
  36.     
  37.     /** @var string $_eol End of Line Characters */
  38.     private $_eol = PHP_EOL;
  39.     
  40.     
  41.     
  42.     /**
  43.      * Constructor
  44.      * @param string $eol End of Line characters
  45.      */
  46.     public function __construct ($eol=null) {
  47.         if (!is_null ($eol)) { $this->setEOL ($eol); }
  48.     }
  49.     
  50.     
  51.     
  52.     /** ACTION METHODS **/
  53.     /**
  54.      * Returns BR tags to New Line Characters
  55.      * @param string $data 
  56.      * @return string 
  57.      */
  58.     public function toNl ($data) {
  59.         try {
  60.             // verify precondition
  61.             if (!is_string ($data)) {
  62.                 throw new Gumbo_Exception ("Invalid Argument 'data:str' => {$data}:" . gettype ($data));
  63.             }
  64.             
  65.             $txt = str_ireplace ("<br>", $this->getEOL (), $data);
  66.             $txt = str_ireplace ("<br/>", $this->getEOL (), $data);
  67.             return str_ireplace ("<br />", $this->getEOL (), $data);
  68.         } catch (Gumbo_Exception $e) {
  69.             $e->setFunction (__METHOD__);
  70.             gumbo_trigger ($e);
  71.         }
  72.         return null;
  73.     }
  74.     
  75.     /**
  76.      * Returns New Line Characters to BR tags
  77.      * @param string $data 
  78.      * @return string 
  79.      */
  80.     public function toBr ($data) {
  81.         try {
  82.             // verify precondition
  83.             if (!is_string ($data)) {
  84.                 throw new Gumbo_Exception ("Invalid Argument 'data:str' => {$data}:" . gettype ($data));
  85.             }
  86.             
  87.             return str_replace ("\n", "<br />", str_replace ("\r", "", $data));
  88.         } catch (Gumbo_Exception $e) {
  89.             $e->setFunction (__METHOD__);
  90.             gumbo_trigger ($e);
  91.         }
  92.         return null;
  93.     }
  94.     
  95.     
  96.     
  97.     /** MUTATOR METHODS **/
  98.     /**
  99.      * Sets the End Of Line Characters
  100.      * @param string $eol 
  101.      * @throws Gumbo_Exception
  102.      */
  103.     public function setEOL ($eol) {
  104.         try {
  105.             // verify precondition
  106.             if (!is_string ($eol)) {
  107.                 throw new Gumbo_Exception ("Invalid Argument 'eol:str' => {$eol}:" . gettype ($eol));
  108.             }
  109.             
  110.             $this->_eol = $eol;
  111.         } catch (Gumbo_Exception $e) {
  112.             $e->setFunction (__METHOD__);
  113.             gumbo_trigger ($e);
  114.         }
  115.     }
  116.     
  117.     
  118.     
  119.     /** ACCESSOR METHODS **/
  120.     /**
  121.      * Returns the End of Line characters
  122.      * @return string 
  123.      */
  124.     public function getEOL () {
  125.         return $this->_eol;
  126.     }
  127.     
  128. }
  129.  
  130. ?>