Joomla! API

Joomla Framework Base Application Class

Base class for a Joomla! Web application.

Class defining the events available in the application.

A basic web application class for handing HTTP requests.

Controller resolver which supports creating controllers from a PSR-11 compatible container

Resolves a controller for the given route.

Event class thrown when an application error occurs.

Base event class for application events.

Exception thrown when the application can't write to the response body

Class to model a Web Client.

An Archive handling class

Bzip2 format adapter for the Archive package

Gzip format adapter for the Archive package

Tar format adapter for the Archive package

ZIP format adapter for the Archive package

Exception class defining an unknown archive type

Exception class defining an unsupported archive adapter

Abstract AuthenticationStrategy for username/password based authentication

Joomla Framework Authentication Class

Exception class defining an unsupported password handler

Password handler for Argon2id hashed passwords

Password handler for Argon2i hashed passwords

Password handler for BCrypt hashed passwords

Joomla Framework Database Strategy Authentication class

Joomla Framework Local Strategy Authentication class

Base application class for a Joomla! command line application.

Class defining the events available in the console application.

Base command class for a Joomla! command line application.

Command to render a command's help data.

Command listing all available commands.

Describes an application.

Text object descriptor.

Event triggered when an uncaught Throwable is received by the application.

Event triggered before a command is executed.

Event triggered when an uncaught Throwable is received by the application from a command.

Base event class for console events.

Event triggered immediately before the process is terminated.

Exception indicating a missing command namespace.

Describes an object.

PSR-11 compatible command loader.

Joomla Framework Base Controller Class

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

Encryption key object for the Joomla Framework.

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

Joomla cipher for encryption, decryption and key generation via the openssl extension.

Cipher for sodium algorithm encryption, decryption and key generation.

Exception representing an error decrypting data

Exception representing an error encrypting data

Exception representing an error generating an encryption key

Exception representing an invalid Joomla\Crypt\Key type for a cipher

Exception representing an error encrypting data

DataObject is a class that is used to store data but allowing you to access the data by mimicking the way PHP handles class properties.

DataSet is a collection class that allows the developer to operate on a set of DataObjects as if they were in a typical PHP array.

Joomla Framework Database Driver Class

Class defining the events dispatched by the database API

Joomla Framework Database Exporter Class

Joomla Framework Database Factory class

Joomla Framework Database Importer Class

Joomla Framework Database Driver Class

Joomla Framework Query Building Class.

Class defining the fetch mode for prepared statements

Class defining the fetch orientation for prepared statements

Class defining the parameter types for prepared statements

Console command for exporting the database

Console command for importing the database

Database connection event

Exception class defining an error connecting to the database platform

No database is available.

Exception class defining an error executing a statement

Exception class defining an error preparing the SQL statement for execution

Exception class defining an exception when attempting to change a query type

Class representing an unknown type for a given database driver.

Exception class defining an unsupported database object

Chained query monitor allowing multiple monitors to be executed.

Query monitor handling logging of queries.

Query monitor handling logging of queries.

MySQL database driver supporting PDO based connections

MySQL Database Exporter.

MySQL Database Importer.

MySQL Query Building Class.

MySQLi Database Driver

MySQLi Database Exporter.

MySQLi Database Importer.

MySQLi Query Building Class.

MySQLi Database Statement.

Joomla Framework PDO Database Driver Class

PDO Query Building Class.

PDO Database Statement.

PostgreSQL PDO Database Driver

PDO PostgreSQL Database Exporter.

PDO PostgreSQL Database Importer.

PDO PostgreSQL Query Building Class.

Query Element Class.

Database service provider

SQL Azure Database Driver

SQL Azure Query Building Class.

SQLite database driver supporting PDO based connections

SQLite Query Building Class.

SQL Server Database Driver

SQL Server Query Building Class.

SQL Server Database Statement.

The Container class.

No container is available.

Exception class for handling errors in resolving a dependency

No entry was found in the container.

Attempt to set the value of a protected key, which already is set

Implementation of EventInterface.

Implementation of a DispatcherInterface supporting prioritized listeners.

Default Event class.

Implementation of an immutable Event.

Decorator for an event listener to be pulled from the service container.

An enumeration of priorities for event listeners that you are encouraged to use when adding them in the Dispatcher.

Command listing information about the application's event dispatcher.

Generic Buffer stream handler

A File handling class

A Folder handling class

File system helper

A Unified Diff Format Patcher class

A Path handling class

Joomla! Stream Interface

FTP client class

Exception class for handling errors in the Filesystem package

String Stream Wrapper

String Controller

InputFilter is a class for filtering input from any data source

OutputFilter is a class for processing an output string for "safe" display

GitHub API object class for the Joomla Framework.

GitHub API package class for the Joomla Framework.

Joomla Framework class for interacting with a GitHub server instance.

GitHub API Activity class for the Joomla Framework.

GitHub API Authorization class for the Joomla Framework.

GitHub API DB class for the Joomla Framework.

GitHub API Emojis class for the Joomla Framework.

GitHub API Gists class for the Joomla Framework.

GitHub API Gitignore class for the Joomla Framework.

GitHub API GraphQL class for the Joomla Framework.

GitHub API Issues class for the Joomla Framework.

GitHub API Markdown class.

GitHub API Meta class for the Joomla Framework.

GitHub API Activity class for the Joomla Framework.

GitHub API Pull Requests class for the Joomla Framework.

GitHub API Activity class for the Joomla Framework.

GitHub API Search class for the Joomla Framework.

GitHub API References class for the Joomla Framework.

GitHub API Zen class for the Joomla Framework.

GitHub API Activity Events class for the Joomla Framework.

GitHub API Activity Feeds class for the Joomla Framework.

GitHub API Activity Events class for the Joomla Framework.

GitHub API Activity Events class for the Joomla Framework.

GitHub API Activity Watching Events class for the Joomla Framework.

GitHub API Data Blobs class for the Joomla Framework.

GitHub API Data Commits class for the Joomla Framework.

GitHub API References class for the Joomla Framework.

GitHub API Data Tags class for the Joomla Framework.

GitHub API Data Trees class for the Joomla Framework.

GitHub API Gists Comments class for the Joomla Framework.

GitHub API Assignees class for the Joomla Framework.

GitHub API Comments class for the Joomla Framework.

GitHub API Issues Events class for the Joomla Framework.

GitHub API Milestones class for the Joomla Framework.

GitHub API Milestones class for the Joomla Framework.

GitHub API Orgs Hooks class for the Joomla Framework.

GitHub API Orgs Members class for the Joomla Framework.

GitHub API Orgs Teams class for the Joomla Framework.

GitHub API Pulls Comments class for the Joomla Framework.

GitHub API Repositories Branches class for the Joomla Framework.

GitHub API Repositories Collaborators class for the Joomla Framework.

GitHub API Repositories Comments class for the Joomla Framework.

GitHub API Repositories Commits class for the Joomla Framework.

GitHub API Repositories Contents class for the Joomla Framework.

GitHub API Deployments class for the Joomla Framework.

GitHub API Repositories Downloads class for the Joomla Framework.

GitHub API Forks class for the Joomla Framework.

GitHub API Hooks class for the Joomla Framework.

GitHub API Forks class for the Joomla Framework.

GitHub API Repositories Merging class for the Joomla Framework.

GitHub API Repositories Pages class for the Joomla Framework.

GitHub API References class for the Joomla Platform.

GitHub API class for the Joomla Framework.

GitHub API References class for the Joomla Framework.

GitHub API Emails class for the Joomla Framework.

GitHub API Followers class for the Joomla Framework.

GitHub API References class for the Joomla Framework.

Abstract transport class.

HTTP client class.

HTTP factory class.

HTTP response data object class.

Exception representing an invalid or undefined HTTP response code

Exception representing an unexpected response

HTTP transport class for using cURL.

HTTP transport class for using sockets directly.

HTTP transport class for using PHP streams.

Joomla! Input Cookie Class

Joomla! Input Files Class

Joomla! Input Base Class

Joomla! Input JSON Class

Keychain Class

Base class for all keychain console commands.

Command class to add an entry to a keychain

Command class to delete an entry in a keychain

Command class to edit an entry in a keychain

Command class to list entries in a keychain

Command class to read a single entry from a keychain

Languages/translation handler class

Language package factory

Helper class for the Language package

Catalogue of loaded translation strings for a language

Registry of file parsers

Text handling class.

Class to transliterate strings

Abstract localisation handler class

en-GB localisation handler class

Language file parser for INI files

LanguageFactory object service provider

Porter English stemmer class.

Mediawiki API object class for the Joomla Framework.

MediaWiki API Categories class.

HTTP client class for connecting to a MediaWiki instance.

MediaWiki API Images class.

MediaWiki API Links class.

Class for interacting with a MediaWiki server instance.

MediaWiki API Pages class.

MediaWiki API Search class.

MediaWiki API Sites class.

MediaWiki API Users class.

Joomla Framework class for interacting with an OAuth 1.0 and 1.0a server.

Joomla Framework class for interacting with an OAuth 2.0 server.

Manager for HTTP/2 asset preloading

Asset preloading event subscriber

Service provider for preload package services

Implementation of ProfilePointInterface.

Implementation of ProfilerInterface.

Default profiler renderer.

Factory class to fetch Registry objects

Registry class

INI format handler for Registry.

JSON format handler for Registry.

PHP class format handler for Registry

XML format handler for Registry.

YAML format handler for Registry.

Abstract class for templates renderer

Blade class for rendering output.

Mustache class for rendering output.

PhpEngine template renderer

Plates class for rendering output.

Twig class for rendering output.

An object representing a resolved route.

An object representing a route definition.

A path router.

Command listing information about the application's router.

Exception defining a method not allowed error.

Exception defining a route not found error.

Class for managing HTTP sessions

Class representing a Session event

Class defining the events dispatched by the session API

Class defining the various states of a session

Command used to create the session database table.

Exception thrown when the database session table cannot be created

Exception thrown when a session validator fails

Exception thrown when the database driver is unsupported

APCu session storage handler

Database session storage handler

Filesystem session storage handler

Memcached session storage handler

Redis session storage handler

Wincache session storage handler

Base class providing a session store

Session storage object that stores objects in Runtime memory. This is designed for use in CLI Apps, including unit testing applications in PHPUnit.

Interface for validating a part of the session

Interface for validating a part of the session

Joomla Framework String Inflector Class

Joomla Framework String Normalise Class

String handling class for UTF-8 data wrapping the phputf8 library. All functions assume the validity of UTF-8 strings.

Helper class for building a database connection in the test environment

Base test case for tests interacting with a database

Static helper methods to assist unit testing PHP code.

Exception indicating the database connection has not yet been initialized

Exception indicating the database credentials have not been set

Base Joomla Uri Class

Uri Class

Uri Helper

UriImmutable Class

ArrayHelper is an array utility class for doing all sorts of odds and ends with arrays.

IpHelper is a utility class for processing IP addresses

Joomla Framework Abstract View Class

Joomla Framework HTML View Class

Joomla Framework JSON View Class