Support Joomla!

Joomla! 1.5 Documentation

Packages

Package: Joomla-Framework

Developer Network License

The Joomla! Developer Network content is © copyright 2006 by the individual contributors and can be used in accordance with the Creative Commons License, Attribution- NonCommercial- ShareAlike 2.5
Source code for file /joomla/filter/output.php

Documentation is available at output.php

  1. <?php
  2. /**
  3.  * @version        $Id: functions.php 4277 2006-07-19 20:35:35Z friesengeist $
  4.  * @package        Joomla.Framework
  5.  * @subpackage    Filter
  6.  * @copyright    Copyright (C) 2005 - 2007 Open Source Matters. All rights reserved.
  7.  * @license        GNU/GPL, see LICENSE.php
  8.  *  Joomla! is free software. This version may have been modified pursuant to the
  9.  *  GNU General Public License, and as distributed it includes or is derivative
  10.  *  of works licensed under the GNU General Public License or other free or open
  11.  *  source software licenses. See COPYRIGHT.php for copyright notices and
  12.  *  details.
  13.  */
  14.  
  15. /**
  16.  * JOutputFilter
  17.  *
  18.  * @static
  19.  * @author        Louis Landry <[email protected]>
  20.  * @package     Joomla.Framework
  21.  * @subpackage    Filter
  22.  * @since        1.5
  23.  */
  24. class JOutputFilter
  25. {
  26.     /**
  27.     * Makes an object safe to display in forms
  28.     *
  29.     * Object parameters that are non-string, array, object or start with underscore
  30.     * will be converted
  31.     *
  32.     * @static
  33.     * @param object An object to be parsed
  34.     * @param int The optional quote style for the htmlspecialchars function
  35.     * @param string|arrayAn optional single field name or array of field names not
  36.     *                      to be parsed (eg, for a textarea)
  37.     * @since 1.5
  38.     */
  39.     function objectHTMLSafe( &$mixed, $quote_style=ENT_QUOTES, $exclude_keys='' )
  40.     {
  41.         if (is_object( $mixed ))
  42.         {
  43.             foreach (get_object_vars( $mixed ) as $k => $v)
  44.             {
  45.                 if (is_array( $v ) || is_object( $v ) || $v == NULL || substr( $k, 1, 1 ) == '_' ) {
  46.                     continue;
  47.                 }
  48.  
  49.                 if (is_string( $exclude_keys ) && $k == $exclude_keys) {
  50.                     continue;
  51.                 } else if (is_array( $exclude_keys ) && in_array( $k, $exclude_keys )) {
  52.                     continue;
  53.                 }
  54.  
  55.                 $mixed->$k = htmlspecialchars( $v, $quote_style );
  56.             }
  57.         }
  58.     }
  59.  
  60.     /**
  61.      * This method processes a string and replaces all instances of & with &amp; in links only
  62.      *
  63.      * @static
  64.      * @param    string    $input    String to process
  65.      * @return    string    Processed string
  66.      * @since    1.5
  67.      */
  68.     function linkXHTMLSafe($input)
  69.     {
  70.         $regex = 'href="([^"]*(&(amp;){0})[^"]*)*?"';
  71.         return preg_replace_callback( "#$regex#i", array('JOutputFilter', '_ampReplaceCallback'), $input );
  72.     }
  73.  
  74.     /**
  75.      * This method processes a string all replaces all accented UTF-8 characters by unaccented
  76.      * ASCII-7 "equivalents", whitespaces are replaced by hyphens and the string is lowercased.
  77.      *
  78.      * @static
  79.      * @param    string    $input    String to process
  80.      * @return    string    Processed string
  81.      * @since    1.5
  82.      */
  83.     function stringURLSafe($string)
  84.     {
  85.         $str = htmlentities(utf8_decode($string));
  86.         $str = preg_replace(
  87.             array('/&szlig;/','/&(..)lig;/', '/&([aouAOU])uml;/','/&(.)[^;]*;/'),
  88.             array('ss',"$1","$1".'e',"$1"),
  89.             $str);
  90.  
  91.         // remove any duplicate whitespace, and ensure all characters are alphanumeric
  92.         $str = preg_replace(array('/\s+/','/[^A-Za-z0-9\-]/'), array('-',''), $str);
  93.  
  94.         // lowercase and trim
  95.         $str = trim(strtolower($str));
  96.         return $str;
  97.     }
  98.  
  99.     /**
  100.     * Replaces &amp; with & for xhtml compliance
  101.     *
  102.     * @todo There must be a better way???
  103.     *
  104.     * @static
  105.     * @since 1.5
  106.     */
  107.     function ampReplace( $text )
  108.     {
  109.         $text = str_replace( '&&', '*--*', $text );
  110.         $text = str_replace( '&#', '*-*', $text );
  111.         $text = str_replace( '&amp;', '&', $text );
  112.         $text = preg_replace( '|&(?![\w]+;)|', '&amp;', $text );
  113.         $text = str_replace( '*-*', '&#', $text );
  114.         $text = str_replace( '*--*', '&&', $text );
  115.  
  116.         return $text;
  117.     }
  118.  
  119.  
  120.  
  121.     /**
  122.      * Callback method for replacing & with &amp; in a string
  123.      *
  124.      * @static
  125.      * @param    string    $m    String to process
  126.      * @return    string    Replaced string
  127.      * @since    1.5
  128.      */
  129.     function _ampReplaceCallback( $m )
  130.     {
  131.          $rx = '&(?!amp;)';
  132.          return preg_replace( '#'.$rx.'#', '&amp;', $m[0] );
  133.     }
  134.  
  135.     /**
  136.     * Cleans text of all formating and scripting code
  137.     */
  138.     function cleanText ( &$text )
  139.     {
  140.         $text = preg_replace( "'<script[^>]*>.*?</script>'si", '', $text );
  141.         $text = preg_replace( '/<a\s+.*?href="([^"]+)"[^>]*>([^<]+)<\/a>/is', '\2 (\1)', $text );
  142.         $text = preg_replace( '/<!--.+?-->/', '', $text );
  143.         $text = preg_replace( '/{.+?}/', '', $text );
  144.         $text = preg_replace( '/&nbsp;/', ' ', $text );
  145.         $text = preg_replace( '/&amp;/', ' ', $text );
  146.         $text = preg_replace( '/&quot;/', ' ', $text );
  147.         $text = strip_tags( $text );
  148.         $text = htmlspecialchars( $text );
  149.         return $text;
  150.     }
  151. }
  152. ?>
Documentation generated on Mon, 05 Mar 2007 21:12:25 +0000 by phpDocumentor 1.3.1