Constants
$signal
$signal
_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. |
CRLF
CRLF
Constant defining a line break
var | |
---|---|
since |
1.5 |
FTP_ASCII
Stub of the native FTP_ASCII constant if PHP is running without the ftp extension enabled
var | |
---|---|
since |
1.5 |
FTP_ASCII
FTP_AUTOASCII
Constant defining whether the FTP connection type will automatically determine ASCII support based on a file extension
var | |
---|---|
since |
1.5 |
FTP_AUTOASCII
FTP_BINARY
Stub of the native FTP_BINARY constant if PHP is running without the ftp extension enabled
var | |
---|---|
since |
1.5 |
FTP_BINARY
FTP_NATIVE
FTP_NATIVE
Constant defining whether native FTP support is available on the platform
var | |
---|---|
since |
1.5 |
JCOMPAT_UNICODE_PROPERTIES
Flag indicating UTF-8 and PCRE support is present
var | |
---|---|
since |
1.6 |
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 |
JPATH_COMPONENT_ADMINISTRATOR
Defines the path to the admin element of the active component for the request
var | |
---|---|
since |
1.5 |
JPATH_COMPONENT_SITE
Defines the path to the site element of the active component for the request
var | |
---|---|
since |
1.5 |
JPATH_ROOT
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
EventInterface
Interface for events.
JsonSerializable
JsonSerializable interface. This file provides backwards compatibility to PHP 5.3 and ensures the interface is present in systems where JSON related code was removed.
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
AbstractDaemonApplication
Class to turn Cli applications into daemons. It requires CLI and PCNTL support built into PHP.
AbstractUri
Uri Class
Adapter
Adapter Class Retains common adapter pattern functions Class harvested from joomla.installer.installer
AdapterInstance
Adapter Instance Class
AdminController
Base class for a Joomla Administrator Controller
AdminModel
Prototype admin model.
ArrayHelper
ArrayHelper is an array utility class for doing all sorts of odds and ends with arrays.
Asset
Table class supporting modified pre-order tree traversal behavior.
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
AuthorField
Form Field to load a list of content authors
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.
Buffer
Generic Buffer stream handler
BufferStreamHandler
Generic Buffer stream handler
CacheConnectingException
Exception class defining an error connecting to the cache storage engine
CallbackFilterIterator
CallbackFilterIterator using the callback to determine which items are accepted or rejected.
CallbackLogger
Joomla! Callback Log class
CategoriesView
Categories view base class.
CategoryFeedView
Base feed View class for a category
CategoryView
Base HTML View class for the a Category list
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.
Cli
Joomla! Input CLI Class
Cli
Joomla! Input CLI Class
CMSObject
Joomla Platform Object Class
ConfirmButton
Renders a standard button with a confirm dialog
ContentHelper
Helper for standard content style extensions.
ContentHistoryHelper
Versions helper class, provides methods to perform various tasks relevant versioning of content.
ContentlanguageField
Provides a list of content languages
Cookie
Joomla! Input Cookie Class
Cookie
Joomla! Input Cookie Class
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
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.
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.
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.
DependencyResolutionException
Exception class for handling errors in resolving a dependency
DownloadSource
Data object representing a download source given as part of an update's `<downloads>` element
EchoLogger
Joomla Echo logger class.
EditorField
A textarea field for content creation
ErrorDocument
ErrorDocument class, provides an easy interface to parse and display an error page
EventImmutable
Implementation of an immutable Event.
FeedDocument
FeedDocument class, provides an easy interface to parse and display any feed document
Files
Joomla! Input Files Class
Files
Joomla! Input Files Class
FilesystemHelper
File system helper
Form
Form Class for the Joomla Platform.
FormattedtextLogger
Joomla! Formatted Text File Log class
FormController
Controller tailored to suit most form-based admin operations.
FormHelper
Form's helper class.
FormModel
Prototype form model.
FrontendlanguageField
Provides a list of published content languages with home pages
Gzip
Gzip format adapter for the Archive package
HelpButton
Renders a help popup window button
Helper
File system helper
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
Input
Joomla! Input Base Class
InputFilter
InputFilter is a class for filtering input from any data source
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.
ItemModel
Prototype item model.
Json
Joomla! Input JSON Class
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.
LimitboxField
Field to load a list of posible item count limits
ListenersPriorityQueue
A class containing an inner listeners priority queue that can be iterated multiple times.
ListModel
Model class for handling lists of items.
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.
MenuitemField
Supports an HTML grouped select list of menu item grouped by menu
MessagequeueLogger
Joomla MessageQueue logger class.
MysqlChangeItem
Checks the database schema against one MySQL DDL query to see if it has been run.
Nested
Table class supporting modified pre-order tree traversal behavior.
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.
PopupButton
Renders a modal window button
Porteren
Porter English stemmer class.
PostgresqlChangeItem
Checks the database schema against one PostgreSQL DDL query to see if it has been run.
Priority
An enumeration of priorities for event listeners, that you are encouraged to use when adding them in the Dispatcher.
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
RegistrationdaterangeField
Registration Date Range field.
RouteHelper
Route Helper
SeparatorButton
Renders a button separator
Session
Class for managing HTTP sessions
Session
Class for managing HTTP sessions
SitePathway
Class to manage the site application pathway.
SliderButton
Renders a button to render an HTML element in a slider container
SqlsrvChangeItem
Checks the database schema against one SQL Server DDL query to see if it has been run.
StandardButton
Renders a standard button
Stream
Joomla! Stream Interface
Stream
Joomla! Stream Interface
StreamString
String Stream Wrapper
String
String Stream Wrapper
String
String handling class for utf-8 data Wraps the phputf8 library All functions assume the validity of utf-8 strings.
StringHelper
String handling class for UTF-8 data wrapping the phputf8 library. All functions assume the validity of UTF-8 strings.
StringWrapper
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.
Tar
Tar format adapter for the Archive package
TemplatestyleField
Supports a select grouped list of template styles
Update
Update class. It is used by Updater::update() to install an update. Use Updater::findUpdates() to find updates for an extension.
UpdateSite
Update site table Stores the update sites for extensions
Uri
Uri Class
Uri
JUri Class
UseractiveField
Field to show a list of available user active statuses
UsergrouplistField
Field to load a dropdown list of available user groups
UserHelper
Authorisation helper class, provides static methods to perform various tasks relevant to the Joomla user and authorisation classes
UserstateField
Field to load a list of available users statuses
W3cLogger
Joomla! W3C Logging class
Zip
ZIP format adapter for the Archive package
Constants
JERROR_CALLBACK_NOT_CALLABLE
Error Definition: Callback does not exist
var | |
---|---|
since |
1.5 |
deprecated |
4.0 |
package |
Joomla.Legacy |
JERROR_ILLEGAL_MODE
Error Definition: Illegal Handler
var | |
---|---|
since |
1.5 |
deprecated |
4.0 |
package |
Joomla.Legacy |
JERROR_ILLEGAL_OPTIONS
Error Definition: Illegal Options
var | |
---|---|
since |
1.5 |
deprecated |
4.0 |
package |
Joomla.Legacy |
JREQUEST_ALLOWHTML
package |
Joomla.Legacy |
---|
JREQUEST_ALLOWRAW
package |
Joomla.Legacy |
---|
JREQUEST_NOTRIM
Set the available masks for cleaning variables
package |
Joomla.Legacy |
---|
Classes
JApplication
Base class for a Joomla! application.
JDispatcher
Deprecated class placeholder. You should use JEventDispatcher instead.
JError
Error Handling Class
JFormFieldCategory
Form Field class for the Joomla Platform.
JFormFieldComponentlayout
Form Field to display a list of the layouts for a component view from the extension or template overrides.
JFormFieldModulelayout
Form Field to display a list of the layouts for module display from the module or template overrides.
JRequest
JRequest Class
JResponse
JResponse Class.
JSimplecrypt
JSimpleCrypt is a very simple encryption algorithm for encrypting/decrypting strings
JSimplepieFactory
Class to maintain a pathway.
Classes
JClassLoader
Decorate Composer ClassLoader for Joomla!
JFormFieldPredefinedList
Form Field to load a list of predefined values
Classes
Functions
jexit
Global application exit.
This function provides a single exit point for the platform.
package |
Joomla.Platform |
---|---|
since |
1.7.0 |
Arguments
- $message
mixed
Exit code or string. Defaults to zero.
jimport
Intelligent file importer.
package |
Joomla.Platform |
---|---|
since |
1.7.0 |
Arguments
- $path
string
A dot syntax path.- $base
string
Search this directory for the class.
Response
boolean
True on success.
Interfaces
JDatabaseQueryLimitable
Joomla Database Query Limitable Interface.
JDatabaseQueryPreparable
Joomla Database Query Preparable Interface.
JObservableInterface
Observable Subject pattern interface for Joomla
JObserverInterface
Observer pattern interface for Joomla
Classes
JArchiveGzip
Gzip format adapter for the JArchive class
JArchiveTar
Tar format adapter for the JArchive class
JArchiveZip
ZIP format adapter for the JArchive class
JArrayHelper
JArrayHelper is an array utility class for doing all sorts of odds and ends with arrays.
JDatabaseExceptionConnecting
Exception class defining an error connecting to the database platform
JDatabaseIteratorPgsql
PostgreSQL database iterator for the PDO based PostgreSQL database driver.
JEventDispatcher
Class to handle dispatching of events.
JFormFieldAccessLevel
Form Field class for the Joomla Platform.
JFormFieldAliastag
Form Field class for the Joomla Framework.
JFormFieldCacheHandler
Form Field class for the Joomla Platform.
JFormFieldCalendar
Form Field class for the Joomla Platform.
JFormFieldCheckbox
Form Field class for the Joomla Platform.
JFormFieldCheckboxes
Form Field class for the Joomla Platform.
JFormFieldColor
Color Form Field class for the Joomla Platform.
JFormFieldComponents
Form Field class for the Joomla Framework.
JFormFieldDatabaseConnection
Form Field class for the Joomla Platform.
JFormFieldEMail
Form Field class for the Joomla Platform.
JFormFieldFileList
Supports an HTML select list of files
JFormFieldFolderList
Supports an HTML select list of folder
JFormFieldGroupedList
Form Field class for the Joomla Platform.
JFormFieldImageList
Supports an HTML select list of image
JFormFieldInteger
Form Field class for the Joomla Platform.
JFormFieldLanguage
Form Field class for the Joomla Platform.
JFormFieldList
Form Field class for the Joomla Platform.
JFormFieldMeter
Form Field class for the Joomla Platform.
JFormFieldNumber
Form Field class for the Joomla Platform.
JFormFieldPlugins
Form Field class for the Joomla Framework.
JFormFieldRange
Form Field class for the Joomla Platform.
JFormFieldRepeatable
Form Field class for the Joomla Platform.
JFormFieldRules
Form Field class for the Joomla Platform.
JFormFieldSessionHandler
Form Field class for the Joomla Platform.
JFormFieldSpacer
Form Field class for the Joomla Platform.
JFormFieldTel
Form Field class for the Joomla Platform.
JFormFieldTextarea
Form Field class for the Joomla Platform.
JFormFieldTimezone
Form Field class for the Joomla Platform.
JFormFieldUsergroup
Form Field class for the Joomla Platform.
JGithubPackageActivityNotifications
GitHub API Activity Events class for the Joomla Platform.
JGithubPackageActivityWatching
GitHub API Activity Watching Events class for the Joomla Platform.
JGithubPackageData
GitHub API DB class for the Joomla Platform.
JGithubPackageDataBlobs
GitHub API Data Blobs class for the Joomla Platform.
JGithubPackageDataTags
GitHub API Data Tags class for the Joomla Platform.
JGithubPackageGitignore
GitHub API Gitignore class for the Joomla Platform.
JGithubPackageIssuesComments
GitHub API Comments class for the Joomla Platform.
JGithubPackageIssuesEvents
GitHub API Issues Events class for the Joomla Platform.
JGithubPackageOrgsTeams
GitHub API Orgs Teams class for the Joomla Platform.
JGithubPackageRepositoriesCollaborators
GitHub API Repositories Collaborators class for the Joomla Platform.
JGithubPackageRepositoriesComments
GitHub API Repositories Comments class for the Joomla Platform.
JGithubPackageRepositoriesCommits
GitHub API Repositories Commits class for the Joomla Platform.
JGithubPackageRepositoriesContents
GitHub API Repositories Contents class for the Joomla Platform.
JGithubPackageRepositoriesDownloads
GitHub API Repositories Downloads class for the Joomla Platform.
JGithubPackageRepositoriesMerging
GitHub API Repositories Merging class for the Joomla Platform.
JGithubPackageRepositoriesStatistics
GitHub API class for the Joomla Platform.
JGithubPackageUsersEmails
GitHub API References class for the Joomla Platform.
JString
String handling class for utf-8 data Wraps the phputf8 library All functions assume the validity of utf-8 strings.