API15:JArrayHelper/toInteger

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

Function to convert array to integer values

<! removed transcluded page call, red link never existed >

Syntax

toInteger(&$array, $default=null)

Parameter Name	Default Value	Description
&$array		$array The source array to convert
$default	null	array) to assign if $array is not an array

Defined in

libraries/joomla/utilities/arrayhelper.php

Importing

jimport( 'joomla.utilities.arrayhelper' );

Source Body

function toInteger(&$array, $default = null)
{
        if (is_array($array)) {
                foreach ($array as $i => $v) {
                        $array[$i] = (int) $v;
                }
        } else {
                if ($default === null) {
                        $array = array();
                } elseif (is_array($default)) {
                        JArrayHelper::toInteger($default, null);
                        $array = $default;
                } else {
                        $array = array( (int) $default );
                }
        }
}

<! removed transcluded page call, red link never existed >

Examples

<CodeExamplesForm />