Classes

Factory

Joomla Platform Factory class.

« More »

Version

Version information class for the Joomla CMS.

« More »

Classes

Access

Class that handles all access authorisation routines.

« More »

Rule

Rule class.

« More »

Rules

Access rules class.

« More »

Classes

AuthenticationFailed

Exception class defining an authentication failed event

« More »

NotAllowed

Exception class defining a not allowed access

« More »

Classes

Adapter

Adapter Class Retains common adapter pattern functions Class harvested from joomla.installer.installer

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

AdapterInstance

Adapter Instance Class

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

Traits

EventAware

Trait for application classes which dispatch events

« More »

ExtensionNamespaceMapper

Trait for application classes which ensures the namespace mapper exists and includes it.

« More »

IdentityAware

Trait for application classes which are identity (user) aware

« More »

Interfaces

CMSApplicationInterface

Interface defining a Joomla! CMS Application class

« More »

CMSWebApplicationInterface

Interface defining a Joomla! CMS Application class for web applications.

« More »

EventAwareInterface

Interface defining application that can trigger Joomla 3.x style events

« More »

Classes

AdministratorApplication

Joomla! Administrator Application class

« More »

ApiApplication

Joomla! API Application class

« More »

ApplicationHelper

Application helper functions

« More »

BaseApplication

Joomla Platform Base Application Class

« More »

CliApplication

Base class for a Joomla! command line application.

« More »

CMSApplication

Joomla! CMS Application class

« More »

DaemonApplication

Class to turn CliApplication applications into daemons. It requires CLI and PCNTL support built into PHP.

« More »

SiteApplication

Joomla! Site Application class

« More »

WebApplication

Base class for a Joomla! Web application.

« More »

Classes

CliInput

Class CliInput

« More »

CliOutput

Base class defining a command line output handler

« More »

ColorStyle

Class defining ANSI-color styles for command line output

« More »

Classes

Stdout

Output handler for writing command line output to the stdout interface

« More »

Xml

Output handler for writing command line output to the stdout interface

« More »

Interfaces

ProcessorInterface

Interface for a command line output processor

« More »

Classes

ColorProcessor

Command line output processor supporting ANSI-colored output

« More »

Classes

NotAcceptable

Exception class defining a not acceptable class

« More »

Traits

AssociationServiceTrait

Trait to implement AssociationServiceInterface

« More »

Interfaces

AssociationExtensionInterface

Association Extension Interface for the helper classes

« More »

AssociationServiceInterface

The association service.

« More »

Classes

AssociationExtensionHelper

Association Extension Helper

« More »

Classes

Authentication

Authentication class, provides an interface for the Joomla authentication system

« More »

AuthenticationResponse

Authentication response class, provides an object for storing user and error details

« More »

Interfaces

CheckIfRehashNeededHandlerInterface

Interface for a password handler which supports checking if the password requires rehashing

« More »

Classes

Argon2idHandler

Password handler for Argon2id hashed passwords

« More »

Argon2iHandler

Password handler for Argon2i hashed passwords

« More »

BCryptHandler

Password handler for BCrypt hashed passwords

« More »

ChainedHandler

Password handler supporting testing against a chain of handlers

« More »

MD5Handler

Password handler for MD5 hashed passwords

« More »

PHPassHandler

Password handler for PHPass hashed passwords

« More »

Classes

ClassLoader

Decorate Composer ClassLoader for Joomla!

For backward compatibility due to class aliasing in the CMS, the loadClass() method was modified to call the JLoader::applyAliasFor() method.
« More »

Interfaces

CacheControllerFactoryInterface

Interface defining a factory which can create CacheController objects

« More »

Classes

Cache

Joomla! Cache base object

« More »

CacheController

Public cache handler

« More »

CacheControllerFactory

Default factory for creating CacheController objects

« More »

CacheStorage

Abstract cache storage handler

« More »

Classes

CallbackController

Joomla! Cache callback type object

« More »

OutputController

Joomla Cache output type object

« More »

PageController

Joomla! Cache page type object

« More »

ViewController

Joomla! Cache view type object

« More »

Interfaces

CacheExceptionInterface

Exception interface defining a cache storage error

« More »

Classes

CacheConnectingException

Exception class defining an error connecting to the cache storage engine

« More »

UnsupportedCacheException

Exception class defining an unsupported cache storage object

« More »

Classes

ApcuStorage

APCu cache storage handler

« More »

CacheStorageHelper

Cache storage helper functions.

« More »

FileStorage

File cache storage handler

« More »

MemcachedStorage

Memcached cache storage handler

« More »

RedisStorage

Redis cache storage handler for PECL

« More »

WincacheStorage

WinCache cache storage handler

« More »

Classes

Captcha

Joomla! Captcha base object

« More »

Classes

HttpBridgePostRequestMethod

Bridges the Joomla! HTTP API to the Google Recaptcha RequestMethod interface for a POST request.

« More »

Traits

CategoryServiceTrait

Trait for component categories service.

« More »

Interfaces

CategoryFactoryInterface

Category factory interface

« More »

CategoryInterface

The category interface.

« More »

CategoryServiceInterface

Access to component specific categories.

« More »

Classes

Categories

Categories Class.

« More »

CategoryFactory

Option based categories factory.

« More »

CategoryNode

Helper class to load Categorytree

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

SectionNotFoundException

Representing when a category section cannot be found.

« More »

Classes

Changelog

Changelog class.

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

Classes

ClientHelper

Client helper class

« More »

FtpClient

FTP client class

« More »

Classes

ComponentHelper

Component helper class

« More »

ComponentRecord

Object representing a component extension record

« More »

Classes

MissingComponentException

Exception class defining an error for a missing component

« More »

Traits

RouterServiceTrait

Trait to implement AssociationServiceInterface

« More »

Interfaces

RouterFactoryInterface

Router factory interface

« More »

RouterInterface

Component routing interface

« More »

RouterServiceInterface

The component router service.

« More »

Classes

RouterBase

Base component routing class

« More »

RouterFactory

Default router factory.

« More »

RouterLegacy

Default routing class for missing or legacy component routers

« More »

RouterView

View-based component routing class

« More »

RouterViewConfiguration

View-configuration class for the view-based component router

« More »

Interfaces

RulesInterface

RouterRules interface for Joomla

« More »

Classes

MenuRules

Rule to identify the right Itemid for a view in a component

« More »

NomenuRules

Rule to process URLs without a menu item

« More »

StandardRules

Rule for the standard handling of component routing

« More »

Classes

AddUserCommand

Console command for adding a user

« More »

AddUserToGroupCommand

Console command to add a user to group

« More »

ChangeUserPasswordCommand

Console command to change a user's password

« More »

CheckJoomlaUpdatesCommand

Console command for checking if there are pending extension updates

« More »

CheckUpdatesCommand

Console command for checking if there are pending extension updates

« More »

CleanCacheCommand

Console command for cleaning the system cache

« More »

DeleteUserCommand

Console command for deleting a user

« More »

ExtensionDiscoverCommand

Console command for discovering extensions

« More »

ExtensionDiscoverInstallCommand

Console command for discovering extensions

« More »

ExtensionDiscoverListCommand

Console command for list discovered extensions

« More »

ExtensionsListCommand

Console command for listing installed extensions

« More »

FinderIndexCommand

Console command Purges and rebuilds the index (search filters are preserved)

« More »

ListUserCommand

Console command to list existing users

« More »

RemoveOldFilesCommand

Console command for removing files which should have been cleared during an update

« More »

RemoveUserFromGroupCommand

Console command to remove a user from a group

« More »

SessionGcCommand

Console command for performing session garbage collection

« More »

SessionMetadataGcCommand

Console command for performing session metadata garbage collection

« More »

SiteDownCommand

Console command wrapper for getting the site into offline mode

« More »

SiteUpCommand

Console command wrapper for getting the site into offline mode

« More »

Interfaces

WritableLoaderInterface

Interface defining a writable command loader.

« More »

Classes

WritableContainerLoader

PSR-11 compatible writable command loader.

« More »

Classes

Crypt

Crypt is a Joomla Platform class for handling basic encryption/decryption of data.

« More »

Classes

CryptoCipher

Crypt cipher for encryption, decryption and key generation via the php-encryption library.

« More »

SodiumCipher

JCrypt cipher for sodium algorithm encryption, decryption and key generation.

« More »

Classes

Date

Date is a class that stores a date and provides logic to manipulate and render that date in a variety of formats.

« More »

Interfaces

ComponentDispatcherFactoryInterface

Component dispatcher factory interface

« More »

DispatcherInterface

Joomla Platform CMS Dispatcher Interface

« More »

ModuleDispatcherFactoryInterface

Module dispatcher factory interface

« More »

Classes

AbstractModuleDispatcher

Base class for a Joomla Module Dispatcher.

« More »

ApiDispatcher

API Implementation for our dispatcher. It loads a component's administrator language files, and calls the API Controller so that components that haven't implemented web services can add their own handling.

Dispatchers are responsible for checking ACL of a component if appropriate and choosing an appropriate controller (and if necessary, a task) and executing it.
« More »

ComponentDispatcher

Base class for a Joomla Component Dispatcher

Dispatchers are responsible for checking ACL of a component if appropriate and choosing an appropriate controller (and if necessary, a task) and executing it.
« More »

ComponentDispatcherFactory

Namespace based implementation of the ComponentDispatcherFactoryInterface

« More »

Dispatcher

Base class for a Joomla Dispatcher

« More »

LegacyComponentDispatcher

Base class for a legacy Joomla Dispatcher

Executes the single entry file of a legacy component.
« More »

ModuleDispatcher

Base class for a Joomla Module Dispatcher

Executes the single entry file of a module.
« More »

ModuleDispatcherFactory

Namespace based implementation of the ModuleDispatcherFactoryInterface

« More »

Interfaces

FactoryInterface

Interface defining a factory which can create Document objects

« More »

PreloadManagerInterface

Joomla! Preload Manager Interface

« More »

RendererInterface

Interface for a document renderer

« More »

Classes

Document

Document class, provides an easy interface to parse and display a document

« More »

DocumentRenderer

Abstract class for a renderer

« More »

ErrorDocument

ErrorDocument class, provides an easy interface to parse and display an HTML based error page

« More »

Factory

Default factory for creating Document objects

« More »

FeedDocument

FeedDocument class, provides an easy interface to parse and display any feed document

« More »

HtmlDocument

HtmlDocument class, provides an easy interface to parse and display a HTML document

« More »

ImageDocument

ImageDocument class, provides an easy interface to output image data

« More »

JsonapiDocument

JsonapiDocument class, provides an easy interface to parse output in JSON-API format.

« More »

JsonDocument

JsonDocument class, provides an easy interface to parse and display JSON output

« More »

OpensearchDocument

Opensearch class, provides an easy interface to display an Opensearch document

« More »

PreloadManager

Joomla! Preload Manager

« More »

RawDocument

RawDocument class, provides an easy interface to parse and display raw output

« More »

XmlDocument

XmlDocument class, provides an easy interface to parse and display XML output

« More »

Classes

FeedEnclosure

Data object representing a feed enclosure

« More »

FeedImage

Data object representing a feed image

« More »

FeedItem

Data object representing a feed item

« More »

Classes

OpensearchImage

Data object representing an OpenSearch image

« More »

OpensearchUrl

Data object representing an OpenSearch URL

« More »

Classes

AtomRenderer

AtomRenderer is a feed that implements the atom specification

Please note that just by using this class you won't automatically produce valid atom files. For example, you have to specify either an editor for the feed or an author for every single feed item.
« More »

RssRenderer

RssRenderer is a feed that implements RSS 2.0 Specification

« More »

Classes

ComponentRenderer

HTML document renderer for the component output

« More »

HeadRenderer

HTML document renderer for the document `<head>` element

« More »

MessageRenderer

HTML document renderer for the system message queue

« More »

MetasRenderer

JDocument metas renderer

« More »

ModuleRenderer

HTML document renderer for a single module

« More »

ModulesRenderer

HTML document renderer for a module position

« More »

ScriptsRenderer

JDocument head renderer

« More »

StylesRenderer

JDocument styles renderer

« More »

Classes

Editor

Editor class to handle WYSIWYG editors

« More »

Functions

hash_pbkdf2

Shim for missing hash_pbkdf2

Arguments

$algo

stringAlgorithm to use

$password

stringPlaintext password

$salt

stringSalt for the hash

$count

integerNumber of iterations

$length

integerLength

$rawOutput

booleanRaw output

Response

stringHashed string

Interfaces

RandValInterface

Interface RandValInterface

« More »

Classes

Aes

A simple implementation of AES-128, AES-192 and AES-256 encryption using the high performance mcrypt library.

« More »

Base32

Base32 encryption class

« More »

Randval

Generates cryptographically-secure random values.

« More »

Totp

This class provides an RFC6238-compliant Time-based One Time Passwords, compatible with Google Authenticator (with PassCodeLength = 6 and TimePeriod = 30).

« More »

Interfaces

AesInterface

Interface for AES encryption adapters

« More »

Classes

AbstractAES

Abstract AES encryption class

« More »

Mcrypt

Mcrypt implementation

« More »

OpenSSL

OpenSSL encryption class

« More »

Classes

Browser

Browser class, provides capability information about the current web client.

Browser identification is performed by examining the HTTP_USER_AGENT environment variable provided by the web server. This class has many influences from the lib/Browser.php code in version 3 of Horde by Chuck Hagenbuch and Jon Parise.
« More »

Interfaces

RendererInterface

Interface defining the rendering engine for the error handling layer

« More »

Classes

AbstractRenderer

Base class for error page renderers

« More »

Classes

AuthenticationFailedExceptionHandler

Handler for permission errors that should give a 401

« More »

CheckinCheckoutExceptionHandler

Handler for invalid checkin/checkout exceptions

« More »

InvalidParameterExceptionHandler

Handler for invalid param

« More »

InvalidRouteExceptionHandler

Handler for routing errors that should give a 404

« More »

NotAcceptableExceptionHandler

Handler for routing errors that should give a 406

« More »

NotAllowedExceptionHandler

Handler for permission errors that should give a 403

« More »

ResourceNotFoundExceptionHandler

Handler for invalid resource requests that should give a 404

« More »

SaveExceptionHandler

Handler for invalid checkin/checkout exceptions

« More »

SendEmailExceptionHandler

Handler for error when send email

« More »

Classes

CliRenderer

Cli error renderer

« More »

FeedRenderer

RSS/Atom feed error page renderer

« More »

HtmlRenderer

HTML error page renderer

« More »

JsonapiRenderer

JSON error page renderer

« More »

JsonRenderer

JSON error page renderer

« More »

XmlRenderer

XML error page renderer

« More »

Classes

AbstractEvent

This class implements the base Event object used system-wide to offer orthogonality. Core objects such as Models, Controllers, etc create such events on-the-fly and dispatch them through the application's Dispatcher (colloquially known as the "Joomla! plugin system"). This way a suitable plugin, typically a "system" plugin, can modify the behaviour of any internal class, providing system-wide services such as tags, content versioning, comments or even low-level services such as the implementation of created/modified/locked behaviours, record hit counter etc.

You can create a new Event with something like this: $event = AbstractEvent::create('onModelBeforeSomething', $myModel, $arguments); You can access the subject object from your event Listener using $event['subject']. It is up to your listener to determine whether it should apply its functionality against the subject. This AbstractEvent class implements a mutable event which is allowed to change its arguments at runtime. This is generally unadvisable. It's best to use AbstractImmutableEvent instead and constrict all your interaction to the subject class.
« More »

AbstractImmutableEvent

This class implements the immutable base Event object used system-wide to offer orthogonality.

You can create a new Event with something like this: $event = AbstractEvent::create('onModelBeforeSomething', $myModel, $arguments); You can access the subject object from your event Listener using $event['subject']. It is up to your listener to determine whether it should apply its functionality against the subject. This AbstractEvent class implements a mutable event which is allowed to change its arguments at runtime. This is generally unadvisable. It's best to use AbstractImmutableEvent instead and constrict all your interaction to the subject class.
« More »

AfterExtensionBootEvent

Event class for representing the extensions's `onBeforeExtensionBoot` event

You can create a new Event with something like this: $event = AbstractEvent::create('onModelBeforeSomething', $myModel, $arguments); You can access the subject object from your event Listener using $event['subject']. It is up to your listener to determine whether it should apply its functionality against the subject. This AbstractEvent class implements a mutable event which is allowed to change its arguments at runtime. This is generally unadvisable. It's best to use AbstractImmutableEvent instead and constrict all your interaction to the subject class.
« More »

BeforeExtensionBootEvent

Event class for representing the extensions's `onBeforeExtensionBoot` event

You can create a new Event with something like this: $event = AbstractEvent::create('onModelBeforeSomething', $myModel, $arguments); You can access the subject object from your event Listener using $event['subject']. It is up to your listener to determine whether it should apply its functionality against the subject. This AbstractEvent class implements a mutable event which is allowed to change its arguments at runtime. This is generally unadvisable. It's best to use AbstractImmutableEvent instead and constrict all your interaction to the subject class.
« More »

ErrorEvent

Event class for representing the application's `onError` event

You can create a new Event with something like this: $event = AbstractEvent::create('onModelBeforeSomething', $myModel, $arguments); You can access the subject object from your event Listener using $event['subject']. It is up to your listener to determine whether it should apply its functionality against the subject. This AbstractEvent class implements a mutable event which is allowed to change its arguments at runtime. This is generally unadvisable. It's best to use AbstractImmutableEvent instead and constrict all your interaction to the subject class.
« More »

GenericEvent

This class gives a concrete implementation of the AbstractEvent class.

You can create a new Event with something like this: $event = AbstractEvent::create('onModelBeforeSomething', $myModel, $arguments); You can access the subject object from your event Listener using $event['subject']. It is up to your listener to determine whether it should apply its functionality against the subject. This AbstractEvent class implements a mutable event which is allowed to change its arguments at runtime. This is generally unadvisable. It's best to use AbstractImmutableEvent instead and constrict all your interaction to the subject class.
« More »

Classes

BeforeBatchEvent

Event class for modifying a table object before a batch event is applied

You can create a new Event with something like this: $event = AbstractEvent::create('onModelBeforeSomething', $myModel, $arguments); You can access the subject object from your event Listener using $event['subject']. It is up to your listener to determine whether it should apply its functionality against the subject. This AbstractEvent class implements a mutable event which is allowed to change its arguments at runtime. This is generally unadvisable. It's best to use AbstractImmutableEvent instead and constrict all your interaction to the subject class.
« More »

Classes

AbstractEvent

Event class for JTable's events

You can create a new Event with something like this: $event = AbstractEvent::create('onModelBeforeSomething', $myModel, $arguments); You can access the subject object from your event Listener using $event['subject']. It is up to your listener to determine whether it should apply its functionality against the subject. This AbstractEvent class implements a mutable event which is allowed to change its arguments at runtime. This is generally unadvisable. It's best to use AbstractImmutableEvent instead and constrict all your interaction to the subject class.
« More »

AfterBindEvent

Event class for JTable's onAfterBind event

You can create a new Event with something like this: $event = AbstractEvent::create('onModelBeforeSomething', $myModel, $arguments); You can access the subject object from your event Listener using $event['subject']. It is up to your listener to determine whether it should apply its functionality against the subject. This AbstractEvent class implements a mutable event which is allowed to change its arguments at runtime. This is generally unadvisable. It's best to use AbstractImmutableEvent instead and constrict all your interaction to the subject class.
« More »

AfterCheckinEvent

Event class for JTable's onAfterCheckin event

You can create a new Event with something like this: $event = AbstractEvent::create('onModelBeforeSomething', $myModel, $arguments); You can access the subject object from your event Listener using $event['subject']. It is up to your listener to determine whether it should apply its functionality against the subject. This AbstractEvent class implements a mutable event which is allowed to change its arguments at runtime. This is generally unadvisable. It's best to use AbstractImmutableEvent instead and constrict all your interaction to the subject class.
« More »

AfterCheckoutEvent

Event class for JTable's onAfterCheckout event

You can create a new Event with something like this: $event = AbstractEvent::create('onModelBeforeSomething', $myModel, $arguments); You can access the subject object from your event Listener using $event['subject']. It is up to your listener to determine whether it should apply its functionality against the subject. This AbstractEvent class implements a mutable event which is allowed to change its arguments at runtime. This is generally unadvisable. It's best to use AbstractImmutableEvent instead and constrict all your interaction to the subject class.
« More »

AfterDeleteEvent

Event class for JTable's onAfterDelete event

You can create a new Event with something like this: $event = AbstractEvent::create('onModelBeforeSomething', $myModel, $arguments); You can access the subject object from your event Listener using $event['subject']. It is up to your listener to determine whether it should apply its functionality against the subject. This AbstractEvent class implements a mutable event which is allowed to change its arguments at runtime. This is generally unadvisable. It's best to use AbstractImmutableEvent instead and constrict all your interaction to the subject class.
« More »

AfterHitEvent

Event class for JTable's onAfterHit event

You can create a new Event with something like this: $event = AbstractEvent::create('onModelBeforeSomething', $myModel, $arguments); You can access the subject object from your event Listener using $event['subject']. It is up to your listener to determine whether it should apply its functionality against the subject. This AbstractEvent class implements a mutable event which is allowed to change its arguments at runtime. This is generally unadvisable. It's best to use AbstractImmutableEvent instead and constrict all your interaction to the subject class.
« More »

AfterLoadEvent

Event class for JTable's onAfterLoad event

You can create a new Event with something like this: $event = AbstractEvent::create('onModelBeforeSomething', $myModel, $arguments); You can access the subject object from your event Listener using $event['subject']. It is up to your listener to determine whether it should apply its functionality against the subject. This AbstractEvent class implements a mutable event which is allowed to change its arguments at runtime. This is generally unadvisable. It's best to use AbstractImmutableEvent instead and constrict all your interaction to the subject class.
« More »

AfterMoveEvent

Event class for JTable's onAfterMove event

You can create a new Event with something like this: $event = AbstractEvent::create('onModelBeforeSomething', $myModel, $arguments); You can access the subject object from your event Listener using $event['subject']. It is up to your listener to determine whether it should apply its functionality against the subject. This AbstractEvent class implements a mutable event which is allowed to change its arguments at runtime. This is generally unadvisable. It's best to use AbstractImmutableEvent instead and constrict all your interaction to the subject class.
« More »

AfterPublishEvent

Event class for JTable's onAfterPublish event

You can create a new Event with something like this: $event = AbstractEvent::create('onModelBeforeSomething', $myModel, $arguments); You can access the subject object from your event Listener using $event['subject']. It is up to your listener to determine whether it should apply its functionality against the subject. This AbstractEvent class implements a mutable event which is allowed to change its arguments at runtime. This is generally unadvisable. It's best to use AbstractImmutableEvent instead and constrict all your interaction to the subject class.
« More »

AfterReorderEvent

Event class for JTable's onAfterReorder event

You can create a new Event with something like this: $event = AbstractEvent::create('onModelBeforeSomething', $myModel, $arguments); You can access the subject object from your event Listener using $event['subject']. It is up to your listener to determine whether it should apply its functionality against the subject. This AbstractEvent class implements a mutable event which is allowed to change its arguments at runtime. This is generally unadvisable. It's best to use AbstractImmutableEvent instead and constrict all your interaction to the subject class.
« More »

AfterResetEvent

Event class for JTable's onAfterReset event

You can create a new Event with something like this: $event = AbstractEvent::create('onModelBeforeSomething', $myModel, $arguments); You can access the subject object from your event Listener using $event['subject']. It is up to your listener to determine whether it should apply its functionality against the subject. This AbstractEvent class implements a mutable event which is allowed to change its arguments at runtime. This is generally unadvisable. It's best to use AbstractImmutableEvent instead and constrict all your interaction to the subject class.
« More »

AfterStoreEvent

Event class for JTable's onAfterStore event

You can create a new Event with something like this: $event = AbstractEvent::create('onModelBeforeSomething', $myModel, $arguments); You can access the subject object from your event Listener using $event['subject']. It is up to your listener to determine whether it should apply its functionality against the subject. This AbstractEvent class implements a mutable event which is allowed to change its arguments at runtime. This is generally unadvisable. It's best to use AbstractImmutableEvent instead and constrict all your interaction to the subject class.
« More »

BeforeBindEvent

Event class for JTable's onBeforeBind event

You can create a new Event with something like this: $event = AbstractEvent::create('onModelBeforeSomething', $myModel, $arguments); You can access the subject object from your event Listener using $event['subject']. It is up to your listener to determine whether it should apply its functionality against the subject. This AbstractEvent class implements a mutable event which is allowed to change its arguments at runtime. This is generally unadvisable. It's best to use AbstractImmutableEvent instead and constrict all your interaction to the subject class.
« More »

BeforeCheckinEvent

Event class for JTable's onBeforeCheckin event

You can create a new Event with something like this: $event = AbstractEvent::create('onModelBeforeSomething', $myModel, $arguments); You can access the subject object from your event Listener using $event['subject']. It is up to your listener to determine whether it should apply its functionality against the subject. This AbstractEvent class implements a mutable event which is allowed to change its arguments at runtime. This is generally unadvisable. It's best to use AbstractImmutableEvent instead and constrict all your interaction to the subject class.
« More »

BeforeCheckoutEvent

Event class for JTable's onBeforeCheckout event

You can create a new Event with something like this: $event = AbstractEvent::create('onModelBeforeSomething', $myModel, $arguments); You can access the subject object from your event Listener using $event['subject']. It is up to your listener to determine whether it should apply its functionality against the subject. This AbstractEvent class implements a mutable event which is allowed to change its arguments at runtime. This is generally unadvisable. It's best to use AbstractImmutableEvent instead and constrict all your interaction to the subject class.
« More »

BeforeDeleteEvent

Event class for JTable's onBeforeDelete event

You can create a new Event with something like this: $event = AbstractEvent::create('onModelBeforeSomething', $myModel, $arguments); You can access the subject object from your event Listener using $event['subject']. It is up to your listener to determine whether it should apply its functionality against the subject. This AbstractEvent class implements a mutable event which is allowed to change its arguments at runtime. This is generally unadvisable. It's best to use AbstractImmutableEvent instead and constrict all your interaction to the subject class.
« More »

BeforeHitEvent

Event class for JTable's onBeforeHit event

You can create a new Event with something like this: $event = AbstractEvent::create('onModelBeforeSomething', $myModel, $arguments); You can access the subject object from your event Listener using $event['subject']. It is up to your listener to determine whether it should apply its functionality against the subject. This AbstractEvent class implements a mutable event which is allowed to change its arguments at runtime. This is generally unadvisable. It's best to use AbstractImmutableEvent instead and constrict all your interaction to the subject class.
« More »

BeforeLoadEvent

Event class for JTable's onBeforeLoad event

You can create a new Event with something like this: $event = AbstractEvent::create('onModelBeforeSomething', $myModel, $arguments); You can access the subject object from your event Listener using $event['subject']. It is up to your listener to determine whether it should apply its functionality against the subject. This AbstractEvent class implements a mutable event which is allowed to change its arguments at runtime. This is generally unadvisable. It's best to use AbstractImmutableEvent instead and constrict all your interaction to the subject class.
« More »

BeforeMoveEvent

Event class for JTable's onBeforeMove event

You can create a new Event with something like this: $event = AbstractEvent::create('onModelBeforeSomething', $myModel, $arguments); You can access the subject object from your event Listener using $event['subject']. It is up to your listener to determine whether it should apply its functionality against the subject. This AbstractEvent class implements a mutable event which is allowed to change its arguments at runtime. This is generally unadvisable. It's best to use AbstractImmutableEvent instead and constrict all your interaction to the subject class.
« More »

BeforePublishEvent

Event class for JTable's onBeforePublish event

You can create a new Event with something like this: $event = AbstractEvent::create('onModelBeforeSomething', $myModel, $arguments); You can access the subject object from your event Listener using $event['subject']. It is up to your listener to determine whether it should apply its functionality against the subject. This AbstractEvent class implements a mutable event which is allowed to change its arguments at runtime. This is generally unadvisable. It's best to use AbstractImmutableEvent instead and constrict all your interaction to the subject class.
« More »

BeforeReorderEvent

Event class for JTable's onBeforeReorder event

You can create a new Event with something like this: $event = AbstractEvent::create('onModelBeforeSomething', $myModel, $arguments); You can access the subject object from your event Listener using $event['subject']. It is up to your listener to determine whether it should apply its functionality against the subject. This AbstractEvent class implements a mutable event which is allowed to change its arguments at runtime. This is generally unadvisable. It's best to use AbstractImmutableEvent instead and constrict all your interaction to the subject class.
« More »

BeforeResetEvent

Event class for JTable's onBeforeReset event

You can create a new Event with something like this: $event = AbstractEvent::create('onModelBeforeSomething', $myModel, $arguments); You can access the subject object from your event Listener using $event['subject']. It is up to your listener to determine whether it should apply its functionality against the subject. This AbstractEvent class implements a mutable event which is allowed to change its arguments at runtime. This is generally unadvisable. It's best to use AbstractImmutableEvent instead and constrict all your interaction to the subject class.
« More »

BeforeStoreEvent

Event class for JTable's onBeforeStore event

You can create a new Event with something like this: $event = AbstractEvent::create('onModelBeforeSomething', $myModel, $arguments); You can access the subject object from your event Listener using $event['subject']. It is up to your listener to determine whether it should apply its functionality against the subject. This AbstractEvent class implements a mutable event which is allowed to change its arguments at runtime. This is generally unadvisable. It's best to use AbstractImmutableEvent instead and constrict all your interaction to the subject class.
« More »

CheckEvent

Event class for JTable's onCheck event

You can create a new Event with something like this: $event = AbstractEvent::create('onModelBeforeSomething', $myModel, $arguments); You can access the subject object from your event Listener using $event['subject']. It is up to your listener to determine whether it should apply its functionality against the subject. This AbstractEvent class implements a mutable event which is allowed to change its arguments at runtime. This is generally unadvisable. It's best to use AbstractImmutableEvent instead and constrict all your interaction to the subject class.
« More »

ObjectCreateEvent

Event class for JTable's onObjectCreate event

You can create a new Event with something like this: $event = AbstractEvent::create('onModelBeforeSomething', $myModel, $arguments); You can access the subject object from your event Listener using $event['subject']. It is up to your listener to determine whether it should apply its functionality against the subject. This AbstractEvent class implements a mutable event which is allowed to change its arguments at runtime. This is generally unadvisable. It's best to use AbstractImmutableEvent instead and constrict all your interaction to the subject class.
« More »

SetNewTagsEvent

Event class for JTable's onSetNewTags event

You can create a new Event with something like this: $event = AbstractEvent::create('onModelBeforeSomething', $myModel, $arguments); You can access the subject object from your event Listener using $event['subject']. It is up to your listener to determine whether it should apply its functionality against the subject. This AbstractEvent class implements a mutable event which is allowed to change its arguments at runtime. This is generally unadvisable. It's best to use AbstractImmutableEvent instead and constrict all your interaction to the subject class.
« More »

Classes

DisplayEvent

Event class for WebAsset events

You can create a new Event with something like this: $event = AbstractEvent::create('onModelBeforeSomething', $myModel, $arguments); You can access the subject object from your event Listener using $event['subject']. It is up to your listener to determine whether it should apply its functionality against the subject. This AbstractEvent class implements a mutable event which is allowed to change its arguments at runtime. This is generally unadvisable. It's best to use AbstractImmutableEvent instead and constrict all your interaction to the subject class.
« More »

Classes

AbstractEvent

Event class for WebAsset events

You can create a new Event with something like this: $event = AbstractEvent::create('onModelBeforeSomething', $myModel, $arguments); You can access the subject object from your event Listener using $event['subject']. It is up to your listener to determine whether it should apply its functionality against the subject. This AbstractEvent class implements a mutable event which is allowed to change its arguments at runtime. This is generally unadvisable. It's best to use AbstractImmutableEvent instead and constrict all your interaction to the subject class.
« More »

WebAssetRegistryAssetChanged

Event class for WebAssetRegistry "asset changed" events

You can create a new Event with something like this: $event = AbstractEvent::create('onModelBeforeSomething', $myModel, $arguments); You can access the subject object from your event Listener using $event['subject']. It is up to your listener to determine whether it should apply its functionality against the subject. This AbstractEvent class implements a mutable event which is allowed to change its arguments at runtime. This is generally unadvisable. It's best to use AbstractImmutableEvent instead and constrict all your interaction to the subject class.
« More »

Classes

AbstractEvent

Event class for WebAsset events

You can create a new Event with something like this: $event = AbstractEvent::create('onModelBeforeSomething', $myModel, $arguments); You can access the subject object from your event Listener using $event['subject']. It is up to your listener to determine whether it should apply its functionality against the subject. This AbstractEvent class implements a mutable event which is allowed to change its arguments at runtime. This is generally unadvisable. It's best to use AbstractImmutableEvent instead and constrict all your interaction to the subject class.
« More »

WorkflowFunctionalityUsedEvent

Event class for Workflow Functionality Used events

You can create a new Event with something like this: $event = AbstractEvent::create('onModelBeforeSomething', $myModel, $arguments); You can access the subject object from your event Listener using $event['subject']. It is up to your listener to determine whether it should apply its functionality against the subject. This AbstractEvent class implements a mutable event which is allowed to change its arguments at runtime. This is generally unadvisable. It's best to use AbstractImmutableEvent instead and constrict all your interaction to the subject class.
« More »

WorkflowTransitionEvent

Event class for Workflow Functionality Used events

You can create a new Event with something like this: $event = AbstractEvent::create('onModelBeforeSomething', $myModel, $arguments); You can access the subject object from your event Listener using $event['subject']. It is up to your listener to determine whether it should apply its functionality against the subject. This AbstractEvent class implements a mutable event which is allowed to change its arguments at runtime. This is generally unadvisable. It's best to use AbstractImmutableEvent instead and constrict all your interaction to the subject class.
« More »

Classes

ExceptionHandler

Displays the custom error page when an uncaught exception occurs.

« More »

Traits

ExtensionManagerTrait

Trait for classes which can load extensions

« More »

Interfaces

BootableExtensionInterface

Interface which defines that an extension can be booted.

« More »

ComponentInterface

Access to component specific services.

« More »

ExtensionManagerInterface

Loads extensions.

« More »

ModuleInterface

Access to module specific services.

« More »

PluginInterface

Access to plugin specific services.

« More »

Classes

Component

Access to component specific services.

« More »

DummyPlugin

Placeholder plugin.

« More »

LegacyComponent

Access to component specific services.

« More »

Module

Access to module specific services.

« More »

MVCComponent

MVC Component class.

« More »

Classes

CategoryFactory

Service provider for the service categories.

« More »

ComponentDispatcherFactory

Service provider for the service dispatcher factory.

« More »

HelperFactory

Service provider for the service helper factory.

« More »

Module

Service provider for the service based modules.

« More »

ModuleDispatcherFactory

Service provider for the service dispatcher factory.

« More »

MVCFactory

Service provider for the service MVC factory.

« More »

RouterFactory

Service provider for the service router factory.

« More »

Classes

Feed

Class to encapsulate a feed for the Joomla Platform.

« More »

FeedEntry

Class to encapsulate a feed entry for the Joomla Platform.

« More »

FeedFactory

Feed factory class.

« More »

FeedParser

Feed Parser class.

« More »

FeedPerson

Feed Person class.

« More »

Interfaces

NamespaceParserInterface

Feed Namespace interface.

« More »

Classes

AtomParser

ATOM Feed Parser class.

« More »

RssParser

RSS Feed Parser class.

« More »

Classes

ItunesRssParser

RSS Feed Parser Namespace handler for iTunes.

« More »

MediaRssParser

RSS Feed Parser Namespace handler for MediaRSS.

« More »

Interfaces

FieldsServiceInterface

The fields service.

« More »

Classes

File

A File handling class

« More »

FilesystemHelper

File system helper

Holds support functions for the filesystem, particularly the stream
« More »

Folder

A Folder handling class

« More »

Patcher

A Unified Diff Format Patcher class

« More »

Path

A Path handling class

« More »

Stream

Joomla! Stream Interface

The Joomla! stream interface is designed to handle files as streams where as the legacy File static class treated files in a rather atomic manner.
« More »

Classes

StreamString

String Stream Wrapper

This class allows you to use a PHP string in the same way that you would normally use a regular stream wrapper
« More »

Classes

StringController

String Controller

« More »

Classes

OutputFilter

OutputFilter

« More »

Traits

FormFactoryAwareTrait

Defines the trait for a FormFactoryInterface Aware Class.

« More »

Interfaces

FormFactoryAwareInterface

Interface to be implemented by classes depending on a form factory.

« More »

FormFactoryInterface

Interface defining a factory which can create Form objects

« More »

FormFilterInterface

Interface for a filter class.

« More »

Classes

Form

Form Class for the Joomla Platform.

This class implements a robust API for constructing, populating, filtering, and validating forms. It uses XML definitions to construct form fields and a variety of field and rule classes to render and validate the form.
« More »

FormFactory

Default factory for creating Form objects

« More »

FormField

Abstract Form Field class for the Joomla Platform.

« More »

FormHelper

Form's helper class.

Provides a storage for filesystem's paths where Form's entities reside and methods for creating those entities. Also stores objects with entities' prototypes for further reusing.
« More »

FormRule

Form Rule class for the Joomla Platform.

« More »

Classes

AccessiblemediaField

The Field to load the form inside current form

« More »

AccesslevelField

Form Field class for the Joomla Platform.

Provides a list of access levels. Access levels control what users in specific groups can see.
« More »

AliastagField

Form Field class for the Joomla Framework.

Supports a generic list of options.
« More »

AuthorField

Form Field to load a list of content authors

Supports a generic list of options.
« More »

CachehandlerField

Form Field class for the Joomla Platform.

Provides a list of available cache handlers
« More »

CalendarField

Form Field class for the Joomla Platform.

Provides a pop up date picker linked to a button. Optionally may be filtered to use user's or server's time zone.
« More »

CaptchaField

Captcha field.

« More »

CategoryField

Form Field class for the Joomla Platform.

Supports an HTML select list of categories
« More »

CheckboxesField

Form Field class for the Joomla Platform.

Displays options as a list of checkboxes. Multiselect may be forced to be true.
« More »

CheckboxField

Form Field class for the Joomla Platform.

Single checkbox field. This is a boolean field with null for false and the specified option for true
« More »

ChromestyleField

Chrome Styles field.

Provides a grouped list select field.
« More »

ColorField

Color Form Field class for the Joomla Platform.

This implementation is designed to be compatible with HTML5's `<input type="color">`
« More »

ComboField

Form Field class for the Joomla Platform.

Implements a combo box field.
« More »

ComponentlayoutField

Form Field to display a list of the layouts for a component view from the extension or template overrides.

« More »

ComponentsField

Form Field class for the Joomla Framework.

Supports a generic list of options.
« More »

ContenthistoryField

Field to select Content History from a modal list.

« More »

ContentlanguageField

Provides a list of content languages

Supports a generic list of options.
« More »

ContenttypeField

Content Type field.

Supports a generic list of options.
« More »

DatabaseconnectionField

Form Field class for the Joomla Platform.

Provides a list of available database connections, optionally limiting to a given list.
« More »

EditorField

A textarea field for content creation

Supports a multi line area for entry of plain text
« More »

EmailField

Form Field class for the Joomla Platform.

Provides and input field for email addresses
« More »

FileField

Form Field class for the Joomla Platform.

Provides an input field for files
« More »

FilelistField

Supports an HTML select list of files

Supports a generic list of options.
« More »

FolderlistField

Supports an HTML select list of folder

Supports a generic list of options.
« More »

FrontendlanguageField

Provides a list of published content languages with home pages

Supports a generic list of options.
« More »

GroupedlistField

Form Field class for the Joomla Platform.

Provides a grouped list select field.
« More »

HeadertagField

Form Field class for the Joomla! CMS.

Supports a generic list of options.
« More »

HiddenField

Form Field class for the Joomla Platform.

Provides a hidden field
« More »

ImagelistField

Supports an HTML select list of image

Supports a generic list of options.
« More »

IntegerField

Form Field class for the Joomla Platform.

Provides a select list of integers with specified first, last and step values.
« More »

LanguageField

Form Field class for the Joomla Platform.

Supports a list of installed application languages
« More »

LastvisitdaterangeField

Field to show a list of available date ranges to filter on last visit date.

Supports a generic list of options.
« More »

LimitboxField

Field to load a list of possible item count limits

Supports a generic list of options.
« More »

ListField

Form Field class for the Joomla Platform.

Supports a generic list of options.
« More »

MediaField

Provides a modal media selector including upload mechanism

« More »

MenuField

Supports an HTML select list of menus

Provides a grouped list select field.
« More »

MenuitemField

Supports an HTML grouped select list of menu item grouped by menu

Provides a grouped list select field.
« More »

MeterField

Form Field class for the Joomla Platform.

Provides a meter to show value in a range.
« More »

ModulelayoutField

Form Field to display a list of the layouts for module display from the module or template overrides.

« More »

ModuleorderField

Module Order field.

« More »

ModulepositionField

Module Position field.

Supports a one line text field.
« More »

ModuletagField

Module Tag field.

Supports a generic list of options.
« More »

NoteField

Form Field class for the Joomla Platform.

Supports a one line text field.
« More »

NumberField

Form Field class for the Joomla Platform.

Provides a one line text box with up-down handles to set a number in the field.
« More »

OrderingField

Ordering field.

« More »

PasswordField

Form Field class for the Joomla Platform.

Text field for passwords
« More »

PluginsField

Form Field class for the Joomla Framework.

Supports a generic list of options.
« More »

PluginstatusField

Plugin Status field.

Supports a generic list of options.
« More »

PredefinedlistField

Form Field to load a list of predefined values

Supports a generic list of options.
« More »

RadiobasicField

Form Field class for the Joomla Platform.

Provides radio button inputs using default styling
« More »

RadioField

Form Field class for the Joomla Platform.

Provides radio button inputs
« More »

RangeField

Form Field class for the Joomla Platform.

Provides a horizontal scroll bar to specify a value in a range.
« More »

RedirectStatusField

Redirect Status field.

Supports a generic list of options.
« More »

RegistrationdaterangeField

Registration Date Range field.

Supports a generic list of options.
« More »

RulesField

Form Field class for the Joomla Platform.

Field for assigning permissions to groups for a given asset
« More »

SessionhandlerField

Form Field class for the Joomla Platform.

Provides a select list of session handler options.
« More »

SpacerField

Form Field class for the Joomla Platform.

Provides spacer markup to be used in form layouts.
« More »

SqlField

Supports a custom SQL select list

Supports a generic list of options.
« More »

StatusField

Form Field to load a list of states

Supports a generic list of options.
« More »

SubformField

The Field to load the form inside current form

« More »

TagField

List of Tags field.

Supports a generic list of options.
« More »

TelephoneField

Form Field class for the Joomla Platform.

Supports a text field telephone numbers.
« More »

TemplatestyleField

Supports a select grouped list of template styles

Provides a grouped list select field.
« More »

TextareaField

Form Field class for the Joomla Platform.

Supports a multi line area for entry of plain text
« More »

TextField

Form Field class for the Joomla Platform.

Supports a one line text field.
« More »

TimeField

Form Field class for the Joomla Platform.

Provides a select list of integers with specified first, last and step values.
« More »

TimezoneField

Form Field class for the Joomla Platform.

Provides a grouped list select field.
« More »

TransitionField

Components Category field.

Supports a generic list of options.
« More »

UrlField

Form Field class for the Joomla Platform.

Supports a URL text field
« More »

UseractiveField

Field to show a list of available user active statuses

Supports a generic list of options.
« More »

UserField

Field to select a user ID from a modal list.

« More »

UsergrouplistField

Field to load a dropdown list of available user groups

Supports a generic list of options.
« More »

UserstateField

Field to load a list of available users statuses

Supports a generic list of options.
« More »

WorkflowComponentSectionsField

Form Field class for the Joomla Framework.

Supports a generic list of options.
« More »

WorkflowconditionField

Workflow States field.

Supports a generic list of options.
« More »

WorkflowstageField

Workflow Stages field.

Provides a grouped list select field.
« More »

Classes

IntarrayFilter

Form Filter class for integer arrays

« More »

RawFilter

Form Filter class for raw values

« More »

RulesFilter

Form Filter class for rules

« More »

SafehtmlFilter

Form Filter class for safe HTML

« More »

TelFilter

Form Filter class for phone numbers

« More »

UnsetFilter

Form Filter class to unset

« More »

UrlFilter

Form Filter class for URLs

« More »

Classes

BooleanRule

Form Rule class for the Joomla Platform.

« More »

CalendarRule

Form Rule class for the Joomla Platform

« More »

CaptchaRule

Form Rule class for the Joomla Framework.

« More »

ColorRule

Form Rule class for the Joomla Platform.

« More »

CssIdentifierRule

Form Rule class for the Joomla Platform.

« More »

EmailRule

Form Rule class for the Joomla Platform.

« More »

EqualsRule

Form Rule class for the Joomla Platform.

« More »

ExistsRule

Form rule class to determine if a value exists in a database table.

« More »

FilePathRule

Form Rule class for the Joomla Platform.

« More »

FolderPathExistsRule

Form Rule class for the Joomla CMS.

« More »

ModuleLayoutRule

Form Rule class for the Joomla Platform.

« More »

NotequalsRule

Form Rule class for the Joomla Platform.

« More »

NumberRule

Form Rule class for the Joomla Platform.

« More »

OptionsRule

Form Rule class for the Joomla Platform.

Requires the value entered be one of the options in a field of type="list"
« More »

PasswordRule

Form Rule class for the Joomla Platform.

« More »

RulesRule

Form Rule class for the Joomla Platform.

« More »

SubformRule

Form rule to validate subforms field-wise.

« More »

TelRule

Form Rule class for the Joomla Platform

« More »

TimeRule

Form Rule class for the Joomla Platform.

« More »

UrlRule

Form Rule class for the Joomla Platform.

« More »

UserIdRule

Form Rule class for the Joomla Platform.

« More »

UsernameRule

Form Rule class for the Joomla Platform.

« More »

Classes

Help

Help system class

« More »

Interfaces

HelperFactoryInterface

Factory to load helper classes.

« More »

Classes

AuthenticationHelper

Authentication helper class

« More »

CMSHelper

Base Helper class.

« More »

ContentHelper

Helper for standard content style extensions.

This class mainly simplifies static helper methods often repeated in individual components
« More »

HelperFactory

Namespace based implementation of the HelperFactoryInterface

« More »

LibraryHelper

Library helper class

« More »

ModuleHelper

Module helper class

« More »

RouteHelper

Route Helper

A class providing basic routing for urls that are for content types found in the #__content_types table and rows found in the #__ucm_content table.
« More »

TagsHelper

Tags helper class, provides methods to perform various tasks relevant tagging of content.

« More »

UserGroupsHelper

Helper to deal with user groups.

« More »

Traits

HTMLRegistryAwareTrait

Defines the trait for a HTML Registry aware class.

« More »

Classes

Registry

Service registry for JHtml services

« More »

Classes

Access

Extended Utility class for all HTML drawing classes.

« More »

ActionsDropdown

HTML utility class for building a dropdown menu

« More »

AdminLanguage

Utility class working with administrator language select lists

« More »

Behavior

Utility class for JavaScript behaviors

« More »

Bootstrap

Utility class for Bootstrap elements.

« More »

Category

Utility class for categories

« More »

Content

Utility class to fire onContentPrepare for non-article based content.

« More »

ContentLanguage

Utility class working with content language select lists

« More »

Date

Extended Utility class for handling date display.

« More »

Debug

Extended Utility class for render debug information.

« More »

DraggableList

HTML utility class for creating a sortable table list

« More »

Dropdown

HTML utility class for building a dropdown menu

« More »

Email

Utility class for cloaking email addresses

« More »

Form

Utility class for form elements

« More »

FormBehavior

Utility class for form related behaviors

« More »

Grid

Utility class for creating HTML Grids

« More »

Icons

Utility class for icons.

« More »

JGrid

Utility class for creating HTML Grids

« More »

Jquery

Utility class for jQuery JavaScript behaviors

« More »

Menu

Utility class working with menu select lists

« More »

Number

HTML helper class for rendering numbers.

« More »

SearchTools

Searchtools elements.

« More »

Select

Utility class for creating HTML select lists

« More »

Sidebar

Utility class to render a list view sidebar

« More »

SortableList

HTML utility class for creating a sortable table list

« More »

StringHelper

HTML helper class for rendering manipulated strings.

« More »

Tag

Utility class for tags

« More »

Telephone

HTML helper class for rendering telephone numbers.

« More »

UiTab

Utility class for the Joomla core UI Tab element.

« More »

User

Utility class working with users

« More »

WorkflowStage

Utility class working with workflow states select lists

« More »

Interfaces

TransportInterface

HTTP transport class interface.

« More »

Classes

Http

HTTP client class.

« More »

HttpFactory

HTTP factory class.

« More »

Response

HTTP response data object class.

« More »

Classes

CurlTransport

HTTP transport class for using cURL.

« More »

SocketTransport

HTTP transport class for using sockets directly.

« More »

StreamTransport

HTTP transport class for using PHP streams.

« More »

Classes

Image

Class to manipulate an image.

« More »

ImageFilter

Class to manipulate an image.

« More »

Classes

UnparsableImageException

Exception thrown when an image has no known properties.

« More »

Classes

Backgroundfill

Image Filter class fill background with color;

« More »

Brightness

Image Filter class adjust the brightness of an image.

« More »

Contrast

Image Filter class adjust the contrast of an image.

« More »

Edgedetect

Image Filter class to add an edge detect effect to an image.

« More »

Emboss

Image Filter class to emboss an image.

« More »

Grayscale

Image Filter class to transform an image to grayscale.

« More »

Negate

Image Filter class to negate the colors of an image.

« More »

Sketchy

Image Filter class to make an image appear "sketchy".

« More »

Smooth

Image Filter class adjust the smoothness of an image.

« More »

Classes

Cli

Joomla! Input CLI Class

This is an abstracted input class used to manage retrieving data from the application environment.
« More »

Files

Joomla! Input Files Class

This is an abstracted input class used to manage retrieving data from the application environment.
« More »

Input

Joomla! Input Base Class

This is an abstracted input class used to manage retrieving data from the application environment.
« More »

Json

Joomla! Input JSON Class

This class decodes a JSON string from the raw request data and makes it available via the standard JInput interface.
« More »

Classes

Installer

Joomla base installer class

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

InstallerAdapter

Abstract adapter for the installer.

« More »

InstallerExtension

Extension object

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

InstallerHelper

Installer helper class

« More »

InstallerScript

Base install script for use by extensions providing helper methods for common behaviours.

« More »

Manifest

Joomla! Package Manifest File

« More »

Classes

ComponentAdapter

Component installer

« More »

FileAdapter

File installer

« More »

LanguageAdapter

Language installer

« More »

LibraryAdapter

Library installer

« More »

ModuleAdapter

Module installer

« More »

PackageAdapter

Package installer

« More »

PluginAdapter

Plugin installer

« More »

TemplateAdapter

Template installer

« More »

Classes

LibraryManifest

Joomla! Library Manifest File

« More »

PackageManifest

Joomla! Package Manifest File

« More »

Interfaces

LanguageFactoryInterface

Interface defining a factory which can create language objects

« More »

Classes

Associations

Utility class for associations in multilang

« More »

CachingLanguageFactory

Caching factory for creating language objects. The requested languages are cached in memory.

« More »

Language

Languages/translation handler class

« More »

LanguageFactory

Default factory for creating language objects

« More »

LanguageHelper

Language helper class

« More »

Multilanguage

Utility class for multilang

« More »

Text

Text handling class.

« More »

Transliterate

Class to transliterate strings

« More »

Interfaces

LayoutInterface

Interface to handle display layout

« More »

Classes

BaseLayout

Base class for rendering a display layout

« More »

FileLayout

Base class for rendering a display layout loaded from from a layout file

« More »

LayoutHelper

Helper to render a Layout object, storing a base path

« More »

Classes

DelegatingPsrLogger

Delegating logger which delegates log messages received from the PSR-3 interface to the Joomla! Log object.

« More »

Log

Joomla! Log Class

This class hooks into the global log configuration settings to allow for user configured logging events to be sent to where the user wishes them to be sent. On high load sites Syslog is probably the best (pure PHP function), then the text file based loggers (CSV, W3c or plain Formattedtext) and finally MySQL offers the most features (e.g. rapid searching) but will incur a performance hit due to INSERT being issued.
« More »

LogEntry

Joomla! Log Entry class

This class is designed to hold log entries for either writing to an engine, or for supported engines, retrieving lists and building in memory (PHP based) search operations.
« More »

Logger

Joomla! Logger Base Class

This class is used to be the basis of logger classes to allow for defined functions to exist regardless of the child class.
« More »

LoggerRegistry

Service registry for loggers

« More »

Classes

CallbackLogger

Joomla! Callback Log class

This class allows logging to be handled by a callback function. This allows unprecedented flexibility in the way logging can be handled.
« More »

DatabaseLogger

Joomla! MySQL Database Log class

This class is designed to output logs to a specific MySQL database table. Fields in this table are based on the Syslog style of log output. This is designed to allow quick and easy searching.
« More »

EchoLogger

Joomla Echo logger class.

This class is used to be the basis of logger classes to allow for defined functions to exist regardless of the child class.
« More »

FormattedtextLogger

Joomla! Formatted Text File Log class

This class is designed to use as a base for building formatted text files for output. By default it emulates the Syslog style format output. This is a disk based output format.
« More »

InMemoryLogger

Logger class that keeps all entries in memory

This class is used to be the basis of logger classes to allow for defined functions to exist regardless of the child class.
« More »

MessagequeueLogger

Joomla MessageQueue logger class.

This class is designed to output logs to a specific MySQL database table. Fields in this table are based on the Syslog style of log output. This is designed to allow quick and easy searching.
« More »

SyslogLogger

Joomla! Syslog Log class

This class is designed to call the PHP Syslog function call which is then sent to the system wide log system. For Linux/Unix based systems this is the syslog subsystem, for the Windows based implementations this can be found in the Event Log. For Windows, permissions may prevent PHP from properly outputting messages.
« More »

W3cLogger

Joomla! W3C Logging class

This class is designed to build log files based on the W3C specification.
« More »

Classes

Mail

Email Class. Provides a common interface to send email from the Joomla! Platform

« More »

MailHelper

Email helper class, provides static methods to perform various tasks relevant to the Joomla email routines.

TODO: Test these methods as the regex work is first run and not tested thoroughly
« More »

MailTemplate

Email Templating Class

« More »

Interfaces

MenuFactoryInterface

Interface defining a factory which can create Menu objects

« More »

Classes

AbstractMenu

Menu class

« More »

AdministratorMenu

Menu class.

« More »

AdministratorMenuItem

Object representing an administrator menu item

« More »

MenuFactory

Default factory for creating Menu objects

« More »

MenuItem

Object representing a menu item

« More »

SiteMenu

Menu class

« More »

Classes

Microdata

Joomla Platform class for interacting with Microdata semantics.

« More »

Interfaces

ControllerInterface

Joomla Platform CMS Interface

« More »

Classes

CheckinCheckout

Checkin/checkout Exception

« More »

ResourceNotFound

Exception class defining a resource not found exception

« More »

Save

Exception saving data

« More »

SendEmail

Send email Exception

« More »

Traits

MVCFactoryAwareTrait

MVCFactory aware trait.

« More »

MVCFactoryServiceTrait

Defines the trait for a MVC factory service class.

« More »

Interfaces

MVCFactoryInterface

Factory to create MVC objects.

« More »

MVCFactoryServiceInterface

Interface to be implemented by classes depending on a MVC factory.

« More »

Classes

ApiMVCFactory

Factory to create MVC objects based on a namespace. Note that in an API Application model and table objects will be created from their administrator counterparts.

« More »

LegacyFactory

Factory to create MVC objects in legacy mode.

Uses the static getInstance function on the classes itself. Behavior of the old none namespaced extension set up.
« More »

MVCFactory

Factory to create MVC objects based on a namespace.

« More »

Traits

DatabaseAwareTrait

Database aware trait.

« More »

FormBehaviorTrait

Trait which supports form behavior.

« More »

StateBehaviorTrait

Trait which supports state behavior

« More »

Interfaces

DatabaseModelInterface

Interface for a database model.

« More »

FormModelInterface

Interface for a form model.

« More »

ItemModelInterface

Interface for an item model.

« More »

ListModelInterface

Interface for a list model.

« More »

ModelInterface

Interface for a base model.

« More »

StatefulModelInterface

Interface for a stateful model.

« More »

WorkflowModelInterface

Interface for a workflow model.

« More »

Classes

AdminModel

Prototype admin model.

Acts as a Factory class for application specific objects and provides many supporting API functions.
« More »

BaseDatabaseModel

Base class for a database aware Joomla Model

Acts as a Factory class for application specific objects and provides many supporting API functions.
« More »

BaseModel

Base class for a Joomla Model

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

FormModel

Prototype form model.

Acts as a Factory class for application specific objects and provides many supporting API functions.
« More »

ItemModel

Prototype item model.

Acts as a Factory class for application specific objects and provides many supporting API functions.
« More »

ListModel

Model class for handling lists of items.

Acts as a Factory class for application specific objects and provides many supporting API functions.
« More »

Interfaces

ViewInterface

Joomla Platform CMS Interface

« More »

Classes

AbstractView

Base class for a Joomla View

Class holding methods for displaying presentation data.
« More »

CategoriesView

Categories view base class.

Class holding methods for displaying presentation data.
« More »

CategoryFeedView

Base feed View class for a category

Class holding methods for displaying presentation data.
« More »

CategoryView

Base HTML View class for the a Category list

Class holding methods for displaying presentation data.
« More »

FormView

Base class for a Joomla Form View

Class holding methods for displaying presentation data.
« More »

GenericDataException

Exception class defining an error getting data from a model into a view

« More »

HtmlView

Base class for a Joomla Html View

Class holding methods for displaying presentation data.
« More »

JsonView

Base class for a Joomla Json View

Class holding methods for displaying presentation data.
« More »

ListView

Base class for a Joomla List View

Class holding methods for displaying presentation data.
« More »

Classes

CMSObject

Joomla Platform Object Class

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

Classes

Pagination

Pagination Class. Provides a common interface for content pagination for the Joomla! CMS.

« More »

PaginationObject

Pagination object representing a particular item in the pagination lists.

« More »

Classes

Pathway

Class to maintain a pathway.

The user's navigated path within the application.
« More »

SitePathway

Class to manage the site application pathway.

The user's navigated path within the application.
« More »

Classes

CMSPlugin

Plugin Class

« More »

PluginHelper

Plugin helper class

« More »

Classes

Profiler

Utility class to assist in the process of benchmarking the execution of sections of code to understand where time is being spent.

« More »

Classes

JsonResponse

JSON Response class.

This class serves to provide the Joomla Platform with a common interface to access response variables for e.g. Ajax requests.
« More »

Classes

AdministratorRouter

Class to create and parse routes

« More »

ApiRouter

Joomla! API Router class

« More »

Route

Route handling class

« More »

Router

Class to create and parse routes

« More »

SiteRouter

Class to create and parse routes for the site application

« More »

Classes

RouteNotFoundException

Exception class defining an error for a missing route

« More »

Classes

ChangeItem

Each object represents one query, which is one line from a DDL SQL query.

This class is used to check the site's database to see if the DDL query has been run. If not, it provides the ability to fix the database by re-running the DDL query. The queries are parsed from the update files in the folder `administrator/components/com_admin/sql/updates/<database>`. These updates are run automatically if the site was updated using com_installer. However, it is possible that the program files could be updated without updating the database (for example, if a user just copies the new files over the top of an existing installation). This is an abstract class. We need to extend it for each database and add a buildCheckQuery() method that creates the query to check that a DDL query has been run.
« More »

ChangeSet

Contains a set of JSchemaChange objects for a particular instance of Joomla.

Each of these objects contains a DDL query that should have been run against the database when this database was created or updated. This enables the Installation Manager to check that the current database schema is up to date.
« More »

Classes

MysqlChangeItem

Checks the database schema against one MySQL DDL query to see if it has been run.

This class is used to check the site's database to see if the DDL query has been run. If not, it provides the ability to fix the database by re-running the DDL query. The queries are parsed from the update files in the folder `administrator/components/com_admin/sql/updates/<database>`. These updates are run automatically if the site was updated using com_installer. However, it is possible that the program files could be updated without updating the database (for example, if a user just copies the new files over the top of an existing installation). This is an abstract class. We need to extend it for each database and add a buildCheckQuery() method that creates the query to check that a DDL query has been run.
« More »

PostgresqlChangeItem

Checks the database schema against one PostgreSQL DDL query to see if it has been run.

This class is used to check the site's database to see if the DDL query has been run. If not, it provides the ability to fix the database by re-running the DDL query. The queries are parsed from the update files in the folder `administrator/components/com_admin/sql/updates/<database>`. These updates are run automatically if the site was updated using com_installer. However, it is possible that the program files could be updated without updating the database (for example, if a user just copies the new files over the top of an existing installation). This is an abstract class. We need to extend it for each database and add a buildCheckQuery() method that creates the query to check that a DDL query has been run.
« More »

SqlsrvChangeItem

Checks the database schema against one SQL Server DDL query to see if it has been run.

This class is used to check the site's database to see if the DDL query has been run. If not, it provides the ability to fix the database by re-running the DDL query. The queries are parsed from the update files in the folder `administrator/components/com_admin/sql/updates/<database>`. These updates are run automatically if the site was updated using com_installer. However, it is possible that the program files could be updated without updating the database (for example, if a user just copies the new files over the top of an existing installation). This is an abstract class. We need to extend it for each database and add a buildCheckQuery() method that creates the query to check that a DDL query has been run.
« More »

Classes

JoomlaSerializer

This class does the messy job of sanitising all the classes Joomla has that contain data and converting them into a standard array that can be consumed by the Tobscure library. It also throws appropriate plugin events to allow 3rd party extensions to add custom data and relations into these properties before they are rendered

« More »

Classes

OnGetApiAttributes

Event for getting extra data attributes for an API Entity

You can create a new Event with something like this: $event = AbstractEvent::create('onModelBeforeSomething', $myModel, $arguments); You can access the subject object from your event Listener using $event['subject']. It is up to your listener to determine whether it should apply its functionality against the subject. This AbstractEvent class implements a mutable event which is allowed to change its arguments at runtime. This is generally unadvisable. It's best to use AbstractImmutableEvent instead and constrict all your interaction to the subject class.
« More »

Classes

ApiRouter

Service provider for the application's API router dependency

« More »

Application

Application service provider

« More »

Authentication

Service provider for the authentication dependencies

« More »

CacheController

Service provider for the cache controller dependency

« More »

Config

Service provider for the application's config dependency

« More »

Console

Service provider for the application's console services

« More »

Database

Service provider for the application's database dependency

« More »

Dispatcher

Service provider for the application's event dispatcher dependency

« More »

Document

Service provider for the application's document dependency

« More »

Form

Service provider for the form dependency

« More »

HTMLRegistry

Service provider for the HTML service registry

« More »

Language

Service provider for the language dependency

« More »

Logger

Service provider for the application's PSR-3 logger dependency

« More »

Menu

Service provider for the application's menu dependency

« More »

Pathway

Service provider for the application's pathway dependency

« More »

Session

Service provider for the application's session dependency

« More »

Toolbar

Service provider for the application's toolbar dependency

« More »

User

Service provider for the user dependency

« More »

WebAssetRegistry

Service provider for the application's WebAsset dependency

« More »

Classes

MetadataManager

Manager for optional session metadata.

« More »

Session

Class for managing HTTP sessions

« More »

SessionFactory

Factory for creating session API objects

« More »

SessionManager

Manager for interacting with the session handler to perform updates on sessions.

« More »

Classes

MetadataManagerListener

Event listener for session events regarding the session metadata for users.

« More »

Classes

UnsupportedStorageException

Exception class defining an unsupported session storage object

« More »

Classes

JoomlaStorage

Service provider for the application's session dependency

« More »

Classes

PunycodeHelper

Joomla Platform String Punycode Class

Class for handling UTF-8 URLs Wraps the Punycode library All functions assume the validity of utf-8 URLs.
« More »

Interfaces

TableInterface

Table class interface.

« More »

Classes

Asset

Table class supporting modified pre-order tree traversal behavior.

Parent class to all tables.
« More »

Category

Category table

Parent class to all tables.
« More »

Content

Content table

Parent class to all tables.
« More »

ContentHistory

Content History table.

Parent class to all tables.
« More »

ContentType

Tags table

Parent class to all tables.
« More »

CoreContent

Core content table

Parent class to all tables.
« More »

Extension

Extension table

Parent class to all tables.
« More »

Language

Languages table.

Parent class to all tables.
« More »

Menu

Menu table

Parent class to all tables.
« More »

MenuType

Menu Types table

Parent class to all tables.
« More »

Module

Module table

Parent class to all tables.
« More »

Nested

Table class supporting modified pre-order tree traversal behavior.

Parent class to all tables.
« More »

Table

Abstract Table class

Parent class to all tables.
« More »

Ucm

UCM map table

Parent class to all tables.
« More »

Update

Update table Stores updates temporarily

Parent class to all tables.
« More »

UpdateSite

Update site table Stores the update sites for extensions

Parent class to all tables.
« More »

User

Users table

Parent class to all tables.
« More »

Usergroup

Usergroup table class.

Parent class to all tables.
« More »

ViewLevel

Viewlevels table class.

Parent class to all tables.
« More »

Traits

TagApiSerializerTrait

Trait for implementing tags in an API Serializer

« More »

TagServiceTrait

Trait for component tags service.

« More »

Interfaces

TagServiceInterface

Access to component specific tagging information.

« More »

Traits

CoreButtonsTrait

Enhance Toolbar class to add more pre-defined methods.

« More »

Interfaces

ToolbarFactoryInterface

Interface for creating toolbar objects

« More »

Classes

ContainerAwareToolbarFactory

Default factory for creating toolbar objects

« More »

Toolbar

ToolBar handler

« More »

ToolbarButton

The ToolbarButton class.

« More »

ToolbarHelper

Utility class for the button bar.

« More »

Classes

AbstractGroupButton

The AbstractGroupButton class.

« More »

BasicButton

Renders a basic button.

« More »

ConfirmButton

Renders a standard button with a confirm dialog

« More »

CustomButton

Renders a custom button

« More »

DropdownButton

Render dropdown buttons.

« More »

HelpButton

Renders a help popup window button

« More »

LinkButton

Renders a link button

« More »

PopupButton

Renders a modal window button

« More »

SeparatorButton

Renders a button separator

« More »

StandardButton

Renders a standard button

« More »

Traits

ImmutableNodeTrait

Defines the trait for an Immutable Node Class.

« More »

NodeTrait

Defines the trait for a Node Interface Trait Class.

« More »

Interfaces

ImmutableNodeInterface

Interface for an immutable node class

« More »

NodeInterface

Interface for a node class

« More »

Interfaces

UCM

Interface to handle UCM

« More »

Classes

UCMBase

Base class for implementing UCM

« More »

UCMContent

Base class for implementing UCM

« More »

UCMType

UCM Class for handling content types

« More »

Classes

DownloadSource

Data object representing a download source given as part of an update's `<downloads>` element

« More »

Update

Update class. It is used by Updater::update() to install an update. Use Updater::findUpdates() to find updates for an extension.

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

UpdateAdapter

UpdateAdapter class.

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

Updater

Updater Class

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

Classes

CollectionAdapter

Collection Update Adapter Class

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

ExtensionAdapter

Extension class for updater

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

Classes

Uri

Uri Class

This class serves two purposes. First it parses a URI and provides a common interface for the Joomla Platform to access and manipulate a URI. Second it obtains the URI of the current executing script from the server regardless of server.
« More »

Interfaces

UserFactoryInterface

Interface defining a factory which can create User objects

« More »

Classes

User

User class. Handles all application interaction with a user

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

UserFactory

Default factory for creating User objects

« More »

Classes

BufferStreamHandler

Generic Buffer stream handler

This class provides a generic buffer stream. It can be used to store/retrieve/manipulate string buffers with the standard PHP filesystem I/O methods.
« More »

Utility

JUtility is a utility functions class

« More »

Traits

VersionableControllerTrait

Defines the trait for a Versionable Controller Class.

« More »

VersionableModelTrait

Defines the trait for a Versionable Model Class.

« More »

Interfaces

VersionableTableInterface

Interface for a versionable Table class

« More »

Classes

Versioning

Handle the versioning of content items

« More »

Interfaces

WebAssetAttachBehaviorInterface

Web Asset Behavior interface

« More »

WebAssetItemInterface

Web Asset Item interface

Asset Item are "read only" object, all properties must be set through class constructor. Only properties allowed to be edited is an attributes and an options. Changing an uri or a dependencies are not allowed, prefer to create a new asset instance.
« More »

WebAssetManagerInterface

Web Asset Manager Interface

« More »

WebAssetRegistryInterface

Web Asset Registry interface

« More »

Classes

WebAssetItem

Web Asset Item class

Asset Item are "read only" object, all properties must be set through class constructor. Only properties allowed to be edited is an attributes and an options. Changing an uri or a dependencies are not allowed, prefer to create a new asset instance.
« More »

WebAssetManager

Web Asset Manager class

« More »

WebAssetRegistry

Web Asset Registry class

« More »

Classes

CoreAssetItem

Web Asset Item class for Core asset

Asset Item are "read only" object, all properties must be set through class constructor. Only properties allowed to be edited is an attributes and an options. Changing an uri or a dependencies are not allowed, prefer to create a new asset instance.
« More »

FormValidateAssetItem

Web Asset Item class for form.validate asset

Asset Item are "read only" object, all properties must be set through class constructor. Only properties allowed to be edited is an attributes and an options. Changing an uri or a dependencies are not allowed, prefer to create a new asset instance.
« More »

KeepaliveAssetItem

Web Asset Item class for Keepalive asset

Asset Item are "read only" object, all properties must be set through class constructor. Only properties allowed to be edited is an attributes and an options. Changing an uri or a dependencies are not allowed, prefer to create a new asset instance.
« More »

LangActiveAssetItem

Web Asset Item class for load asset file for active language.

Used in core templates.
« More »

Interfaces

WebAssetExceptionInterface

Exception interface defining a WebAsset error

« More »

Classes

InvalidActionException

Exception class defining an Invalid Action error

« More »

UnknownAssetException

Exception class defining an Unknown Asset

« More »

UnsatisfiedDependencyException

Exception class defining an Unsatisfied Dependency

« More »

Traits

WorkflowPluginTrait

Trait for component workflow plugins.

« More »

WorkflowServiceTrait

Trait for component workflow service.

« More »