Joomla! API

Abstract AES encryption class

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.

Event class for the Table's events

Event class for WebAsset events

Event class for WebAsset events

The AbstractGroupButton class.

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

Menu class

Base class for a Joomla Module Dispatcher.

Base class for error page renderers

Base class for a Joomla View

Class that handles all access authorisation routines.

Extended Utility class for all HTML drawing classes.

The Field to load the form inside current form

Form Field class for the Joomla Platform.

The TaskButton class.

HTML utility class for building a dropdown menu

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

Adapter Instance Class

Console command for adding a user

Console command to add a user to group

Base class for a Joomla Administrator Controller

Joomla! Administrator Application class

Menu class.

Object representing an administrator menu item

Class to create and parse routes

Utility class working with administrator language select lists

Prototype admin model.

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

Event class for JTable's onAfterBind event

Event class for JTable's onAfterCheckin event

Event class for JTable's onAfterCheckout event

Event class for JTable's onAfterDelete event

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

Event class for JTable's onAfterHit event

Event class for JTable's onAfterLoad event

Event class for JTable's onAfterMove event

Event class for JTable's onAfterPublish event

Event class for JTable's onAfterReorder event

Event class for JTable's onAfterReset event

Event class for JTable's onAfterStore event

Concrete event class for the onAjaxWebauthn event

Concrete event class for the onAjaxWebauthnChallenge event

Concrete event class for the onAjaxWebauthnCreate event

Concrete event class for the onAjaxWebauthnDelete event

Concrete event class for the onAjaxWebauthnInitcreate event

Concrete event class for the onAjaxWebauthnLogin event

Concrete event class for the onAjaxWebauthnSavelabel event

Form Field class for the Joomla Framework.

APCu cache storage handler

Joomla! API Application class

Base class for a Joomla API Controller

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.

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.

Joomla! API Router class

Application service provider

Application helper functions

Password handler for Argon2id hashed passwords

Password handler for Argon2i hashed passwords

Table class supporting modified pre-order tree traversal behavior.

Association Extension Helper

Utility class for associations in multilang

ATOM Feed Parser class.

AtomRenderer is a feed that implements the atom specification

Authentication class, provides an interface for the Joomla authentication system

Service provider for the authentication dependencies

Exception class defining an authentication failed event

Handler for permission errors that should give a 401

Authentication helper class

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

Form Field to load a list of content authors

Image Filter class fill background with color;

Base32 encryption class

Joomla Platform Base Application Class

Base class for a Joomla Controller

Base class for a database aware Joomla Model

Base class for rendering a display layout

Base class for a Joomla Model

Renders a basic button.

Password handler for BCrypt hashed passwords

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

Event class for JTable's onBeforeBind event

Event class for JTable's onBeforeCheckin event

Event class for JTable's onBeforeCheckout event

Event class for JTable's onBeforeDelete event

Concrete Event class for the onUserMultifactorBeforeDisplayMethods event

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

Event class for JTable's onBeforeHit event

Event class for JTable's onBeforeLoad event

Event class for JTable's onBeforeMove event

Event class for JTable's onBeforePublish event

Event class for JTable's onBeforeReorder event

Event class for JTable's onBeforeReset event

Event class for JTable's onBeforeStore event

Utility class for JavaScript behaviors

Form Rule class for the Joomla Platform.

Utility class for Bootstrap elements.

Image Filter class adjust the brightness of an image.

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

Generic Buffer stream handler

Joomla! Cache base object

Exception class defining an error connecting to the cache storage engine

Public cache handler

Service provider for the cache controller dependency

Default factory for creating CacheController objects

Form Field class for the Joomla Platform.

Abstract cache storage handler

Cache storage helper functions.

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

Form Field class for the Joomla Platform.

Form Rule class for the Joomla Platform

Concrete Event class for the onUserMultifactorCallback event

Joomla! Cache callback type object

Joomla! Callback Log class

Joomla! Captcha base object

Captcha field.

Form Rule class for the Joomla Framework.

Concrete Event class for the onUserMultifactorCaptive event

Categories Class.

Categories view base class.

Utility class for categories

Category table

Option based categories factory.

Service provider for the service categories.

Base feed View class for a category

Form Field class for the Joomla Platform.

Helper class to load Categorytree

Base HTML View class for the a Category list

Password handler supporting testing against a chain of handlers

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

Changelog class.

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

Console command to change a user's password

Form Field class for the Joomla Platform.

Form Field class for the Joomla Platform.

Event class for JTable's onCheck event

Checkin/checkout Exception

Handler for invalid checkin/checkout exceptions

Console command for checking if there are pending extension updates

Console command for checking if there are pending extension updates

Chrome Styles field.

Decorate Composer ClassLoader for Joomla!

Console command for cleaning the system cache

Joomla! Input CLI Class

Base class for a Joomla! command line application.

Client helper class

Class CliInput

Base class defining a command line output handler

Cli error renderer

Joomla! CMS Application class

Base Helper class.

Joomla Platform Object Class

Plugin Class

Collection Update Adapter Class

Color Form Field class for the Joomla Platform.

Command line output processor supporting ANSI-colored output

Form Rule class for the Joomla Platform.

Class defining ANSI-color styles for command line output

Form Field class for the Joomla Platform.

Access to component specific services.

Component installer

Base class for a Joomla Component Dispatcher

Namespace based implementation of the ComponentDispatcherFactoryInterface

Service provider for the service dispatcher factory.

Component helper class

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

Object representing a component extension record

HTML document renderer for the component output

Form Field class for the Joomla Framework.

Service provider for the application's config dependency

Renders a standard button with a confirm dialog

Service provider for the application's console services

The Joomla! CMS Console Application

Default factory for creating toolbar objects

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

Content table

Helper for standard content style extensions.

Content History table.

Field to select Content History from a modal list.

Utility class working with content language select lists

Provides a list of content languages

Tags table

Content Type field.

Image Filter class adjust the contrast of an image.

Joomla! Input Cookie Class

Web Asset Item class for Core asset

Core content table

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

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

Form Rule class for the Joomla Platform.

Form Rule class for the Joomla Platform.

HTTP transport class for using cURL.

Renders a custom button

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

Service provider for the application's database dependency

Form Field class for the Joomla Platform.

Joomla! MySQL Database Log class

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

Extended Utility class for handling date display.

Extended Utility class for render debug information.

Console command for deleting a user

Base class for a Joomla Dispatcher

Service provider for the application's event dispatcher dependency

Event class for WebAsset events

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

Service provider for the application's document dependency

Abstract class for a renderer

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

HTML utility class for creating a sortable table list

HTML utility class for building a dropdown menu

Render dropdown buttons.

Placeholder plugin.

Joomla Echo logger class.

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

Editor class to handle WYSIWYG editors

A textarea field for content creation

Utility class for cloaking email addresses

Form Field class for the Joomla Platform.

Form Rule class for the Joomla Platform.

Image Filter class to emboss an image.

Form Rule class for the Joomla Platform.

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

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

Displays the custom error page when an uncaught exception occurs.

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

Extension table

Extension class for updater

Console command for discovering extensions

Console command for discovering extensions

Console command for list discovered extensions

Extension Helper class.

Console command for installing extensions

Console command for removing extensions

Console command for listing installed extensions

Default factory for creating Document objects

Joomla Platform Factory class.

The FeaturedButton class.

Class to encapsulate a feed for the Joomla Platform.

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

Data object representing a feed enclosure

Class to encapsulate a feed entry for the Joomla Platform.

Feed factory class.

Data object representing a feed image

Data object representing a feed item

Feed Link class.

Feed Parser class.

Feed Person class.

RSS/Atom feed error page renderer

A File handling class

File installer

Form Field class for the Joomla Platform.

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

Supports an HTML select list of files

Form Rule class for the Joomla Platform.

Joomla! Input Files Class

File cache storage handler

File system helper

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

A Folder handling class

Supports an HTML select list of folder

Form Rule class for the Joomla CMS.

Form Class for the Joomla Platform.

Utility class for form elements

Service provider for the form dependency

Joomla! Formatted Text File Log class

Utility class for form related behaviors

Controller tailored to suit most form-based admin operations.

Default factory for creating Form objects

Abstract Form Field class for the Joomla Platform.

Form's helper class.

Prototype form model.

Form Rule class for the Joomla Platform.

Web Asset Item class for form.validate asset

Base class for a Joomla Form View

Provides a list of published content languages with home pages

FTP client class

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

This class gives a concrete implementation of the AbstractEvent class.

Console command for displaying configuration options

Event class for the onGetIcon event.

Concrete Event class for the onUserMultifactorGetMethod event

Concrete Event class for the onUserMultifactorGetSetup event

Image Filter class to transform an image to grayscale.

Utility class for creating HTML Grids

Form Field class for the Joomla Platform.

Form Field class for the Joomla! CMS.

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

Help system class

Renders a help popup window button

Service provider for the service helper factory.

Namespace based implementation of the HelperFactoryInterface

Form Field class for the Joomla Platform.

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

Utility class for all HTML drawing classes

Service provider for the HTML service registry

HTML error page renderer

Base class for a Joomla Html View

HTTP client class.

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

HTTP factory class.

Utility class for icons.

Class to manipulate an image.

ImageDocument class, provides an easy interface to output image data

Class to manipulate an image.

Supports an HTML select list of image

Renders a button to show / hide the inline help text

Logger class that keeps all entries in memory

Joomla! Input Base Class

InputFilter is a class for filtering input from any data source

Joomla base installer class

Abstract adapter for the installer.

Extension object

Installer helper class

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

Form Filter class for integer arrays

Form Field class for the Joomla Platform.

Exception class defining an Invalid Action error

Handler for invalid param

Handler for routing errors that should give a 404

Prototype item model.

RSS Feed Parser Namespace handler for iTunes.

Utility class for creating HTML Grids

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

Service provider for the application's session dependency

Utility class for jQuery JavaScript behaviors

Joomla! Input JSON Class

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

JSON error page renderer

Base class for a Joomla Json List View

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

JSON error page renderer

JSON Response class.

Base class for a Joomla Json View

Web Asset Item class for Keepalive asset

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

Languages/translation handler class

Service provider for the language dependency

Languages table.

Language installer

Default factory for creating language objects

Form Field class for the Joomla Platform.

Language helper class

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

Helper to render a Layout object, storing a base path

Access to component specific services.

Base class for a legacy Joomla Dispatcher

Factory to create MVC objects in legacy mode.

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

Library installer

Library helper class

Joomla! Library Manifest File

Field to load a list of possible item count limits

Renders a link button

Utility class for icons.

Form Field class for the Joomla Platform.

Utility class for creating different select lists

Model class for handling lists of items.

Console command to list existing users

Base class for a Joomla List View

Joomla! Log Class

Joomla! Log Entry class

Joomla! Logger Base Class

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

Service registry for loggers

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

Exception class defining an error for disabled mail functionality.

Service provider for the mailer dependency

Default factory for creating mailer objects.

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

Email Templating Class

Joomla! Package Manifest File

Mcrypt implementation

Password handler for MD5 hashed passwords

Provides a modal media selector including upload mechanism

Media helper class

RSS Feed Parser Namespace handler for MediaRSS.

Memcached cache storage handler

Utility class working with menu select lists

Service provider for the application's menu dependency

Menu table

Default factory for creating Menu objects

Supports an HTML select list of menus

Object representing a menu item

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

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

Menu Types table

Joomla MessageQueue logger class.

HTML document renderer for the system message queue

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

JDocument metas renderer

Form Field class for the Joomla Platform.

Joomla Platform class for interacting with Microdata semantics.

Exception class defining an error for a missing component

Access to module specific services.

Service provider for the service based modules.

Module table

Module installer

Base class for a Joomla Module Dispatcher

Namespace based implementation of the ModuleDispatcherFactoryInterface

Service provider for the service dispatcher factory.

Module helper class

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

Form Rule class for the Joomla Platform.

Module Order field.

Module Position field.

HTML document renderer for a single module

HTML document renderer for a module position

Module Tag field.

Utility class for multilang

MVC Component class.

Service provider for the service MVC factory.

Factory to create MVC objects based on a namespace.

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

Image Filter class to negate the colors of an image.

Table class supporting modified pre-order tree traversal behavior.

Rule to process URLs without a menu item

Exception class defining a not acceptable class

Handler for routing errors that should give a 406

Exception class defining a not allowed access

Handler for permission errors that should give a 403

Form Field class for the Joomla Platform.

Form Rule class for the Joomla Platform.

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

HTML helper class for rendering numbers.

Form Field class for the Joomla Platform.

Form Rule class for the Joomla Platform.

Event class for JTable's onObjectCreate event

Event for getting extra data attributes for an API Entity

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

Event for getting information on an API Relationship

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

Data object representing an OpenSearch image

Data object representing an OpenSearch URL

OpenSSL encryption class

Form Rule class for the Joomla Platform.

Ordering field.

Joomla Cache output type object

OutputFilter

Package installer

Joomla! Package Manifest File

Joomla! Cache page type object

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

Pagination object representing a particular item in the pagination lists.

Form Field class for the Joomla Platform.

Form Rule class for the Joomla Platform.

A Unified Diff Format Patcher class

A Path handling class

Class to maintain a pathway.

Service provider for the application's pathway dependency

Password handler for PHPass hashed passwords

Plugin installer

Plugin helper class

Form Field class for the Joomla Framework.

Plugin Status field.

Renders a modal window button

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

Form Field to load a list of predefined values

Joomla! Preload Manager

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

The PublishedButton class.

Joomla Platform String Punycode Class

Form Field class for the Joomla Platform.

Form Field class for the Joomla Platform.

Generates cryptographically-secure random values.

Form Field class for the Joomla Platform.

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

Form Filter class for raw values

Redirect Status field.

Redis cache storage handler for PECL

Registration Date Range field.

Service registry for JHtml services

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

Console command to remove a user from a group

Exception class defining a resource not found exception

Handler for invalid resource requests that should give a 404

HTTP response data object class.

Route handling class

Route Helper

Exception class defining an error for a missing route

Class to create and parse routes

Service provider for the application's API router dependency

Base component routing class

Default router factory.

Service provider for the service router factory.

Default routing class for missing or legacy component routers

View-based component routing class

View-configuration class for the view-based component router

RSS Feed Parser class.

RssRenderer is a feed that implements RSS 2.0 Specification

Rule class.

Access rules class.

Form Field class for the Joomla Platform.

Form Filter class for rules

Form Rule class for the Joomla Platform.

Form Filter class for safe HTML

Exception saving data

Handler for invalid checkin/checkout exceptions

Concrete Event class for the onUserMultifactorSaveSetup event

JDocument head renderer

Searchtools elements.

Representing when a category section cannot be found.

Utility class for creating HTML select lists

Send email Exception

Handler for error when send email

Renders a button separator

Service provider for the application's session dependency

Class for managing HTTP sessions

Factory for creating session API objects

Console command for performing session garbage collection

Form Field class for the Joomla Platform.

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

Console command for performing session metadata garbage collection

Console command Setting Configuration options

Event class for JTable's onSetNewTags event

Utility class to render a list view sidebar

Joomla! Site Application class

Console command wrapper for getting the site into offline mode

Menu class

Class to manage the site application pathway.

Class to create and parse routes for the site application

Console command wrapper for getting the site into offline mode

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

Image Filter class adjust the smoothness of an image.

HTTP transport class for using sockets directly.

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

HTML utility class for creating a sortable table list

Form Field class for the Joomla Platform.

Supports a custom SQL select list

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

Renders a standard button

Rule for the standard handling of component routing

Form Field to load a list of states

Output handler for writing command line output to the stdout interface

Joomla! Stream Interface

String Stream Wrapper

HTTP transport class for using PHP streams.

String Controller

HTML helper class for rendering manipulated strings.

JDocument styles renderer

The Field to load the form inside current form

Form rule to validate subforms field-wise.

Joomla! Syslog Log class

Abstract Table class

Web Asset Item class for tables.column asset

Utility class for tags

List of Tags field.

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

Console command to list scheduled tasks.

Console command to run scheduled tasks.

Console command to change the state of tasks.

HTML helper class for rendering telephone numbers.

Form Field class for the Joomla Platform.

Form Filter class for phone numbers

Form Rule class for the Joomla Platform

Template installer

Supports a select grouped list of template styles

Text handling class.

Form Field class for the Joomla Platform.

Form Field class for the Joomla Platform.

Form Field class for the Joomla Platform.

Form Rule class for the Joomla Platform.

Form Field class for the Joomla Platform.

Service provider for the application's toolbar dependency

ToolBar handler

The ToolbarButton class.

Utility class for the button bar.

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

The PublishedButton class.

Workflow Transitions field.

Class to transliterate strings

UCM map table

Base class for implementing UCM

Base class for implementing UCM

UCM Class for handling content types

Utility class for the Joomla core UI Tab element.

Exception class defining an Unknown Asset

Exception thrown when an image has no known properties.

Exception class defining an Unsatisfied Dependency

Form Filter class to unset

Exception class defining an unsupported cache storage object

Exception class defining an unsupported session storage object

Update table Stores updates temporarily

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

UpdateAdapter class.

Console command for updating Joomla! core

Updater Class

Update site table Stores the update sites for extensions

Uri Class

Form Field class for the Joomla Platform.

Form Filter class for URLs

Form Rule class for the Joomla Platform.

Utility class working with users

Service provider for the user dependency

Users table

User class. Handles all application interaction with a user

Field to show a list of available user active statuses

Default factory for creating User objects

Field to select a user ID from a modal list.

Usergroup table class.

Field to load a dropdown list of available user groups

Helper to deal with user groups.

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

Form Rule class for the Joomla Platform.

Form Rule class for the Joomla Platform.

Field to load a list of available users statuses

JUtility is a utility functions class

Concrete Event class for the onUserMultifactorValidate event

Version information class for the Joomla CMS.

Handle the versioning of content items

Joomla! Cache view type object

Viewlevels table class.

Joomla! W3C Logging class

Base class for a Joomla! Web application.

Web Asset Item class

Web Asset Manager class

Service provider for the application's WebAsset dependency

Web Asset Registry class

Event class for WebAssetRegistry "asset changed" events

WinCache cache storage handler

Workflow Class.

Form Field class for the Joomla Framework.

Workflow States field.

Event class for Workflow Functionality Used events

Utility class working with workflow states select lists

Workflow Stages field.

Event class for Workflow Functionality Used events

PSR-11 compatible writable command loader.

Output handler for writing command line output to the stdout interface

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

XML error page renderer