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/base/object.php (line 22)


	
			
Direct descendents
Class Description
JSite Mock JSite class used to fool the frontend search plugins because they route the results.
JBrowser Browser class, provides capability information about the current web client.
JURI JURI Class
JArchiveGzip Gzip format adapter for the JArchive class
JArchiveZip ZIP format adapter for the JArchive class
JArchiveTar Tar format adapter for the JArchive class
JArchiveBzip2 Bzip2 format adapter for the JArchive class
JStream Joomla! Stream Interface
JLDAP LDAP client class
JModel Base class for a Joomla Model
JView Base class for a Joomla View
JController Base class for a Joomla Controller
JPathway Class to maintain a pathway.
JCategoryNode Helper class to load Categorytree
JApplication Base class for a Joomla! application.
JMenu JMenu class
JRouter Class to create and parse routes
JApplicationBase Joomla Platform Base Application Class
JTable Abstract Table class
JSimpleCrypt JSimpleCrypt is a very simple encryption algorithm for encrypting/decrypting strings
JSimpleXML SimpleXML implementation.
JSimpleXMLElement SimpleXML Element
JDocumentRenderer Abstract class for a renderer
JDocument Document class, provides an easy interface to parse and display a document
JFeedItem JFeedItem is an internal class that stores feed item information
JFeedEnclosure JFeedEnclosure is an internal class that stores feed enclosure information
JFeedImage JFeedImage is an internal class that stores feed image information
JOpenSearchUrl JOpenSearchUrl is an internal class that stores the search URLs for the OpenSearch description
JOpenSearchImage JOpenSearchImage is an internal class that stores Images for the OpenSearch Description
JCache Joomla! Cache base object
JUser User class. Handles all application interaction with a user
JAuthentication Authentication class, provides an interface for the Joomla authentication system
JAuthenticationResponse Authentication response class, provides an object for storing user and error details
JObservable Abstract observable class to implement the observer design pattern
JAdapter Adapter Class Retains common adapter pattern functions Class harvested from joomla.installer.installer
JTree Tree Class.
JObserver Abstract observer class to implement the observer design pattern
JAdapterInstance Adapter Instance Class
JNode Tree Node Class.
JProfiler Utility class to assist in the process of benchmarking the execution of sections of code to understand where time is being spent.
JUpdate Update class.
JExtension Extension object
JLibraryManifest Joomla! Library Manifest File
JPackageManifest Joomla! Package Manifest File
JFilterInput JFilterInput is a class for filtering input from any data source
JLanguage Languages/translation handler class
JButton Button base class
JToolBar ToolBar handler
JEditor JEditor class to handle WYSIWYG editors
JPagination Pagination Class. Provides a common interface for content pagination for the Joomla! Platform.
JPaginationObject Pagination object representing a particular item in the pagination lists.
JElement Parameter base class
JPane JPane abstract class
JDispatcher Class to handle dispatching of events.
JEvent JEvent Class
JSessionStorage Custom session storage handler for PHP
JSession Class for managing HTTP sessions
JSchemaChangeitem Each object represents one query, which is one line from a DDS SQL query.
JSchemaChangeset Contains a set of JSchemaChange objects for a particular instance of Joomla.
JCaptcha Joomla! Captcha base object
JRouterInstallation Class to create and parse routes
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 ()
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:
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.

mixed get (string $property, [mixed $default = null])
  • string $property: The name of the property.
  • mixed $default: The default value.

Redefined in descendants as:
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.

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.

Redefined in descendants as:
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.

Redefined in descendants as:
setProperties (line 209)

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

boolean setProperties (mixed $properties)
  • mixed $properties: Either an associative array or another object.
toString (line 249)

Converts the object to a string (the class name).

string toString ()

Redefined in descendants as:
__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 ()

Redefined in descendants as:

Documentation generated on Mon, 25 Jun 2012 13:58:17 -0500 by phpDocumentor 1.4.4