Joomla! API

Download
Launch
  • \ Joomla.Platform

Functions

callbackJFilterInputConvertDecimal

Decimal decode callback for JFilterInput::_decode.

package

Joomla.Platform

Arguments

$matches

Response

string

callbackJFilterInputConvertHex

Hex decode callback for JFilterInput::_decode.

package

Joomla.Platform

Arguments

$matches

Response

string

jexit

Global application exit.

This function provides a single exit point for the platform.

package

Joomla.Platform
since

11.1

Arguments

$message

mixedExit code or string. Defaults to zero.

jimport

Intelligent file importer.

package

Joomla.Platform
since

11.1

Arguments

$path

stringA dot syntax path.

Response

booleanTrue on success.

Constants

_QQ_

Allows for quoting in language .ini files.

package

Joomla.Platform

CRLF

package

Joomla.Platform

DS

package

Joomla.Platform

FTP_ASCII

package

Joomla.Platform

FTP_AUTOASCII

package

Joomla.Platform

FTP_BINARY

package

Joomla.Platform

FTP_NATIVE

package

Joomla.Platform

JAUTHENTICATE_STATUS_CANCEL

Status to indicate cancellation of authentication (unused)

deprecated
package

Joomla.Platform

JAUTHENTICATE_STATUS_FAILURE

This is the status code returned when the authentication failed (prevent login if no success)

deprecated

Use JAuthentication::STATUS_FAILURE
package

Joomla.Platform

JAUTHENTICATE_STATUS_SUCCESS

This is the status code returned when the authentication is success (permit login)

deprecated

Use JAuthentication::STATUS_SUCCESS
package

Joomla.Platform

JCOMPAT_UNICODE_PROPERTIES

package

Joomla.Platform

JERROR_CALLBACK_NOT_CALLABLE

package

Joomla.Platform

JERROR_ILLEGAL_MODE

package

Joomla.Platform

JERROR_ILLEGAL_OPTIONS

package

Joomla.Platform

JPATH_COMPONENT

package

Joomla.Platform

JPATH_COMPONENT_ADMINISTRATOR

package

Joomla.Platform

JPATH_COMPONENT_SITE

package

Joomla.Platform

JPATH_ISMAC

package

Joomla.Platform

JPATH_ISWIN

package

Joomla.Platform

JPATH_ROOT

package

Joomla.Platform

JREQUEST_ALLOWHTML

package

Joomla.Platform

JREQUEST_ALLOWRAW

package

Joomla.Platform

JREQUEST_NOTRIM

Set the available masks for cleaning variables

package

Joomla.Platform

JROUTER_MODE_RAW

Set the available masks for the routing mode

package

Joomla.Platform

JROUTER_MODE_SEF

package

Joomla.Platform

Classes

JFactory

Joomla Platform Factory class

« More »

JLoader

Static class to handle loading of libraries.

« More »

JPlatform

Version information class for the Joomla Platform.

« More »

JRoute

Route handling class

« More »
  • \ Joomla.Platform
  • \ Access

Classes

JAccess

Class that handles all access authorisation routines.

« More »

JAccessRule

JAccessRule class.

« More »

JAccessRules

JAccessRules class.

« More »

JRule

Deprecated class placeholder. You should use JAccessRule instead.

« More »

JRules

Deprecated class placeholder. You should use JAccessRules instead.

« More »
  • \ Joomla.Platform
  • \ Application

Classes

JApplication

Base class for a Joomla! application.

Acts as a Factory class for application specific objects and provides many supporting API functions. Derived clases should supply the route(), dispatch() and render() functions.
« More »

JApplicationBase

Joomla Platform Base Application Class

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

JApplicationCli

Base class for a Joomla! command line application.

« More »

JApplicationDaemon

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

« More »

JApplicationHelper

Application helper functions

« More »

JApplicationWeb

Base class for a Joomla! Web application.

« More »

JCategories

JCategories Class.

« More »

JCategoryNode

Helper class to load Categorytree

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

JCli

Deprecated class placeholder. You should use JApplicationCli instead.

« More »

JComponentHelper

Component helper class

« More »

JController

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 »

JControllerAdmin

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 »

JControllerForm

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 »

JDaemon

Backward Compatability Stub for JApplicationDaemon

« More »

JInput

Joomla! Input Base Class

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

JInputCLI

Joomla! Input CLI Class

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

JInputCookie

Joomla! Input Cookie Class

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

JInputFiles

Joomla! Input Files Class

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

JMenu

JMenu class

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

JModel

Base class for a Joomla Model

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

JModelAdmin

Prototype admin model.

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

JModelForm

Prototype form model.

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

JModelItem

Prototype item model.

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

JModelList

Model class for handling lists of items.

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

JModuleHelper

Module helper class

« More »

JPathway

Class to maintain a pathway.

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

JRouter

Class to create and parse routes

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

JView

Base class for a Joomla View

Class holding methods for displaying presentation data.
« More »

JWeb

Deprecated class placeholder. You should use JApplicationWeb instead.

« More »

JWebClient

Class to model a Web Client.

« More »
  • \ Joomla.Platform
  • \ Base

Classes

JAdapter

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 »

JAdapterInstance

Adapter Instance Class

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

JNode

Tree Node Class.

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

JObject

Joomla Platform Object Class

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

JObservable

Abstract observable class to implement the observer design pattern

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

JObserver

Abstract observer class to implement the observer design pattern

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

JTree

Tree Class.

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

Classes

JCache

Joomla! Cache base object

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

JCacheController

Public cache handler

« More »

JCacheControllerCallback

Joomla! Cache callback type object

« More »

JCacheControllerOutput

Joomla Cache output type object

« More »

JCacheControllerPage

Joomla! Cache page type object

« More »

JCacheControllerView

Joomla! Cache view type object

« More »

JCacheStorage

Abstract cache storage handler

« More »

JCacheStorageApc

APC cache storage handler

« More »

JCacheStorageCachelite

Cache lite storage handler

« More »

JCacheStorageEaccelerator

eAccelerator cache storage handler

« More »

JCacheStorageFile

File cache storage handler

« More »

JCacheStorageHelper

Cache storage helper functions.

« More »

JCacheStorageMemcache

Memcache cache storage handler

« More »

JCacheStorageMemcached

Memcached cache storage handler

« More »

JCacheStorageWincache

WINCACHE cache storage handler

« More »

JCacheStorageXcache

XCache cache storage handler

« More »

JSessionStorageXcache

XCache session storage handler

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

Classes

JClientHelper

Client helper class

« More »

JFTP

FTP client class

« More »

JLDAP

LDAP client class

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

Interfaces

JCryptCipher

JCrypt cipher interface.

« More »

Classes

JCrypt

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

« More »

JCryptCipherSimple

JCrypt cipher for Simple encryption, decryption and key generation.

« More »

JCryptKey

Encryption key object for the Joomla Platform.

« More »
  • \ Joomla.Platform
  • \ Database

Interfaces

JDatabaseInterface

Database interface class.

« More »

Classes

JDatabase

Database connector class.

« More »

JDatabaseException

Exception class definition for the Database subpackage.

« More »

JDatabaseExporterMySQL

MySQL export driver.

« More »

JDatabaseExporterMySQLi

MySQL export driver.

« More »

JDatabaseImporterMySQL

MySQL import driver.

« More »

JDatabaseImporterMySQLi

MySQL import driver.

« More »

JDatabaseMySQL

MySQL database driver

« More »

JDatabaseMySQLi

MySQLi database driver

« More »

JDatabaseQuery

Query Building Class.

« More »

JDatabaseQueryElement

Query Element Class.

« More »

JDatabaseQueryMySQL

Query Building Class.

« More »

JDatabaseQueryMySQLi

Query Building Class.

« More »

JDatabaseQuerySQLAzure

Query Building Class.

« More »

JDatabaseQuerySQLSrv

Query Building Class.

« More »

JDatabaseSQLAzure

SQL Server database driver

« More »

JDatabaseSQLSrv

SQL Server database driver

« More »

JTableAsset

Table class supporting modified pre-order tree traversal behavior.

Parent class to all tables.
« More »

JTableLanguage

Languages table.

Parent class to all tables.
« More »

JTableNested

Table class supporting modified pre-order tree traversal behavior.

Parent class to all tables.
« More »

JTableUsergroup

Usergroup table class.

Parent class to all tables.
« More »

JTableViewlevel

Viewlevels table class.

Parent class to all tables.
« More »
  • \ Joomla.Platform
  • \ Document

Classes

JDocument

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

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

JDocumentError

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

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

JDocumentFeed

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

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

JDocumentHTML

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

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

JDocumentJSON

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

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

JDocumentOpensearch

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

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

JDocumentRaw

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

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

JDocumentRenderer

Abstract class for a renderer

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

JDocumentRendererAtom

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

JDocumentRendererComponent

Component renderer

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

JDocumentRendererHead

JDocument head renderer

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

JDocumentRendererMessage

JDocument system message renderer

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

JDocumentRendererModule

JDocument Module renderer

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

JDocumentRendererModules

JDocument Modules renderer

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

JDocumentRendererRSS

JDocumentRenderer_RSS is a feed that implements RSS 2.0 Specification

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

JDocumentXml

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

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

JFeedEnclosure

JFeedEnclosure is an internal class that stores feed enclosure information

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

JFeedImage

JFeedImage is an internal class that stores feed image information

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

JFeedItem

JFeedItem is an internal class that stores feed item information

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

JOpenSearchImage

JOpenSearchImage is an internal class that stores Images for the OpenSearch Description

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

JOpenSearchUrl

JOpenSearchUrl is an internal class that stores the search URLs for the OpenSearch description

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

Classes

JBrowser

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 »

JRequest

JRequest Class

This class serves to provide the Joomla Platform with a common interface to access request variables. This includes $_POST, $_GET, and naturally $_REQUEST. Variables can be passed through an input filter to avoid injection or returned raw.
« More »

JResponse

JResponse Class.

This class serves to provide the Joomla Platform with a common interface to access response variables. This includes header and body.
« More »

JURI

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.Platform
  • \ Error

Classes

JError

Error Handling Class

This class is inspired in design and concept by patErrorManager <http://www.php-tools.net> patErrorManager contributors include: - gERD Schaufelberger <[email protected]> - Sebastian Mordziol <[email protected]> - Stephan Schmidt <[email protected]>
« More »

JException

Joomla! Exception object.

« More »

JProfiler

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

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

Classes

JDispatcher

Class to handle dispatching of events.

This is the Observable part of the Observer design pattern for the event architecture.
« More »

JEvent

JEvent Class

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

Classes

JArchive

An Archive handling class

« More »

JArchiveBzip2

Bzip2 format adapter for the JArchive class

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

JArchiveGzip

Gzip format adapter for the JArchive class

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 »

JArchiveTar

Tar format adapter for the JArchive class

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 »

JArchiveZip

ZIP format adapter for the JArchive class

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 »

JFile

A File handling class

« More »

JFilesystemHelper

File system helper

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

JFolder

A Folder handling class

« More »

JPath

A Path handling class

« More »

JStreamString

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 »

JStringController

String Controller

« More »
  • \ Joomla.Platform
  • \ FileSystem This class adheres to the stream wrapper operations:

Classes

JStream

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.
« More »
  • \ Joomla.Platform
  • \ Filter

Classes

JFilterInput

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

JFilterOutput

JFilterOutput

« More »
  • \ Joomla.Platform
  • \ Form

Classes

JForm

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 »

JFormField

Abstract Form Field class for the Joomla Platform.

« More »

JFormFieldAccessLevel

Form Field class for the Joomla Platform.

Provides a list of access levels. Access levels control what users in specific groups can see.
« More »

JFormFieldCacheHandler

Form Field class for the Joomla Platform.

Provides a list of available cache handlers
« More »

JFormFieldCalendar

Form Field class for the Joomla Platform.

Provides a pop up date picker linked to a button. Optionally may be filtered to use user's or server's time zone.
« More »

JFormFieldCategory

Form Field class for the Joomla Platform.

Supports an HTML select list of categories
« More »

JFormFieldCheckbox

Form Field class for the Joomla Platform.

Single check box field. This is a boolean field with null for false and the specified option for true
« More »

JFormFieldCheckboxes

Form Field class for the Joomla Platform.

Displays options as a list of check boxes. Multiselect may be forced to be true.
« More »

JFormFieldColor

Color Form Field class for the Joomla Platform.

This implementation is designed to be compatible with HTML5's <input type="color">
« More »

JFormFieldCombo

Form Field class for the Joomla Platform.

Implements a combo box field.
« More »

JFormFieldComponentLayout

Form Field to display a list of the layouts for a component view from the extension or template overrides.

« More »

JFormFieldContentLanguage

Form Field class for the Joomla Platform.

Provides a list of content languages
« More »

JFormFieldDatabaseConnection

Form Field class for the Joomla Platform.

Provides a list of available database connections, optionally limiting to a given list.
« More »

JFormFieldEditor

Form Field class for the Joomla Platform.

An editarea field for content creation
« More »

JFormFieldEditors

Form Field class for the Joomla Platform.

Provides a list of installed editors.
« More »

JFormFieldEMail

Form Field class for the Joomla Platform.

Provides and input field for e-mail addresses
« More »

JFormFieldFile

Form Field class for the Joomla Platform.

Provides an input field for files
« More »

JFormFieldFileList

Supports an HTML select list of files

Supports a generic list of options.
« More »

JFormFieldFolderList

Supports an HTML select list of folder

Supports a generic list of options.
« More »

JFormFieldGroupedList

Form Field class for the Joomla Platform.

Provides a grouped list select field.
« More »

JFormFieldHidden

Form Field class for the Joomla Platform.

Provides a hidden field
« More »

JFormFieldImageList

Supports an HTML select list of image

Supports a generic list of options.
« More »

JFormFieldInteger

Form Field class for the Joomla Platform.

Provides a select list of integers with specified first, last and step values.
« More »

JFormFieldLanguage

Form Field class for the Joomla Platform.

Supports a list of installed application languages
« More »

JFormFieldList

Form Field class for the Joomla Platform.

Supports a generic list of options.
« More »

JFormFieldMedia

Form Field class for the Joomla Platform.

Provides a modal media selector including upload mechanism
« More »

JFormFieldMenuItem

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

Provides a grouped list select field.
« More »

JFormFieldModuleLayout

Form Field to display a list of the layouts for module display from the module or template overrides.

« More »

JFormFieldPassword

Form Field class for the Joomla Platform.

Text field for passwords
« More »

JFormFieldPlugins

Form Field class for the Joomla Framework.

Supports a generic list of options.
« More »

JFormFieldRadio

Form Field class for the Joomla Platform.

Provides radio button inputs
« More »

JFormFieldRules

Form Field class for the Joomla Platform.

Field for assigning permissions to groups for a given asset
« More »

JFormFieldSessionHandler

Form Field class for the Joomla Platform.

Provides a select list of session handler options.
« More »

JFormFieldSpacer

Form Field class for the Joomla Platform.

Provides spacer markup to be used in form layouts.
« More »

JFormFieldSQL

Supports an custom SQL select list

Supports a generic list of options.
« More »

JFormFieldTel

Form Field class for the Joomla Platform.

Supports a text field telephone numbers.
« More »

JFormFieldText

Form Field class for the Joomla Platform.

Supports a one line text field.
« More »

JFormFieldTextarea

Form Field class for the Joomla Platform.

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

JFormFieldTimezone

Form Field class for the Joomla Platform.

Provides a grouped list select field.
« More »

JFormFieldUrl

Form Field class for the Joomla Platform.

Supports a URL text field
« More »

JFormFieldUsergroup

Form Field class for the Joomla Platform.

Supports a nested check box field listing user groups. Multiselect is available by default.
« More »

JFormHelper

JForm's helper class.

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

JFormRule

Form Rule class for the Joomla Platform.

« More »

JFormRuleBoolean

Form Rule class for the Joomla Platform.

« More »

JFormRuleColor

Form Rule class for the Joomla Platform.

« More »

JFormRuleEmail

Form Rule class for the Joomla Platform.

« More »

JFormRuleEquals

Form Rule class for the Joomla Platform.

« More »

JFormRuleOptions

Form Rule class for the Joomla Platform.

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

JFormRuleRules

Form Rule class for the Joomla Platform.

« More »

JFormRuleTel

Form Rule class for the Joomla Platform

« More »

JFormRuleUrl

Form Rule class for the Joomla Platform.

« More »

JFormRuleUsername

Form Rule class for the Joomla Platform.

« More »
  • \ Joomla.Platform
  • \ GitHub

Classes

JGithub

Joomla Platform class for interacting with a GitHub server instance.

« More »

JGithubForks

GitHub API References class for the Joomla Platform.

« More »

JGithubGists

GitHub API Gists class for the Joomla Platform.

« More »

JGithubHttp

HTTP client class for connecting to a GitHub instance.

« More »

JGithubIssues

GitHub API Issues class for the Joomla Platform.

« More »

JGithubObject

GitHub API object class for the Joomla Platform.

« More »

JGithubPulls

GitHub API Pull Requests class for the Joomla Platform.

« More »

JGithubRefs

GitHub API References class for the Joomla Platform.

« More »
  • \ Joomla.Platform
  • \ HTML

Classes

JButton

Button base class

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

JButtonConfirm

Renders a standard button with a confirm dialog

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

JButtonCustom

Renders a custom button

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

JButtonHelp

Renders a help popup window button

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

JButtonLink

Renders a link button

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

JButtonPopup

Renders a popup window button

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

JButtonSeparator

Renders a button separator

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

JButtonStandard

Renders a standard button

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

JEditor

JEditor class to handle WYSIWYG editors

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

JGrid

JGrid class to dynamically generate HTML tables

« More »

JHtml

Utility class for all HTML drawing classes

« More »

JHtmlAccess

Extended Utility class for all HTML drawing classes.

« More »

JHtmlBatch

Extended Utility class for batch processing widgets.

« More »

JHtmlBehavior

Utility class for javascript behaviors

« More »

JHtmlCategory

Utility class for categories

« More »

JHtmlContent

Utility class to fire onContentPrepare for non-article based content.

« More »

JHtmlContentLanguage

Utility class working with content language select lists

« More »

JHtmlDate

Extended Utility class for handling date display.

« More »

JHtmlEmail

Utility class for cloaking email addresses

« More »

JHtmlForm

Utility class for form elements

« More »

JHtmlGrid

Utility class for creating HTML Grids

« More »

JHtmlImage

Utility class working with images.

« More »

JHtmlJGrid

Utility class for creating HTML Grids

« More »

JHtmlList

Utility class for creating different select lists

« More »

JHtmlMenu

Utility class working with menu select lists

« More »

JHtmlNumber

HTML helper class for rendering numbers.

« More »

JHtmlRules

Extended Utility class for all HTML drawing classes.

« More »

JHtmlSelect

Utility class for creating HTML select lists

« More »

JHtmlSliders

Utility class for Sliders elements

« More »

JHtmlString

HTML helper class for rendering manipulated strings.

« More »

JHtmlTabs

Utility class for Tabs elements.

« More »

JHtmlTel

HTML helper class for rendering telephone numbers.

« More »

JHtmlUser

Utility class working with users

« More »

JPagination

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

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

JPaginationObject

Pagination object representing a particular item in the pagination lists.

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

JPane

JPane abstract class

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

JPaneSliders

JPanelSliders class to to draw parameter panes.

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

JPaneTabs

JPanelTabs class to to draw parameter panes.

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

JToolBar

ToolBar handler

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

Interfaces

JHttpTransport

HTTP transport class interface.

« More »

Classes

JHttp

HTTP client class.

« More »

JHttpFactory

HTTP factory class.

« More »

JHttpResponse

HTTP response data object class.

« More »

JHttpTransportCurl

HTTP transport class for using cURL.

« More »

JHttpTransportSocket

HTTP transport class for using sockets directly.

« More »

JHttpTransportStream

HTTP transport class for using PHP streams.

« More »
  • \ Joomla.Platform
  • \ Image

Classes

JImage

Class to manipulate an image.

« More »

JImageFilter

Class to manipulate an image.

« More »

JImageFilterBrightness

Image Filter class adjust the brightness of an image.

« More »

JImageFilterContrast

Image Filter class adjust the contrast of an image.

« More »

JImageFilterEdgedetect

Image Filter class to add an edge detect effect to an image.

« More »

JImageFilterEmboss

Image Filter class to emboss an image.

« More »

JImageFilterGrayScale

Image Filter class to transform an image to grayscale.

« More »

JImageFilterNegate

Image Filter class to negate the colors of an image.

« More »

JImageFilterSketchy

Image Filter class to make an image appear "sketchy".

« More »

JImageFilterSmooth

Image Filter class adjust the smoothness of an image.

« More »
  • \ Joomla.Platform
  • \ Installer

Classes

JExtension

Extension object

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

JInstaller

Joomla base installer class

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

JInstallerComponent

Component installer

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

JInstallerFile

File installer

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

JInstallerHelper

Installer helper class

« More »

JInstallerLanguage

Language installer

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

JInstallerLibrary

Library installer

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

JInstallerModule

Module installer

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

JInstallerPackage

Package installer

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

JInstallerPlugin

Plugin installer

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

JInstallerTemplate

Template installer

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

JLibraryManifest

Joomla! Library Manifest File

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

JPackageManifest

Joomla! Package Manifest File

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

Classes

JHelp

Help system class

« More »

JLanguage

Languages/translation handler class

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

JLanguageHelper

Language helper class

« More »

JLanguageTransliterate

Class to transliterate strings

« More »

JText

Text handling class.

« More »
  • \ Joomla.Platform
  • \ Log

Classes

JLog

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 »

JLogEntry

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 »

JLogger

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 »

JLoggerDatabase

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 »

JLoggerEcho

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 »

JLoggerFormattedText

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 »

JLoggerMessageQueue

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 »

JLoggerSysLog

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 »

JLoggerW3C

Joomla! W3C Logging class

This class is designed to build log files based on the W3C specification at: http://www.w3.org/TR/WD-logfile.html
« More »

LogException

Exception class definition for the Log subpackage.

« More »
  • \ Joomla.Platform
  • \ Mail

Classes

JMail

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

« More »

JMailHelper

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 »
  • \ Joomla.Platform
  • \ Parameter

Classes

JElement

Parameter base class

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

JElementCalendar

Renders a calendar element

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

JElementCategory

Renders a category element

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

JElementComponentLayouts

Parameter to display a list of the layouts for a component view from the extension or default template overrides.

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

JElementContentLanguages

Renders a select list of Asset Groups

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

JElementEditors

Renders a editors element

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

JElementFilelist

Renders a filelist element

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

JElementFolderlist

Renders a filelist element

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

JElementHelpsites

Renders a helpsites element

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

JElementHidden

Renders a hidden element

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

JElementImageList

Renders a imagelist element

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

JElementLanguages

Renders a languages element

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

JElementList

Renders a list element

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

JElementMenu

Renders a menu element

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

JElementMenuItem

Renders a menu item element

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

JElementModuleLayouts

Parameter to display a list of the layouts for a module from the module or default template overrides.

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

JElementPassword

Renders a password element

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

JElementRadio

Renders a radio element

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

JElementSpacer

Renders a spacer element

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

JElementSQL

Renders a SQL element

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

JElementTemplateStyle

Renders a list of template styles.

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

JElementText

Renders a text element

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

JElementTextarea

Renders a textarea element

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

JElementTimezones

Renders a timezones element

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

JElementUserGroup

Renders a editors element

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

JParameter

Parameter handler

« More »
  • \ Joomla.Platform
  • \ Plugin

Classes

JPlugin

JPlugin Class

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

JPluginHelper

Plugin helper class

« More »
  • \ Joomla.Platform
  • \ Registry

Classes

JRegistry

JRegistry class

« More »

JRegistryFormat

Abstract Format for JRegistry

« More »

JRegistryFormatINI

INI format handler for JRegistry.

« More »

JRegistryFormatJSON

JSON format handler for JRegistry.

« More »

JRegistryFormatPHP

PHP class format handler for JRegistry

« More »

JRegistryFormatXML

XML format handler for JRegistry.

« More »
  • \ Joomla.Platform
  • \ Session

Classes

JSession

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 »

JSessionStorage

Custom session storage handler for PHP

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

JSessionStorageApc

APC session storage handler for PHP

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

JSessionStorageDatabase

Database session storage handler for PHP

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

JSessionStorageEaccelerator

eAccelerator session storage handler for PHP

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

JSessionStorageMemcache

Memcache session storage handler for PHP

-- Inspired in both design and implementation by the Horde memcache handler --
« More »

JSessionStorageMemcached

Memcached session storage handler for PHP

-- Inspired in both design and implementation by the Horde memcached handler --
« More »

JSessionStorageNone

File session handler for PHP

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

JSessionStorageWincache

WINCACHE session storage handler for PHP

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

Classes

JString

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

« More »

JStringNormalise

Joomla Platform String Normalise Class

« More »

JStringNormalize

Joomla Platform String Normalize Class

« More »
  • \ Joomla.Platform
  • \ Table

Classes

JTable

Abstract Table class

Parent class to all tables.
« More »

JTableCategory

Category table

Parent class to all tables.
« More »

JTableContent

Content table

Parent class to all tables.
« More »

JTableExtension

Extension table Replaces plugins table

Parent class to all tables.
« More »

JTableMenu

Menu table

Parent class to all tables.
« More »

JTableMenuType

Menu Types table

Parent class to all tables.
« More »

JTableModule

Module table

Parent class to all tables.
« More »

JTableSession

Session table

Parent class to all tables.
« More »

JTableUpdate

Update table Stores updates temporarily

Parent class to all tables.
« More »

JTableUser

Users table

Parent class to all tables.
« More »
  • \ Joomla.Platform
  • \ Updater

Classes

JUpdate

Update class.

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

JUpdateAdapter

UpdateAdapter class.

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

JUpdater

Updater Class

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

JUpdaterCollection

Collection Update Adapter Class

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

JUpdaterExtension

Extension class for updater

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

Classes

JAuthentication

Authentication class, provides an interface for the Joomla authentication system

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

JAuthenticationResponse

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

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

JUser

User class. Handles all application interaction with a user

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

JUserHelper

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 »
  • \ Joomla.Platform
  • \ Utilities

Classes

JArrayHelper

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

« More »

JBuffer

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 »

JDate

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

« More »

JSimpleCrypt

JSimpleCrypt is a very simple encryption algorithm for encrypting/decrypting strings

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

JSimpleXML

SimpleXML implementation.

The XML Parser extension (expat) is required to use JSimpleXML. The class provides a pure PHP4 implementation of the PHP5 interface SimpleXML. As with PHP5's SimpleXML it is what it says: simple. Nevertheless, it is an easy way to deal with XML data, especially for read only access. Because it's not possible to use the PHP5 ArrayIterator interface with PHP4 there are some differences between this implementation and that of PHP5: The access to the root node has to be explicit in JSimpleXML, not implicit as with PHP5. Write $xml->document->node instead of $xml->node You cannot access CDATA using array syntax. Use the method data() instead You cannot access attributes directly with array syntax. Use attributes() to read them. Comments are ignored. Last and least, this is not as fast as PHP5 SimpleXML--it is pure PHP4. Example: <code> :simple.xml: <?xml version="1.0" encoding="utf-8" standalone="yes"?> <document> <node> <child gender="m">Tom Foo</child> <child gender="f">Tamara Bar</child> <node> </document> --- // read and write a document $xml = new JSimpleXML; $xml->loadFile('simple.xml'); print $xml->document->toString(); // access a given node's CDATA print $xml->root->node->child[0]->data(); // Tom Foo // access attributes $attr = $xml->root->node->child[1]->attributes(); print $attr['gender']; // f // access children foreach($xml->root->node->children() as $child) { print $child->data(); } </code> Note: JSimpleXML cannot be used to access sophisticated XML doctypes using datatype ANY (e.g. XHTML). With a DOM implementation you can handle this.
« More »

JSimpleXMLElement

SimpleXML Element

This object stores all of the direct children of itself in the $children array. They are also stored by type as arrays. So, if, for example, this tag had 2 <font> tags as children, there would be a class member called $font created as an array. $font[0] would be the first font tag, and $font[1] would be the second. To loop through all of the direct children of this object, the $children member should be used. To loop through all of the direct children of a specific tag for this object, it is probably easier to use the arrays of the specific tag names, as explained above.
« More »

JUtility

JUtility is a utility functions class

« More »

JXMLElement

Wrapper class for php SimpleXMLElement.

« More »