Joomla! API

Download
Launch
  • \ Joomla
  • \ CMS

Classes

Factory

Joomla Platform Factory class.

« More »

Version

Version information class for the Joomla CMS.

« More »
  • \ Joomla
  • \ CMS
  • \ Access

Classes

Access

Class that handles all access authorisation routines.

« More »

Rule

Rule class.

« More »

Rules

Access rules class.

« More »
  • \ Joomla
  • \ CMS
  • \ Access
  • \ Exception

Classes

NotAllowed

Exception class defining a not allowed access

« More »
  • \ Joomla
  • \ CMS
  • \ Access
  • \ Wrapper

Classes

Access

Wrapper class for Access

« More »
  • \ Joomla
  • \ CMS
  • \ Adapter

Classes

Adapter

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

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

AdapterInstance

Adapter Instance Class

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

Classes

AdministratorApplication

Joomla! Administrator Application class

« More »

ApplicationHelper

Application helper functions

« More »

BaseApplication

Joomla Platform Base Application Class

« More »

CliApplication

Base class for a Joomla! command line application.

« More »

CMSApplication

Joomla! CMS Application class

« More »

DaemonApplication

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

« More »

SiteApplication

Joomla! Site Application class

« More »

WebApplication

Base class for a Joomla! Web application.

« More »
  • \ Joomla
  • \ CMS
  • \ Association

Interfaces

AssociationExtensionInterface

Association Extension Interface for the helper classes

« More »

Classes

AssociationExtensionHelper

Association Extension Helper

« More »
  • \ Joomla
  • \ CMS
  • \ Authentication

Classes

Authentication

Authentication class, provides an interface for the Joomla authentication system

« More »

AuthenticationResponse

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

« More »
  • \ Joomla
  • \ CMS
  • \ Cache

Classes

Cache

Joomla! Cache base object

« More »

CacheController

Public cache handler

« More »

CacheStorage

Abstract cache storage handler

« More »
  • \ Joomla
  • \ CMS
  • \ Cache
  • \ Controller

Classes

CallbackController

Joomla! Cache callback type object

« More »

OutputController

Joomla Cache output type object

« More »

PageController

Joomla! Cache page type object

« More »

ViewController

Joomla! Cache view type object

« More »
  • \ Joomla
  • \ CMS
  • \ Cache
  • \ Exception

Interfaces

CacheExceptionInterface

Exception interface defining a cache storage error

« More »

Classes

CacheConnectingException

Exception class defining an error connecting to the cache storage engine

« More »

UnsupportedCacheException

Exception class defining an unsupported cache storage object

« More »
  • \ Joomla
  • \ CMS
  • \ Cache
  • \ Storage

Classes

ApcStorage

APC cache storage handler

« More »

ApcuStorage

APCu cache storage handler

« More »

CacheliteStorage

Cache lite storage handler

« More »

CacheStorageHelper

Cache storage helper functions.

« More »

FileStorage

File cache storage handler

« More »

MemcachedStorage

Memcached cache storage handler

« More »

MemcacheStorage

Memcache cache storage handler

« More »

RedisStorage

Redis cache storage handler for PECL

« More »

WincacheStorage

WinCache cache storage handler

« More »

XcacheStorage

XCache cache storage handler

« More »
  • \ Joomla
  • \ CMS
  • \ Captcha

Classes

Captcha

Joomla! Captcha base object

« More »
  • \ Joomla
  • \ CMS
  • \ Captcha
  • \ Google

Classes

HttpBridgePostRequestMethod

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

« More »
  • \ Joomla
  • \ CMS
  • \ Categories

Interfaces

CategoryFactoryInterface

Category factory interface

« More »

CategoryInterface

The category interface.

« More »

Classes

Categories

Categories Class.

« More »

CategoryFactory

Option based categories factory.

« More »

CategoryNode

Helper class to load Categorytree

« More »

SectionNotFoundException

Representing when a category section cannot be found.

« More »
  • \ Joomla
  • \ CMS
  • \ Client

Classes

ClientHelper

Client helper class

« More »

ClientWrapper

Wrapper class for ClientHelper

« More »

FtpClient

FTP client class

« More »
  • \ Joomla
  • \ CMS
  • \ Component

Classes

ComponentHelper

Component helper class

« More »

ComponentRecord

Object representing a component extension record

« More »
  • \ Joomla
  • \ CMS
  • \ Component
  • \ Exception

Classes

MissingComponentException

Exception class defining an error for a missing component

« More »
  • \ Joomla
  • \ CMS
  • \ Component
  • \ Router

Interfaces

RouterInterface

Component routing interface

« More »

Classes

RouterBase

Base component routing class

« 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 »
  • \ Joomla
  • \ CMS
  • \ Component
  • \ Router
  • \ Rules

Interfaces

RulesInterface

RouterRules interface for Joomla

« More »

Classes

MenuRules

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

« More »

NomenuRules

Rule to process URLs without a menu item

« More »

StandardRules

Rule for the standard handling of component routing

« More »
  • \ Joomla
  • \ CMS
  • \ Crypt

Interfaces

CipherInterface

Crypt cipher interface.

« More »

CryptPassword

Joomla Platform Password Hashing Interface

« More »

Classes

Crypt

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

« More »

Key

Encryption key object for the Joomla Platform.

« More »
  • \ Joomla
  • \ CMS
  • \ Crypt
  • \ Cipher

Classes

BlowfishCipher

Crypt cipher for Blowfish encryption, decryption and key generation.

« More »

CryptoCipher

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

« More »

McryptCipher

Crypt cipher for mcrypt algorithm encryption, decryption and key generation.

« More »

Rijndael256Cipher

Crypt cipher for Rijndael 256 encryption, decryption and key generation.

« More »

SimpleCipher

Crypt cipher for Simple encryption, decryption and key generation.

« More »

SodiumCipher

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

« More »

TripleDesCipher

JCrypt cipher for Triple DES encryption, decryption and key generation.

« More »
  • \ Joomla
  • \ CMS
  • \ Crypt
  • \ Password

Classes

SimpleCryptPassword

Joomla Platform Password Crypter

« More »
  • \ Joomla
  • \ CMS
  • \ Date

Classes

Date

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

« More »
  • \ Joomla
  • \ CMS
  • \ Document

Classes

Document

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

« More »

DocumentRenderer

Abstract class for a renderer

« More »

ErrorDocument

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

« More »

FeedDocument

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

« More »

HtmlDocument

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

« More »

ImageDocument

ImageDocument class, provides an easy interface to output image data

« More »

JsonDocument

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

« More »

OpensearchDocument

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

« More »

RawDocument

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

« More »

XmlDocument

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

« More »
  • \ Joomla
  • \ CMS
  • \ Document
  • \ Feed

Classes

FeedEnclosure

Data object representing a feed enclosure

« More »

FeedImage

Data object representing a feed image

« More »

FeedItem

Data object representing a feed item

« More »
  • \ Joomla
  • \ CMS
  • \ Document
  • \ Opensearch

Classes

OpensearchImage

Data object representing an OpenSearch image

« More »

OpensearchUrl

Data object representing an OpenSearch URL

« More »
  • \ Joomla
  • \ CMS
  • \ Document
  • \ Renderer
  • \ Feed

Classes

AtomRenderer

AtomRenderer is a feed that implements the atom specification

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

RssRenderer

RssRenderer is a feed that implements RSS 2.0 Specification

« More »
  • \ Joomla
  • \ CMS
  • \ Document
  • \ Renderer
  • \ Html

Classes

ComponentRenderer

HTML document renderer for the component output

« More »

HeadRenderer

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

« More »

MessageRenderer

HTML document renderer for the system message queue

« More »

ModuleRenderer

HTML document renderer for a single module

« More »

ModulesRenderer

HTML document renderer for a module position

« More »
  • \ Joomla
  • \ CMS
  • \ Editor

Classes

Editor

Editor class to handle WYSIWYG editors

« More »
  • \ Joomla
  • \ CMS
  • \ Environment

Classes

Browser

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

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

Classes

ExceptionHandler

Displays the custom error page when an uncaught exception occurs.

« More »
  • \ Joomla
  • \ CMS
  • \ Extension

Classes

ExtensionHelper

Extension Helper class.

« More »
  • \ Joomla
  • \ CMS
  • \ Feed

Classes

Feed

Class to encapsulate a feed for the Joomla Platform.

« More »

FeedEntry

Class to encapsulate a feed entry for the Joomla Platform.

« More »

FeedFactory

Feed factory class.

« More »

FeedLink

Feed Link class.

« More »

FeedParser

Feed Parser class.

« More »

FeedPerson

Feed Person class.

« More »
  • \ Joomla
  • \ CMS
  • \ Feed
  • \ Parser

Interfaces

NamespaceParserInterface

Feed Namespace interface.

« More »

Classes

AtomParser

ATOM Feed Parser class.

« More »

RssParser

RSS Feed Parser class.

« More »
  • \ Joomla
  • \ CMS
  • \ Feed
  • \ Parser
  • \ Rss

Classes

ItunesRssParser

RSS Feed Parser Namespace handler for iTunes.

« More »

MediaRssParser

RSS Feed Parser Namespace handler for MediaRSS.

« More »
  • \ Joomla
  • \ CMS
  • \ Filesystem

Classes

File

A File handling class

« More »

FilesystemHelper

File system helper

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

Folder

A Folder handling class

« More »

Patcher

A Unified Diff Format Patcher class

« More »

Path

A Path handling class

« More »

Stream

Joomla! Stream Interface

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

Classes

StreamString

String Stream Wrapper

This class allows you to use a PHP string in the same way that you would normally use a regular stream wrapper
« More »
  • \ Joomla
  • \ CMS
  • \ Filesystem
  • \ Support

Classes

StringController

String Controller

« More »
  • \ Joomla
  • \ CMS
  • \ Filesystem
  • \ Wrapper

Classes

FileWrapper

Wrapper class for File

« More »

FolderWrapper

Wrapper class for Folder

« More »

PathWrapper

Wrapper class for Path

« More »
  • \ Joomla
  • \ CMS
  • \ Filter

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

« More »
  • \ Joomla
  • \ CMS
  • \ Filter
  • \ Wrapper

Classes

OutputFilterWrapper

Wrapper class for OutputFilter

« More »
  • \ Joomla
  • \ CMS
  • \ Form

Classes

Form

Form Class for the Joomla Platform.

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

FormField

Abstract Form Field class for the Joomla Platform.

« More »

FormHelper

Form's helper class.

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

FormRule

Form Rule class for the Joomla Platform.

« More »

FormWrapper

Wrapper class for FormHelper

« More »
  • \ Joomla
  • \ CMS
  • \ Form
  • \ Field

Classes

AuthorField

Form Field to load a list of content authors

Supports a generic list of options.
« More »

CaptchaField

Captcha field.

« More »

ChromestyleField

Chrome Styles field.

Provides a grouped list select field.
« More »

ContenthistoryField

Field to select Content History from a modal list.

« More »

ContentlanguageField

Provides a list of content languages

Supports a generic list of options.
« More »

ContenttypeField

Content Type field.

Supports a generic list of options.
« More »

EditorField

A textarea field for content creation

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

FrontendlanguageField

Provides a list of published content languages with home pages

Supports a generic list of options.
« More »

HeadertagField

Form Field class for the Joomla! CMS.

Supports a generic list of options.
« More »

HelpsiteField

Form Field class for the Joomla Platform.

Provides a select list of help sites.
« More »

LastvisitdaterangeField

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

Supports a generic list of options.
« More »

LimitboxField

Field to load a list of posible item count limits

Supports a generic list of options.
« More »

MediaField

Provides a modal media selector including upload mechanism

« More »

MenuField

Supports an HTML select list of menus

Provides a grouped list select field.
« More »

MenuitemField

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

Provides a grouped list select field.
« More »

ModuleorderField

Module Order field.

« More »

ModulepositionField

Module Position field.

Supports a one line text field.
« More »

ModuletagField

Module Tag field.

Supports a generic list of options.
« More »

OrderingField

Ordering field.

« More »

PluginstatusField

Plugin Status field.

Supports a generic list of options.
« More »

RedirectStatusField

Redirect Status field.

Supports a generic list of options.
« More »

RegistrationdaterangeField

Registration Date Range field.

Supports a generic list of options.
« More »

StatusField

Form Field to load a list of states

Supports a generic list of options.
« More »

TagField

List of Tags field.

Supports a generic list of options.
« More »

TemplatestyleField

Supports a select grouped list of template styles

Provides a grouped list select field.
« More »

UseractiveField

Field to show a list of available user active statuses

Supports a generic list of options.
« More »

UserField

Field to select a user ID from a modal list.

« More »

UsergrouplistField

Field to load a dropdown list of available user groups

Supports a generic list of options.
« More »

UserstateField

Field to load a list of available users statuses

Supports a generic list of options.
« More »
  • \ Joomla
  • \ CMS
  • \ Form
  • \ Rule

Classes

BooleanRule

Form Rule class for the Joomla Platform.

« More »

CalendarRule

Form Rule class for the Joomla Platform

« More »

CaptchaRule

Form Rule class for the Joomla Framework.

« More »

ColorRule

Form Rule class for the Joomla Platform.

« More »

EmailRule

Form Rule class for the Joomla Platform.

« More »

EqualsRule

Form Rule class for the Joomla Platform.

« More »

ExistsRule

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

« More »

FilePathRule

Form Rule class for the Joomla Platform.

« More »

ModuleLayoutRule

Form Rule class for the Joomla Platform.

« More »

NotequalsRule

Form Rule class for the Joomla Platform.

« More »

NumberRule

Form Rule class for the Joomla Platform.

« More »

OptionsRule

Form Rule class for the Joomla Platform.

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

PasswordRule

Form Rule class for the Joomla Platform.

« More »

RulesRule

Form Rule class for the Joomla Platform.

« More »

SubformRule

Form rule to validate subforms field-wise.

« More »

TelRule

Form Rule class for the Joomla Platform

« More »

UrlRule

Form Rule class for the Joomla Platform.

« More »

UsernameRule

Form Rule class for the Joomla Platform.

« More »
  • \ Joomla
  • \ CMS
  • \ Help

Classes

Help

Help system class

« More »
  • \ Joomla
  • \ CMS
  • \ Helper

Classes

AuthenticationHelper

Authentication helper class

« More »

CMSHelper

Base Helper class.

« More »

ContentHelper

Helper for standard content style extensions.

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

ContentHistoryHelper

Versions helper class, provides methods to perform various tasks relevant versioning of content.

« More »

LibraryHelper

Library helper class

« More »

MediaHelper

Media helper class

« More »

ModuleHelper

Module helper class

« More »

RouteHelper

Route Helper

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

SearchHelper

Helper class for Joomla! Search components

« More »

TagsHelper

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

« More »

UserGroupsHelper

Helper to deal with user groups.

« More »
  • \ Joomla
  • \ CMS
  • \ HTML

Classes

HTMLHelper

Utility class for all HTML drawing classes

« More »
  • \ Joomla
  • \ CMS
  • \ Http

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 »
  • \ Joomla
  • \ CMS
  • \ Http
  • \ Transport

Classes

CurlTransport

HTTP transport class for using cURL.

« More »

SocketTransport

HTTP transport class for using sockets directly.

« More »

StreamTransport

HTTP transport class for using PHP streams.

« More »
  • \ Joomla
  • \ CMS
  • \ Http
  • \ Wrapper

Classes

FactoryWrapper

Wrapper class for HttpFactory

« More »
  • \ Joomla
  • \ CMS
  • \ Image

Classes

Image

Class to manipulate an image.

« More »

ImageFilter

Class to manipulate an image.

« More »
  • \ Joomla
  • \ CMS
  • \ Input

Classes

Cli

Joomla! Input CLI Class

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

Cookie

Joomla! Input Cookie Class

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

Files

Joomla! Input Files Class

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

Input

Joomla! Input Base Class

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

Json

Joomla! Input JSON Class

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

Classes

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 »

Manifest

Joomla! Package Manifest File

« More »
  • \ Joomla
  • \ CMS
  • \ Installer
  • \ Adapter

Classes

ComponentAdapter

Component installer

« More »

FileAdapter

File installer

« More »

LanguageAdapter

Language installer

« More »

LibraryAdapter

Library installer

« More »

ModuleAdapter

Module installer

« More »

PackageAdapter

Package installer

« More »

PluginAdapter

Plugin installer

« More »

TemplateAdapter

Template installer

« More »
  • \ Joomla
  • \ CMS
  • \ Installer
  • \ Manifest

Classes

LibraryManifest

Joomla! Library Manifest File

« More »

PackageManifest

Joomla! Package Manifest File

« More »
  • \ Joomla
  • \ CMS
  • \ Language

Classes

Associations

Utility class for associations in multilang

« More »

Language

Languages/translation handler class

« More »

LanguageHelper

Language helper class

« More »

LanguageStemmer

Stemmer base class.

« More »

Multilanguage

Utility class for multilang

« More »

Text

Text handling class.

« More »

Transliterate

Class to transliterate strings

« More »
  • \ Joomla
  • \ CMS
  • \ Language
  • \ Stemmer

Classes

Porteren

Porter English stemmer class.

This class was adapted from one written by Richard Heyes. See copyright and link information above.
« More »
  • \ Joomla
  • \ CMS
  • \ Language
  • \ Wrapper

Classes

JTextWrapper

Wrapper class for JText

« More »

LanguageHelperWrapper

Wrapper class for LanguageHelper

« More »

TransliterateWrapper

Wrapper class for Transliterate

« More »
  • \ Joomla
  • \ CMS
  • \ Layout

Interfaces

LayoutInterface

Interface to handle display layout

« More »

Classes

BaseLayout

Base class for rendering a display layout

« More »

FileLayout

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

« More »

LayoutHelper

Helper to render a Layout object, storing a base path

« More »
  • \ Joomla
  • \ CMS
  • \ Log

Classes

DelegatingPsrLogger

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

« More »

Log

Joomla! Log Class

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

LogEntry

Joomla! Log Entry class

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

Logger

Joomla! Logger Base Class

This class is used to be the basis of logger classes to allow for defined functions to exist regardless of the child class.
« More »
  • \ Joomla
  • \ CMS
  • \ Log
  • \ Logger

Classes

CallbackLogger

Joomla! Callback Log class

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

DatabaseLogger

Joomla! MySQL Database Log class

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

EchoLogger

Joomla Echo logger class.

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

FormattedtextLogger

Joomla! Formatted Text File Log class

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

MessagequeueLogger

Joomla MessageQueue logger class.

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

SyslogLogger

Joomla! Syslog Log class

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

W3cLogger

Joomla! W3C Logging class

This class is designed to build log files based on the W3C specification.
« More »
  • \ Joomla
  • \ CMS
  • \ Mail

Classes

Mail

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

« More »

MailHelper

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

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

MailWrapper

Wrapper class for MailHelper

« More »
  • \ Joomla
  • \ CMS
  • \ Menu

Classes

AbstractMenu

Menu class

« More »

AdministratorMenu

Menu class.

« More »

MenuHelper

Menu Helper utility

« More »

MenuItem

Object representing a menu item

« More »

Node

A Node for MenuTree

« More »

SiteMenu

Menu class

« More »

Tree

Menu Tree class to represent a menu tree hierarchy

« More »
  • \ Joomla
  • \ CMS
  • \ Menu
  • \ Node

Classes

Component

A Component type of node for MenuTree

« More »

Container

A Container type of node for MenuTree

« More »

Heading

A Heading type of node for MenuTree

« More »

Separator

A Separator type of node for MenuTree

« More »

Url

An external Url type of node for MenuTree

« More »
  • \ Joomla
  • \ CMS
  • \ Microdata

Classes

Microdata

Joomla Platform class for interacting with Microdata semantics.

« More »
  • \ Joomla
  • \ CMS
  • \ MVC
  • \ Controller

Classes

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 »

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 »

FormController

Controller tailored to suit most form-based admin operations.

Controller (Controllers are where you put all the actual code.) Provides basic functionality, such as rendering views (aka displaying templates).
« More »
  • \ Joomla
  • \ CMS
  • \ MVC
  • \ Factory

Interfaces

MVCFactoryInterface

Factory to create MVC objects.

« More »

Classes

LegacyFactory

Factory to create MVC objects in legacy mode.

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

MVCFactory

Factory to create MVC objects based on a namespace.

« More »
  • \ Joomla
  • \ CMS
  • \ MVC
  • \ Model

Classes

AdminModel

Prototype admin model.

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

BaseDatabaseModel

Base class for a database aware Joomla Model

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

FormModel

Prototype form model.

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

ItemModel

Prototype item model.

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

ListModel

Model class for handling lists of items.

Acts as a Factory class for application specific objects and provides many supporting API functions.
« More »
  • \ Joomla
  • \ CMS
  • \ MVC
  • \ View

Classes

CategoriesView

Categories view base class.

Class holding methods for displaying presentation data.
« More »

CategoryFeedView

Base feed View class for a category

Class holding methods for displaying presentation data.
« More »

CategoryView

Base HTML View class for the a Category list

Class holding methods for displaying presentation data.
« More »

HtmlView

Base class for a Joomla View

Class holding methods for displaying presentation data.
« More »
  • \ Joomla
  • \ CMS
  • \ Object

Classes

CMSObject

Joomla Platform Object Class

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

Classes

Pagination

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

« More »

PaginationObject

Pagination object representing a particular item in the pagination lists.

« More »
  • \ Joomla
  • \ CMS
  • \ Pathway

Classes

Pathway

Class to maintain a pathway.

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

SitePathway

Class to manage the site application pathway.

The user's navigated path within the application.
« More »
  • \ Joomla
  • \ CMS
  • \ Plugin

Classes

CMSPlugin

Plugin Class

« More »

PluginHelper

Plugin helper class

« More »
  • \ Joomla
  • \ CMS
  • \ Profiler

Classes

Profiler

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

« More »
  • \ Joomla
  • \ CMS
  • \ Response

Classes

JsonResponse

JSON Response class.

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

Classes

AdministratorRouter

Class to create and parse routes

« More »

Route

Route handling class

« More »

Router

Class to create and parse routes

« More »

SiteRouter

Class to create and parse routes for the site application

« More »
  • \ Joomla
  • \ CMS
  • \ Router
  • \ Exception

Classes

RouteNotFoundException

Exception class defining an error for a missing route

« More »
  • \ Joomla
  • \ CMS
  • \ Schema

Classes

ChangeItem

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

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

ChangeSet

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

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

Classes

MysqlChangeItem

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

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

PostgresqlChangeItem

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

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

SqlsrvChangeItem

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

This class is used to check the site's database to see if the DDL query has been run. If not, it provides the ability to fix the database by re-running the DDL query. The queries are parsed from the update files in the folder `administrator/components/com_admin/sql/updates/<database>`. These updates are run automatically if the site was updated using com_installer. However, it is possible that the program files could be updated without udpating 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 »
  • \ Joomla
  • \ CMS
  • \ Session

Classes

MetadataManager

Manager for optional session metadata.

« More »

Session

Class for managing HTTP sessions

Provides access to session-state values as well as session-level settings and lifetime management methods. Based on the standard PHP session handling mechanism it provides more advanced features such as expire timeouts.
« More »
  • \ Joomla
  • \ CMS
  • \ Session
  • \ Exception

Classes

UnsupportedStorageException

Exception class defining an unsupported session storage object

« More »
  • \ Joomla
  • \ CMS
  • \ String

Classes

PunycodeHelper

Joomla Platform String Punycode Class

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

Interfaces

TableInterface

Table class interface.

« More »

Classes

Asset

Table class supporting modified pre-order tree traversal behavior.

Parent class to all tables.
« More »

Category

Category table

Parent class to all tables.
« More »

Content

Content table

Parent class to all tables.
« More »

ContentHistory

Content History table.

Parent class to all tables.
« More »

ContentType

Tags table

Parent class to all tables.
« More »

CoreContent

Core content table

Parent class to all tables.
« More »

Extension

Extension table

Parent class to all tables.
« More »

Language

Languages table.

Parent class to all tables.
« More »

Menu

Menu table

Parent class to all tables.
« More »

MenuType

Menu Types table

Parent class to all tables.
« More »

Module

Module table

Parent class to all tables.
« More »

Nested

Table class supporting modified pre-order tree traversal behavior.

Parent class to all tables.
« More »

Table

Abstract Table class

Parent class to all tables.
« More »

Ucm

UCM map table

Parent class to all tables.
« More »

Update

Update table Stores updates temporarily

Parent class to all tables.
« More »

UpdateSite

Update site table Stores the update sites for extensions

Parent class to all tables.
« More »

User

Users table

Parent class to all tables.
« More »

Usergroup

Usergroup table class.

Parent class to all tables.
« More »

ViewLevel

Viewlevels table class.

Parent class to all tables.
« More »
  • \ Joomla
  • \ CMS
  • \ Table
  • \ Observer

Classes

AbstractObserver

Table class supporting modified pre-order tree traversal behavior.

« More »

ContentHistory

Table class supporting modified pre-order tree traversal behavior.

« More »

Tags

Abstract class defining methods that can be implemented by an Observer class of a Table class (which is an Observable).

Attaches $this Observer to the $table in the constructor. The classes extending this class should not be instantiated directly, as they are automatically instanciated by the \JObserverMapper
« More »
  • \ Joomla
  • \ CMS
  • \ Tag

Interfaces

TaggableTableInterface

Empty Interface for a taggable Table class as a placeholder for extensions that need compatibility between Joomla Note: This is an empty placeholder to ease transition to the new system in 4.0. In 4.x this interface will contain 4 methods (these aren't included as they contain return typehints which would unncessarily increase the minimum PHP version required to use this interface).

« More »
  • \ Joomla
  • \ CMS
  • \ Toolbar

Classes

Toolbar

ToolBar handler

« More »

ToolbarButton

Button base class

The JButton is the base class for all JButton types
« More »

ToolbarHelper

Utility class for the button bar.

« More »
  • \ Joomla
  • \ CMS
  • \ Toolbar
  • \ Button

Classes

ConfirmButton

Renders a standard button with a confirm dialog

The JButton is the base class for all JButton types
« More »

CustomButton

Renders a custom button

The JButton is the base class for all JButton types
« More »

HelpButton

Renders a help popup window button

The JButton is the base class for all JButton types
« More »

LinkButton

Renders a link button

The JButton is the base class for all JButton types
« More »

PopupButton

Renders a modal window button

The JButton is the base class for all JButton types
« More »

SeparatorButton

Renders a button separator

The JButton is the base class for all JButton types
« More »

SliderButton

Renders a button to render an HTML element in a slider container

The JButton is the base class for all JButton types
« More »

StandardButton

Renders a standard button

The JButton is the base class for all JButton types
« More »
  • \ Joomla
  • \ CMS
  • \ UCM

Interfaces

UCM

Interface to handle UCM

« More »

Classes

UCMBase

Base class for implementing UCM

« More »

UCMContent

Base class for implementing UCM

« More »

UCMType

UCM Class for handling content types

« More »
  • \ Joomla
  • \ CMS
  • \ Updater

Classes

DownloadSource

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

« More »

Update

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

« More »

UpdateAdapter

UpdateAdapter class.

« More »

Updater

Updater Class

« More »
  • \ Joomla
  • \ CMS
  • \ Updater
  • \ Adapter

Classes

CollectionAdapter

Collection Update Adapter Class

« More »

ExtensionAdapter

Extension class for updater

« More »
  • \ Joomla
  • \ CMS
  • \ Uri

Classes

Uri

JUri 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 »
  • \ Joomla
  • \ CMS
  • \ User

Classes

User

User class. Handles all application interaction with a user

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

UserWrapper

Wrapper class for UserHelper

« More »
  • \ Joomla
  • \ CMS
  • \ Utility

Classes

BufferStreamHandler

Generic Buffer stream handler

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

Utility

JUtility is a utility functions class

« More »
  • \ Joomla
  • \ CMS
  • \ Versioning

Traits

TaggableTableTrait

Defines the trait for a Taggable Table Class.

Note: This is a placeholder to ease transition to the new system in 4.0
« More »

VersionableControllerTrait

Defines the trait for a Versionable Controller Class.

Note: This is a placeholder to ease transition to the new system in 4.0
« More »

VersionableModelTrait

Defines the trait for a Versionable Model Class.

Note: This is a placeholder to ease transition to the new system in 4.0
« More »

Interfaces

VersionableTableInterface

Interface for a versionable Table class

« More »