Constants
_QQ_
Defines a placeholder for a double quote character (") in a language file
var | |
---|---|
since |
1.6 |
deprecated |
4.0 Use escaped double quotes (") instead. |
package |
Joomla CMS |
CRLF
Constant defining a line break
var | |
---|---|
since |
1.5 |
package |
Joomla CMS |
FTP_ASCII
Stub of the native FTP_ASCII constant if PHP is running without the ftp extension enabled
var | |
---|---|
since |
1.5 |
package |
Joomla CMS |
FTP_AUTOASCII
Constant defining whether the FTP connection type will automatically determine ASCII support based on a file extension
var | |
---|---|
since |
1.5 |
package |
Joomla CMS |
FTP_BINARY
Stub of the native FTP_BINARY constant if PHP is running without the ftp extension enabled
var | |
---|---|
since |
1.5 |
package |
Joomla CMS |
FTP_NATIVE
Constant defining whether native FTP support is available on the platform
var | |
---|---|
since |
1.5 |
package |
Joomla CMS |
JCOMPAT_UNICODE_PROPERTIES
Flag indicating UTF-8 and PCRE support is present
var | |
---|---|
since |
1.6 |
package |
Joomla CMS |
JPATH_COMPONENT
Defines the path to the active component for the request
Note this constant is application aware and is different for each application (site/admin).
var | |
---|---|
since |
1.5 |
package |
Joomla CMS |
JPATH_COMPONENT_ADMINISTRATOR
Defines the path to the admin element of the active component for the request
var | |
---|---|
since |
1.5 |
package |
Joomla CMS |
JPATH_COMPONENT_SITE
Defines the path to the site element of the active component for the request
var | |
---|---|
since |
1.5 |
package |
Joomla CMS |
JPATH_ROOT
package |
Joomla CMS |
---|
Traits
TaggableTableTrait
Defines the trait for a Taggable Table Class.
VersionableControllerTrait
Defines the trait for a Versionable Controller Class.
VersionableModelTrait
Defines the trait for a Versionable Model Class.
Interfaces
ProviderAwareAuthenticationPluginInterface
Interface class defining the necessary methods for an authentication plugin to be provider aware Please note: might be deprecated with Joomla 4.2
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).
Classes
Adapter
Adapter Class Retains common adapter pattern functions Class harvested from joomla.installer.installer
AdminController
Base class for a Joomla Administrator Controller
AtomRenderer
AtomRenderer is a feed that implements the atom specification
Authentication
Authentication class, provides an interface for the Joomla authentication system
AuthenticationResponse
Authentication response class, provides an object for storing user and error details
BaseController
Base class for a Joomla Controller
BaseDatabaseModel
Base class for a database aware Joomla Model
Browser
Browser class, provides capability information about the current web client.
BufferStreamHandler
Generic Buffer stream handler
CacheConnectingException
Exception class defining an error connecting to the cache storage engine
CallbackLogger
Joomla! Callback Log class
ChangeItem
Each object represents one query, which is one line from a DDL SQL query.
ChangeSet
Contains a set of JSchemaChange objects for a particular instance of Joomla.
CMSObject
Joomla Platform Object Class
ContentHelper
Helper for standard content style extensions.
ContentHistoryHelper
Versions helper class, provides methods to perform various tasks relevant versioning of content.
CryptoCipher
Crypt cipher for encryption, decryption and key generation via the php-encryption library.
DaemonApplication
Class to turn CliApplication applications into daemons. It requires CLI and PCNTL support built into PHP.
DatabaseLogger
Joomla! MySQL Database Log class
Date
JDate is a class that stores a date and provides logic to manipulate and render that date in a variety of formats.
DelegatingPsrLogger
Delegating logger which delegates log messages received from the PSR-3 interface to the Joomla! Log object.
DownloadSource
Data object representing a download source given as part of an update's `<downloads>` element
ErrorDocument
ErrorDocument class, provides an easy interface to parse and display an error page
FeedDocument
FeedDocument class, provides an easy interface to parse and display any feed document
FilesystemHelper
File system helper
Form
Form Class for the Joomla Platform.
FormattedtextLogger
Joomla! Formatted Text File Log class
FormHelper
Form's helper class.
HelpsiteField
Form Field class for the Joomla Platform.
HtmlDocument
HtmlDocument class, provides an easy interface to parse and display a HTML document
HtmlView
Base class for a Joomla View
HttpBridgePostRequestMethod
Bridges the Joomla! HTTP API to the Google Recaptcha RequestMethod interface for a POST request.
Input
Joomla! Input Base Class
InputFilter
InputFilter is a class for filtering input from any data source
InstallerScript
Base install script for use by extensions providing helper methods for common behaviours.
Json
Joomla! Input JSON Class
JsonDocument
JsonDocument class, provides an easy interface to parse and display JSON output
JsonResponse
JSON Response class.
LastvisitdaterangeField
Field to show a list of available date ranges to filter on last visit date.
LegacyFactory
Factory to create MVC objects in legacy mode.
Log
Joomla! Log Class
LogEntry
Joomla! Log Entry class
Logger
Joomla! Logger Base Class
MailHelper
Email helper class, provides static methods to perform various tasks relevant to the Joomla email routines.
MessagequeueLogger
Joomla MessageQueue logger class.
MysqlChangeItem
Checks the database schema against one MySQL DDL query to see if it has been run.
OpensearchDocument
Opensearch class, provides an easy interface to display an Opensearch document
OptionsRule
Form Rule class for the Joomla Platform.
Pagination
Pagination Class. Provides a common interface for content pagination for the Joomla! CMS.
Porteren
Porter English stemmer class.
PostgresqlChangeItem
Checks the database schema against one PostgreSQL DDL query to see if it has been run.
Profiler
Utility class to assist in the process of benchmarking the execution of sections of code to understand where time is being spent.
PunycodeHelper
Joomla Platform String Punycode Class
RouteHelper
Route Helper
Session
Class for managing HTTP sessions
SqlsrvChangeItem
Checks the database schema against one SQL Server DDL query to see if it has been run.
Stream
Joomla! Stream Interface
StreamString
String Stream Wrapper
SyslogLogger
Joomla! Syslog Log class
Tags
Abstract class defining methods that can be implemented by an Observer class of a Table class (which is an Observable).
TagsHelper
Tags helper class, provides methods to perform various tasks relevant tagging of content.
Update
Update class. It is used by Updater::update() to install an update. Use Updater::findUpdates() to find updates for an extension.
Uri
JUri Class
UserHelper
Authorisation helper class, provides static methods to perform various tasks relevant to the Joomla user and authorisation classes
W3cLogger
Joomla! W3C Logging class