API16

API16:JObject/getProperties

From Joomla! Documentation

Revision as of 14:16, 24 March 2017 by JoomlaWikiBot (talk | contribs) (clean up)

Description

Returns an associative array of object properties.


{{subst:Description:JObject/getProperties}}

Syntax

getProperties($public=true)
Parameter Name Default Value Description
$public true $public If true, returns only the public properties.

Returns

array

Defined in

libraries/joomla/base/object.php

Importing

jimport( 'joomla.base.object' );

Source Body

public function getProperties($public = true)
{
        $vars  = get_object_vars($this);
        if ($public)
        {
                foreach ($vars as $key => $value)
                {
                        if ('_' == substr($key, 0, 1)) {
                                unset($vars[$key]);
                        }
                }
        }

        return $vars;
}


{{subst:SeeAlso:JObject/getProperties}}

Examples

<CodeExamplesForm />