Constants

_QQ_

Allows for quoting in language .ini files.

deprecated

2.0

package

Joomla Framework

CRLF

package

Joomla Framework

FTP_ASCII

package

Joomla Framework

FTP_AUTOASCII

package

Joomla Framework

FTP_BINARY

package

Joomla Framework

FTP_NATIVE

package

Joomla Framework

Classes

AbstractApplication

Joomla Framework Base Application Class

« More »

AbstractCliApplication

Base class for a Joomla! command line application.

« More »

AbstractDaemonApplication

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

« More »

AbstractWebApplication

Base class for a Joomla! Web application.

« More »

Classes

CliInput

Class CliInput

« More »

CliOutput

Class CliOutput

« More »

ColorProcessor

Class ColorProcessor.

« More »

ColorStyle

Class ColorStyle

« More »

Classes

Stdout

Class Stdout.

« More »

Xml

Class Xml.

« More »

Interfaces

ProcessorInterface

Class ProcessorInterface.

« More »

Classes

ColorProcessor

Class ColorProcessor.

« More »

Classes

WebClient

Class to model a Web Client.

« More »

Interfaces

ExtractableInterface

Archive class interface

« More »

Classes

Archive

An Archive handling class

« More »

Bzip2

Bzip2 format adapter for the Archive package

« More »

Gzip

Gzip format adapter for the Archive package

This class is inspired from and draws heavily in code and concept from the Compress package of The Horde Project <http://www.horde.org>
« More »

Tar

Tar format adapter for the Archive package

This class is inspired from and draws heavily in code and concept from the Compress package of The Horde Project <http://www.horde.org>
« More »

Zip

ZIP format adapter for the Archive package

The ZIP compression code is partially based on code from: Eric Mueller <[email protected]> http://www.zend.com/codex.php?id=535&single=1 Deins125 <[email protected]> http://www.zend.com/codex.php?id=470&single=1 The ZIP compression date code is partially based on code from Peter Listiak <[email protected]> This class is inspired from and draws heavily in code and concept from the Compress package of The Horde Project <http://www.horde.org>
« More »

Classes

UnknownArchiveException

Exception class defining an unknown archive type

« More »

UnsupportedArchiveException

Exception class defining an unsupported archive adapter

« More »

Interfaces

AuthenticationStrategyInterface

Joomla Framework AuthenticationStrategy Interface

« More »

Classes

AbstractUsernamePasswordAuthenticationStrategy

Abstract AuthenticationStrategy for username/password based authentication

« More »

Authentication

Joomla Framework Authentication Class

« More »

Interfaces

HandlerInterface

Interface defining a password handler

« More »

Classes

Argon2idHandler

Password handler for Argon2id hashed passwords

« More »

Argon2iHandler

Password handler for Argon2i hashed passwords

« More »

BCryptHandler

Password handler for BCrypt hashed passwords

« More »

Classes

DatabaseStrategy

Joomla Framework Database Strategy Authentication class

« More »

LocalStrategy

Joomla Framework Local Strategy Authentication class

« More »

Classes

Application

Base application class for a Joomla! command line application.

« More »

ConsoleEvents

Class defining the events available in the console application.

« More »

Classes

AbstractCommand

Base command class for a Joomla! command line application.

« More »

HelpCommand

Command to render a command's help data.

« More »

ListCommand

Command listing all available commands.

« More »

Classes

ApplicationDescription

Describes an application.

« More »

TextDescriptor

Text object descriptor.

« More »

Classes

ApplicationErrorEvent

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

« More »

BeforeCommandExecuteEvent

Event triggered before a command is executed.

« More »

CommandErrorEvent

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

« More »

ConsoleEvent

Base event class for console events.

« More »

TerminateEvent

Event triggered immediately before the process is terminated.

« More »

Classes

NamespaceNotFoundException

Exception indicating a missing command namespace.

« More »

Classes

DescriptorHelper

Describes an object.

« More »

Interfaces

LoaderInterface

Interface defining a command loader.

« More »

Classes

ContainerLoader

PSR-11 compatible command loader.

« More »

Interfaces

ControllerInterface

Joomla Framework Controller Interface

« More »

Classes

AbstractController

Joomla Framework Base Controller Class

« More »

Interfaces

DumpableInterface

An interface to define if an object is dumpable.

« More »

Classes

DataObject

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.

« More »

DataSet

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

« More »

Interfaces

DatabaseInterface

Joomla Framework Database Interface

« More »

Classes

DatabaseDriver

Joomla Framework Database Driver Class

« More »

DatabaseExporter

Joomla Framework Database Exporter Class

« More »

DatabaseFactory

Joomla Framework Database Factory class

« More »

DatabaseImporter

Joomla Framework Database Importer Class

« More »

DatabaseIterator

Joomla Framework Database Driver Class

« More »

DatabaseQuery

Joomla Framework Query Building Class.

« More »

Classes

ConnectionFailureException

Exception class defining an error connecting to the database platform

« More »

ExecutionFailureException

Exception class defining an error executing a statement

« More »

UnsupportedAdapterException

Exception class defining an unsupported database object

« More »

Classes

MysqlDriver

MySQL database driver supporting PDO based connections

« More »

MysqlExporter

MySQL Database Exporter.

« More »

MysqlImporter

MySQL Database Importer.

« More »

MysqlIterator

MySQL Database Iterator

« More »

MysqlQuery

MySQL Query Building Class.

« More »

Classes

MysqliDriver

MySQLi Database Driver

« More »

MysqliExporter

MySQLi Database Exporter.

« More »

MysqliImporter

MySQLi Database Importer.

« More »

MysqliIterator

MySQLi Database Iterator.

« More »

MysqliQuery

MySQLi Query Building Class.

« More »

Classes

OracleDriver

Oracle Database Driver supporting PDO based connections

« More »

OracleIterator

Oracle Database Iterator.

« More »

OracleQuery

Oracle Query Building Class.

« More »

Classes

PdoDriver

Joomla Framework PDO Database Driver Class

« More »

PdoIterator

PDO Database Iterator.

« More »

PdoQuery

PDO Query Building Class.

« More »

Classes

PgsqlDriver

PostgreSQL PDO Database Driver

« More »

PgsqlExporter

PDO PostgreSQL Database Exporter.

« More »

PgsqlImporter

PDO PostgreSQL Database Importer.

« More »

PgsqlIterator

PDO PostgreSQL Database Iterator.

« More »

PgsqlQuery

PDO PostgreSQL Query Building Class.

« More »

Classes

PostgresqlDriver

PostgreSQL Database Driver

« More »

PostgresqlExporter

PostgreSQL Database Exporter.

« More »

PostgresqlImporter

PostgreSQL Database Importer.

« More »

PostgresqlIterator

PostgreSQL Database Iterator.

« More »

PostgresqlQuery

PostgreSQL Query Building Class.

« More »

Interfaces

LimitableInterface

Joomla Database Query LimitableInterface.

Adds bind/unbind methods as well as a getBounded() method to retrieve the stored bounded variables on demand prior to query execution.
« More »

PreparableInterface

Joomla Database Query Preparable Interface.

Adds bind/unbind methods as well as a getBounded() method to retrieve the stored bounded variables on demand prior to query execution.
« More »

Classes

QueryElement

Query Element Class.

« More »

Classes

SqlazureDriver

SQL Azure Database Driver

« More »

SqlazureIterator

SQL Azure Database Iterator.

« More »

SqlazureQuery

SQL Azure Query Building Class.

« More »

Classes

SqliteDriver

SQLite database driver supporting PDO based connections

« More »

SqliteIterator

SQLite Database Iterator.

« More »

SqliteQuery

SQLite Query Building Class.

« More »

Classes

SqlsrvDriver

SQL Server Database Driver

« More »

SqlsrvIterator

SQL Server Database Iterator.

« More »

SqlsrvQuery

SQL Server Query Building Class.

« More »

Traits

ContainerAwareTrait

Defines the trait for a Container Aware Class.

« More »

Interfaces

ContainerAwareInterface

Defines the interface for a Container Aware class.

« More »

ServiceProviderInterface

Defines the interface for a Service Provider.

« More »

Classes

Container

The Container class.

« More »

Classes

DependencyResolutionException

Exception class for handling errors in resolving a dependency

« More »

KeyNotFoundException

No entry was found in the container.

« More »

ProtectedKeyException

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

« More »

Traits

DispatcherAwareTrait

Defines the trait for a Dispatcher Aware Class.

« More »

Interfaces

DispatcherAwareInterface

Interface to be implemented by classes depending on a dispatcher.

« More »

DispatcherInterface

Interface for event dispatchers.

« More »

EventInterface

Interface for events.

An event has a name and its propagation can be stopped (if the implementation supports it).
« More »

Classes

AbstractEvent

Implementation of EventInterface.

« More »

DelegatingDispatcher

A dispatcher delegating its methods to an other dispatcher.

« More »

Dispatcher

Implementation of a DispatcherInterface supporting prioritized listeners.

« More »

Event

Default Event class.

« More »

EventImmutable

Implementation of an immutable Event.

An immutable event cannot be modified after instanciation : - its propagation cannot be stopped - its arguments cannot be modified You may want to use this event when you want to ensure that the listeners won't manipulate it.
« More »

ListenersPriorityQueue

A class containing an inner listeners priority queue that can be iterated multiple times.

One instance of ListenersPriorityQueue is used per Event in the Dispatcher.
« More »

Priority

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

« More »

Classes

Buffer

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 »

File

A File handling class

« More »

Folder

A Folder handling class

« More »

Helper

File system helper

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

Patcher

A Unified Diff Format Patcher class

« More »

Path

A Path handling class

« More »

Stream

Joomla! Stream Interface

The Joomla! stream interface is designed to handle files as streams where as the legacy JFile static class treated files in a rather atomic manner. This class adheres to the stream wrapper operations:
« More »

Classes

FtpClient

FTP client class

« More »

Classes

FilesystemException

Exception class for handling errors in the Filesystem package

« More »

Classes

String

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 »

StringWrapper

String Stream Wrapper

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

Classes

StringController

String Controller

« More »

Classes

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 »

OutputFilter

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

« More »

Classes

AbstractGithubObject

GitHub API object class for the Joomla Framework.

« More »

AbstractPackage

GitHub API package class for the Joomla Framework.

« More »

Github

Joomla Framework class for interacting with a GitHub server instance.

« More »

GithubObject

GitHub API object class for the Joomla Framework.

« More »

Http

HTTP client class for connecting to a GitHub instance.

« More »

Package

GitHub API package class for the Joomla Framework.

« More »

Classes

Activity

GitHub API Activity class for the Joomla Framework.

« More »

Authorization

GitHub API Authorization class for the Joomla Framework.

« More »

Data

GitHub API DB class for the Joomla Framework.

« More »

Emojis

GitHub API Emojis class for the Joomla Framework.

« More »

Gists

GitHub API Gists class for the Joomla Framework.

« More »

Gitignore

GitHub API Gitignore class for the Joomla Framework.

The .gitignore Templates API lists and fetches templates from the GitHub .gitignore repository.
« More »

Graphql

GitHub API GraphQL class for the Joomla Framework.

« More »

Issues

GitHub API Issues class for the Joomla Framework.

« More »

Markdown

GitHub API Markdown class.

« More »

Meta

GitHub API Meta class for the Joomla Framework.

« More »

Orgs

GitHub API Activity class for the Joomla Framework.

« More »

Pulls

GitHub API Pull Requests class for the Joomla Framework.

« More »

Repositories

GitHub API Activity class for the Joomla Framework.

« More »

Users

GitHub API References class for the Joomla Framework.

« More »

Zen

GitHub API Zen class for the Joomla Framework.

« More »

Classes

Events

GitHub API Activity Events class for the Joomla Framework.

« More »

Feeds

GitHub API Activity Feeds class for the Joomla Framework.

« More »

Notifications

GitHub API Activity Events class for the Joomla Framework.

« More »

Starring

GitHub API Activity Events class for the Joomla Framework.

« More »

Watching

GitHub API Activity Watching Events class for the Joomla Framework.

« More »

Classes

Blobs

GitHub API Data Blobs class for the Joomla Framework.

Since blobs can be any arbitrary binary data, the input and responses for the blob API takes an encoding parameter that can be either utf-8 or base64. If your data cannot be losslessly sent as a UTF-8 string, you can base64 encode it.
« More »

Commits

GitHub API Data Commits class for the Joomla Framework.

« More »

Refs

GitHub API References class for the Joomla Framework.

« More »

Tags

GitHub API Data Tags class for the Joomla Framework.

This tags API only deals with tag objects - so only annotated tags, not lightweight tags.
« More »

Trees

GitHub API Data Trees class for the Joomla Framework.

« More »

Classes

Comments

GitHub API Gists Comments class for the Joomla Framework.

« More »

Classes

Assignees

GitHub API Assignees class for the Joomla Framework.

« More »

Comments

GitHub API Comments class for the Joomla Framework.

The Issue Comments API supports listing, viewing, editing, and creating comments on issues and pull requests.
« More »

Events

GitHub API Issues Events class for the Joomla Framework.

Records various events that occur around an Issue or Pull Request. This is useful both for display on issue/pull request information pages and also to determine who should be notified of comments.
« More »

Labels

GitHub API Milestones class for the Joomla Framework.

« More »

Milestones

GitHub API Milestones class for the Joomla Framework.

« More »

Classes

Hooks

GitHub API Orgs Hooks class for the Joomla Framework.

All actions against organization webhooks require the authenticated user to be an admin of the organization being managed. Additionally, OAuth tokens require the "admin:org_hook" scope.
« More »

Members

GitHub API Orgs Members class for the Joomla Framework.

« More »

Teams

GitHub API Orgs Teams class for the Joomla Framework.

All actions against teams require at a minimum an authenticated user who is a member of the owner’s team in the :org being managed. Additionally, OAuth users require “user” scope.
« More »

Classes

Comments

GitHub API Pulls Comments class for the Joomla Framework.

« More »

Classes

Branches

GitHub API Repositories Branches class for the Joomla Framework.

« More »

Collaborators

GitHub API Repositories Collaborators class for the Joomla Framework.

« More »

Comments

GitHub API Repositories Comments class for the Joomla Framework.

« More »

Commits

GitHub API Repositories Commits class for the Joomla Framework.

« More »

Contents

GitHub API Repositories Contents class for the Joomla Framework.

These API methods let you retrieve the contents of files within a repository as Base64 encoded content. See media types for requesting raw or other formats.
« More »

Deployments

GitHub API Deployments class for the Joomla Framework.

« More »

Downloads

GitHub API Repositories Downloads class for the Joomla Framework.

The downloads API is for package downloads only. If you want to get source tarballs you should use http://developer.github.com/v3/repos/contents/#get-archive-link instead.
« More »

Forks

GitHub API Forks class for the Joomla Framework.

« More »

Hooks

GitHub API Hooks class for the Joomla Framework.

« More »

Keys

GitHub API Forks class for the Joomla Framework.

« More »

Merging

GitHub API Repositories Merging class for the Joomla Framework.

« More »

Pages

GitHub API Repositories Pages class for the Joomla Framework.

« More »

Releases

GitHub API References class for the Joomla Platform.

« More »

Statistics

GitHub API class for the Joomla Framework.

The Repository Statistics API allows you to fetch the data that GitHub uses for visualizing different types of repository activity.
« More »

Statuses

GitHub API References class for the Joomla Framework.

« More »

Classes

Emails

GitHub API Emails class for the Joomla Framework.

Management of email addresses via the API requires that you are authenticated through basic auth or OAuth with the user scope.
« More »

Followers

GitHub API Followers class for the Joomla Framework.

« More »

Keys

GitHub API References class for the Joomla Framework.

« More »

Interfaces

TransportInterface

HTTP transport class interface.

« More »

Classes

Http

HTTP client class.

« More »

HttpFactory

HTTP factory class.

« More »

Response

HTTP response data object class.

« More »

Classes

InvalidResponseCodeException

Exception representing an invalid or undefined HTTP response code

« More »

UnexpectedResponseException

Exception representing an unexpected response

« More »

Classes

Curl

HTTP transport class for using cURL.

« More »

Socket

HTTP transport class for using sockets directly.

« More »

Stream

HTTP transport class for using PHP streams.

« More »

Classes

Cli

Joomla! Input CLI Class

« More »

Files

Joomla! Input Files Class

« More »

Input

Joomla! Input Base Class

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

Json

Joomla! Input JSON Class

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

Classes

Keychain

Keychain Class

« More »

Interfaces

StemmerInterface

Stemmer interface.

« More »

Classes

Language

Languages/translation handler class

« More »

LanguageFactory

Language package factory

« More »

Stemmer

Stemmer base class.

« More »

Text

Text handling class.

« More »

Transliterate

Class to transliterate strings

« More »

Classes

Porteren

Porter English stemmer class.

This class was adapted from one written by Richard Heyes. See copyright and link information above.
« More »

Classes

AbstractMediawikiObject

Mediawiki API object class for the Joomla Framework.

« More »

Categories

MediaWiki API Categories class.

« More »

Http

HTTP client class for connecting to a MediaWiki instance.

« More »

Images

MediaWiki API Images class.

« More »

Mediawiki

Class for interacting with a MediaWiki server instance.

« More »

Pages

MediaWiki API Pages class.

« More »

Sites

MediaWiki API Sites class.

« More »

Users

MediaWiki API Users class.

« More »

Traits

DatabaseModelTrait

Trait representing a model holding a database reference

« More »

StatefulModelTrait

Trait representing a model holding a state

« More »

Interfaces

DatabaseModelInterface

Joomla Framework Database Model Interface

« More »

ModelInterface

Joomla Framework Model Interface

« More »

StatefulModelInterface

Joomla Framework Stateful Model Interface

« More »

Classes

AbstractDatabaseModel

Joomla Framework Database Model Class

« More »

AbstractModel

Joomla Framework Base Model Class

« More »

Classes

Client

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

« More »

Classes

Client

Joomla Framework class for interacting with an OAuth 2.0 server.

« More »

Classes

PreloadManager

Manager for HTTP/2 asset preloading

« More »

Classes

PreloadSubscriber

Asset preloading event subscriber

« More »

Classes

PreloadProvider

Service provider for preload package services

« More »

Interfaces

ProfilePointInterface

Interface for profile points.

A Profile point belongs to a ProfilerInterface and the values it holds (time and memory) are relative to the values of the first marked point in that profiler.
« More »

ProfilerInterface

Interface for Profilers containing a sequence of ProfilePointInterface.

« More »

ProfilerRendererInterface

Interface for profiler renderers.

« More »

Classes

ProfilePoint

Implementation of ProfilePointInterface.

« More »

Profiler

Implementation of ProfilerInterface.

« More »

Classes

DefaultRenderer

Default profiler renderer.

« More »

Interfaces

FormatInterface

Interface defining a format object

« More »

Classes

AbstractRegistryFormat

Abstract Format for Registry

« More »

Factory

Factory class to fetch Registry objects

« More »

Registry

Registry class

« More »

Classes

Ini

INI format handler for Registry.

« More »

Json

JSON format handler for Registry.

« More »

Php

PHP class format handler for Registry

« More »

Xml

XML format handler for Registry.

« More »

Yaml

YAML format handler for Registry.

« More »

Interfaces

AddTemplateFolderInterface

Interface for a renderer which can have template paths added during runtime.

« More »

ConfigurableFileExtensionInterface

Interface defining a renderer with a configurable file extension.

« More »

RendererInterface

Rendering interface.

« More »

Classes

AbstractRenderer

Abstract class for templates renderer

« More »

BladeRenderer

Blade class for rendering output.

« More »

MustacheRenderer

Mustache class for rendering output.

« More »

PhpEngineRenderer

PhpEngine template renderer

« More »

PlatesRenderer

Plates class for rendering output.

« More »

TwigRenderer

Twig class for rendering output.

« More »

Classes

RestRouter

RESTful Web application router class for the Joomla Framework.

« More »

Router

A path router.

« More »

Classes

Inflector

Joomla Framework String Inflector Class

The Inflector transforms words
« More »

Normalise

Joomla Framework String Normalise Class

« More »

String

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

« More »

StringHelper

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

« More »

Classes

Config

Test stub configuration class.

« More »

TestDatabase

Abstract test case class for database testing.

« More »

TestHelper

Static helper methods to assist unit testing PHP code.

« More »

WebInspector

Inspector for the Joomla\Application\AbstractWebApplication class.

« More »

Classes

PhpUnit6TestCase

Compatibility test case used for PHPUnit 6.x and earlier

« More »

PhpUnit7TestCase

Compatibility test case used for PHPUnit 7.x and later

« More »

TestCase

Compatibility test case used for PHPUnit 6.x and earlier

« More »

Interfaces

UriInterface

Uri Interface

Interface for read-only access to Uris.
« More »

Classes

AbstractUri

Uri Class

Abstract base for out uri classes. This class should be considered an implementation detail. Typehint against UriInterface.
« More »

Uri

Uri Class

This class parses a URI and provides a common interface for the Joomla Framework to access and manipulate a URI.
« More »

UriHelper

Uri Helper

This class provides a UTF-8 safe version of parse_url().
« More »

UriImmutable

Uri Class

This is an immutable version of the uri class.
« More »

Classes

ArrayHelper

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

« More »

IpHelper

IpHelper is a utility class for processing IP addresses

« More »

Interfaces

ViewInterface

Joomla Framework View Interface

« More »

Classes

AbstractHtmlView

Joomla Framework HTML View Class

« More »

AbstractView

Joomla Framework Abstract View Class

« More »