Joomla! Documentation™

The "API15" namespace is an archived namespace. This page contains information for a Joomla! version which is no longer supported. It exists only as a historical reference, it will not be improved and its content may be incomplete and/or contain broken links.

Description

Utility function to map an object to an array

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

Syntax

fromObject($p_obj, $recurse=true, $regex=null)

Parameter Name	Default Value	Description
$p_obj		The source object
$recurse	true	True to recurve through multi-level objects
$regex	null	An optional regular expression to match on field names

Returns

array The array mapped from the given object

Defined in

libraries/joomla/utilities/arrayhelper.php

Importing

jimport( 'joomla.utilities.arrayhelper' );

Source Body

function fromObject( $p_obj, $recurse = true, $regex = null )
{
        $result = null;
        if (is_object( $p_obj ))
        {
                $result = array();
                foreach (get_object_vars($p_obj) as $k => $v)
                {
                        if ($regex)
                        {
                                if (!preg_match( $regex, $k ))
                                {
                                        continue;
                                }
                        }
                        if (is_object( $v ))
                        {
                                if ($recurse)
                                {
                                        $result[$k] = JArrayHelper::fromObject( $v, $recurse, $regex );
                                }
                        }
                        else
                        {
                                $result[$k] = $v;
                        }
                }
        }
        return $result;
}

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

Examples

<CodeExamplesForm />