Joomla! Platform 12.1

Download

Demo

Class JObject

Description
Description | Descendents | Variables (details) | Methods (details)

Base 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) 

Class JObject   (Subpackage Base)
Direct descendents
Description | Descendents | Variables (details) | Methods (details)
Class Description
ClassJCache Joomla! Cache base object
ClassJLanguage Languages/translation handler class
ClassJProfiler Utility class to assist in the process of benchmarking the execution of sections of code to understand where time is being spent.
Abstract classJPane JPane abstract class
ClassJPagination Pagination Class. Provides a common interface for content pagination for the Joomla! Platform.
ClassJPaginationObject Pagination object representing a particular item in the pagination lists.
Abstract classJButton Button base class
ClassJToolBar ToolBar handler
ClassJElement Parameter base class
ClassJEditor JEditor class to handle WYSIWYG editors
ClassJDocumentRenderer Abstract class for a renderer
ClassJOpenSearchUrl JOpenSearchUrl is an internal class that stores the search URLs for the OpenSearch description
ClassJOpenSearchImage JOpenSearchImage is an internal class that stores Images for the OpenSearch Description
ClassJFeedItem JFeedItem is an internal class that stores feed item information
ClassJFeedEnclosure JFeedEnclosure is an internal class that stores feed enclosure information
ClassJFeedImage JFeedImage is an internal class that stores feed image information
ClassJDocument Document class, provides an easy interface to parse and display a document
ClassJBrowser Browser class, provides capability information about the current web client.
ClassJURI JURI Class
Abstract classJTable Abstract Table class
ClassJSimpleCrypt JSimpleCrypt is a very simple encryption algorithm for encrypting/decrypting strings
ClassJSimpleXML SimpleXML implementation.
ClassJSimpleXMLElement SimpleXML Element
ClassJUpdate Update class.
ClassJRouter Class to create and parse routes
ClassJPathway Class to maintain a pathway.
ClassJMenu JMenu class
ClassJApplication Base class for a Joomla! application.
ClassJCategoryNode Helper class to load Categorytree
ClassJView Base class for a Joomla View
Abstract classJModel Base class for a Joomla Model
ClassJController Base class for a Joomla Controller
ClassJLDAP LDAP client class
ClassJAuthentication Authentication class, provides an interface for the Joomla authentication system
ClassJAuthenticationResponse Authentication response class, provides an object for storing user and error details
ClassJUser User class. Handles all application interaction with a user
ClassJStream Joomla! Stream Interface
ClassJArchiveTar Tar format adapter for the JArchive class
ClassJArchiveZip ZIP format adapter for the JArchive class
ClassJArchiveGzip Gzip format adapter for the JArchive class
ClassJArchiveBzip2 Bzip2 format adapter for the JArchive class
Abstract classJEvent JEvent Class
ClassJDispatcher Class to handle dispatching of events.
ClassJExtension Extension object
ClassJLibraryManifest Joomla! Library Manifest File
ClassJPackageManifest Joomla! Package Manifest File
ClassJSession Class for managing HTTP sessions
Abstract classJSessionStorage Custom session storage handler for PHP
ClassJAdapterInstance Adapter Instance Class
ClassJNode Tree Node Class.
Abstract classJObserver Abstract observer class to implement the observer design pattern
ClassJObservable Abstract observable class to implement the observer design pattern
ClassJTree Tree Class.
ClassJAdapter Adapter Class Retains common adapter pattern functions Class harvested from joomla.installer.installer
ClassJFilterInput JFilterInput is a class for filtering input from any data source
Variable Summary
Description | Descendants | Variables (details) | Methods (details)
Variable array $_errors
Method Summary
Description | Descendants | Variables (details) | Methods (details)
Constructor JObject __construct ([mixed $properties = null])
Method mixed def (string $property, [mixed $default = null])
Method mixed get (string $property, [mixed $default = null])
Method string getError ([integer $i = null], [boolean $toString = true])
Method array getErrors ()
Method array getProperties ([boolean $public = true])
Method mixed set (string $property, [mixed $value = null])
Method void setError (string $error)
Method boolean setProperties (mixed $properties)
Method string toString ()
Method string __toString ()
Variables
Description | Descendents | Variables (details) | Methods (details)
array $_errors = array() (line 30)

An array of error messages or JExceptions objects.

  • since: 11.1
  • access: protected
Methods
Description | Descendents | Variables (details) Methods (details)
Constructor __construct (line 40)

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 70)

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 88)

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 135)

Get the most recent error message.

  • return: Error message
  • 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 169)

Return all errors, if any.

  • return: Array of error messages or JErrors.
  • since: 11.1
  • access: public
array getErrors ()
getProperties (line 108)

Returns an associative array of object properties.

array getProperties ([boolean $public = true])
  • boolean $public: If true, returns only the public properties.
set (line 184)

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 226)

Add an error message.

  • since: 11.1
  • access: public
void setError (string $error)
  • string $error: Error message.
Redefined in descendants as:
setProperties (line 202)

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 240)

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

string toString ()
Redefined in descendants as:
__toString (line 55)

Magic method to convert the object to a string gracefully.

  • return: The classname.
  • since: 11.1
  • access: public
string __toString ()
Redefined in descendants as:
Support Joomla!
/html>