Support Joomla!

Packages

Package: Joomla-Framework

License

Content on this site is copyright © 2005 - 2008 Open Source Matters Inc and can be used in accordance with the Joomla! Electronic Documentation License. Some parts of this website may be subject to other licenses.

Class JObject

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

Object class, allowing __construct in PHP4.

  • since: 1.5

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

Class JObject   (Subpackage Base)
Direct descendents
Description | Descendents | Variables (details) | Methods (details)
Class Description
Abstract classJRegistryFormat Abstract Format for JRegistry
ClassJRegistry JRegistry class
Abstract classJTable Abstract Table class
Abstract classJDatabase Database connector class
ClassJFilterInput JFilterInput is a class for filtering input from any data source
ClassJLog Joomla! Logging class
ClassJProfiler Utility class to assist in the process of benchmarking the execution of sections of code to understand where time is being spent.
ClassJException Joomla! Exception object.
ClassJURI JURI Class
ClassJBrowser Browser class, provides capability information about the current web client.
ClassJArchiveZip ZIP format adapter for the JArchive class
ClassJArchiveTar Tar format adapter for the JArchive class
ClassJArchiveGzip Gzip format adapter for the JArchive class
ClassJArchiveBzip2 Bzip2 format adapter for the JArchive class
ClassJPagination Pagination Class. Provides a common interface for content pagination for the Joomla! Framework
ClassJPaginationObject Pagination object representing a particular item in the pagination lists
Abstract classJPane JPane abstract class
Abstract classJElement Parameter base class
ClassJToolBar ToolBar handler
Abstract classJButton Button base class
Abstract classJSessionStorage Custom session storage handler for PHP
ClassJSession Class for managing HTTP sessions
Abstract classJCache Joomla! Cache base object
Abstract classJCacheStorage Abstract cache storage handler
Abstract classJView Base class for a Joomla View
Abstract classJModel Base class for a Joomla Model
Abstract classJController Base class for a Joomla Controller
ClassJMenu JMenu class
Abstract classJPathway Class to maintain a pathway.
Abstract classJRouter Class to create and parse routes
Abstract classJApplication Base class for a Joomla! application.
Abstract classJDocumentRenderer Abstract class for a renderer
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
Abstract classJDocument Document class, provides an easy interface to parse and display a document
ClassJDate JDate is a class that stores a date
ClassJSimpleCrypt JSimpleCrypt is a very simple encryption algorithm for encyrpting/decrypting strings
ClassJSimpleXML SimpleXML implementation.
ClassJSimpleXMLElement SimpleXML Element
ClassJLanguage Languages/translation handler class
ClassJLDAP LDAP client class
ClassJFTP FTP client class
ClassJTree Tree Class.
ClassJNode Tree Node Class.
Abstract classJObserver Abstract observer class to implement the observer design pattern
Abstract classJObservable Abstract observable class to implement the observer design pattern
ClassJUser User class. Handles all application interaction with a user
ClassJAuthenticationResponse Authorization response class, provides an object for storing user and error details
ClassJInstallerLanguage Language installer
ClassJInstallerComponent Component installer
ClassJInstallerTemplate Template installer
ClassJInstallerPlugin Plugin installer
ClassJInstallerModule Module installer
ClassJInstaller Joomla base installer class
Variable Summary
Description | Descendants | Variables (details) | Methods (details)
Variable array $_errors
Method Summary
Description | Descendants | Variables (details) | Methods (details)
Constructor JObject __construct ()
Constructor Object JObject ()
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 void getPublicProperties ()
Method mixed set (string $property, [mixed $value = null])
Method void setError (string $error)
Method boolean setProperties ($array $properties)
Method string toString ()
Variables
Description | Descendents | Variables (details) | Methods (details)
array $_errors = array() (line 32)

An array of errors

  • var: of error messages or JExceptions objects
  • since: 1.0
  • access: protected
Methods
Description | Descendents | Variables (details) Methods (details)
Constructor __construct (line 57)

Class constructor, overridden in descendant classes.

  • since: 1.5
  • access: protected
JObject __construct ()
Redefined in descendants as:
Constructor JObject (line 45)

A hack to support __construct() on PHP 4

Hint: descendant classes have no PHP4 class_name() constructors, so this constructor gets called first and calls the top-layer __construct() which (if present) should call parent::__construct()

  • since: 1.5
  • access: public
Object JObject ()
get (line 70)

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

Get the most recent error message

  • return: Error message
  • since: 1.5
  • 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 144)

Return all errors, if any

  • return: Array of error messages or JErrors
  • since: 1.5
  • access: public
array getErrors ()
getProperties (line 87)

Returns an associative array of object properties

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

Legacy Method, use JObject::getProperties() instead

  • since: 1.0
  • deprecated: as of 1.5
void getPublicProperties ()
set (line 160)

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

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

Add an error message

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

Set the object properties based on a named array/hash

boolean setProperties ($array $properties)
  • $array $properties: mixed Either and associative array or another object
toString (line 212)

Object-to-string conversion.

Each class can override it as necessary.

  • return: This name of this class
  • since: 1.5
  • access: public
string toString ()
Redefined in descendants as:
Documentation generated on Sat, 14 Nov 2009 11:16:24 +0000 by phpDocumentor 1.3.1