Functions

hash_pbkdf2

Shim for missing hash_pbkdf2

package

Joomla CMS

Arguments

algo

stringAlgorithm to use

password

stringPlaintext password

salt

stringSalt for the hash

count

intNumber of iterations

length

intLength

rawOutput

boolRaw output

Response

stringHashed string

Constants

CRLF

Constant defining a line break

var
since

1.5

package

Joomla CMS

FTP_ASCII

Stub of the native FTP_ASCII constant if PHP is running without the ftp extension enabled

var
since

1.5

package

Joomla CMS

FTP_AUTOASCII

Constant defining whether the FTP connection type will automatically determine ASCII support based on a file extension

var
since

1.5

package

Joomla CMS

FTP_BINARY

Stub of the native FTP_BINARY constant if PHP is running without the ftp extension enabled

var
since

1.5

package

Joomla CMS

FTP_NATIVE

Constant defining whether native FTP support is available on the platform

var
since

1.5

package

Joomla CMS

JCOMPAT_UNICODE_PROPERTIES

Flag indicating UTF-8 and PCRE support is present

var
since

1.6

deprecated

5.0 Will be removed without replacement (Also remove phpcs exception)

package

Joomla CMS

JPATH_COMPONENT

Defines the path to the active component for the request

Note this constant is application aware and is different for each application (site/admin).

var
since

1.5

deprecated

5.0 without replacement

package

Joomla CMS

JPATH_COMPONENT_ADMINISTRATOR

Defines the path to the admin element of the active component for the request

var
since

1.5

deprecated

5.0 without replacement

package

Joomla CMS

JPATH_COMPONENT_SITE

Defines the path to the site element of the active component for the request

var
since

1.5

deprecated

5.0 without replacement

package

Joomla CMS

JPATH_ROOT

package

Joomla CMS

Traits

AssociationServiceTrait

Trait to implement AssociationServiceInterface

« More »

CacheControllerFactoryAwareTrait

Defines the trait for a CacheControllerFactoryInterface Aware Class.

« More »

CategoryServiceTrait

Trait for component categories service.

« More »

CoreButtonsTrait

Enhance Toolbar class to add more pre-defined methods.

« More »

CoreEventAware

Returns the most suitable event class for a Joomla core event name

« More »

CurrentUserTrait

Trait for classes which require a user to work with.

« More »

DatabaseAwareTrait

Database aware trait.

« More »

EventAware

Trait for application classes which dispatch events

« More »

ExtensionManagerTrait

Trait for classes which can load extensions

« More »

ExtensionNamespaceMapper

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

« More »

FormBehaviorTrait

Trait which supports form behavior.

« More »

FormFactoryAwareTrait

Defines the trait for a FormFactoryInterface Aware Class.

« More »

HelperFactoryAwareTrait

Defines the trait for a HelperFactory Aware Class.

« More »

HTMLRegistryAwareTrait

Defines the trait for a HTML Registry aware class.

« More »

IdentityAware

Trait for application classes which are identity (user) aware

« More »

ImmutableNodeTrait

Defines the trait for an Immutable Node Class.

« More »

LegacyModelLoaderTrait

Trait which contains the legacy getInstance functionality

« More »

MultiFactorAuthenticationHandler

Implements the code required for integrating with Joomla's Multi-factor Authentication.

Please keep in mind that Joomla's MFA, like any MFA method, is designed to be user-interactive. Moreover, it's meant to be used in an HTML- and JavaScript-aware execution environment i.e. a web browser, web view or similar. If your application is designed to work non-interactively (e.g. a JSON API application) or outside and HTML- and JavaScript-aware execution environments (e.g. CLI) you MUST NOT use this trait. Authentication should be either implicit (e.g. CLI) or using sufficiently secure non- interactive methods (tokens, certificates, ...). Regarding the Joomla CMS itself, only the SiteApplication (frontend) and AdministratorApplication (backend) applications use this trait because of this reason. The CLI application is implicitly authorised at the highest level, whereas the ApiApplication encourages the use of tokens for authentication.
« More »

MVCFactoryAwareTrait

MVCFactory aware trait.

« More »

MVCFactoryServiceTrait

Defines the trait for a MVC factory service class.

« More »

NodeTrait

Defines the trait for a Node Interface Trait Class.

« More »

ReshapeArgumentsAware

A Trait to reshape arguments maintaining b/c with legacy plugin events.

Old plugin event handlers expect positional arguments, not named arguments, since they are simple PHP methods, e.g. public onExample($foo, $bar, $baz). Concrete Event classes, however, use named arguments which can be passed in any order. The following two examples are equivalent: $event1 = new ConcreteEventClass('onExample', ['foo' => 1, 'bar' => 2, 'baz' => 3]; $event2 = new ConcreteEventClass('onExample', ['bar' => 2, 'baz' => 3, 'foo' => 1,]; However, this means that the internal $arguments property of the event object holds the named arguments in a **different** order in each case. When the event handler is aware of the ConcreteEventClass it can retrieve named arguments and all is good in the world. However, when you have a legacy plugin listener registered through CMSPlugin::registerLegacyListener you have a major problem! The legacy listener is passing the arguments **positionally**, in the order they were added to the Event object. In the previous example, $event1 would work as expected because the foo, bar, and baz arguments were given in the same order legacy listeners expected them. On the other hand, $event2 would fail miserably because the call order would be $bar, $baz, $foo which is NOT what the legacy listener expected. The only way to fix that is to *reshape the argument* in the concrete event's constructor so that the order of arguments is guaranteed to be the same as expected by legacy listeners. Moreover, since Joomla is passing all arguments (except the 'result' argument) blindly to the legacy listener we must ensure that a. all necessary arguments are set and b. any other named arguments do NOT exist. Otherwise our legacy listeners would receive the wrong number of positional arguments and break. All this is achieved by the reshapeArguments() method in this trait which has to be called in the constructor of the concrete event class. This trait is marked as deprecated with a removal target of 5.0 because in Joomla 5 we will only be using concrete event classes with named arguments, removing legacy listeners and their positional arguments headaches.
« More »

ResultAware

This Trait partially implements the ResultAwareInterface for mutable and immutable events.

You must additionally implement the typeCheckResult method or use one of the ResultType*Aware traits in your Event handler.
« More »

ResultTypeArrayAware

This Trait partially implements the ResultAwareInterface for type checking.

Events using this Trait (and the ResultAware trait) will expect event handlers to set results of an Array type.
« More »

ResultTypeBooleanAware

This Trait partially implements the ResultAwareInterface for type checking.

Events using this Trait (and the ResultAware trait) will expect event handlers to set results of a Boolean type.
« More »

ResultTypeFloatAware

This Trait partially implements the ResultAwareInterface for type checking.

Events using this Trait (and the ResultAware trait) will expect event handlers to set results of a Float type.
« More »

ResultTypeIntegerAware

This Trait partially implements the ResultAwareInterface for type checking.

Events using this Trait (and the ResultAware trait) will expect event handlers to set results of an Integer type.
« More »

ResultTypeMixedAware

This Trait partially implements the ResultAwareInterface for type checking.

Events using this Trait (and the ResultAware trait) will expect event handlers to set results of a any type. THIS IS A COP OUT! If you expect a nullable or union type it's best to implement the typeCheckResult method yourself to check for the exact types you expect.
« More »

ResultTypeNumericAware

This Trait partially implements the ResultAwareInterface for type checking.

Events using this Trait (and the ResultAware trait) will expect event handlers to set results of a Numeric type.
« More »

ResultTypeObjectAware

This Trait partially implements the ResultAwareInterface for type checking.

Events using this Trait (and the ResultAware trait) will expect event handlers to set results of an object type. If you do not set a list of acceptable result classes any PHP object will satisfy this type check.
« More »

ResultTypeStringAware

This Trait partially implements the ResultAwareInterface for type checking.

Events using this Trait (and the ResultAware trait) will expect event handlers to set results of a String type.
« More »

RouterServiceTrait

Trait to implement AssociationServiceInterface

« More »

SiteRouterAwareTrait

Defines the trait for a Site Router Aware Class.

« More »

StateBehaviorTrait

Trait which supports state behavior

« More »

TagApiSerializerTrait

Trait for implementing tags in an API Serializer

« More »

TaggableTableTrait

Defines the trait for a Taggable Table Class.

« More »

TagServiceTrait

Trait for component tags service.

« More »

VersionableControllerTrait

Defines the trait for a Versionable Controller Class.

« More »

VersionableModelTrait

Defines the trait for a Versionable Model Class.

« More »

WorkflowBehaviorTrait

Trait which supports state behavior

« More »

WorkflowPluginTrait

Trait for component workflow plugins.

« More »

WorkflowServiceTrait

Trait for component workflow service.

« More »

Interfaces

AesInterface

Interface for AES encryption adapters

« More »

AssociationExtensionInterface

Association Extension Interface for the helper classes

« More »

AssociationServiceInterface

The association service.

« More »

BootableExtensionInterface

Interface which defines that an extension can be booted.

« More »

CacheControllerFactoryAwareInterface

Interface to be implemented by classes depending on a cache controller factory.

« More »

CacheControllerFactoryInterface

Interface defining a factory which can create CacheController objects

« More »

CacheExceptionInterface

Exception interface defining a cache storage error

« More »

CategoryFactoryInterface

Category factory interface

« More »

CategoryInterface

The category interface.

« More »

CategoryServiceInterface

Access to component specific categories.

« More »

CheckIfRehashNeededHandlerInterface

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

« More »

CMSApplicationInterface

Interface defining a Joomla! CMS Application class

« More »

CMSWebApplicationInterface

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

« More »

ComponentDispatcherFactoryInterface

Component dispatcher factory interface

« More »

ComponentInterface

Access to component specific services.

« More »

ControllerInterface

Joomla Platform CMS Interface

« More »

CurrentUserInterface

Interface to be implemented by classes depending on a current user.

« More »

DatabaseModelInterface

Interface for a database model.

« More »

DispatcherInterface

Joomla Platform CMS Dispatcher Interface

« More »

EventAwareInterface

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

« More »

ExtensionManagerInterface

Loads extensions.

« More »

FactoryInterface

Interface defining a factory which can create Document objects

« More »

FieldsServiceInterface

The fields service.

« More »

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 »

FormModelInterface

Interface for a form model.

« More »

HelperFactoryAwareInterface

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

« More »

HelperFactoryInterface

Factory to load helper classes.

« More »

ImmutableNodeInterface

Interface for an immutable node class

« More »

InstallerScriptInterface

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

« More »

ItemModelInterface

Interface for an item model.

« More »

LanguageFactoryInterface

Interface defining a factory which can create language objects

« More »

LayoutInterface

Interface to handle display layout

« More »

ListModelInterface

Interface for a list model.

« More »

MenuFactoryInterface

Interface defining a factory which can create Menu objects

« More »

ModelInterface

Interface for a base model.

« More »

ModuleDispatcherFactoryInterface

Module dispatcher factory interface

« More »

ModuleInterface

Access to module specific services.

« More »

MVCFactoryInterface

Factory to create MVC objects.

« More »

MVCFactoryServiceInterface

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

« More »

NamespaceParserInterface

Feed Namespace interface.

« More »

NodeInterface

Interface for a node class

« More »

PluginInterface

Access to plugin specific services.

« More »

PreloadManagerInterface

Joomla! Preload Manager Interface

« More »

ProcessorInterface

Interface for a command line output processor

« More »

ProviderAwareAuthenticationPluginInterface

Interface class defining the necessary methods for an authentication plugin to be provider aware Please note: might be deprecated with Joomla 4.2

« More »

RandValInterface

Interface RandValInterface

« More »

RendererInterface

Interface for a document renderer

« More »

RendererInterface

Interface defining the rendering engine for the error handling layer

« More »

ResultAwareInterface

Defines an Event which has an append-only array argument named 'result'.

This is used for Events whose handlers are expected to return something when called, similar to how many plugin events worked in earlier versions of Joomla. This interface is partially implemented by the ResultAware trait. The typeCheckResult method is implemented by the various ResultType*Aware traits. Your event needs to use both the ResultAware trait and one of the ResultType*Aware traits. For example, if your event returns boolean results you need to use the ResultAware and ResultTypeBooleanAware traits in your event.
« More »

RouterFactoryInterface

Router factory interface

« More »

RouterInterface

Component routing interface

« More »

RouterServiceInterface

The component router service.

« More »

RulesInterface

RouterRules interface for Joomla

« More »

SiteRouterAwareInterface

Interface for site router aware classes.

« More »

StatefulModelInterface

Interface for a stateful model.

« More »

TableInterface

Table class interface.

« More »

TaggableTableInterface

Interface for a taggable Table class

« More »

TagServiceInterface

Access to component specific tagging information.

« More »

ToolbarFactoryInterface

Interface for creating toolbar objects

« More »

TransportInterface

HTTP transport class interface.

« More »

UCM

Interface to handle UCM

« More »

UserFactoryInterface

Interface defining a factory which can create User objects

« More »

VersionableTableInterface

Interface for a versionable Table class

« More »

ViewInterface

Joomla Platform CMS Interface

« More »

WebAssetAttachBehaviorInterface

Web Asset Behavior interface

« More »

WebAssetExceptionInterface

Exception interface defining a WebAsset error

« 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 »

WorkflowModelInterface

Interface for a workflow model.

« More »

WorkflowServiceInterface

The workflow service.

« More »

WritableLoaderInterface

Interface defining a writable command loader.

« More »

Classes

AbstractAES

Abstract AES encryption class

« More »

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 »

AbstractEvent

Event class for the Table's events

« More »

AbstractEvent

Event class for WebAsset events

« More »

AbstractEvent

Event class for WebAsset events

« More »

AbstractGroupButton

The AbstractGroupButton class.

« More »

AbstractImmutableEvent

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

« More »

AbstractMenu

Menu class

« More »

AbstractModuleDispatcher

Base class for a Joomla Module Dispatcher.

« More »

AbstractRenderer

Base class for error page renderers

« More »

AbstractView

Base class for a Joomla View

Class holding methods for displaying presentation data.
« More »

Access

Class that handles all access authorisation routines.

« More »

Access

Extended Utility class for all HTML drawing classes.

« More »

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 »

ActionButton

The TaskButton class.

« More »

ActionsDropdown

HTML utility class for building a dropdown menu

« More »

Adapter

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

« More »

AdapterInstance

Adapter Instance Class

« More »

AddUserCommand

Console command for adding a user

« More »

AddUserToGroupCommand

Console command to add a user to group

« More »

AdminController

Base class for a Joomla Administrator Controller

Controller (controllers are where you put all the actual code) Provides basic functionality, such as rendering views (aka displaying templates).
« More »

AdministratorApplication

Joomla! Administrator Application class

« More »

AdministratorMenu

Menu class.

« More »

AdministratorMenuItem

Object representing an administrator menu item

« More »

AdministratorRouter

Class to create and parse routes

« More »

AdminLanguage

Utility class working with administrator language select lists

« More »

AdminModel

Prototype admin model.

« More »

Aes

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

« More »

AfterBindEvent

Event class for JTable's onAfterBind event

« More »

AfterCheckinEvent

Event class for JTable's onAfterCheckin event

« More »

AfterCheckoutEvent

Event class for JTable's onAfterCheckout event

« More »

AfterDeleteEvent

Event class for JTable's onAfterDelete event

« More »

AfterExtensionBootEvent

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

« More »

AfterHitEvent

Event class for JTable's onAfterHit event

« More »

AfterLoadEvent

Event class for JTable's onAfterLoad event

« More »

AfterMoveEvent

Event class for JTable's onAfterMove event

« More »

AfterPublishEvent

Event class for JTable's onAfterPublish event

« More »

AfterReorderEvent

Event class for JTable's onAfterReorder event

« More »

AfterResetEvent

Event class for JTable's onAfterReset event

« More »

AfterStoreEvent

Event class for JTable's onAfterStore event

« More »

Ajax

Concrete event class for the onAjaxWebauthn event

« More »

AjaxChallenge

Concrete event class for the onAjaxWebauthnChallenge event

« More »

AjaxCreate

Concrete event class for the onAjaxWebauthnCreate event

« More »

AjaxDelete

Concrete event class for the onAjaxWebauthnDelete event

« More »

AjaxInitCreate

Concrete event class for the onAjaxWebauthnInitcreate event

« More »

AjaxLogin

Concrete event class for the onAjaxWebauthnLogin event

« More »

AjaxSaveLabel

Concrete event class for the onAjaxWebauthnSavelabel event

« More »

AliastagField

Form Field class for the Joomla Framework.

« More »

ApcuStorage

APCu cache storage handler

« More »

ApiApplication

Joomla! API Application class

« More »

ApiController

Base class for a Joomla API Controller

Controller (controllers are where you put all the actual code) Provides basic functionality, such as rendering views (aka displaying templates).
« 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.

« More »

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 »

ApiRouter

Joomla! API Router class

« More »

Application

Application service provider

« More »

ApplicationHelper

Application helper functions

« More »

Argon2idHandler

Password handler for Argon2id hashed passwords

« More »

Argon2iHandler

Password handler for Argon2i hashed passwords

« More »

Asset

Table class supporting modified pre-order tree traversal behavior.

« More »

AssociationExtensionHelper

Association Extension Helper

« More »

Associations

Utility class for associations in multilang

« More »

AtomParser

ATOM Feed Parser class.

« More »

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 »

Authentication

Authentication class, provides an interface for the Joomla authentication system

« More »

Authentication

Service provider for the authentication dependencies

« More »

AuthenticationFailed

Exception class defining an authentication failed event

« More »

AuthenticationFailedExceptionHandler

Handler for permission errors that should give a 401

« More »

AuthenticationHelper

Authentication helper class

« More »

AuthenticationResponse

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

« More »

AuthorField

Form Field to load a list of content authors

« More »

Backgroundfill

Image Filter class fill background with color;

« More »

Base32

Base32 encryption class

« More »

BaseApplication

Joomla Platform Base Application Class

« More »

BaseController

Base class for a Joomla Controller

Controller (Controllers are where you put all the actual code.) Provides basic functionality, such as rendering views (aka displaying templates).
« 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 »

BaseLayout

Base class for rendering a display layout

« More »

BaseModel

Base class for a Joomla Model

« More »

BasicButton

Renders a basic button.

« More »

BCryptHandler

Password handler for BCrypt hashed passwords

« More »

BeforeBatchEvent

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

« More »

BeforeBindEvent

Event class for JTable's onBeforeBind event

« More »

BeforeCheckinEvent

Event class for JTable's onBeforeCheckin event

« More »

BeforeCheckoutEvent

Event class for JTable's onBeforeCheckout event

« More »

BeforeDeleteEvent

Event class for JTable's onBeforeDelete event

« More »

BeforeDisplayMethods

Concrete Event class for the onUserMultifactorBeforeDisplayMethods event

« More »

BeforeExtensionBootEvent

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

« More »

BeforeHitEvent

Event class for JTable's onBeforeHit event

« More »

BeforeLoadEvent

Event class for JTable's onBeforeLoad event

« More »

BeforeMoveEvent

Event class for JTable's onBeforeMove event

« More »

BeforePublishEvent

Event class for JTable's onBeforePublish event

« More »

BeforeReorderEvent

Event class for JTable's onBeforeReorder event

« More »

BeforeResetEvent

Event class for JTable's onBeforeReset event

« More »

BeforeStoreEvent

Event class for JTable's onBeforeStore event

« More »

Behavior

Utility class for JavaScript behaviors

« More »

BooleanRule

Form Rule class for the Joomla Platform.

« More »

Bootstrap

Utility class for Bootstrap elements.

« More »

Brightness

Image Filter class adjust the brightness of an image.

« More »

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 »

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 »

Cache

Joomla! Cache base object

« More »

CacheConnectingException

Exception class defining an error connecting to the cache storage engine

« More »

CacheController

Public cache handler

« More »

CacheController

Service provider for the cache controller dependency

« More »

CacheControllerFactory

Default factory for creating CacheController objects

« More »

CachehandlerField

Form Field class for the Joomla Platform.

Provides a list of available cache handlers
« More »

CacheStorage

Abstract cache storage handler

« More »

CacheStorageHelper

Cache storage helper functions.

« More »

CachingLanguageFactory

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

« 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 »

CalendarRule

Form Rule class for the Joomla Platform

« More »

Callback

Concrete Event class for the onUserMultifactorCallback event

« More »

CallbackController

Joomla! Cache callback type object

« More »

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 »

Captcha

Joomla! Captcha base object

« More »

CaptchaField

Captcha field.

« More »

CaptchaRule

Form Rule class for the Joomla Framework.

« More »

Captive

Concrete Event class for the onUserMultifactorCaptive event

« More »

Categories

Categories Class.

« More »

CategoriesView

Categories view base class.

« More »

Category

Utility class for categories

« More »

Category

Category table

« More »

CategoryFactory

Option based categories factory.

« More »

CategoryFactory

Service provider for the service categories.

« More »

CategoryFeedView

Base feed View class for a category

« More »

CategoryField

Form Field class for the Joomla Platform.

Supports an HTML select list of categories
« More »

CategoryNode

Helper class to load Categorytree

« More »

CategoryView

Base HTML View class for the a Category list

« More »

ChainedHandler

Password handler supporting testing against a chain of handlers

« More »

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 »

Changelog

Changelog class.

« 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 »

ChangeUserPasswordCommand

Console command to change a user's password

« 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 »

CheckEvent

Event class for JTable's onCheck event

« More »

CheckinCheckout

Checkin/checkout Exception

« More »

CheckinCheckoutExceptionHandler

Handler for invalid checkin/checkout exceptions

« 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 »

ChromestyleField

Chrome Styles field.

« More »

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 »

CleanCacheCommand

Console command for cleaning the system cache

« More »

Cli

Joomla! Input CLI Class

« More »

CliApplication

Base class for a Joomla! command line application.

« More »

ClientHelper

Client helper class

« More »

CliInput

Class CliInput

« More »

CliOutput

Base class defining a command line output handler

« More »

CliRenderer

Cli error renderer

« More »

CMSApplication

Joomla! CMS Application class

« More »

CMSHelper

Base Helper class.

« More »

CMSObject

Joomla Platform Object Class

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

CMSPlugin

Plugin Class

« More »

CollectionAdapter

Collection Update Adapter Class

« More »

ColorField

Color Form Field class for the Joomla Platform.

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

ColorProcessor

Command line output processor supporting ANSI-colored output

« More »

ColorRule

Form Rule class for the Joomla Platform.

« More »

ColorStyle

Class defining ANSI-color styles for command line output

« More »

ComboField

Form Field class for the Joomla Platform.

Implements a combo box field.
« More »

Component

Access to component specific services.

« More »

ComponentAdapter

Component installer

« 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 »

ComponentDispatcherFactory

Service provider for the service dispatcher factory.

« More »

ComponentHelper

Component helper class

« More »

ComponentlayoutField

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

« More »

ComponentRecord

Object representing a component extension record

« More »

ComponentRenderer

HTML document renderer for the component output

« More »

ComponentsField

Form Field class for the Joomla Framework.

« More »

Config

Service provider for the application's config dependency

« More »

ConfirmButton

Renders a standard button with a confirm dialog

« More »

Console

Service provider for the application's console services

« More »

ConsoleApplication

The Joomla! CMS Console Application

« More »

ContainerAwareToolbarFactory

Default factory for creating toolbar objects

« More »

Content

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

« More »

Content

Content table

« More »

ContentHelper

Helper for standard content style extensions.

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

ContentHistory

Content History table.

« More »

ContenthistoryField

Field to select Content History from a modal list.

« More »

ContentLanguage

Utility class working with content language select lists

« More »

ContentlanguageField

Provides a list of content languages

« More »

ContentType

Tags table

« More »

ContenttypeField

Content Type field.

« More »

Contrast

Image Filter class adjust the contrast of an image.

« More »

CoreAssetItem

Web Asset Item class for Core asset

« More »

CoreContent

Core content table

« More »

Crypt

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

« More »

CryptoCipher

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

« More »

CssIdentifierRule

Form Rule class for the Joomla Platform.

« More »

CssIdentifierSubstringRule

Form Rule class for the Joomla Platform.

« More »

CurlTransport

HTTP transport class for using cURL.

« More »

CustomButton

Renders a custom button

« More »

DaemonApplication

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

« More »

Database

Service provider for the application's database dependency

« More »

DatabaseconnectionField

Form Field class for the Joomla Platform.

Provides a list of available database connections, optionally limiting to a given list.
« 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 »

Date

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

« More »

Date

Extended Utility class for handling date display.

« More »

Debug

Extended Utility class for render debug information.

« More »

DelegatingPsrLogger

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

« More »

DeleteUserCommand

Console command for deleting a user

« More »

Dispatcher

Base class for a Joomla Dispatcher

« More »

Dispatcher

Service provider for the application's event dispatcher dependency

« More »

DisplayEvent

Event class for WebAsset events

« More »

Document

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

« More »

Document

Service provider for the application's document dependency

« More »

DocumentRenderer

Abstract class for a renderer

« More »

DownloadSource

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

« More »

DraggableList

HTML utility class for creating a sortable table list

« More »

Dropdown

HTML utility class for building a dropdown menu

« More »

DropdownButton

Render dropdown buttons.

« More »

DummyPlugin

Placeholder plugin.

« More »

EchoLogger

Joomla Echo logger class.

« More »

Edgedetect

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

« More »

Editor

Editor class to handle WYSIWYG editors

« More »

EditorField

A textarea field for content creation

« More »

Email

Utility class for cloaking email addresses

« More »

EmailField

Form Field class for the Joomla Platform.

Provides and input field for email addresses
« More »

EmailRule

Form Rule class for the Joomla Platform.

« More »

Emboss

Image Filter class to emboss an image.

« More »

EqualsRule

Form Rule class for the Joomla Platform.

« More »

ErrorDocument

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

« More »

ErrorEvent

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

« More »

ExceptionHandler

Displays the custom error page when an uncaught exception occurs.

« More »

ExistsRule

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

« More »

Extension

Extension table

« More »

ExtensionAdapter

Extension class for updater

« More »

ExtensionDiscoverCommand

Console command for discovering extensions

« More »

ExtensionDiscoverInstallCommand

Console command for discovering extensions

« More »

ExtensionDiscoverListCommand

Console command for list discovered extensions

« More »

ExtensionHelper

Extension Helper class.

« More »

ExtensionInstallCommand

Console command for installing extensions

« More »

ExtensionRemoveCommand

Console command for removing extensions

« More »

ExtensionsListCommand

Console command for listing installed extensions

« More »

Factory

Default factory for creating Document objects

« More »

Factory

Joomla Platform Factory class.

« More »

FeaturedButton

The FeaturedButton class.

« More »

Feed

Class to encapsulate a feed for the Joomla Platform.

« More »

FeedDocument

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

« More »

FeedEnclosure

Data object representing a feed enclosure

« More »

FeedEntry

Class to encapsulate a feed entry for the Joomla Platform.

« More »

FeedFactory

Feed factory class.

« More »

FeedImage

Data object representing a feed image

« More »

FeedItem

Data object representing a feed item

« More »

FeedParser

Feed Parser class.

« More »

FeedPerson

Feed Person class.

« More »

FeedRenderer

RSS/Atom feed error page renderer

« More »

File

A File handling class

« More »

FileAdapter

File installer

« More »

FileField

Form Field class for the Joomla Platform.

Provides an input field for files
« More »

FileLayout

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

« More »

FilelistField

Supports an HTML select list of files

« More »

FilePathRule

Form Rule class for the Joomla Platform.

« More »

Files

Joomla! Input Files Class

« More »

FileStorage

File cache storage handler

« More »

FilesystemHelper

File system helper

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

FinderIndexCommand

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

« More »

Folder

A Folder handling class

« More »

FolderlistField

Supports an HTML select list of folder

« More »

FolderPathExistsRule

Form Rule class for the Joomla CMS.

« More »

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 »

Form

Utility class for form elements

« More »

Form

Service provider for the form dependency

« 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 »

FormBehavior

Utility class for form related behaviors

« More »

FormController

Controller tailored to suit most form-based admin operations.

« 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 »

FormModel

Prototype form model.

« More »

FormRule

Form Rule class for the Joomla Platform.

« More »

FormValidateAssetItem

Web Asset Item class for form.validate asset

« More »

FormView

Base class for a Joomla Form View

Class holding methods for displaying presentation data.
« More »

FrontendlanguageField

Provides a list of published content languages with home pages

« More »

FtpClient

FTP client class

« More »

GenericDataException

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

« More »

GenericEvent

This class gives a concrete implementation of the AbstractEvent class.

« More »

GetConfigurationCommand

Console command for displaying configuration options

« More »

GetIconEvent

Event class for the onGetIcon event.

« More »

GetMethod

Concrete Event class for the onUserMultifactorGetMethod event

« More »

GetSetup

Concrete Event class for the onUserMultifactorGetSetup event

« More »

Grayscale

Image Filter class to transform an image to grayscale.

« More »

Grid

Utility class for creating HTML Grids

« More »

GroupedlistField

Form Field class for the Joomla Platform.

Provides a grouped list select field.
« More »

HeadertagField

Form Field class for the Joomla! CMS.

« More »

HeadRenderer

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

« More »

Help

Help system class

« More »

HelpButton

Renders a help popup window button

« More »

HelperFactory

Service provider for the service helper factory.

« More »

HelperFactory

Namespace based implementation of the HelperFactoryInterface

« More »

HiddenField

Form Field class for the Joomla Platform.

Provides a hidden field
« More »

HtmlDocument

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

« More »

HTMLHelper

Utility class for all HTML drawing classes

« More »

HTMLRegistry

Service provider for the HTML service registry

« More »

HtmlRenderer

HTML error page renderer

« More »

HtmlView

Base class for a Joomla Html View

Class holding methods for displaying presentation data.
« More »

Http

HTTP client class.

« More »

HttpBridgePostRequestMethod

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

« More »

HttpFactory

HTTP factory class.

« More »

Icons

Utility class for icons.

« More »

Image

Class to manipulate an image.

« More »

ImageDocument

ImageDocument class, provides an easy interface to output image data

« More »

ImageFilter

Class to manipulate an image.

« More »

ImagelistField

Supports an HTML select list of image

« More »

InlinehelpButton

Renders a button to show / hide the inline help text

« More »

InMemoryLogger

Logger class that keeps all entries in memory

« More »

Input

Joomla! Input Base Class

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

InputFilter

InputFilter is a class for filtering input from any data source

Forked from the php input filter library by: Daniel Morris <[email protected]> Original Contributors: Gianpaolo Racca, Ghislain Picard, Marco Wandschneider, Chris Tobin and Andrew Eddie.
« More »

Installer

Joomla base installer class

« More »

InstallerAdapter

Abstract adapter for the installer.

« More »

InstallerExtension

Extension object

« More »

InstallerHelper

Installer helper class

« More »

InstallerScript

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

« More »

IntarrayFilter

Form Filter class for integer arrays

« More »

IntegerField

Form Field class for the Joomla Platform.

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

InvalidActionException

Exception class defining an Invalid Action error

« More »

InvalidParameterExceptionHandler

Handler for invalid param

« More »

InvalidRouteExceptionHandler

Handler for routing errors that should give a 404

« More »

ItemModel

Prototype item model.

« More »

ItunesRssParser

RSS Feed Parser Namespace handler for iTunes.

« More »

JGrid

Utility class for creating HTML Grids

« More »

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 »

JoomlaStorage

Service provider for the application's session dependency

« More »

Jquery

Utility class for jQuery JavaScript behaviors

« 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 »

JsonapiDocument

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

« More »

JsonapiRenderer

JSON error page renderer

« More »

JsonApiView

Base class for a Joomla Json List View

Class holding methods for displaying presentation data.
« More »

JsonDocument

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

« More »

JsonRenderer

JSON error page renderer

« More »

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 »

JsonView

Base class for a Joomla Json View

Class holding methods for displaying presentation data.
« More »

KeepaliveAssetItem

Web Asset Item class for Keepalive asset

« More »

LangActiveAssetItem

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

Used in core templates.
« More »

Language

Languages/translation handler class

« More »

Language

Service provider for the language dependency

« More »

Language

Languages table.

« More »

LanguageAdapter

Language installer

« More »

LanguageFactory

Default factory for creating language objects

« More »

LanguageField

Form Field class for the Joomla Platform.

Supports a list of installed application languages
« More »

LanguageHelper

Language helper class

« More »

LastvisitdaterangeField

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

« More »

LayoutHelper

Helper to render a Layout object, storing a base path

« More »

LegacyComponent

Access to component specific services.

« More »

LegacyComponentDispatcher

Base class for a legacy Joomla Dispatcher

Executes the single entry file of a legacy component.
« 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 »

LegacyInstallerScript

Legacy installer script which delegates the methods to the internal instance when possible.

« More »

LibraryAdapter

Library installer

« More »

LibraryHelper

Library helper class

« More »

LibraryManifest

Joomla! Library Manifest File

« More »

LimitboxField

Field to load a list of possible item count limits

« More »

LinkButton

Renders a link button

« More »

ListField

Form Field class for the Joomla Platform.

Supports a generic list of options.
« More »

ListHelper

Utility class for creating different select lists

« More »

ListModel

Model class for handling lists of items.

« More »

ListUserCommand

Console command to list existing users

« More »

ListView

Base class for a Joomla List View

Class holding methods for displaying presentation data.
« 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 »

Logger

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

« More »

LoggerRegistry

Service registry for loggers

« More »

Mail

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

« More »

MailDisabledException

Exception class defining an error for disabled mail functionality.

« More »

MailHelper

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

« More »

MailTemplate

Email Templating Class

« More »

Manifest

Joomla! Package Manifest File

« More »

Mcrypt

Mcrypt implementation

« More »

MD5Handler

Password handler for MD5 hashed passwords

« More »

MediaField

Provides a modal media selector including upload mechanism

« More »

MediaHelper

Media helper class

« More »

MediaRssParser

RSS Feed Parser Namespace handler for MediaRSS.

« More »

MemcachedStorage

Memcached cache storage handler

« More »

Menu

Utility class working with menu select lists

« More »

Menu

Service provider for the application's menu dependency

« More »

Menu

Menu table

« More »

MenuFactory

Default factory for creating Menu objects

« More »

MenuField

Supports an HTML select list of menus

« More »

MenuItem

Object representing a menu item

« More »

MenuitemField

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

« More »

MenuRules

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

« More »

MenuType

Menu Types table

« 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 »

MessageRenderer

HTML document renderer for the system message queue

« More »

MetadataManagerListener

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

« More »

MetasRenderer

JDocument metas renderer

« More »

MeterField

Form Field class for the Joomla Platform.

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

Microdata

Joomla Platform class for interacting with Microdata semantics.

« More »

MissingComponentException

Exception class defining an error for a missing component

« More »

Module

Access to module specific services.

« More »

Module

Service provider for the service based modules.

« More »

Module

Module table

« More »

ModuleAdapter

Module installer

« 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 »

ModuleDispatcherFactory

Service provider for the service dispatcher factory.

« More »

ModuleHelper

Module helper class

« More »

ModulelayoutField

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

« More »

ModuleLayoutRule

Form Rule class for the Joomla Platform.

« More »

ModuleorderField

Module Order field.

« More »

ModulepositionField

Module Position field.

« More »

ModuleRenderer

HTML document renderer for a single module

« More »

ModulesRenderer

HTML document renderer for a module position

« More »

ModuletagField

Module Tag field.

« More »

Multilanguage

Utility class for multilang

« More »

MVCComponent

MVC Component class.

« More »

MVCFactory

Service provider for the service MVC factory.

« More »

MVCFactory

Factory to create MVC objects based on a namespace.

« More »

MysqlChangeItem

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

« More »

Negate

Image Filter class to negate the colors of an image.

« More »

Nested

Table class supporting modified pre-order tree traversal behavior.

« More »

NomenuRules

Rule to process URLs without a menu item

« More »

NotAcceptable

Exception class defining a not acceptable class

« More »

NotAcceptableExceptionHandler

Handler for routing errors that should give a 406

« More »

NotAllowed

Exception class defining a not allowed access

« More »

NotAllowedExceptionHandler

Handler for permission errors that should give a 403

« More »

NoteField

Form Field class for the Joomla Platform.

Supports a one line text field.
« More »

NotequalsRule

Form Rule class for the Joomla Platform.

« More »

NotifyActionLog

Concrete event class for the custom events used to notify the User Action Log plugin about Two Factor Authentication actions.

« More »

Number

HTML helper class for rendering numbers.

« 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 »

NumberRule

Form Rule class for the Joomla Platform.

« More »

ObjectCreateEvent

Event class for JTable's onObjectCreate event

« More »

OnGetApiAttributes

Event for getting extra data attributes for an API Entity

« More »

OnGetApiFields

Event for getting extra API Fields and Relations to render with an entity

« More »

OnGetApiRelation

Event for getting information on an API Relationship

« More »

OpensearchDocument

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

« More »

OpensearchImage

Data object representing an OpenSearch image

« More »

OpensearchUrl

Data object representing an OpenSearch URL

« More »

OpenSSL

OpenSSL encryption class

« 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 »

OrderingField

Ordering field.

« More »

OutputController

Joomla Cache output type object

« More »

OutputFilter

OutputFilter

« More »

PackageAdapter

Package installer

« More »

PackageManifest

Joomla! Package Manifest File

« More »

PageController

Joomla! Cache page type object

« More »

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 »

PasswordField

Form Field class for the Joomla Platform.

Text field for passwords
« More »

PasswordRule

Form Rule class for the Joomla Platform.

« More »

Patcher

A Unified Diff Format Patcher class

« More »

Path

A Path handling class

« More »

Pathway

Class to maintain a pathway.

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

Pathway

Service provider for the application's pathway dependency

« More »

PHPassHandler

Password handler for PHPass hashed passwords

« More »

PluginAdapter

Plugin installer

« More »

PluginHelper

Plugin helper class

« More »

PluginsField

Form Field class for the Joomla Framework.

« More »

PluginstatusField

Plugin Status field.

« More »

PopupButton

Renders a modal window button

« More »

PostgresqlChangeItem

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

« More »

PredefinedlistField

Form Field to load a list of predefined values

« More »

PreloadManager

Joomla! Preload Manager

« More »

Profiler

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

« More »

PublishedButton

The PublishedButton class.

« More »

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 »

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 »

Randval

Generates cryptographically-secure random values.

« More »

RangeField

Form Field class for the Joomla Platform.

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

RawDocument

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

« More »

RawFilter

Form Filter class for raw values

« More »

RedirectStatusField

Redirect Status field.

« More »

RedisStorage

Redis cache storage handler for PECL

« More »

RegistrationdaterangeField

Registration Date Range field.

« More »

Registry

Service registry for JHtml services

« 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 »

ResourceNotFound

Exception class defining a resource not found exception

« More »

ResourceNotFoundExceptionHandler

Handler for invalid resource requests that should give a 404

« More »

Response

HTTP response data object class.

« More »

Route

Route handling 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 »

RouteNotFoundException

Exception class defining an error for a missing route

« More »

Router

Class to create and parse routes

« More »

Router

Service provider for the application's API router dependency

« More »

RouterBase

Base component routing class

« More »

RouterFactory

Default router factory.

« More »

RouterFactory

Service provider for the service 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 »

RssParser

RSS Feed Parser class.

« More »

RssRenderer

RssRenderer is a feed that implements RSS 2.0 Specification

« More »

Rule

Rule class.

« More »

Rules

Access rules class.

« More »

RulesField

Form Field class for the Joomla Platform.

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

RulesFilter

Form Filter class for rules

« More »

RulesRule

Form Rule class for the Joomla Platform.

« More »

SafehtmlFilter

Form Filter class for safe HTML

« More »

Save

Exception saving data

« More »

SaveExceptionHandler

Handler for invalid checkin/checkout exceptions

« More »

SaveSetup

Concrete Event class for the onUserMultifactorSaveSetup event

« More »

ScriptsRenderer

JDocument head renderer

« More »

SearchTools

Searchtools elements.

« More »

SectionNotFoundException

Representing when a category section cannot be found.

« More »

Select

Utility class for creating HTML select lists

« More »

SendEmail

Send email Exception

« More »

SendEmailExceptionHandler

Handler for error when send email

« More »

SeparatorButton

Renders a button separator

« More »

Session

Service provider for the application's session dependency

« More »

Session

Class for managing HTTP sessions

« More »

SessionFactory

Factory for creating session API objects

« More »

SessionGcCommand

Console command for performing session garbage collection

« More »

SessionhandlerField

Form Field class for the Joomla Platform.

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

SessionManager

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

« More »

SessionMetadataGcCommand

Console command for performing session metadata garbage collection

« More »

SetConfigurationCommand

Console command Setting Configuration options

« More »

SetNewTagsEvent

Event class for JTable's onSetNewTags event

« More »

Sidebar

Utility class to render a list view sidebar

« More »

SiteApplication

Joomla! Site Application class

« More »

SiteDownCommand

Console command wrapper for getting the site into offline mode

« More »

SiteMenu

Menu class

« More »

SitePathway

Class to manage the site application pathway.

« More »

SiteRouter

Class to create and parse routes for the site application

« More »

SiteUpCommand

Console command wrapper for getting the site into offline mode

« More »

Sketchy

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

« More »

Smooth

Image Filter class adjust the smoothness of an image.

« More »

SocketTransport

HTTP transport class for using sockets directly.

« More »

SodiumCipher

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

« More »

SortableList

HTML utility class for creating a sortable table list

« 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

« More »

SqlsrvChangeItem

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

« More »

StandardButton

Renders a standard button

« More »

StandardRules

Rule for the standard handling of component routing

« More »

StatusField

Form Field to load a list of states

« More »

Stdout

Output handler for writing command line output to the stdout interface

« 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 »

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 »

StreamTransport

HTTP transport class for using PHP streams.

« More »

StringController

String Controller

« More »

StringHelper

HTML helper class for rendering manipulated strings.

« More »

StylesRenderer

JDocument styles renderer

« More »

SubformField

The Field to load the form inside current form

« More »

SubformRule

Form rule to validate subforms field-wise.

« 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 »

Table

Abstract Table class

Parent class to all tables.
« More »

TableColumnsAssetItem

Web Asset Item class for tables.column asset

« More »

Tag

Utility class for tags

« More »

TagField

List of Tags field.

« More »

TagsHelper

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

« More »

TasksListCommand

Console command to list scheduled tasks.

« More »

TasksRunCommand

Console command to run scheduled tasks.

« More »

TasksStateCommand

Console command to change the state of tasks.

« More »

Telephone

HTML helper class for rendering telephone numbers.

« More »

TelephoneField

Form Field class for the Joomla Platform.

Supports a text field telephone numbers.
« More »

TelFilter

Form Filter class for phone numbers

« More »

TelRule

Form Rule class for the Joomla Platform

« More »

TemplateAdapter

Template installer

« More »

TemplatestyleField

Supports a select grouped list of template styles

« More »

Text

Text handling class.

« 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 »

TimeRule

Form Rule class for the Joomla Platform.

« More »

TimezoneField

Form Field class for the Joomla Platform.

« More »

Toolbar

Service provider for the application's toolbar dependency

« More »

Toolbar

ToolBar handler

« More »

ToolbarButton

The ToolbarButton class.

« More »

ToolbarHelper

Utility class for the button bar.

« More »

Totp

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

« More »

TransitionButton

The PublishedButton class.

« More »

TransitionField

Components Category field.

« More »

Transliterate

Class to transliterate strings

« More »

Ucm

UCM map table

« More »

UCMBase

Base class for implementing UCM

« More »

UCMContent

Base class for implementing UCM

« More »

UCMType

UCM Class for handling content types

« More »

UiTab

Utility class for the Joomla core UI Tab element.

« More »

UnknownAssetException

Exception class defining an Unknown Asset

« More »

UnparsableImageException

Exception thrown when an image has no known properties.

« More »

UnsatisfiedDependencyException

Exception class defining an Unsatisfied Dependency

« More »

UnsetFilter

Form Filter class to unset

« More »

UnsupportedCacheException

Exception class defining an unsupported cache storage object

« More »

UnsupportedStorageException

Exception class defining an unsupported session storage object

« More »

Update

Update table Stores updates temporarily

« More »

Update

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

« More »

UpdateAdapter

UpdateAdapter class.

« More »

UpdateCoreCommand

Console command for updating Joomla! core

« More »

Updater

Updater Class

« More »

UpdateSite

Update site table Stores the update sites for extensions

« More »

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 »

UrlField

Form Field class for the Joomla Platform.

Supports a URL text field
« More »

UrlFilter

Form Filter class for URLs

« More »

UrlRule

Form Rule class for the Joomla Platform.

« More »

User

Utility class working with users

« More »

User

Service provider for the user dependency

« More »

User

Users table

« More »

User

User class. Handles all application interaction with a user

« More »

UseractiveField

Field to show a list of available user active statuses

« More »

UserFactory

Default factory for creating User objects

« More »

UserField

Field to select a user ID from a modal list.

« More »

Usergroup

Usergroup table class.

« More »

UsergrouplistField

Field to load a dropdown list of available user groups

« More »

UserGroupsHelper

Helper to deal with user groups.

« More »

UserHelper

Authorisation helper class, provides static methods to perform various tasks relevant to the Joomla user and authorisation classes

This class has influences and some method logic from the Horde Auth package
« More »

UserIdRule

Form Rule class for the Joomla Platform.

« More »

UsernameRule

Form Rule class for the Joomla Platform.

« More »

UserstateField

Field to load a list of available users statuses

« More »

Utility

JUtility is a utility functions class

« More »

Validate

Concrete Event class for the onUserMultifactorValidate event

« More »

Version

Version information class for the Joomla CMS.

« More »

Versioning

Handle the versioning of content items

« More »

ViewController

Joomla! Cache view type object

« More »

ViewLevel

Viewlevels table class.

« More »

W3cLogger

Joomla! W3C Logging class

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

WebApplication

Base class for a Joomla! Web application.

« More »

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

Service provider for the application's WebAsset dependency

« More »

WebAssetRegistry

Web Asset Registry class

« More »

WebAssetRegistryAssetChanged

Event class for WebAssetRegistry "asset changed" events

« More »

WincacheStorage

WinCache cache storage handler

« More »

Workflow

Workflow Class.

« More »

WorkflowComponentSectionsField

Form Field class for the Joomla Framework.

« More »

WorkflowconditionField

Workflow States field.

« More »

WorkflowFunctionalityUsedEvent

Event class for Workflow Functionality Used events

« More »

WorkflowStage

Utility class working with workflow states select lists

« More »

WorkflowstageField

Workflow Stages field.

« More »

WorkflowTransitionEvent

Event class for Workflow Functionality Used events

« More »

WritableContainerLoader

PSR-11 compatible writable command loader.

« More »

Xml

Output handler for writing command line output to the stdout interface

« More »

XmlDocument

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

« More »

XmlRenderer

XML error page renderer

« More »