API15:JFilterOutput/objectHTMLSafe

This Namespace has been archived - Please Do Not Edit or Create Pages in this namespace. Pages contain information for a Joomla! version which is no longer supported. It exists only as a historical reference, will not be improved and its content may be incomplete.

Description

Makes an object safe to display in forms

Syntax

objectHTMLSafe(&$mixed, $quote_style=ENT_QUOTES, $exclude_keys='')

Parameter Name	Default Value	Description
&$mixed		An object to be parsed
$quote_style	ENT_QUOTES	The optional quote style for the htmlspecialchars function
$exclude_keys		An optional single field name or array of field names not to be parsed (eg, for a textarea)

Defined in

libraries/joomla/filter/filteroutput.php

Importing

jimport( 'joomla.filter.filteroutput' );

Source Body

function objectHTMLSafe( &$mixed, $quote_style=ENT_QUOTES, $exclude_keys='' )
{
        if (is_object( $mixed ))
        {
                foreach (get_object_vars( $mixed ) as $k => $v)
                {
                        if (is_array( $v ) || is_object( $v ) || $v == NULL || substr( $k, 1, 1 ) == '_' ) {
                                continue;
                        }
 
                        if (is_string( $exclude_keys ) && $k == $exclude_keys) {
                                continue;
                        } else if (is_array( $exclude_keys ) && in_array( $k, $exclude_keys )) {
                                continue;
                        }
 
                        $mixed->$k = htmlspecialchars( $v, $quote_style, 'UTF-8' );
                }
        }
}

Examples

<CodeExamplesForm />