Docs For Class JObject

Description

Joomla Platform Object Class

This class allows for simple but smart objects with get and set methods and an internal error handler.

since: 11.1

Located in /libraries/joomla/object/object.php (line 22)

Direct descendents

Class	Description
JSite	Mock JSite class used to fool the frontend search plugins because they route the results.
JAdminCssMenu	Tree based class to render the admin menu
JMenuNode	A Node for JAdminCssMenu
JCaptcha	Joomla! Captcha base object
JEditor	JEditor class to handle WYSIWYG editors
JInstallerExtension	Extension object
FOFController	FrameworkOnFramework controller class. FOF is based on the thin controller paradigm, where the controller is mainly used to set up the model state and spawn the view.
FOFDispatcher	FrameworkOnFramework dispatcher class
FOFModel	FrameworkOnFramework Model class. The Model is the worhorse. It performs all
FOFTable	FrameworkOnFramework Table class. The Table is one part controller, one part model and one part data adapter. It's supposed to handle operations for single records.
FOFView	FrameworkOnFramework View class. The View is the MVC component which gets the raw data from a Model and renders it in a way that makes sense. The usual rendering is HTML, but you can also output JSON, CSV, XML, or even media (images, videos, ...) and documents (Word, PDF, Excel...).
JAdapter	Adapter Class Retains common adapter pattern functions Class harvested from joomla.installer.installer
JAdapterInstance	Adapter Instance Class
JEventDispatcher	Class to handle dispatching of events.
JEvent	JEvent Class
JStream	Joomla! Stream Interface
JTable	Abstract Table class
JUpdate	Update class.
JAuthentication	Authentication class, provides an interface for the Joomla authentication system
JUser	User class. Handles all application interaction with a user
JNode	Tree Node Class.
JObservable	Abstract observable class to implement the observer design pattern
JObserver	Abstract observer class to implement the observer design pattern
JTree	Tree Class.
JCategoryNode	Helper class to load Categorytree
JControllerLegacy	Base class for a Joomla Controller
JModelLegacy	Base class for a Joomla Model
JViewLegacy	Base class for a Joomla View

Variable Summary

array $_errors

Method Summary

JObject __construct ([mixed $properties = null])

mixed def (string $property, [mixed $default = null])

mixed get (string $property, [mixed $default = null])

string getError ([integer $i = null], [boolean $toString = true])

array getErrors ()

array getProperties ([boolean $public = true])

mixed set (string $property, [mixed $value = null])

void setError (string $error)

boolean setProperties (mixed $properties)

string __toString ()

Variables

array $_errors = array() (line 32)

An array of error messages or Exception objects.

see: JError
deprecated: 12.3 JError has been deprecated
since: 11.1
access: protected

Methods

Constructor __construct (line 42)

Class constructor, overridden in descendant classes.

since: 11.1
access: public

JObject __construct ([mixed $properties = null])

mixed $properties: Either and associative array or another object to set the initial properties of the object.

Redefined in descendants as:

JAdminCssMenu::__construct() : Constructor
JMenuNode::__construct() : Constructor for the class.
JCaptcha::__construct() : Class constructor.
JEditor::__construct() : Constructor
JInstallerExtension::__construct() : Constructor
JExtension::__construct() : Constructor
FOFController::__construct() : Public constructor of the Controller class
FOFDispatcher::__construct() : Public constructor
FOFModel::__construct() : Public class constructor
FOFTable::__construct() : Class Constructor.
FOFView::__construct() : Public constructor. Instantiates a FOFView object.
FOFViewRaw::__construct() : Class constructor
FOFViewHtml::__construct() : Class constructor
FOFViewCsv::__construct() : Public constructor. Instantiates a FOFViewCsv object.
FOFViewJson::__construct() : Public constructor
JAdapter::__construct() : Constructor
JInstaller::__construct() : Constructor
JUpdater::__construct() : Constructor
JAdapterInstance::__construct() : Constructor
JDispatcher::__construct() : Constructor.
JEvent::__construct() : Constructor
JPlugin::__construct() : Constructor
FinderIndexerAdapter::__construct() : Method to instantiate the indexer adapter.
PlgSystemCache::__construct() : Constructor
PlgSystemDebug::__construct() : Constructor.
PlgSystemLanguageFilter::__construct()
PlgSystemLogout::__construct() : Object Constructor.
PlgSystemRedirect::__construct() : Object Constructor.
PlgSystemRemember::__construct() : Constructor. We use it to set the app and db properties.
PlgTwofactorauthTotp::__construct() : Constructor
PlgTwofactorauthYubikey::__construct() : Constructor
PlgUserJoomla::__construct() : Constructor. We use it to set the app and db properties.
PlgUserProfile::__construct() : Constructor
JStream::__construct() : Constructor
JTable::__construct() : Object constructor to set table and key fields. In most cases this will be overridden by child classes to explicitly set the table and key fields for a particular database table.
BannersTableBanner::__construct() : Constructor
BannersTableClient::__construct()
ContactTableContact::__construct() : Constructor
ContentTableFeatured::__construct()
FinderTableFilter::__construct() : Constructor
FinderTableLink::__construct() : Constructor
FinderTableMap::__construct() : Constructor
MessagesTableMessage::__construct() : Constructor
NewsfeedsTableNewsfeed::__construct() : Constructor
RedirectTableLink::__construct() : Constructor
TemplatesTableStyle::__construct() : Constructor
UsersTableNote::__construct() : Constructor
WeblinksTableWeblink::__construct() : Constructor
JTableContenthistory::__construct() : Constructor
JTableContenttype::__construct() : Constructor
JTableCorecontent::__construct() : Constructor
JTableUcm::__construct() : Constructor
JTableExtension::__construct() : Constructor
JTableLanguage::__construct() : Constructor
TagsTableTag::__construct() : Constructor
JTableAsset::__construct() : Constructor
JTableCategory::__construct() : Constructor
JTableMenu::__construct() : Constructor
JTableUpdate::__construct() : Constructor
JTableUser::__construct() : Constructor
JTableUsergroup::__construct() : Constructor
JTableViewlevel::__construct() : Constructor
JTableContent::__construct() : Constructor
JTableMenuType::__construct() : Constructor
JTableModule::__construct() : Constructor.
JTableSession::__construct() : Constructor
JAuthentication::__construct() : Constructor
JUser::__construct() : Constructor activating the default information of the language
JNode::__construct() : Constructor
JObservable::__construct() : Constructor
JObserver::__construct() : Constructor
JTree::__construct() : Constructor
JCategoryNode::__construct() : Class constructor
JControllerLegacy::__construct() : Constructor.
CategoriesController::__construct() : Constructor.
ConfigControllerApplication::__construct() : Class Constructor
ConfigControllerComponent::__construct() : Class Constructor
ContentController::__construct()
InstallerControllerManage::__construct() : Constructor.
TemplatesControllerTemplate::__construct() : Constructor.
JControllerAdmin::__construct() : Constructor.
BannersControllerBanners::__construct() : Constructor.
ContactControllerContacts::__construct() : Constructor.
ContentControllerArticles::__construct() : Constructor.
MenusControllerItems::__construct()
UsersControllerUsers::__construct() : Constructor.
JControllerForm::__construct() : Constructor.
CategoriesControllerCategory::__construct() : Constructor.
JModelLegacy::__construct() : Constructor
SearchModelSearch::__construct() : Constructor
UsersModelProfile::__construct()
JModelAdmin::__construct() : Constructor.
CategoriesModelCategory::__construct() : Override parent constructor.
UsersModelUser::__construct() : Constructor.
JModelList::__construct() : Constructor.
BannersModelClients::__construct() : Constructor.
BannersModelTracks::__construct() : Constructor.
CategoriesModelCategories::__construct() : Constructor.
ContactModelContacts::__construct() : Constructor.
ContentModelArticles::__construct() : Constructor.
ContenthistoryModelHistory::__construct() : Constructor.
FinderModelFilters::__construct() : Constructor.
FinderModelIndex::__construct() : Constructor.
FinderModelMaps::__construct() : Constructor.
InstallerModel::__construct() : Constructor.
InstallerModelManage::__construct() : Constructor.
InstallerModelLanguages::__construct() : Constructor override, defines a white list of column filters.
InstallerModelUpdate::__construct() : Constructor.
LanguagesModelLanguages::__construct() : Constructor.
LanguagesModelOverrides::__construct() : Constructor
MenusModelItems::__construct() : Constructor.
MenusModelMenus::__construct() : Constructor.
MessagesModelMessages::__construct() : Constructor.
ModulesModelModules::__construct() : Constructor.
ModulesModelPositions::__construct() : Constructor.
NewsfeedsModelNewsfeeds::__construct() : Constructor.
PluginsModelPlugins::__construct() : Constructor.
RedirectModelLinks::__construct() : Constructor.
SearchModelSearches::__construct() : Constructor.
TemplatesModelStyles::__construct() : Constructor.
TemplatesModelTemplates::__construct() : Constructor.
UsersModelGroups::__construct() : Constructor.
UsersModelLevels::__construct() : Constructor.
UsersModelNotes::__construct() : Class constructor.
UsersModelUsers::__construct() : Constructor.
WeblinksModelWeblinks::__construct() : Constructor.
ContactModelCategory::__construct() : Constructor.
ContactModelFeatured::__construct() : Constructor.
ContentModelCategory::__construct() : Constructor.
NewsfeedsModelCategory::__construct() : Constructor.
TagsModelTag::__construct() : Constructor.
WeblinksModelCategory::__construct() : Constructor.
JViewLegacy::__construct() : Constructor
InstallerViewDefault::__construct() : Constructor

def (line 73)

Sets a default value if not alreay assigned

since: 11.1
access: public

mixed def (string $property, [mixed $default = null])

string $property: The name of the property.
mixed $default: The default value.

get (line 91)

Returns a property of the object or the default value if the property is not set.

return: The value of the property.
see: JObject::getProperties()
since: 11.1
access: public

mixed get (string $property, [mixed $default = null])

string $property: The name of the property.
mixed $default: The default value.

Redefined in descendants as:

FOFView::get() : Method to get data from a registered model or a property of the view
JViewLegacy::get() : Method to get data from a registered model or a property of the view

getError (line 140)

Get the most recent error message.

return: Error message
see: JError
deprecated: 12.3 JError has been deprecated
since: 11.1
access: public

string getError ([integer $i = null], [boolean $toString = true])

integer $i: Option error index.
boolean $toString: Indicates if JError objects should return their error message.

getErrors (line 176)

Return all errors, if any.

return: Array of error messages or JErrors.
see: JError
deprecated: 12.3 JError has been deprecated
since: 11.1
access: public

array getErrors ()

getProperties (line 111)

Returns an associative array of object properties.

see: JObject::get()
since: 11.1
access: public

array getProperties ([boolean $public = true])

boolean $public: If true, returns only the public properties.

set (line 191)

Modifies a property of the object, creating it if it does not already exist.

return: Previous value of the property.
since: 11.1
access: public

mixed set (string $property, [mixed $value = null])

string $property: The name of the property.
mixed $value: The value of the property to set.

setError (line 235)

Add an error message.

see: JError
deprecated: 12.3 JError has been deprecated
since: 11.1
access: public

void setError (string $error)

string $error: Error message.

setProperties (line 209)

Set the object properties based on a named array/hash.

see: JObject::set()
since: 11.1
access: public

boolean setProperties (mixed $properties)

mixed $properties: Either an associative array or another object.

__toString (line 58)

Magic method to convert the object to a string gracefully.

return: The classname.
deprecated: 12.3 Classes should provide their own __toString() implementation.
since: 11.1
access: public

string __toString ()