API16:JModel/getState

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

Method to get model state variables

Syntax

getState($property=null, $default=null)

Parameter Name	Default Value	Description
$property	null	Optional parameter name
$default	null	Optional default value

Returns

object The property where specified, the state object where omitted

Defined in

libraries/joomla/application/component/model.php

Importing

jimport( 'joomla.application.component.model' );

Source Body

public function getState($property = null, $default = null)
{
        if (!$this->__state_set)
        {
                // Private method to auto-populate the model state.
                $this->_populateState();
 
                // Set the model state set flat to true.
                $this->__state_set = true;
        }
 
        return $property === null ? $this->_state : $this->_state->get($property, $default);
}

Examples

<CodeExamplesForm />