JApplicationBase

Extends \JObject

Joomla Platform Base Application Class

abstract

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

package

Joomla.Platform

subpackage

Application

since

12.1

Methods

__construct

Class constructor, overridden in descendant classes.

__construct(mixed $properties = null) 
inherited
since

11.1

Arguments

$properties

mixedEither and associative array or another object to set the initial properties of the object.

__toString

Magic method to convert the object to a string gracefully.

__toString() : string
inherited deprecated
since

11.1

deprecated

12.3 Classes should provide their own __toString() implementation.

Response

stringThe classname.

close

Method to close the application.

close(integer $code) : void
since

12.1

Arguments

$code

integerThe exit code (optional; default is 0).

def

Sets a default value if not alreay assigned

def(string $property, mixed $default = null) : mixed
inherited
since

11.1

Arguments

$property

stringThe name of the property.

$default

mixedThe default value.

Response

mixed

get

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

get(string $property, mixed $default = null) : mixed
inherited
since

11.1

see \JObject::getProperties()

Arguments

$property

stringThe name of the property.

$default

mixedThe default value.

Response

mixedThe value of the property.

getError

Get the most recent error message.

getError(integer $i = null, boolean $toString = true) : string
inherited deprecated
since

11.1

see \JError
deprecated

12.3 JError has been deprecated

Arguments

$i

integerOption error index.

$toString

booleanIndicates if JError objects should return their error message.

Response

stringError message

getErrors

Return all errors, if any.

getErrors() : array
inherited deprecated
since

11.1

see \JError
deprecated

12.3 JError has been deprecated

Response

arrayArray of error messages or JErrors.

getIdentity

Get the application identity.

getIdentity() : mixed
since

12.1

Response

mixedA JUser object or null.

getProperties

Returns an associative array of object properties.

getProperties(boolean $public = true) : array
inherited
since

11.1

see \JObject::get()

Arguments

$public

booleanIf true, returns only the public properties.

Response

array

loadDispatcher

Allows the application to load a custom or default dispatcher.

loadDispatcher(\JDispatcher $dispatcher = null) : \JApplicationBase

The logic and options for creating this object are adequately generic for default cases but for many applications it will make sense to override this method and create event dispatchers, if required, based on more specific needs.

since

12.1

Arguments

$dispatcher

\JDispatcherAn optional dispatcher object. If omitted, the factory dispatcher is created.

Response

\JApplicationBaseThis method is chainable.

loadIdentity

Allows the application to load a custom or default identity.

loadIdentity(\JUser $identity = null) : \JApplicationBase

The logic and options for creating this object are adequately generic for default cases but for many applications it will make sense to override this method and create an identity, if required, based on more specific needs.

since

12.1

Arguments

$identity

\JUserAn optional identity object. If omitted, the factory user is created.

Response

\JApplicationBaseThis method is chainable.

registerEvent

Registers a handler to a particular event group.

registerEvent(string $event, callback $handler) : \JApplicationBase
since

12.1

Arguments

$event

stringThe event name.

$handler

callbackThe handler, a function or an instance of a event object.

Response

\JApplicationBaseThe application to allow chaining.

set

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

set(string $property, mixed $value = null) : mixed
inherited
since

11.1

Arguments

$property

stringThe name of the property.

$value

mixedThe value of the property to set.

Response

mixedPrevious value of the property.

setError

Add an error message.

setError(string $error) : void
inherited deprecated
since

11.1

see \JError
deprecated

12.3 JError has been deprecated

Arguments

$error

stringError message.

setProperties

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

setProperties(mixed $properties) : boolean
inherited
since

11.1

see \JObject::set()

Arguments

$properties

mixedEither an associative array or another object.

Response

boolean

toString

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

toString() : string
inherited deprecated
since

11.1

deprecated

12.1 Use magic method __toString()

see \JObject::__toString()

Response

string

triggerEvent

Calls all handlers associated with an event group.

triggerEvent(string $event, array $args = null) : array
since

12.1

Arguments

$event

stringThe event name.

$args

arrayAn array of arguments (optional).

Response

arrayAn array of results from each function call, or null if no dispatcher is defined.

Properties

dispatcher

The application dispatcher object.

since

12.1

Type(s)

\JEventDispatcher

identity

The application identity object.

since

12.1

Type(s)

\JUser

input

The application input object.

since

12.1

Type(s)

\JInput

_errors

An array of error messages or Exception objects.

inherited deprecated
since

11.1

see \JError
deprecated

12.3 JError has been deprecated

Type(s)

array