Docs for class JObject

Description

Object class, allowing __construct in PHP4.

since: 1.5
author: Johan Janssens <johan.janssens@joomla.org>

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

 JObject   (Subpackage Base)

Direct descendents

Class	Description
JApplication	Base class for a Joomla! application.
JController	Base class for a Joomla Controller
JModel	Base class for a Joomla Model
JView	Base class for a Joomla View
JMenu	JMenu class
JPathway	Class to maintain a pathway.
JRouter	Class to create and parse routes
JObservable	Abstract observable class to implement the observer design pattern
JObserver	Abstract observer class to implement the observer design pattern
JTree	Tree Class.
JNode	Tree Node Class.
JCache	Joomla! Cache base object
JCacheStorage	Abstract cache storage handler
JFTP	FTP client class
JLDAP	LDAP client class
JDatabase	Database connector class
JTable	Abstract Table class
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
JDocumentRenderer	Abstract class for a renderer
JBrowser	Browser class, provides capability information about the current web client.
JURI	JURI Class
JException	Joomla! Exception object.
JLog	Joomla! Logging class
JProfiler	Utility class to assist in the process of benchmarking the execution of sections of code to understand where time is being spent.
JArchiveBzip2	Bzip2 format adapter for the JArchive class
JArchiveGzip	Gzip format adapter for the JArchive class
JArchiveTar	Tar format adapter for the JArchive class
JArchiveZip	ZIP format adapter for the JArchive class
JFilterInput	JFilterInput is a class for filtering input from any data source
JPagination	Pagination Class. Provides a common interface for content pagination for the Joomla! Framework
JPaginationObject	Pagination object representing a particular item in the pagination lists
JPane	JPane abstract class
JElement	Parameter base class
JButton	Button base class
JToolBar	ToolBar handler
JInstallerComponent	Component installer
JInstallerLanguage	Language installer
JInstallerModule	Module installer
JInstallerPlugin	Plugin installer
JInstallerTemplate	Template installer
JInstaller	Joomla base installer class
JLanguage	Languages/translation handler class
JRegistryFormat	Abstract Format for JRegistry
JRegistry	JRegistry class
JSession	Class for managing HTTP sessions
JSessionStorage	Custom session storage handler for PHP
JAuthenticationResponse	Authorization response class, provides an object for storing user and error details
JUser	User class. Handles all application interaction with a user
JDate	JDate is a class that stores a date
JSimpleCrypt	JSimpleCrypt is a very simple encryption algorithm for encyrpting/decrypting strings
JSimpleXML	SimpleXML implementation.
JSimpleXMLElement	SimpleXML Element

Variable Summary

array $_errors

Method Summary

JObject __construct ()

Object JObject ()

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

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

array getErrors ()

array getProperties ([boolean $public = true])

void getPublicProperties ()

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

void setError (string $error)

boolean setProperties ($array $properties)

string toString ()

Variables

array $_errors = array() (line 33)

An array of errors

var: of error messages or JExceptions objects
since: 1.0
access: protected

Methods

Constructor __construct (line 58)

Class constructor, overridden in descendant classes.

since: 1.5
access: protected

JObject __construct ()

Redefined in descendants as:

JApplication::__construct() : Class constructor.
JController::__construct() : Constructor.
JModel::__construct() : Constructor
JView::__construct() : Constructor
JMenu::__construct() : Class constructor
JPathway::__construct() : Class constructor
JRouter::__construct() : Class constructor
JObservable::__construct() : Constructor
JDispatcher::__construct() : Constructor
JEditor::__construct() : constructor
JAuthentication::__construct() : Constructor
JObserver::__construct() : Constructor
JPlugin::__construct() : Constructor
JTree::__construct()
JNode::__construct()
JCache::__construct() : Constructor
JCacheStorage::__construct() : Constructor
JCacheStorageApc::__construct() : Constructor
JCacheStorageEaccelerator::__construct() : Constructor
JCacheStorageFile::__construct() : Constructor
JCacheStorageMemcache::__construct() : Constructor
JCacheStorageXCache::__construct() : Constructor
JFTP::__construct() : JFTP object constructor
JLDAP::__construct() : Constructor
JDatabase::__construct() : Database object constructor
JDatabaseMySQL::__construct() : Database object constructor
JDatabaseMySQLi::__construct() : Database object constructor
JTable::__construct() : Object constructor to set table and key field
JTableARO::__construct()
JTableAROGroup::__construct()
JTableCategory::__construct()
JTableComponent::__construct()
JTableContent::__construct()
JTableMenu::__construct() : Constructor
JTableMenuTypes::__construct() : Constructor
JTableModule::__construct() : Contructore
JTablePlugin::__construct()
JTableSection::__construct()
JTableSession::__construct() : Constructor
JTableUser::__construct()
JDocument::__construct() : Class constructor
JDocumentError::__construct() : Class constructor
JDocumentFeed::__construct() : Class constructor
JDocumentHTML::__construct() : Class constructor
JDocumentPDF::__construct() : Class constructore
JDocumentRAW::__construct() : Class constructore
JDocumentRenderer::__construct() : Class constructor
JBrowser::__construct() : Create a browser instance (Constructor).
JURI::__construct() : Constructor.
JException::__construct() : Constructor
- used to set up the error with all needed error details.
JLog::__construct() : Constructor
JProfiler::__construct() : Constructor
JArchiveBzip2::__construct() : Constructor tries to load the bz2 extension of not loaded
JFilterInput::__construct() : Constructor for inputFilter class. Only first parameter is required.
JPagination::__construct() : Constructor
JPaginationObject::__construct()
JPane::__construct() : Constructor
JPaneTabs::__construct() : Constructor
JPaneSliders::__construct() : Constructor
JElement::__construct() : Constructor
JButton::__construct() : Constructor
JToolBar::__construct() : Constructor
JInstallerComponent::__construct() : Constructor
JInstallerLanguage::__construct() : Constructor
JInstallerModule::__construct() : Constructor
JInstallerPlugin::__construct() : Constructor
JInstallerTemplate::__construct() : Constructor
JInstaller::__construct() : Constructor
JLanguage::__construct() : Constructor activating the default information of the language
JRegistry::__construct() : Constructor
JParameter::__construct() : Constructor
JSession::__construct() : Constructor
JSessionStorage::__construct() : Constructor
JSessionStorageApc::__construct() : Constructor
JSessionStorageEaccelerator::__construct() : Constructor
JSessionStorageMemcache::__construct() : Constructor
JSessionStorageXcache::__construct() : Constructor
JAuthenticationResponse::__construct() : Constructor
JUser::__construct() : Constructor activating the default information of the language
JDate::__construct() : Creates a new instance of JDate representing a given date.
JSimpleCrypt::__construct() : Object Constructor takes an optional key to be used for encryption/decryption. If no key is given then the secret word from the configuration object is used.
JSimpleXML::__construct() : Constructor.
JSimpleXMLElement::__construct() : Constructor, sets up all the default values

Constructor JObject (line 46)

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

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

return: The value of the property
since: 1.5
see: JObject::getProperties()
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:

JView::get() : Method to get data from a registered model
JCache::get() : Get cached data by id and group
JCacheCallback::get() : Executes a cacheable callback if not found in cache else returns cached output and result
JCachePage::get() : Get the cached page data
JCacheView::get() : Get the cached view data
JCacheStorage::get() : Get cached data by id and group
JCacheStorageApc::get() : Get cached data from APC by id and group
JCacheStorageEaccelerator::get() : Get cached data by id and group
JCacheStorageFile::get() : Get cached data from a file by id and group
JCacheStorageMemcache::get() : Get cached data from memcache by id and group
JCacheStorageXCache::get() : Get cached data by id and group
JFTP::get() : Method to get a file from the FTP server and save it to a local file
JLanguage::get() : Get a matadata language property
JParameter::get() : Get a value
JSession::get() : Get data from the session store

getError (line 114)

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

Return all errors, if any

return: Array of error messages or JErrors
since: 1.5
access: public

array getErrors ()

getProperties (line 88)

Returns an associative array of object properties

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

array getProperties ([boolean $public = true])

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

getPublicProperties (line 224)

Legacy Method, use JObject::getProperties() instead

since: 1.0
deprecated: as of 1.5

void getPublicProperties ()

set (line 161)

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

return: Previous value of the property
since: 1.5
see: JObject::setProperties()
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:

JParameter::set() : Set a value
JSession::set() : Set data into the session store

setError (line 200)

Add an error message

since: 1.0
access: public

void setError (string $error)

string $error: Error message

Redefined in descendants as:

JDocumentError::setError() : Set error object

setProperties (line 177)

Set the object properties based on a named array/hash

since: 1.5
see: JObject::set()
access: protected

boolean setProperties ($array $properties)

$array $properties: mixed Either and associative array or another object

toString (line 213)

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:

JURI::toString() : Returns full uri string
JException::toString() : Returns to error message
JRegistry::toString() : Get a namespace in a given string format
JSimpleXMLElement::toString() : Return a well-formed XML string based on SimpleXML element

Joomla! 1.5 Documentation

Packages

Package: Joomla-Framework

Other documents

License

JObject