A

JLoader::applyAliasFor() — Method in class JLoader

Applies a class alias for an already loaded class, if a class alias was created for it.

AccessClass in namespace Joomla\CMS\Access

Class that handles all access authorisation routines.

$ Access#assetRulesProperty in class Access

Array of rules for the asset

$ Access#assetRulesIdentitiesProperty in class Access

Array of identities for asset rules

$ Access#assetPermissionsParentIdMappingProperty in class Access

Array of the permission parent ID mappings

AuthenticationFailedClass in namespace Joomla\CMS\Access\Exception

Exception class defining an authentication failed event

Rule::allow() — Method in class Rule

Checks that this action can be performed by an identity.

Rules::allow() — Method in class Rules

Checks that an action can be performed by an identity.

AdapterClass in namespace Joomla\CMS\Adapter

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

AdapterInstanceClass in namespace Joomla\CMS\Adapter

Adapter Instance Class

AdministratorApplicationClass in namespace Joomla\CMS\Application

Joomla! Administrator Application class

$ AdministratorApplication#allowedUnprivilegedOptionsProperty in class AdministratorApplication

List of allowed components for guests and users which do not have the core.login.admin privilege.

ApiApplicationClass in namespace Joomla\CMS\Application

Joomla! API Application class

$ ApiApplication#authenticationPluginTypeProperty in class ApiApplication

The authentication plugin type

ApiApplication::addFormatMap() — Method in class ApiApplication

Adds a mapping from a content type to the format stored. Note the format type cannot be overwritten.

ApplicationHelperClass in namespace Joomla\CMS\Application

Application helper functions

ApplicationHelper::addClientInfo() — Method in class ApplicationHelper

Adds information for a client.

ColorProcessor::addStyle() — Method in class ColorProcessor

Add a style.

$ CMSApplication#authenticationPluginTypeProperty in class CMSApplication

The authentication plugin type

SiteApplication::authorise() — Method in class SiteApplication

Check if the user can access the application

WebApplication::afterSessionStart() — Method in class WebApplication

After the session has been started we need to populate it with some default values.

AssociationExtensionHelperClass in namespace Joomla\CMS\Association

Association Extension Helper

$ AssociationExtensionHelper#associationsSupportProperty in class AssociationExtensionHelper

Has the extension association support

AssociationExtensionInterfaceClass in namespace Joomla\CMS\Association

Association Extension Interface for the helper classes

AssociationServiceInterfaceClass in namespace Joomla\CMS\Association

The association service.

AssociationServiceTraitClass in namespace Joomla\CMS\Association

Trait to implement AssociationServiceInterface

AuthenticationClass in namespace Joomla\CMS\Authentication

Authentication class, provides an interface for the Joomla authentication system

Authentication::authenticate() — Method in class Authentication

Finds out if a set of login credentials are valid by asking all observing objects to run their respective authentication routines.

Authentication::authorise() — Method in class Authentication

Authorises that a particular user should be able to login

AuthenticationResponseClass in namespace Joomla\CMS\Authentication

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

Argon2iHandlerClass in namespace Joomla\CMS\Authentication\Password

Password handler for Argon2i hashed passwords

Argon2idHandlerClass in namespace Joomla\CMS\Authentication\Password

Password handler for Argon2id hashed passwords

ChainedHandler::addHandler() — Method in class ChainedHandler

Add a handler to the chain

ActionButtonClass in namespace Joomla\CMS\Button

The TaskButton class.

ActionButton::addState() — Method in class ActionButton

Add a state profile.

Cache::addIncludePath() — Method in class Cache

Add a directory where Cache should search for handlers. You may either pass a string or an array of directories.

CacheController::addIncludePath() — Method in class CacheController

Add a directory where Cache should search for controllers. You may either pass a string or an array of directories.

CacheStorage::addIncludePath() — Method in class CacheStorage

Add a directory where CacheStorage should search for handlers. You may either pass a string or an array of directories.

ApcuStorageClass in namespace Joomla\CMS\Cache\Storage

APCu cache storage handler

CaptchaRegistry::add() — Method in class CaptchaRegistry

Register element in registry, add new or override existing.

$ CategoryNode#asset_idProperty in class CategoryNode

The id of the category in the asset table

$ CategoryNode#aliasProperty in class CategoryNode

The alias for the category

$ CategoryNode#accessProperty in class CategoryNode

Access level for the category

$ CategoryNode#assetsProperty in class CategoryNode

Array of assets

$ Changelog#additionProperty in class Changelog

Update manifest <addition> element

FtpClient::append() — Method in class FtpClient

Method to append a string to the FTP server

$ RouterBase#appProperty in class RouterBase

Application object to use in the router

RouterView::attachRules() — Method in class RouterView

Add a number of router rules to the object

RouterView::attachRule() — Method in class RouterView

Attach a build rule

RouterViewConfiguration::addLayout() — Method in class RouterViewConfiguration

Add a layout to this view

AddUserCommandClass in namespace Joomla\CMS\Console

Console command for adding a user

AddUserToGroupCommandClass in namespace Joomla\CMS\Console

Console command to add a user to group

WritableContainerLoader::add() — Method in class WritableContainerLoader

Adds a command to the loader.

WritableLoaderInterface::add() — Method in class WritableLoaderInterface

Adds a command to the loader.

$ TasksListCommand#applicationProperty in class TasksListCommand

The console application object

$ TasksStateCommand#applicationProperty in class TasksStateCommand

The console application object

Date::add() — Method in class Date

Adds an amount of days, months, years, hours, minutes and seconds to a Date object.

AbstractModuleDispatcherClass in namespace Joomla\CMS\Dispatcher

Base class for a Joomla Module Dispatcher.

ApiDispatcherClass in namespace Joomla\CMS\Dispatcher

API Implementation for our dispatcher. It loads a component's administrator language files, and calls the API Controller so that components that haven't implemented web services can add their own handling.

$ Dispatcher#appProperty in class Dispatcher

The application instance

Document::addScript() — Method in class Document

Adds a linked script to the page

Document::addScriptDeclaration() — Method in class Document

Adds a script to the page

Document::addScriptOptions() — Method in class Document

Add option for script

Document::addStyleSheet() — Method in class Document

Adds a linked stylesheet to the page

Document::addStyleDeclaration() — Method in class Document

Adds a stylesheet declaration to the page

FeedDocument::addItem() — Method in class FeedDocument

Adds a FeedItem to the feed.

$ FeedItem#authorProperty in class FeedItem

Author item element

$ FeedItem#authorEmailProperty in class FeedItem

Author email element

HtmlDocument::addHeadLink() — Method in class HtmlDocument

Adds <link> tags to the head of the document

HtmlDocument::addFavicon() — Method in class HtmlDocument

Adds a shortcut icon (favicon)

HtmlDocument::addCustomTag() — Method in class HtmlDocument

Adds a custom HTML string to the head block

JsonapiDocument::addLink() — Method in class JsonapiDocument

Add a link to the output.

JsonapiDocument::addMeta() — Method in class JsonapiDocument

Add a link to the output.

OpensearchDocument::addUrl() — Method in class OpensearchDocument

Adds a URL to the Opensearch description.

OpensearchDocument::addImage() — Method in class OpensearchDocument

Adds an image to the Opensearch description.

AtomRendererClass in namespace Joomla\CMS\Document\Renderer\Feed

AtomRenderer is a feed that implements the atom specification

AbstractEditorProviderClass in namespace Joomla\CMS\Editor

Abstract editor provider

ButtonsRegistry::add() — Method in class ButtonsRegistry

Register element in registry, add new or override existing.

ButtonsRegistryInterface::add() — Method in class ButtonsRegistryInterface

Register element in registry, add new or override existing.

$ Editor#assetProperty in class Editor

Object asset

$ Editor#authorProperty in class Editor

Object author

EditorsRegistry::add() — Method in class EditorsRegistry

Register element in registry, add new or override existing.

EditorsRegistryInterface::add() — Method in class EditorsRegistryInterface

Register element in registry, add new or override existing.

AbstractAESClass in namespace Joomla\CMS\Encrypt\AES

Abstract AES encryption class

AesInterfaceClass in namespace Joomla\CMS\Encrypt\AES

Interface for AES encryption adapters

AesClass in namespace Joomla\CMS\Encrypt

A simple implementation of AES-128, AES-192 and AES-256 encryption using the high performance mcrypt library.

$ Aes#adapterProperty in class Aes

The AES encryption adapter in use.

$ Browser#agentProperty in class Browser
$ Browser#acceptProperty in class Browser
$ Browser#acceptParsedProperty in class Browser
AbstractRendererClass in namespace Joomla\CMS\Error

Base class for error page renderers

AuthenticationFailedExceptionHandlerClass in namespace Joomla\CMS\Error\JsonApi

Handler for permission errors that should give a 401

AbstractEventClass in namespace Joomla\CMS\Event

This class implements the base Event object used system-wide to offer orthogonality. Core objects such as Models, Controllers, etc create such events on-the-fly and dispatch them through the application's Dispatcher (colloquially known as the "Joomla! plugin system"). This way a suitable plugin, typically a "system" plugin, can modify the behaviour of any internal class, providing system-wide services such as tags, content versioning, comments or even low-level services such as the implementation of created/modified/locked behaviours, record hit counter etc.

AbstractImmutableEventClass in namespace Joomla\CMS\Event

This class implements the immutable base Event object used system-wide to offer orthogonality.

AfterLogExportEventClass in namespace Joomla\CMS\Event\ActionLog

Class for ActionLog events

AfterLogPurgeEventClass in namespace Joomla\CMS\Event\ActionLog

Class for ActionLog events

AfterExtensionBootEventClass in namespace Joomla\CMS\Event

Event class for representing the extensions's onBeforeExtensionBoot event

AfterApiRouteEventClass in namespace Joomla\CMS\Event\Application

Class for AfterApiRoute event

AfterCompressEventClass in namespace Joomla\CMS\Event\Application

Class for AfterCompress event

AfterDispatchEventClass in namespace Joomla\CMS\Event\Application

Class for AfterDispatch event

AfterExecuteEventClass in namespace Joomla\CMS\Event\Application

Class for AfterExecute event

AfterInitialiseDocumentEventClass in namespace Joomla\CMS\Event\Application

Event class for AfterInitialiseDocument event

AfterInitialiseEventClass in namespace Joomla\CMS\Event\Application

Class for AfterInitialise event

AfterRenderEventClass in namespace Joomla\CMS\Event\Application

Class for AfterRender event

AfterRespondEventClass in namespace Joomla\CMS\Event\Application

Class for AfterRespond event

AfterRouteEventClass in namespace Joomla\CMS\Event\Application

Class for AfterRoute event

AfterSaveConfigurationEventClass in namespace Joomla\CMS\Event\Application

Class for Application Configuration events

ApplicationConfigurationEventClass in namespace Joomla\CMS\Event\Application

Class for Application Configuration events

ApplicationDocumentEventClass in namespace Joomla\CMS\Event\Application

Class for Application's Document events

ApplicationEventClass in namespace Joomla\CMS\Event\Application

Class for Application events

AfterPurgeEventClass in namespace Joomla\CMS\Event\Cache

Class for Cache events

AfterCheckinEventClass in namespace Joomla\CMS\Event\Checkin

Class for Checkin events

AfterDisplayEventClass in namespace Joomla\CMS\Event\Content

Class for Content event.

AfterTitleEventClass in namespace Joomla\CMS\Event\Content

Class for Content event.

AbstractPrepareFieldEventClass in namespace Joomla\CMS\Event\CustomFields

Class for CustomFields events

AfterPrepareFieldEventClass in namespace Joomla\CMS\Event\CustomFields

Class for CustomFields events

AbstractExtensionEventClass in namespace Joomla\CMS\Event\Extension

Base class for Extension events

AbstractJoomlaUpdateEventClass in namespace Joomla\CMS\Event\Extension

Base class for Joomla Update events

AfterInstallEventClass in namespace Joomla\CMS\Event\Extension

Class for Extension events

AfterJoomlaUpdateEventClass in namespace Joomla\CMS\Event\Extension

Class for Joomla Update events

AfterUninstallEventClass in namespace Joomla\CMS\Event\Extension

Class for Extension events

AfterUpdateEventClass in namespace Joomla\CMS\Event\Extension

Class for Extension events

AbstractFinderEventClass in namespace Joomla\CMS\Event\Finder

Class for Finder events

AfterCategoryChangeStateEventClass in namespace Joomla\CMS\Event\Finder

Class for Model event.

AfterChangeStateEventClass in namespace Joomla\CMS\Event\Finder

Class for Model event.

AfterDeleteEventClass in namespace Joomla\CMS\Event\Finder

Class for Model event.

AfterSaveEventClass in namespace Joomla\CMS\Event\Finder

Class for Model event.

AddInstallationTabEventClass in namespace Joomla\CMS\Event\Installer

Class for Installer events

AfterInstallerEventClass in namespace Joomla\CMS\Event\Installer

Class for Installer events

AfterGetMenuTypeOptionsEventClass in namespace Joomla\CMS\Event\Menu

Class for menu events

AfterCategoryChangeStateEventClass in namespace Joomla\CMS\Event\Model

Class for Model event.

AfterChangeStateEventClass in namespace Joomla\CMS\Event\Model

Class for Model event.

AfterCleanCacheEventClass in namespace Joomla\CMS\Event\Model

Class for Clean cache events

AfterDeleteEventClass in namespace Joomla\CMS\Event\Model

Class for Model event.

AfterSaveEventClass in namespace Joomla\CMS\Event\Model

Class for Model event.

AfterCleanModuleListEventClass in namespace Joomla\CMS\Event\Module

Class for Module events.

AfterModuleListEventClass in namespace Joomla\CMS\Event\Module

Class for Module events.

AfterRenderModuleEventClass in namespace Joomla\CMS\Event\Module

Class for Module events.

AfterRenderModulesEventClass in namespace Joomla\CMS\Event\Module

Class for Module events.

AjaxEventClass in namespace Joomla\CMS\Event\Plugin

Class for onAjax... events

AjaxEvent::addResult() — Method in class AjaxEvent

Appends data to the result of the event.

AjaxClass in namespace Joomla\CMS\Event\Plugin\System\Webauthn

Concrete event class for the onAjaxWebauthn event

AjaxChallengeClass in namespace Joomla\CMS\Event\Plugin\System\Webauthn

Concrete event class for the onAjaxWebauthnChallenge event

AjaxCreateClass in namespace Joomla\CMS\Event\Plugin\System\Webauthn

Concrete event class for the onAjaxWebauthnCreate event

AjaxDeleteClass in namespace Joomla\CMS\Event\Plugin\System\Webauthn

Concrete event class for the onAjaxWebauthnDelete event

AjaxInitCreateClass in namespace Joomla\CMS\Event\Plugin\System\Webauthn

Concrete event class for the onAjaxWebauthnInitcreate event

AjaxLoginClass in namespace Joomla\CMS\Event\Plugin\System\Webauthn

Concrete event class for the onAjaxWebauthnLogin event

AjaxSaveLabelClass in namespace Joomla\CMS\Event\Plugin\System\Webauthn

Concrete event class for the onAjaxWebauthnSavelabel event

ResultAware::addResult() — Method in class ResultAware

Appends data to the result array of the event.

ResultAwareInterface::addResult() — Method in class ResultAwareInterface

Appends data to the result array of the event.

AbstractEventClass in namespace Joomla\CMS\Event\Table

Event class for the Table's events

AfterBindEventClass in namespace Joomla\CMS\Event\Table

Event class for \Joomla\CMS\Table\Table onAfterBind event

AfterCheckinEventClass in namespace Joomla\CMS\Event\Table

Event class for \Joomla\CMS\Table\Table onAfterCheckin event

AfterCheckoutEventClass in namespace Joomla\CMS\Event\Table

Event class for \Joomla\CMS\Table\Table onAfterCheckout event

AfterDeleteEventClass in namespace Joomla\CMS\Event\Table

Event class for \Joomla\CMS\Table\Table onAfterDelete event

AfterHitEventClass in namespace Joomla\CMS\Event\Table

Event class for \Joomla\CMS\Table\Table onAfterHit event

AfterLoadEventClass in namespace Joomla\CMS\Event\Table

Event class for \Joomla\CMS\Table\Table onAfterLoad event

AfterMoveEventClass in namespace Joomla\CMS\Event\Table

Event class for \Joomla\CMS\Table\Table onAfterMove event

AfterPublishEventClass in namespace Joomla\CMS\Event\Table

Event class for \Joomla\CMS\Table\Table onAfterPublish event

AfterReorderEventClass in namespace Joomla\CMS\Event\Table

Event class for \Joomla\CMS\Table\Table onAfterReorder event

AfterResetEventClass in namespace Joomla\CMS\Event\Table

Event class for \Joomla\CMS\Table\Table onAfterReset event

AfterStoreEventClass in namespace Joomla\CMS\Event\Table

Event class for \Joomla\CMS\Table\Table onAfterStore event

AbstractDeleteEventClass in namespace Joomla\CMS\Event\User

Base class for User delete event

AbstractLoginEventClass in namespace Joomla\CMS\Event\User

Base class for User login event

AbstractLogoutEventClass in namespace Joomla\CMS\Event\User

Base class for User logout event

AbstractResetEventClass in namespace Joomla\CMS\Event\User

Class for User reset event.

AbstractSaveEventClass in namespace Joomla\CMS\Event\User

Base class for User save event

AfterDeleteEventClass in namespace Joomla\CMS\Event\User

Class for User delete event.

AfterLoginEventClass in namespace Joomla\CMS\Event\User

Class for User event.

AfterLogoutEventClass in namespace Joomla\CMS\Event\User

Class for User event.

AfterRemindEventClass in namespace Joomla\CMS\Event\User

Class for User event.

AfterResetCompleteEventClass in namespace Joomla\CMS\Event\User

Class for User reset event.

AfterResetRequestEventClass in namespace Joomla\CMS\Event\User

Class for User reset event.

AfterSaveEventClass in namespace Joomla\CMS\Event\User

Class for User save event.

AuthenticationEventClass in namespace Joomla\CMS\Event\User

Class for User event.

AuthorisationEventClass in namespace Joomla\CMS\Event\User

Class for User event.

AuthorisationFailureEventClass in namespace Joomla\CMS\Event\User

Class for User event.

AbstractEventClass in namespace Joomla\CMS\Event\WebAsset

Event class for WebAsset events

AbstractEventClass in namespace Joomla\CMS\Event\Workflow

Event class for WebAsset events

$ Factory#applicationProperty in class Factory

Global application object

$ Feed#authorProperty in class Feed

Person responsible for feed content.

Feed::addCategory() — Method in class Feed

Method to add a category to the feed object.

Feed::addContributor() — Method in class Feed

Method to add a contributor to the feed object.

Feed::addEntry() — Method in class Feed

Method to add an entry to the feed object.

$ FeedEntry#authorProperty in class FeedEntry

Person responsible for feed entry content.

FeedEntry::addCategory() — Method in class FeedEntry

Method to add a category to the feed entry object.

FeedEntry::addContributor() — Method in class FeedEntry

Method to add a contributor to the feed entry object.

FeedEntry::addLink() — Method in class FeedEntry

Method to add a link to the feed entry object.

AtomParserClass in namespace Joomla\CMS\Feed\Parser

ATOM Feed Parser class.

File::append() — Method in class File

Append contents to a file

Patcher::apply() — Method in class Patcher

Apply the patches

Patcher::addFile() — Method in class Patcher

Add a unified diff file to the patcher

Patcher::add() — Method in class Patcher

Add a unified diff string to the patcher

Patcher::applyHunk() — Method in class Patcher

Apply the patch

Stream::addContextEntry() — Method in class Stream

Adds a particular options to the context

Stream::applyContextToStream() — Method in class Stream

Applies the current context to the stream

Stream::appendFilter() — Method in class Stream

Stream filters Append a filter to the chain

OutputFilter::ampReplaceCallback() — Method in class OutputFilter

Callback method for replacing & with & in a string

AccessiblemediaFieldClass in namespace Joomla\CMS\Form\Field

The Field to load the form inside current form

AccesslevelFieldClass in namespace Joomla\CMS\Form\Field

Form Field class for the Joomla Platform.

AliastagFieldClass in namespace Joomla\CMS\Form\Field

Form Field class for the Joomla Framework.

AuthorFieldClass in namespace Joomla\CMS\Form\Field

Form Field to load a list of content authors

$ EditorField#assetFieldProperty in class EditorField

The assetField of the editor.

$ EditorField#authorFieldProperty in class EditorField

The authorField of the editor.

$ EditorField#assetProperty in class EditorField

The asset of the editor.

$ FileField#acceptProperty in class FileField

The accepted file type list.

ListField::addOption() — Method in class ListField

Method to add an option to the list field.

$ MediaField#authorFieldProperty in class MediaField

The authorField.

$ MediaField#assetProperty in class MediaField

The asset.

$ MeterField#activeProperty in class MeterField

Whether the field is active or not.

$ MeterField#animatedProperty in class MeterField

Whether the field is animated or not.

$ RulesField#assetFieldProperty in class RulesField

The assetField.

$ RulesField#assetRulesProperty in class RulesField

The asset rules

$ RulesField#actionsProperty in class RulesField

The actions

$ RulesField#assetIdProperty in class RulesField

The asset Id

TagField::allowCustom() — Method in class TagField

Determines if the field allows or denies custom values

$ TextField#addonBeforeProperty in class TextField

Input addon before

$ TextField#addonAfterProperty in class TextField

Input addon after

$ WorkflowstageField#activeonlyProperty in class WorkflowstageField

Show only the stages which has an item attached

Form::addFieldPath() — Method in class Form

Proxy for FormHelper::addFieldPath().

Form::addFormPath() — Method in class Form

Proxy for FormHelper::addFormPath().

Form::addRulePath() — Method in class Form

Proxy for FormHelper::addRulePath().

Form::addFilterPath() — Method in class Form

Proxy for FormHelper::addFilterPath().

Form::addNode() — Method in class Form

Adds a new child SimpleXMLElement node to the source.

Form::addControlField() — Method in class Form

Add control field

$ FormField#autocompleteProperty in class FormField

The autocomplete state for the form field. If 'off' element will not be automatically completed by browser.

$ FormField#autofocusProperty in class FormField

The autofocus request for the form field. If true element will be automatically focused on document load.

FormHelper::addFieldPath() — Method in class FormHelper

Method to add a path to the list of field include paths.

FormHelper::addFormPath() — Method in class FormHelper

Method to add a path to the list of form include paths.

FormHelper::addRulePath() — Method in class FormHelper

Method to add a path to the list of rule include paths.

FormHelper::addFilterPath() — Method in class FormHelper

Method to add a path to the list of filter include paths.

FormHelper::addPath() — Method in class FormHelper

Method to add a path to the list of include paths for one of the form's entities.

FormHelper::addFieldPrefix() — Method in class FormHelper

Method to add a namespace prefix to the list of field lookups.

FormHelper::addFormPrefix() — Method in class FormHelper

Method to add a namespace to the list of form lookups.

FormHelper::addRulePrefix() — Method in class FormHelper

Method to add a namespace to the list of rule lookups.

FormHelper::addFilterPrefix() — Method in class FormHelper

Method to add a namespace to the list of filter lookups.

FormHelper::addPrefix() — Method in class FormHelper

Method to add a namespace to the list of namespaces for one of the form's entities.

HTMLHelper::addIncludePath() — Method in class HTMLHelper

Add a directory where HTMLHelper should search for helpers. You may either pass a string or an array of directories.

HTMLHelper::addFileToBuffer() — Method in class HTMLHelper

Method that searches if file exists in given path and returns the relative path. If a minified version exists it will be preferred.

AccessClass in namespace Joomla\CMS\HTML\Helpers

Extended Utility class for all HTML drawing classes.

$ Access#asset_groupsProperty in class Access

A cached array of the asset groups

Access::actions() — Method in class Access

Returns a UL list of actions with checkboxes

Access::assetgroups() — Method in class Access

Gets a list of the asset groups as an array of JHtml compatible options.

Access::assetgrouplist() — Method in class Access

Displays a Select list of the available asset groups

ActionsDropdownClass in namespace Joomla\CMS\HTML\Helpers

HTML utility class for building a dropdown menu

ActionsDropdown::archive() — Method in class ActionsDropdown

Append an archive item to the current dropdown menu

ActionsDropdown::addCustomItem() — Method in class ActionsDropdown

Append a custom item to current dropdown menu.

AdminLanguageClass in namespace Joomla\CMS\HTML\Helpers

Utility class working with administrator language select lists

Bootstrap::alert() — Method in class Bootstrap

Add javascript support for Bootstrap alerts

Bootstrap::addSlide() — Method in class Bootstrap

Begins the display of a new accordion slide.

Bootstrap::addTab() — Method in class Bootstrap

Begins the display of a new tab content panel.

Dropdown::archive() — Method in class Dropdown

Append an archive item to the current dropdown menu

Dropdown::addCustomItem() — Method in class Dropdown

Append a custom item to current dropdown menu

FormBehavior::ajaxchosen() — Method in class FormBehavior

Method to load the AJAX Chosen library

JGrid::action() — Method in class JGrid

Returns an action on a grid

$ Sidebar#actionProperty in class Sidebar

Value for the action attribute of the form.

Sidebar::addEntry() — Method in class Sidebar

Method to add a menu item to submenu.

Sidebar::addFilter() — Method in class Sidebar

Method to add a filter to the submenu

StringHelper::abridge() — Method in class StringHelper

Abridges text strings over the specified character limit. The behavior will insert an ellipsis into the text replacing a section of variable size to ensure the string does not exceed the defined maximum length. This method is UTF-8 safe.

Tag::ajaxfield() — Method in class Tag

This is just a proxy for the formbehavior.ajaxchosen method

UiTab::addTab() — Method in class UiTab

Begins the display of a new tab content panel.

AuthenticationHelperClass in namespace Joomla\CMS\Helper

Authentication helper class

ContentHelper::addSubmenu() — Method in class ContentHelper

Configure the Linkbar. Must be implemented by each extension.

TagsHelper::addTagMapping() — Method in class TagsHelper

Method to add tag rows to mapping table.

$ Cli#argsProperty in class Cli

The additional arguments passed to the script that are not associated with a specific argument name.

Installer::abort() — Method in class Installer

Installation abort method

$ InstallerScript#allowDowngradesProperty in class InstallerScript

Allow downgrades of your extension

InstallerScript::addDashboardMenu() — Method in class InstallerScript

Creates the dashboard menu module

$ LibraryManifest#authorProperty in class LibraryManifest

Author for the library

$ LibraryManifest#authoremailProperty in class LibraryManifest

Author email for the library

$ LibraryManifest#authorurlProperty in class LibraryManifest

Author URL for the library

$ PackageManifest#authorurlProperty in class PackageManifest

Author url of the package

$ PackageManifest#authorProperty in class PackageManifest

Author of the package

$ PackageManifest#authoremailProperty in class PackageManifest

Author email of the package

AssociationsClass in namespace Joomla\CMS\Language

Utility class for associations in multilang

Text::alt() — Method in class Text

Translates a string into the current language.

BaseLayout::addDebugMessage() — Method in class BaseLayout

Add a debug message to the debug messages array

FileLayout::addIncludePath() — Method in class FileLayout

Add one path to include in layout search. Proxy of addIncludePaths()

FileLayout::addIncludePaths() — Method in class FileLayout

Add one or more paths to include in layout search

Log::add() — Method in class Log

Method to add an entry to the log.

Log::addLogger() — Method in class Log

Add a logger to the Log instance. Loggers route log entries to the correct files/systems to be logged.

Log::addLoggerInternal() — Method in class Log

Add a logger to the Log instance. Loggers route log entries to the correct files/systems to be logged.

Log::addLogEntry() — Method in class Log

Method to add an entry to the appropriate loggers.

Logger::addEntry() — Method in class Logger

Method to add an entry to the log.

CallbackLogger::addEntry() — Method in class CallbackLogger

Method to add an entry to the log.

DatabaseLogger::addEntry() — Method in class DatabaseLogger

Method to add an entry to the log.

EchoLogger::addEntry() — Method in class EchoLogger

Method to add an entry to the log.

FormattedtextLogger::addEntry() — Method in class FormattedtextLogger

Method to add an entry to the log.

InMemoryLogger::addEntry() — Method in class InMemoryLogger

Method to add an entry to the log.

MessagequeueLogger::addEntry() — Method in class MessagequeueLogger

Method to add an entry to the log.

SyslogLogger::addEntry() — Method in class SyslogLogger

Method to add an entry to the log.

AdminControllerClass in namespace Joomla\CMS\MVC\Controller

Base class for a Joomla Administrator Controller

$ AdminController#appProperty in class AdminController

The Application. Redeclared to show this class requires a web application.

ApiControllerClass in namespace Joomla\CMS\MVC\Controller

Base class for a Joomla API Controller

$ ApiController#appProperty in class ApiController

The Application. Redeclared to show this class requires a web application.

ApiController::add() — Method in class ApiController

Method to add a new record.

ApiController::allowEdit() — Method in class ApiController

Method to check if you can edit an existing record.

ApiController::allowAdd() — Method in class ApiController

Method to check if you can add a new record.

$ BaseController#appProperty in class BaseController

The Application

BaseController::addModelPath() — Method in class BaseController

Adds to the stack of model paths in LIFO order.

BaseController::addPath() — Method in class BaseController

Adds to the search path for templates and resources.

BaseController::addViewPath() — Method in class BaseController

Add one or more view paths to the controller's stack, in LIFO order.

$ FormController#appProperty in class FormController

The Application. Redeclared to show this class requires a web application.

FormController::add() — Method in class FormController

Method to add a new record.

FormController::allowAdd() — Method in class FormController

Method to check if you can add a new record.

FormController::allowEdit() — Method in class FormController

Method to check if you can edit an existing record.

FormController::allowSave() — Method in class FormController

Method to check if you can save a new or existing record.

ApiMVCFactoryClass in namespace Joomla\CMS\MVC\Factory

Factory to create MVC objects based on a namespace. Note that in an API Application model and table objects will be created from their administrator counterparts.

AdminModelClass in namespace Joomla\CMS\MVC\Model

Prototype admin model.

$ AdminModel#associationsContextProperty in class AdminModel

The context used for the associations table

BaseModel::addIncludePath() — Method in class BaseModel

Add a directory where \JModelLegacy should search for models. You may either pass a string or an array of directories.

LegacyModelLoaderTrait::addTablePath() — Method in class LegacyModelLoaderTrait

Adds to the stack of model table paths in LIFO order.

WorkflowBehaviorTrait::addTransitionField() — Method in class WorkflowBehaviorTrait

Adds a transition field to the form. Can be overwritten by the child class if not needed

AbstractViewClass in namespace Joomla\CMS\MVC\View

Base class for a Joomla View

CategoryView::addFeed() — Method in class CategoryView

Method to add an alternative feed link to a category layout.

OnGetApiFields::addFields() — Method in class OnGetApiFields

Allows the user to add names of properties that will be interpreted as relations Note that if there is an existing data property it will also be displayed as well as the relation due to the internal implementation (this behaviour is not part of this API however and should not be guaranteed)

OnGetApiFields::addRelations() — Method in class OnGetApiFields

Allows the user to add names of properties that will be interpreted as relations Note that if there is an existing data property it will also be displayed as well as the relation due to the internal implementation (this behaviour is not part of this API however and should not be guaranteed)

FormView::addToolbar() — Method in class FormView

Add the page title and toolbar.

HtmlView::addTemplatePath() — Method in class HtmlView

Adds to the stack of view script paths in LIFO order.

HtmlView::addHelperPath() — Method in class HtmlView

Adds to the stack of helper script paths in LIFO order.

$ ListView#activeFiltersProperty in class ListView

The active search filters

ListView::addToolbar() — Method in class ListView

Add the page title and toolbar.

Mail::add() — Method in class Mail

Add recipients to the email.

Mail::addRecipient() — Method in class Mail

Add a recipient to the email.

Mail::addCc() — Method in class Mail

Add a carbon copy recipient to the email.

Mail::addBcc() — Method in class Mail

Add a blind carbon copy recipient to the email.

Mail::addAttachment() — Method in class Mail

Add file attachment to the email.

Mail::addReplyTo() — Method in class Mail

Add Reply to email address to the email

$ MailTemplate#attachmentsProperty in class MailTemplate
MailTemplate::addAttachment() — Method in class MailTemplate

Add an attachment to the mail

MailTemplate::addRecipient() — Method in class MailTemplate

Adds recipients for this mail

MailTemplate::addLayoutTemplateData() — Method in class MailTemplate

Add data to the html layout template

MailTemplate::addTemplateData() — Method in class MailTemplate

Add data to replace in the template

MailTemplate::addUnsafeTags() — Method in class MailTemplate

Mark tags as unsafe to ensure escaping in HTML mails

MailerInterface::addRecipient() — Method in class MailerInterface

Add a recipient to the email.

MailerInterface::addCc() — Method in class MailerInterface

Add a carbon copy recipient to the email.

MailerInterface::addBcc() — Method in class MailerInterface

Add a blind carbon copy recipient to the email.

MailerInterface::addAttachment() — Method in class MailerInterface

Add file attachment to the email.

MailerInterface::addReplyTo() — Method in class MailerInterface

Add Reply to email address to the email

AbstractMenuClass in namespace Joomla\CMS\Menu

Menu class

$ AbstractMenu#activeProperty in class AbstractMenu

Identifier of the active menu item

AbstractMenu::authorise() — Method in class AbstractMenu

Method to check Menu object authorization against an access control object and optionally an access extension object

AdministratorMenuClass in namespace Joomla\CMS\Menu

Menu class.

AdministratorMenuItemClass in namespace Joomla\CMS\Menu

Object representing an administrator menu item

$ MenuItem#aliasProperty in class MenuItem

The SEF alias of the menu item

$ MenuItem#accessProperty in class MenuItem

The access level required to view the menu item

$ SiteMenu#appProperty in class SiteMenu

Application object

$ Pagination#additionalUrlParamsProperty in class Pagination

Additional URL parameters to be added to the pagination URLs generated by the class. These may be useful for filters and extra values when dealing with lists and GET requests.

$ Pagination#appProperty in class Pagination
$ PaginationObject#activeProperty in class PaginationObject
Pathway::addItem() — Method in class Pathway

Create and add an item to the pathway.

$ CMSPlugin#autoloadLanguageProperty in class CMSPlugin

Affects constructor behavior. If true, language files will be loaded automatically.

$ CMSPlugin#allowLegacyListenersProperty in class CMSPlugin

Should I try to detect and register legacy event listeners, i.e. methods which accept unwrapped arguments? While this maintains a great degree of backwards compatibility to Joomla! 3.x-style plugins it is much slower. You are advised to implement your plugins using proper Listeners, methods accepting an AbstractEvent as their sole parameter, for best performance. Also bear in mind that Joomla! 5.x onwards will only allow proper listeners, removing support for legacy Listeners.

ArrayProxyClass in namespace Joomla\CMS\Proxy

Array proxy class

ArrayReadOnlyProxyClass in namespace Joomla\CMS\Proxy

Array read-only proxy class.

AdministratorRouterClass in namespace Joomla\CMS\Router

Class to create and parse routes

ApiRouterClass in namespace Joomla\CMS\Router

Joomla! API Router class

$ ApiRouter#appProperty in class ApiRouter

The application object

Router::attachBuildRule() — Method in class Router

Attach a build rule

Router::attachParseRule() — Method in class Router

Attach a parse rule

$ SiteRouter#appProperty in class SiteRouter
SchemaorgPluginTrait::addSchemaType() — Method in class SchemaorgPluginTrait

Add a new option to schemaType list field in schema form

OnGetApiAttributes::addAttribute() — Method in class OnGetApiAttributes

Set a named attribute to be rendered in the API.

OnGetApiAttributes::addAttributes() — Method in class OnGetApiAttributes

Set attributes to be rendered in the API.

ApplicationClass in namespace Joomla\CMS\Service\Provider

Application service provider

AuthenticationClass in namespace Joomla\CMS\Service\Provider

Service provider for the authentication dependencies

JoomlaStorage::all() — Method in class JoomlaStorage

Retrieves all variables from the session store

$ TufFetcher#appProperty in class TufFetcher

The web application object

AssetClass in namespace Joomla\CMS\Table

Table class supporting modified pre-order tree traversal behavior.

$ Nested#aliasProperty in class Nested

Object property holding the alias of this node used to construct the full text path, forward-slash delimited.

Table::addIncludePath() — Method in class Table

Add a filesystem path where Table should search for table class files.

Table::appendPrimaryKeys() — Method in class Table

Method to append the primary keys for this table to a query.

AbstractGroupButtonClass in namespace Joomla\CMS\Toolbar\Button

The AbstractGroupButton class.

CoreButtonsTrait::assign() — Method in class CoreButtonsTrait

Writes a common 'assign' button for a record.

CoreButtonsTrait::addNew() — Method in class CoreButtonsTrait

Writes the common 'new' icon for the button bar.

CoreButtonsTrait::archive() — Method in class CoreButtonsTrait

Writes a common 'archive' button.

CoreButtonsTrait::apply() — Method in class CoreButtonsTrait

Writes a save button for a given option.

Toolbar::appendButton() — Method in class Toolbar

Append a button to toolbar.

Toolbar::addButtonPath() — Method in class Toolbar

Add a directory where Toolbar should search for button types in LIFO order.

ToolbarButton::attributes() — Method in class ToolbarButton
ToolbarHelper::assign() — Method in class ToolbarHelper

Writes a common 'assign' button for a record.

ToolbarHelper::addNew() — Method in class ToolbarHelper

Writes the common 'new' icon for the button bar.

ToolbarHelper::archiveList() — Method in class ToolbarHelper

Writes a common 'archive' button for a list of records.

ToolbarHelper::apply() — Method in class ToolbarHelper

Writes a save button for a given option.

NodeInterface::addChild() — Method in class NodeInterface

Add child to this node

NodeTrait::addChild() — Method in class NodeTrait

Add child to this node

$ UCMBase#aliasProperty in class UCMBase

The alias for the content table

$ UCMType#aliasProperty in class UCMType

The alias for the content type

$ UCMType#asset_idProperty in class UCMType
$ UpdateAdapter#appendExtensionProperty in class UpdateAdapter

Should we try appending a .xml extension to the update site's URL?

$ User#activationProperty in class User

Activation hash

$ User#authProviderProperty in class User

The authentication provider

User::authorise() — Method in class User

Method to check User object authorisation against an access control object and optionally an access extension object

UserHelper::addUserToGroup() — Method in class UserHelper

Method to add a user to a group.

UserHelper::activateUser() — Method in class UserHelper

Method to activate a user

$ WebAssetItem#attributesProperty in class WebAssetItem

Attributes for the asset, to be rendered in the asset's HTML tag

$ WebAssetManager#activeAssetsProperty in class WebAssetManager

A list of active assets (including their dependencies).

WebAssetManager::assetExists() — Method in class WebAssetManager

Helper method to check whether the asset exists in the registry.

WebAssetManager::addInline() — Method in class WebAssetManager

Add a new inline content asset.

WebAssetManager::addInlineStyle() — Method in class WebAssetManager
WebAssetManager::addInlineScript() — Method in class WebAssetManager
$ WebAssetRegistry#assetsProperty in class WebAssetRegistry

Registry of available Assets

WebAssetRegistry::add() — Method in class WebAssetRegistry

Add Asset to registry of known assets

WebAssetRegistry::addRegistryFile() — Method in class WebAssetRegistry

Register new file with Asset(s) info

WebAssetRegistry::addTemplateRegistryFile() — Method in class WebAssetRegistry

Helper method to register new file with Template Asset(s) info

WebAssetRegistry::addExtensionRegistryFile() — Method in class WebAssetRegistry

Helper method to register new file with Extension Asset(s) info

WebAssetRegistryInterface::add() — Method in class WebAssetRegistryInterface

Add Asset to registry of known assets

Server::addAlgorithm() — Method in class Server

Add an allowed COSE algorithm

$ Workflow#appProperty in class Workflow

Application Object

B

BaseApplicationClass in namespace Joomla\CMS\Application

Joomla Platform Base Application Class

$ AuthenticationResponse#birthdateProperty in class AuthenticationResponse

The End User's date of birth as YYYY-MM-DD. Any values whose representation uses fewer than the specified number of digits should be zero-padded. The length of this value MUST always be 10. If the End User user does not want to reveal any particular component of this value, it MUST be set to zero.

BCryptHandlerClass in namespace Joomla\CMS\Authentication\Password

Password handler for BCrypt hashed passwords

RouterInterface::build() — Method in class RouterInterface

Build method for URLs This method is meant to transform the query parameters into a more human readable form. It is only executed when SEF mode is switched on.

RouterLegacy::build() — Method in class RouterLegacy

Generic build function for missing or legacy component router

RouterView::build() — Method in class RouterView

Build method for URLs

MenuRules::buildLookup() — Method in class MenuRules

Method to build the lookup array

MenuRules::build() — Method in class MenuRules

Dummy method to fulfil the interface requirements

NomenuRules::build() — Method in class NomenuRules

Build a menu-less URL

PreprocessRules::build() — Method in class PreprocessRules

Dummy method to fulfil the interface requirements

RulesInterface::build() — Method in class RulesInterface

Builds URI segments from a query to encode the necessary information for a route in a human-readable URL.

StandardRules::build() — Method in class StandardRules

Build a standard URL

$ Document#baseProperty in class Document

Document base URL

$ HtmlDocument#baseurlProperty in class HtmlDocument

Base url

ButtonClass in namespace Joomla\CMS\Editor\Button
ButtonInterfaceClass in namespace Joomla\CMS\Editor\Button

Editor button interface

ButtonsRegistryClass in namespace Joomla\CMS\Editor\Button

Buttons Registry class

ButtonsRegistryInterfaceClass in namespace Joomla\CMS\Editor\Button

Buttons Registry class

Base32Class in namespace Joomla\CMS\Encrypt

Base32 encryption class

BrowserClass in namespace Joomla\CMS\Environment

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

$ Browser#browserProperty in class Browser
BeforeApiRouteEventClass in namespace Joomla\CMS\Event\Application

Class for BeforeApiRoute event

BeforeCompileHeadEventClass in namespace Joomla\CMS\Event\Application

Class for BeforeCompileHead event

BeforeExecuteEventClass in namespace Joomla\CMS\Event\Application

Class for BeforeExecute event

BeforeRenderEventClass in namespace Joomla\CMS\Event\Application

Class for BeforeRender event

BeforeRespondEventClass in namespace Joomla\CMS\Event\Application

Class for BeforeRespond event

BeforeSaveConfigurationEventClass in namespace Joomla\CMS\Event\Application

Class for Application Configuration events

BeforeExtensionBootEventClass in namespace Joomla\CMS\Event

Event class for representing the extensions's onBeforeExtensionBoot event

BeforeDisplayEventClass in namespace Joomla\CMS\Event\Content

Class for Content event.

BeforePrepareFieldEventClass in namespace Joomla\CMS\Event\CustomFields

Class for CustomFields events

BeforeInstallEventClass in namespace Joomla\CMS\Event\Extension

Class for Extension events

BeforeJoomlaUpdateEventClass in namespace Joomla\CMS\Event\Extension

Class for Joomla Update events

BeforeUninstallEventClass in namespace Joomla\CMS\Event\Extension

Class for Extension events

BeforeUpdateEventClass in namespace Joomla\CMS\Event\Extension

Class for Extension events

BeforeIndexEventClass in namespace Joomla\CMS\Event\Finder

Class for Finder events.

BeforeSaveEventClass in namespace Joomla\CMS\Event\Finder

Class for Model event.

BuildIndexEventClass in namespace Joomla\CMS\Event\Finder

Class for Finder events.

BeforeInstallationEventClass in namespace Joomla\CMS\Event\Installer

Class for Installer events

BeforeInstallerEventClass in namespace Joomla\CMS\Event\Installer

Class for Installer events

BeforePackageDownloadEventClass in namespace Joomla\CMS\Event\Installer

Class for Installer events

BeforeUpdateSiteDownloadEventClass in namespace Joomla\CMS\Event\Installer

Class for update site events

BeforeRenderingMailTemplateEventClass in namespace Joomla\CMS\Event\Mail

Class for MailTemplate events Example: new BeforeRenderingMailTemplateEvent('onEventName', ['templateId' => 'com_example.template', 'subject' => $mailTemplateInstance]);

BeforeRenderMenuItemsViewEventClass in namespace Joomla\CMS\Event\Menu

Class for menu events

BeforeBatchEventClass in namespace Joomla\CMS\Event\Model

Event class for modifying a table object before a batch event is applied

BeforeChangeStateEventClass in namespace Joomla\CMS\Event\Model

Class for Model event.

BeforeDeleteEventClass in namespace Joomla\CMS\Event\Model

Class for Model event.

BeforeSaveEventClass in namespace Joomla\CMS\Event\Model

Class for Model event.

BeforeValidateDataEventClass in namespace Joomla\CMS\Event\Model

Class for Model Form event.

BeforeRenderModuleEventClass in namespace Joomla\CMS\Event\Module

Class for Module events.

BeforeDisplayMethodsClass in namespace Joomla\CMS\Event\MultiFactor

Concrete Event class for the onUserMultifactorBeforeDisplayMethods event

BeforeCompileHeadEventClass in namespace Joomla\CMS\Event\Plugin\System\Schemaorg

Class for SchemaBeforeCompileHeadEvent event Example: new BeforeCompileHeadEvent('onSchemaBeforeCompileHead', ['subject' => $schema, 'context' => 'com_example.example']);

BeforeBindEventClass in namespace Joomla\CMS\Event\Table

Event class for Table onBeforeBind event

BeforeCheckinEventClass in namespace Joomla\CMS\Event\Table

Event class for \Joomla\CMS\Table\Table onBeforeCheckin event

BeforeCheckoutEventClass in namespace Joomla\CMS\Event\Table

Event class for \Joomla\CMS\Table\Table onBeforeCheckout event

BeforeDeleteEventClass in namespace Joomla\CMS\Event\Table

Event class for \Joomla\CMS\Table\Table onBeforeDelete event

BeforeHitEventClass in namespace Joomla\CMS\Event\Table

Event class for \Joomla\CMS\Table\Table onBeforeHit event

BeforeLoadEventClass in namespace Joomla\CMS\Event\Table

Event class for \Joomla\CMS\Table\Table onBeforeLoad event

BeforeMoveEventClass in namespace Joomla\CMS\Event\Table

Event class for \Joomla\CMS\Table\Table onBeforeMove event

BeforePublishEventClass in namespace Joomla\CMS\Event\Table

Event class for \Joomla\CMS\Table\Table onBeforePublish event

BeforeReorderEventClass in namespace Joomla\CMS\Event\Table

Event class for \Joomla\CMS\Table\Table onBeforeReorder event

BeforeResetEventClass in namespace Joomla\CMS\Event\Table

Event class for \Joomla\CMS\Table\Table onBeforeReset event

BeforeStoreEventClass in namespace Joomla\CMS\Event\Table

Event class for \Joomla\CMS\Table\Table onBeforeStore event

BeforeDeleteEventClass in namespace Joomla\CMS\Event\User

Class for User delete event.

BeforeResetCompleteEventClass in namespace Joomla\CMS\Event\User

Class for User reset event.

BeforeResetRequestEventClass in namespace Joomla\CMS\Event\User

Class for User reset event.

BeforeSaveEventClass in namespace Joomla\CMS\Event\User

Class for User save event.

BootableExtensionInterfaceClass in namespace Joomla\CMS\Extension

Interface which defines that an extension can be booted.

BootableExtensionInterface::boot() — Method in class BootableExtensionInterface

Booting the extension. This is the function to set up the environment of the extension like registering new class loaders, etc.

ExtensionManagerInterface::bootComponent() — Method in class ExtensionManagerInterface

Boots the component with the given name.

ExtensionManagerInterface::bootModule() — Method in class ExtensionManagerInterface

Boots the module with the given name.

ExtensionManagerInterface::bootPlugin() — Method in class ExtensionManagerInterface

Boots the plugin with the given name and type.

ExtensionManagerTrait::bootComponent() — Method in class ExtensionManagerTrait

Boots the component with the given name.

ExtensionManagerTrait::bootModule() — Method in class ExtensionManagerTrait

Boots the module with the given name.

ExtensionManagerTrait::bootPlugin() — Method in class ExtensionManagerTrait

Boots the plugin with the given name and type.

$ EditorField#buttonsProperty in class EditorField

The buttons of the editor.

$ ModalSelectField#buttonIconsProperty in class ModalSelectField

List of icons for each button type: select, edit, new

$ SubformField#buttonsProperty in class SubformField

Which buttons to show in multiple mode

Form::bind() — Method in class Form

Method to bind data to the form.

Form::bindLevel() — Method in class Form

Method to bind data to the form for the group level.

BooleanRuleClass in namespace Joomla\CMS\Form\Rule

Form Rule class for the Joomla Platform.

BehaviorClass in namespace Joomla\CMS\HTML\Helpers

Utility class for JavaScript behaviors

BootstrapClass in namespace Joomla\CMS\HTML\Helpers

Utility class for Bootstrap elements.

Bootstrap::button() — Method in class Bootstrap

Add javascript support for Bootstrap buttons

Icons::buttons() — Method in class Icons

Method to generate html code for a list of buttons

Icons::button() — Method in class Icons

Method to generate html code for a list of buttons

Number::bytes() — Method in class Number

Converts bytes to more distinguishable formats such as: kilobytes, megabytes, etc.

Select::booleanlist() — Method in class Select

Generates a yes/no radio list.

BackgroundfillClass in namespace Joomla\CMS\Image\Filter

Image Filter class fill background with color;

BrightnessClass in namespace Joomla\CMS\Image\Filter

Image Filter class adjust the brightness of an image.

$ PackageManifest#blockChildUninstallProperty in class PackageManifest

Flag if the package blocks individual child extensions from being uninstalled

BaseLayoutClass in namespace Joomla\CMS\Layout

Base class for rendering a display layout

$ FileLayout#basePathProperty in class FileLayout

Base path to use when loading layout files

BaseControllerClass in namespace Joomla\CMS\MVC\Controller

Base class for a Joomla Controller

$ BaseController#basePathProperty in class BaseController

The base path of the controller

FormController::batch() — Method in class FormController

Method to run batch operations.

$ AdminModel#batch_copymoveProperty in class AdminModel

Batch copy/move command. If set to false, the batch copy/move command is not supported

$ AdminModel#batch_commandsProperty in class AdminModel

Allowed batch commands

$ AdminModel#batchSetProperty in class AdminModel

A flag to indicate if member variables for batch actions (and saveorder) have been initialized

AdminModel::batch() — Method in class AdminModel

Method to perform batch operations on an item or a set of items.

AdminModel::batchAccess() — Method in class AdminModel

Batch access level changes for a group of rows.

AdminModel::batchCopy() — Method in class AdminModel

Batch copy items to a new category or current.

AdminModel::batchLanguage() — Method in class AdminModel

Batch language changes for a group of rows.

AdminModel::batchMove() — Method in class AdminModel

Batch move items to a new category

AdminModel::batchTag() — Method in class AdminModel

Batch tag a list of item.

BaseDatabaseModelClass in namespace Joomla\CMS\MVC\Model

Base class for a database aware Joomla Model

BaseDatabaseModel::bootComponent() — Method in class BaseDatabaseModel

Boots the component with the given name.

BaseModelClass in namespace Joomla\CMS\MVC\Model

Base class for a Joomla Model

WorkflowBehaviorTrait::batchWorkflowStage() — Method in class WorkflowBehaviorTrait

Batch change workflow stage or current.

$ MenuItem#browserNavProperty in class MenuItem

The click behaviour of the link

$ PaginationObject#baseProperty in class PaginationObject
$ Profiler#bufferProperty in class Profiler
AdministratorRouter::build() — Method in class AdministratorRouter

Function to convert an internal URI to a route

Router::build() — Method in class Router

Function to convert an internal URI to a route

SiteRouter::buildInit() — Method in class SiteRouter

Do some initial processing for building a URL

SiteRouter::buildComponentPreprocess() — Method in class SiteRouter

Run the component preprocess method

SiteRouter::buildSefRoute() — Method in class SiteRouter

Build the SEF route

SiteRouter::buildPaginationData() — Method in class SiteRouter

Convert limits for pagination

SiteRouter::buildFormat() — Method in class SiteRouter

Build the format of the request

SiteRouter::buildRewrite() — Method in class SiteRouter

Create a uri based on a full or partial URL string

SiteRouter::buildBase() — Method in class SiteRouter

Add the basepath to the URI

ChangeItem::buildCheckQuery() — Method in class ChangeItem

Checks a DDL query to see if it is a known type If yes, build a check query to see if the DDL has been run on the database.

MysqlChangeItem::buildCheckQuery() — Method in class MysqlChangeItem

Checks a DDL query to see if it is a known type If yes, build a check query to see if the DDL has been run on the database.

PostgresqlChangeItem::buildCheckQuery() — Method in class PostgresqlChangeItem

Checks a DDL query to see if it is a known type If yes, build a check query to see if the DDL has been run on the database.

Category::bind() — Method in class Category

Overloaded bind function.

Content::bind() — Method in class Content

Overloaded bind function

Menu::bind() — Method in class Menu

Overloaded bind function

Module::bind() — Method in class Module

Overloaded bind function.

Table::bind() — Method in class Table

Method to bind an associative array or object to the TableInterface instance.

TableInterface::bind() — Method in class TableInterface

Method to bind an associative array or object to the TableInterface instance.

User::bind() — Method in class User

Method to bind the user, user groups, and any other necessary data.

ViewLevel::bind() — Method in class ViewLevel

Method to bind the data.

BasicButtonClass in namespace Joomla\CMS\Toolbar\Button

Renders a basic button.

PopupButton::bodyHeight() — Method in class PopupButton
CoreButtonsTrait::back() — Method in class CoreButtonsTrait

Writes a cancel button that will go back to the previous page without doing any other operation.

Toolbar::basicButton() — Method in class Toolbar
ToolbarButton::buttonClass() — Method in class ToolbarButton
ToolbarHelper::back() — Method in class ToolbarHelper

Writes a cancel button that will go back to the previous page without doing any other operation.

$ CollectionAdapter#baseProperty in class CollectionAdapter

Root of the tree

$ Uri#baseProperty in class Uri
Uri::base() — Method in class Uri

Returns the base URI for the request.

Uri::buildQuery() — Method in class Uri

Build a query from an array (reverse of the PHP parse_str()).

$ User#blockProperty in class User

Block status

User::bind() — Method in class User

Method to bind an associative array of data to a user object

BufferStreamHandlerClass in namespace Joomla\CMS\Utility

Generic Buffer stream handler

$ BufferStreamHandler#buffersProperty in class BufferStreamHandler

Buffer hash

__TwigTemplate_0bf62896b95c7e97cd0f4eae5f5f6195::block_title() — Method in class __TwigTemplate_0bf62896b95c7e97cd0f4eae5f5f6195
__TwigTemplate_0bf62896b95c7e97cd0f4eae5f5f6195::block_body_class() — Method in class __TwigTemplate_0bf62896b95c7e97cd0f4eae5f5f6195
__TwigTemplate_0bf62896b95c7e97cd0f4eae5f5f6195::block_page_content() — Method in class __TwigTemplate_0bf62896b95c7e97cd0f4eae5f5f6195
__TwigTemplate_0bf62896b95c7e97cd0f4eae5f5f6195::block_js_search() — Method in class __TwigTemplate_0bf62896b95c7e97cd0f4eae5f5f6195
__TwigTemplate_3994fb5d5d826575e5e068ab43919da3::block_title() — Method in class __TwigTemplate_3994fb5d5d826575e5e068ab43919da3
__TwigTemplate_3994fb5d5d826575e5e068ab43919da3::block_body_class() — Method in class __TwigTemplate_3994fb5d5d826575e5e068ab43919da3
__TwigTemplate_3994fb5d5d826575e5e068ab43919da3::block_page_content() — Method in class __TwigTemplate_3994fb5d5d826575e5e068ab43919da3
__TwigTemplate_85e091843a2d5eb6b1597c2f89e0752c::block_content() — Method in class __TwigTemplate_85e091843a2d5eb6b1597c2f89e0752c
__TwigTemplate_85e091843a2d5eb6b1597c2f89e0752c::block_below_menu() — Method in class __TwigTemplate_85e091843a2d5eb6b1597c2f89e0752c
__TwigTemplate_85e091843a2d5eb6b1597c2f89e0752c::block_page_content() — Method in class __TwigTemplate_85e091843a2d5eb6b1597c2f89e0752c
__TwigTemplate_85e091843a2d5eb6b1597c2f89e0752c::block_menu() — Method in class __TwigTemplate_85e091843a2d5eb6b1597c2f89e0752c
__TwigTemplate_85e091843a2d5eb6b1597c2f89e0752c::block_leftnav() — Method in class __TwigTemplate_85e091843a2d5eb6b1597c2f89e0752c
__TwigTemplate_85e091843a2d5eb6b1597c2f89e0752c::block_control_panel() — Method in class __TwigTemplate_85e091843a2d5eb6b1597c2f89e0752c
__TwigTemplate_85e091843a2d5eb6b1597c2f89e0752c::block_footer() — Method in class __TwigTemplate_85e091843a2d5eb6b1597c2f89e0752c
__TwigTemplate_896e1a17f0353adb41deb8b45210ae94::block_title() — Method in class __TwigTemplate_896e1a17f0353adb41deb8b45210ae94
__TwigTemplate_896e1a17f0353adb41deb8b45210ae94::block_head() — Method in class __TwigTemplate_896e1a17f0353adb41deb8b45210ae94
__TwigTemplate_896e1a17f0353adb41deb8b45210ae94::block_html() — Method in class __TwigTemplate_896e1a17f0353adb41deb8b45210ae94
__TwigTemplate_896e1a17f0353adb41deb8b45210ae94::block_body_class() — Method in class __TwigTemplate_896e1a17f0353adb41deb8b45210ae94
__TwigTemplate_896e1a17f0353adb41deb8b45210ae94::block_page_id() — Method in class __TwigTemplate_896e1a17f0353adb41deb8b45210ae94
__TwigTemplate_896e1a17f0353adb41deb8b45210ae94::block_content() — Method in class __TwigTemplate_896e1a17f0353adb41deb8b45210ae94
__TwigTemplate_959903b26cb0d471d240abcbd9524242::block_title() — Method in class __TwigTemplate_959903b26cb0d471d240abcbd9524242
__TwigTemplate_959903b26cb0d471d240abcbd9524242::block_body_class() — Method in class __TwigTemplate_959903b26cb0d471d240abcbd9524242
__TwigTemplate_959903b26cb0d471d240abcbd9524242::block_page_content() — Method in class __TwigTemplate_959903b26cb0d471d240abcbd9524242
__TwigTemplate_a53d5b9a592c30f5292fdf2cf5daaf44::block_title() — Method in class __TwigTemplate_a53d5b9a592c30f5292fdf2cf5daaf44
__TwigTemplate_a53d5b9a592c30f5292fdf2cf5daaf44::block_body_class() — Method in class __TwigTemplate_a53d5b9a592c30f5292fdf2cf5daaf44
__TwigTemplate_a53d5b9a592c30f5292fdf2cf5daaf44::block_page_id() — Method in class __TwigTemplate_a53d5b9a592c30f5292fdf2cf5daaf44
__TwigTemplate_a53d5b9a592c30f5292fdf2cf5daaf44::block_below_menu() — Method in class __TwigTemplate_a53d5b9a592c30f5292fdf2cf5daaf44
__TwigTemplate_a53d5b9a592c30f5292fdf2cf5daaf44::block_page_content() — Method in class __TwigTemplate_a53d5b9a592c30f5292fdf2cf5daaf44
__TwigTemplate_acdad90fc61f5e474deb98262a7dc3eb::block_title() — Method in class __TwigTemplate_acdad90fc61f5e474deb98262a7dc3eb
__TwigTemplate_acdad90fc61f5e474deb98262a7dc3eb::block_body_class() — Method in class __TwigTemplate_acdad90fc61f5e474deb98262a7dc3eb
__TwigTemplate_acdad90fc61f5e474deb98262a7dc3eb::block_page_content() — Method in class __TwigTemplate_acdad90fc61f5e474deb98262a7dc3eb
__TwigTemplate_adbbf7f4f8572fd945270d87a68752a6::block_title() — Method in class __TwigTemplate_adbbf7f4f8572fd945270d87a68752a6
__TwigTemplate_adbbf7f4f8572fd945270d87a68752a6::block_body_class() — Method in class __TwigTemplate_adbbf7f4f8572fd945270d87a68752a6
__TwigTemplate_adbbf7f4f8572fd945270d87a68752a6::block_page_content() — Method in class __TwigTemplate_adbbf7f4f8572fd945270d87a68752a6
__TwigTemplate_bc6db32d62004a1677f9a4af03635305::block_title() — Method in class __TwigTemplate_bc6db32d62004a1677f9a4af03635305
__TwigTemplate_bc6db32d62004a1677f9a4af03635305::block_body_class() — Method in class __TwigTemplate_bc6db32d62004a1677f9a4af03635305
__TwigTemplate_bc6db32d62004a1677f9a4af03635305::block_page_id() — Method in class __TwigTemplate_bc6db32d62004a1677f9a4af03635305
__TwigTemplate_bc6db32d62004a1677f9a4af03635305::block_below_menu() — Method in class __TwigTemplate_bc6db32d62004a1677f9a4af03635305
__TwigTemplate_bc6db32d62004a1677f9a4af03635305::block_page_content() — Method in class __TwigTemplate_bc6db32d62004a1677f9a4af03635305
__TwigTemplate_bc6db32d62004a1677f9a4af03635305::block_class_signature() — Method in class __TwigTemplate_bc6db32d62004a1677f9a4af03635305
__TwigTemplate_bc6db32d62004a1677f9a4af03635305::block_method_signature() — Method in class __TwigTemplate_bc6db32d62004a1677f9a4af03635305
__TwigTemplate_bc6db32d62004a1677f9a4af03635305::block_method_parameters_signature() — Method in class __TwigTemplate_bc6db32d62004a1677f9a4af03635305
__TwigTemplate_bc6db32d62004a1677f9a4af03635305::block_parameters() — Method in class __TwigTemplate_bc6db32d62004a1677f9a4af03635305
__TwigTemplate_bc6db32d62004a1677f9a4af03635305::block_return() — Method in class __TwigTemplate_bc6db32d62004a1677f9a4af03635305
__TwigTemplate_bc6db32d62004a1677f9a4af03635305::block_exceptions() — Method in class __TwigTemplate_bc6db32d62004a1677f9a4af03635305
__TwigTemplate_bc6db32d62004a1677f9a4af03635305::block_examples() — Method in class __TwigTemplate_bc6db32d62004a1677f9a4af03635305
__TwigTemplate_bc6db32d62004a1677f9a4af03635305::block_see() — Method in class __TwigTemplate_bc6db32d62004a1677f9a4af03635305
__TwigTemplate_bc6db32d62004a1677f9a4af03635305::block_constants() — Method in class __TwigTemplate_bc6db32d62004a1677f9a4af03635305
__TwigTemplate_bc6db32d62004a1677f9a4af03635305::block_properties() — Method in class __TwigTemplate_bc6db32d62004a1677f9a4af03635305
__TwigTemplate_bc6db32d62004a1677f9a4af03635305::block_methods() — Method in class __TwigTemplate_bc6db32d62004a1677f9a4af03635305
__TwigTemplate_bc6db32d62004a1677f9a4af03635305::block_methods_details() — Method in class __TwigTemplate_bc6db32d62004a1677f9a4af03635305
__TwigTemplate_bc6db32d62004a1677f9a4af03635305::block_method() — Method in class __TwigTemplate_bc6db32d62004a1677f9a4af03635305
__TwigTemplate_ebd3ded38a1374cfcb2671eaa14a1d29::block_title() — Method in class __TwigTemplate_ebd3ded38a1374cfcb2671eaa14a1d29
__TwigTemplate_ebd3ded38a1374cfcb2671eaa14a1d29::block_body_class() — Method in class __TwigTemplate_ebd3ded38a1374cfcb2671eaa14a1d29
__TwigTemplate_ebd3ded38a1374cfcb2671eaa14a1d29::block_page_content() — Method in class __TwigTemplate_ebd3ded38a1374cfcb2671eaa14a1d29
__TwigTemplate_f39bca71236ed63ca7b7b0f776c66525::block_body_class() — Method in class __TwigTemplate_f39bca71236ed63ca7b7b0f776c66525

C

CannotPerformOperationExceptionClass in namespace [Global Namespace]
CryptoClass in namespace [Global Namespace]
Crypto::CreateNewRandomKey() — Method in class Crypto
CryptoExceptionHandlerClass in namespace [Global Namespace]
CryptoTestFailedExceptionClass in namespace [Global Namespace]
$ JLoader#classesProperty in class JLoader

Container for already imported library paths.

$ JLoader#classAliasesProperty in class JLoader

Holds proxy classes and the class names the proxy.

$ JLoader#classAliasesInverseProperty in class JLoader

Holds the inverse lookup for proxy classes and the class names the proxy.

JNamespacePsr4Map::create() — Method in class JNamespacePsr4Map

Create the namespace file

Access::clearStatics() — Method in class Access

Method for clearing static caches.

Access::check() — Method in class Access

Method to check if a user is authorised to perform an action, optionally on an asset.

Access::checkGroup() — Method in class Access

Method to check if a group is authorised to perform an action, optionally on an asset.

Access::cleanAssetKey() — Method in class Access

Method to clean the asset key to make sure we always have something.

CliInputClass in namespace Joomla\CMS\Application\CLI

Class CliInput

CliOutputClass in namespace Joomla\CMS\Application\CLI

Base class defining a command line output handler

ColorStyleClass in namespace Joomla\CMS\Application\CLI

Class defining ANSI-color styles for command line output

ColorProcessorClass in namespace Joomla\CMS\Application\CLI\Output\Processor

Command line output processor supporting ANSI-colored output

CMSApplicationClass in namespace Joomla\CMS\Application

Joomla! CMS Application class

$ CMSApplication#clientIdProperty in class CMSApplication

The client identifier.

CMSApplication::checkSession() — Method in class CMSApplication

Checks the user session.

CMSApplication::checkUserRequireReset() — Method in class CMSApplication

Check if the user is required to reset their password.

CMSApplication::checkUserRequiresReset() — Method in class CMSApplication

Check if the user is required to reset their password.

CMSApplication::checkToken() — Method in class CMSApplication

Checks for a form token in the request.

CMSApplicationInterfaceClass in namespace Joomla\CMS\Application

Interface defining a Joomla! CMS Application class

CMSWebApplicationInterfaceClass in namespace Joomla\CMS\Application

Interface defining a Joomla! CMS Application class for web applications.

CliApplicationClass in namespace Joomla\CMS\Application

Base class for a Joomla! command line application.

$ CliApplication#cliInputProperty in class CliApplication

CLI Input object

ConsoleApplicationClass in namespace Joomla\CMS\Application

The Joomla! CMS Console Application

DaemonApplication::changeIdentity() — Method in class DaemonApplication

Method to change the identity of the daemon process and resources.

ExtensionNamespaceMapper::createExtensionNamespaceMap() — Method in class ExtensionNamespaceMapper

Allows the application to load a custom or default identity.

$ AuthenticationResponse#countryProperty in class AuthenticationResponse

The End User's country of residence as specified by ISO3166.

Argon2iHandler::checkIfRehashNeeded() — Method in class Argon2iHandler

Check if the password requires rehashing

Argon2idHandler::checkIfRehashNeeded() — Method in class Argon2idHandler

Check if the password requires rehashing

BCryptHandler::checkIfRehashNeeded() — Method in class BCryptHandler

Check if the password requires rehashing

ChainedHandlerClass in namespace Joomla\CMS\Authentication\Password

Password handler supporting testing against a chain of handlers

ChainedHandler::checkIfRehashNeeded() — Method in class ChainedHandler

Check if the password requires rehashing

CheckIfRehashNeededHandlerInterfaceClass in namespace Joomla\CMS\Authentication\Password

Interface for a password handler which supports checking if the password requires rehashing

CheckIfRehashNeededHandlerInterface::checkIfRehashNeeded() — Method in class CheckIfRehashNeededHandlerInterface

Check if the password requires rehashing

MD5Handler::checkIfRehashNeeded() — Method in class MD5Handler

Check if the password requires rehashing

PHPassHandler::checkIfRehashNeeded() — Method in class PHPassHandler

Check if the password requires rehashing

ClassLoaderClass in namespace Joomla\CMS\Autoload

Decorate Composer ClassLoader for Joomla!

CacheClass in namespace Joomla\CMS\Cache

Joomla! Cache base object

Cache::contains() — Method in class Cache

Check if the cache contains data stored by ID and group

Cache::clean() — Method in class Cache

Clean cache for a group given a mode.

CacheControllerClass in namespace Joomla\CMS\Cache

Public cache handler

$ CacheController#cacheProperty in class CacheController

Cache object

CacheControllerFactoryClass in namespace Joomla\CMS\Cache

Default factory for creating CacheController objects

CacheControllerFactory::createCacheController() — Method in class CacheControllerFactory

Method to get an instance of a cache controller.

CacheControllerFactoryAwareInterfaceClass in namespace Joomla\CMS\Cache

Interface to be implemented by classes depending on a cache controller factory.

CacheControllerFactoryAwareTraitClass in namespace Joomla\CMS\Cache

Defines the trait for a CacheControllerFactoryInterface Aware Class.

CacheControllerFactoryInterfaceClass in namespace Joomla\CMS\Cache

Interface defining a factory which can create CacheController objects

CacheControllerFactoryInterface::createCacheController() — Method in class CacheControllerFactoryInterface

Method to get an instance of a cache controller.

CacheStorageClass in namespace Joomla\CMS\Cache

Abstract cache storage handler

CacheStorage::contains() — Method in class CacheStorage

Check if the cache contains data stored by ID and group

CacheStorage::clean() — Method in class CacheStorage

Clean cache for a group given a mode.

CallbackControllerClass in namespace Joomla\CMS\Cache\Controller

Joomla! Cache callback type object

CacheConnectingExceptionClass in namespace Joomla\CMS\Cache\Exception

Exception class defining an error connecting to the cache storage engine

CacheExceptionInterfaceClass in namespace Joomla\CMS\Cache\Exception

Exception interface defining a cache storage error

ApcuStorage::contains() — Method in class ApcuStorage

Check if the cache contains data stored by ID and group

ApcuStorage::clean() — Method in class ApcuStorage

Clean cache for a group given a mode.

CacheStorageHelperClass in namespace Joomla\CMS\Cache\Storage

Cache storage helper functions.

$ CacheStorageHelper#countProperty in class CacheStorageHelper
Counter
FileStorage::contains() — Method in class FileStorage

Check if the cache contains data stored by ID and group

FileStorage::clean() — Method in class FileStorage

Clean cache for a group given a mode.

MemcachedStorage::contains() — Method in class MemcachedStorage

Check if the cache contains data stored by ID and group

MemcachedStorage::clean() — Method in class MemcachedStorage

Clean cache for a group given a mode.

RedisStorage::contains() — Method in class RedisStorage

Check if the cache contains data stored by ID and group

RedisStorage::clean() — Method in class RedisStorage

Clean cache for a group given a mode.

CaptchaClass in namespace Joomla\CMS\Captcha

Joomla! Captcha base object

Captcha::checkAnswer() — Method in class Captcha

Checks if the answer is correct.

CaptchaProviderInterfaceClass in namespace Joomla\CMS\Captcha

Captcha Provider Interface

CaptchaProviderInterface::checkAnswer() — Method in class CaptchaProviderInterface

Calls an HTTP POST function to verify if the user's guess was correct.

CaptchaRegistryClass in namespace Joomla\CMS\Captcha

Captcha Registry class

CaptchaNotFoundExceptionClass in namespace Joomla\CMS\Captcha\Exception

Exception class defining a missing element

CategoriesClass in namespace Joomla\CMS\Categories

Categories Class.

CategoryFactoryClass in namespace Joomla\CMS\Categories

Option based categories factory.

CategoryFactory::createCategory() — Method in class CategoryFactory

Creates a category.

CategoryFactoryInterfaceClass in namespace Joomla\CMS\Categories

Category factory interface

CategoryFactoryInterface::createCategory() — Method in class CategoryFactoryInterface

Creates a category.

CategoryInterfaceClass in namespace Joomla\CMS\Categories

The category interface.

CategoryNodeClass in namespace Joomla\CMS\Categories

Helper class to load Categorytree

$ CategoryNode#checked_outProperty in class CategoryNode

Whether the category is or is not checked out

$ CategoryNode#checked_out_timeProperty in class CategoryNode

The time at which the category was checked out

$ CategoryNode#created_user_idProperty in class CategoryNode

The ID of the user who created the category

$ CategoryNode#created_timeProperty in class CategoryNode

The time at which the category was created

CategoryServiceInterfaceClass in namespace Joomla\CMS\Categories

Access to component specific categories.

CategoryServiceInterface::countItems() — Method in class CategoryServiceInterface

Adds Count Items for Category Manager.

CategoryServiceTraitClass in namespace Joomla\CMS\Categories

Trait for component categories service.

CategoryServiceTrait::countItems() — Method in class CategoryServiceTrait

Adds Count Items for Category Manager.

ChangelogClass in namespace Joomla\CMS\Changelog

Changelog class.

$ Changelog#changeProperty in class Changelog

Update manifest <change> elements

$ Changelog#currentChangelogProperty in class Changelog

Object containing the current update data

Changelog::characterData() — Method in class Changelog

Character Parser Function

ClientHelperClass in namespace Joomla\CMS\Client

Client helper class

FtpClient::connect() — Method in class FtpClient

Method to connect to a FTP server

FtpClient::chdir() — Method in class FtpClient

Method to change the current working directory on the FTP server

FtpClient::chmod() — Method in class FtpClient

Method to change mode for a path on the FTP server

FtpClient::create() — Method in class FtpClient

Method to create an empty file on the FTP server

ComponentHelperClass in namespace Joomla\CMS\Component

Component helper class

$ ComponentHelper#componentsProperty in class ComponentHelper

The component list cache

ComponentRecordClass in namespace Joomla\CMS\Component

Object representing a component extension record

RouterFactory::createRouter() — Method in class RouterFactory

Creates a router.

RouterFactoryInterface::createRouter() — Method in class RouterFactoryInterface

Creates a router.

$ RouterLegacy#componentProperty in class RouterLegacy

Name of the component

RouterServiceInterface::createRouter() — Method in class RouterServiceInterface

Returns the router.

RouterServiceTrait::createRouter() — Method in class RouterServiceTrait

Returns the router.

$ RouterViewConfiguration#childrenProperty in class RouterViewConfiguration

Child-views of this view

$ RouterViewConfiguration#child_keysProperty in class RouterViewConfiguration

Keys used for this parent view by the child views

AddUserCommand::configure() — Method in class AddUserCommand

Configure the command.

AddUserToGroupCommand::configure() — Method in class AddUserToGroupCommand

Configure the command.

ChangeUserPasswordCommandClass in namespace Joomla\CMS\Console

Console command to change a user's password

ChangeUserPasswordCommand::configure() — Method in class ChangeUserPasswordCommand

Configure the command.

CheckJoomlaUpdatesCommandClass in namespace Joomla\CMS\Console

Console command for checking if there are pending extension updates

CheckJoomlaUpdatesCommand::configure() — Method in class CheckJoomlaUpdatesCommand

Initialise the command.

CheckUpdatesCommandClass in namespace Joomla\CMS\Console

Console command for checking if there are pending extension updates

CheckUpdatesCommand::configure() — Method in class CheckUpdatesCommand

Configure the command.

CleanCacheCommandClass in namespace Joomla\CMS\Console

Console command for cleaning the system cache

CleanCacheCommand::configure() — Method in class CleanCacheCommand

Configure the command.

CoreUpdateChannelCommandClass in namespace Joomla\CMS\Console

Console command for managing the update channel for Joomla

CoreUpdateChannelCommand::configure() — Method in class CoreUpdateChannelCommand

Initialise the command.

DeleteUserCommand::configure() — Method in class DeleteUserCommand

Configure the command.

ExtensionDiscoverCommand::configure() — Method in class ExtensionDiscoverCommand

Initialise the command.

ExtensionDiscoverInstallCommand::configure() — Method in class ExtensionDiscoverInstallCommand

Initialise the command.

ExtensionDiscoverListCommand::configure() — Method in class ExtensionDiscoverListCommand

Initialise the command.

ExtensionInstallCommand::configure() — Method in class ExtensionInstallCommand

Initialise the command.

ExtensionRemoveCommand::configure() — Method in class ExtensionRemoveCommand

Initialise the command.

$ ExtensionsListCommand#cliInputProperty in class ExtensionsListCommand

Stores the Input Object

ExtensionsListCommand::configureIO() — Method in class ExtensionsListCommand

Configures the IO

ExtensionsListCommand::configure() — Method in class ExtensionsListCommand

Initialise the command.

FinderIndexCommand::configure() — Method in class FinderIndexCommand

Initialise the command.

GetConfigurationCommand::configure() — Method in class GetConfigurationCommand

Initialise the command.

ListUserCommand::configure() — Method in class ListUserCommand

Configure the command.

MaintenanceDatabaseCommand::configure() — Method in class MaintenanceDatabaseCommand

Initialise the command.

RemoveOldFilesCommand::configure() — Method in class RemoveOldFilesCommand

Configure the command.

RemoveUserFromGroupCommand::configure() — Method in class RemoveUserFromGroupCommand

Configure the command.

SessionGcCommand::configure() — Method in class SessionGcCommand

Configure the command.

SessionMetadataGcCommand::configure() — Method in class SessionMetadataGcCommand

Configure the command.

SetConfigurationCommand::configure() — Method in class SetConfigurationCommand

Initialise the command.

SetConfigurationCommand::checkDb() — Method in class SetConfigurationCommand

Verifies database connection

SiteCreatePublicFolderCommand::configure() — Method in class SiteCreatePublicFolderCommand

Configure the command.

SiteDownCommand::configure() — Method in class SiteDownCommand

Initialise the command.

SiteUpCommand::configure() — Method in class SiteUpCommand

Initialise the command.

TasksListCommand::configure() — Method in class TasksListCommand

Configure the command.

TasksRunCommand::configure() — Method in class TasksRunCommand

Configure the command.

TasksStateCommand::configure() — Method in class TasksStateCommand

Configure the command.

UpdateCoreCommand::configure() — Method in class UpdateCoreCommand

Initialise the command.

UpdateCoreCommand::copyFileTo() — Method in class UpdateCoreCommand

Copy a file to a destination directory

UpdateCoreCommand::checkSchema() — Method in class UpdateCoreCommand

Check Database Table Structure

CryptoCipherClass in namespace Joomla\CMS\Crypt\Cipher

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

CryptClass in namespace Joomla\CMS\Crypt

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

Date::calendar() — Method in class Date

Gets the date as a formatted string in a local calendar.

ComponentDispatcherClass in namespace Joomla\CMS\Dispatcher

Base class for a Joomla Component Dispatcher

ComponentDispatcher::checkAccess() — Method in class ComponentDispatcher

Method to check component access permission

ComponentDispatcherFactoryClass in namespace Joomla\CMS\Dispatcher

Namespace based implementation of the ComponentDispatcherFactoryInterface

ComponentDispatcherFactory::createDispatcher() — Method in class ComponentDispatcherFactory

Creates a dispatcher.

ComponentDispatcherFactoryInterfaceClass in namespace Joomla\CMS\Dispatcher

Component dispatcher factory interface

ComponentDispatcherFactoryInterface::createDispatcher() — Method in class ComponentDispatcherFactoryInterface

Creates a dispatcher.

ModuleDispatcherFactory::createDispatcher() — Method in class ModuleDispatcherFactory

Creates a dispatcher.

ModuleDispatcherFactoryInterface::createDispatcher() — Method in class ModuleDispatcherFactoryInterface

Creates a dispatcher.

Factory::createDocument() — Method in class Factory

Creates a new Document object for the requested format.

Factory::createRenderer() — Method in class Factory

Creates a new renderer object.

FactoryInterface::createDocument() — Method in class FactoryInterface

Creates a new Document object for the requested format.

FactoryInterface::createRenderer() — Method in class FactoryInterface

Creates a new renderer object.

$ FeedDocument#copyrightProperty in class FeedDocument

Copyright feed element

$ FeedDocument#categoryProperty in class FeedDocument

Category feed element

$ FeedItem#categoryProperty in class FeedItem

Category element

$ FeedItem#commentsProperty in class FeedItem

Comments element

$ HtmlDocument#cspNonceProperty in class HtmlDocument

Script nonce (string if set, null otherwise)

HtmlDocument::countModules() — Method in class HtmlDocument

Count the modules in the given position

HtmlDocument::countMenuChildren() — Method in class HtmlDocument

Count the number of child menu items of the current active menu item

ComponentRendererClass in namespace Joomla\CMS\Document\Renderer\Html

HTML document renderer for the component output

$ Mcrypt#cipherTypeProperty in class Mcrypt

Cypher Type

$ Mcrypt#cipherModeProperty in class Mcrypt

Cypher Mode

Totp::checkCode() — Method in class Totp

Check is the given passcode $code is a valid TOTP generated using secret key $secret

CheckinCheckoutExceptionHandlerClass in namespace Joomla\CMS\Error\JsonApi

Handler for invalid checkin/checkout exceptions

CliRendererClass in namespace Joomla\CMS\Error\Renderer

Cli error renderer

AbstractEvent::create() — Method in class AbstractEvent

Creates a new CMS event object for a given event name and subject. The following arguments must be given: subject object The subject of the event. This is the core object you are going to manipulate.

CaptchaSetupEventClass in namespace Joomla\CMS\Event\Captcha

Captcha setup event

ContentEventClass in namespace Joomla\CMS\Event\Content

Base class for Content events

ContentPrepareEventClass in namespace Joomla\CMS\Event\Content

Class for Content event.

CoreEventAwareClass in namespace Joomla\CMS\Event

Returns the most suitable event class for a Joomla core event name

CustomFieldsEventClass in namespace Joomla\CMS\Event\CustomFields

Class for CustomFields events

ChangeStateEventClass in namespace Joomla\CMS\Event\Model

Class for Model event

CallbackClass in namespace Joomla\CMS\Event\MultiFactor

Concrete Event class for the onUserMultifactorCallback event

CaptiveClass in namespace Joomla\CMS\Event\MultiFactor

Concrete Event class for the onUserMultifactorCaptive event

CanRemoveDataEventClass in namespace Joomla\CMS\Event\Privacy

Class for Privacy events.

CheckPrivacyPolicyPublishedEventClass in namespace Joomla\CMS\Event\Privacy

Class for Privacy events.

CollectCapabilitiesEventClass in namespace Joomla\CMS\Event\Privacy

Class for Privacy events.

CheckEventClass in namespace Joomla\CMS\Event\Table

Event class for \Joomla\CMS\Table\Table onCheck event

ComponentClass in namespace Joomla\CMS\Extension

Access to component specific services.

ComponentInterfaceClass in namespace Joomla\CMS\Extension

Access to component specific services.

$ ExtensionHelper#coreExtensionsProperty in class ExtensionHelper

Array of core extensions Each element is an array with elements "type", "element", "folder" and "client_id".

$ ExtensionHelper#coreExtensionIdsProperty in class ExtensionHelper

Array of core extension IDs.

ExtensionHelper::checkIfCoreExtension() — Method in class ExtensionHelper

Check if an extension is core or not

LegacyComponent::countItems() — Method in class LegacyComponent

Adds Count Items for Category Manager.

LegacyComponent::countTagItems() — Method in class LegacyComponent

Adds Count Items for Tag Manager.

LegacyComponent::createRouter() — Method in class LegacyComponent

Returns the router.

CategoryFactoryClass in namespace Joomla\CMS\Extension\Service\Provider

Service provider for the service categories.

ComponentDispatcherFactoryClass in namespace Joomla\CMS\Extension\Service\Provider

Service provider for the service dispatcher factory.

$ Factory#cacheProperty in class Factory

Global cache object

$ Factory#configProperty in class Factory

Global configuration object

$ Factory#containerProperty in class Factory

Global container object

Factory::createConfig() — Method in class Factory

Create a configuration object

Factory::createContainer() — Method in class Factory

Create a container object

Factory::createDbo() — Method in class Factory

Create a database object

Factory::createMailer() — Method in class Factory

Create a mailer object

Factory::createLanguage() — Method in class Factory

Create a language object

Factory::createDocument() — Method in class Factory

Create a document object

$ Feed#categoriesProperty in class Feed

Categories to which the feed belongs.

$ Feed#contributorsProperty in class Feed

People who contributed to the feed content.

$ Feed#copyrightProperty in class Feed

Information about rights, e.g. copyrights, held in and over the feed.

Feed::count() — Method in class Feed

Returns a count of the number of entries in the feed.

$ FeedEntry#categoriesProperty in class FeedEntry

Categories to which the feed entry belongs.

$ FeedEntry#contentProperty in class FeedEntry

The content of the feed entry.

$ FeedEntry#contributorsProperty in class FeedEntry

People who contributed to the feed entry content.

$ FeedEntry#copyrightProperty in class FeedEntry

Information about rights, e.g. copyrights, held in and over the feed entry.

$ File#canFlushFileCacheProperty in class File
File::copy() — Method in class File

Copies a file

File::canFlushFileCache() — Method in class File

First we check if opcache is enabled Then we check if the opcache_invalidate function is available Lastly we check if the host has restricted which scripts can use opcache_invalidate using opcache.restrict_api.

Folder::copy() — Method in class Folder

Copy a folder.

Folder::create() — Method in class Folder

Create a folder -- and all necessary parent folders.

Path::check() — Method in class Path

Checks for snooping outside of the file system root.

$ Stream#chunksizeProperty in class Stream

Default Chunk Size

$ Stream#contextProperty in class Stream

Context to use when opening the connection

$ Stream#contextOptionsProperty in class Stream

Context options; used to rebuild the context

Stream::close() — Method in class Stream

Attempt to close a file handle

Stream::chmod() — Method in class Stream

Chmod wrapper

Stream::copy() — Method in class Stream

Copy a file from src to dest

$ StreamString#currentStringProperty in class StreamString

The current string

StringController::createRef() — Method in class StringController

Create a reference

InputFilter::clean() — Method in class InputFilter

Method to be called by another php script. Processes for XSS and specified bad code.

CachehandlerFieldClass in namespace Joomla\CMS\Form\Field

Form Field class for the Joomla Platform.

CalendarFieldClass in namespace Joomla\CMS\Form\Field

Form Field class for the Joomla Platform.

CaptchaFieldClass in namespace Joomla\CMS\Form\Field

Captcha field.

CategoryFieldClass in namespace Joomla\CMS\Form\Field

Form Field class for the Joomla Platform.

CheckboxFieldClass in namespace Joomla\CMS\Form\Field

Form Field class for the Joomla Platform.

$ CheckboxField#checkedProperty in class CheckboxField

The checked state of checkbox field.

CheckboxesFieldClass in namespace Joomla\CMS\Form\Field

Form Field class for the Joomla Platform.

$ CheckboxesField#checkedOptionsProperty in class CheckboxesField

The comma separated list of checked checkboxes value.

ChromestyleFieldClass in namespace Joomla\CMS\Form\Field

Chrome Styles field.

$ ChromestyleField#clientIdProperty in class ChromestyleField

The client ID.

ColorFieldClass in namespace Joomla\CMS\Form\Field

Color Form Field class for the Joomla Platform.

$ ColorField#controlProperty in class ColorField

The control.

$ ColorField#colorsProperty in class ColorField

The colors.

ComboFieldClass in namespace Joomla\CMS\Form\Field

Form Field class for the Joomla Platform.

ComponentlayoutFieldClass in namespace Joomla\CMS\Form\Field

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

ComponentsFieldClass in namespace Joomla\CMS\Form\Field

Form Field class for the Joomla Framework.

ContenthistoryFieldClass in namespace Joomla\CMS\Form\Field

Field to select Content History from a modal list.

ContentlanguageFieldClass in namespace Joomla\CMS\Form\Field

Provides a list of content languages

ContenttypeFieldClass in namespace Joomla\CMS\Form\Field

Content Type field.

$ MenuitemField#clientIdProperty in class MenuitemField

The client id.

$ MeterField#colorProperty in class MeterField

The color of the progress bar

$ ModalSelectField#canDoProperty in class ModalSelectField

Enabled actions: select, clear, edit, new

$ ModulepositionField#clientIdProperty in class ModulepositionField

The client ID.

$ OrderingField#contentTypeProperty in class OrderingField

The form field content type.

$ RulesField#componentProperty in class RulesField

The component.

$ TagField#comParamsProperty in class TagField

com_tags parameters

$ TemplatestyleField#clientNameProperty in class TemplatestyleField

The client name.

$ TextField#charcounterProperty in class TextField

Does this field support a character counter?

$ TextareaField#columnsProperty in class TextareaField

The number of columns in textarea.

$ TextareaField#charcounterProperty in class TextareaField

Does this field support a character counter?

$ Form#controlFieldsProperty in class Form

List of control fields.

FormFactory::createForm() — Method in class FormFactory

Method to get an instance of a form.

FormFactoryInterface::createForm() — Method in class FormFactoryInterface

Method to get an instance of a form.

$ FormField#classProperty in class FormField

The class of the form field

$ FormField#countProperty in class FormField

The count value for generated name field

FormField::collectLayoutData() — Method in class FormField

Method to get the data to be passed to the layout for rendering.

CalendarRuleClass in namespace Joomla\CMS\Form\Rule

Form Rule class for the Joomla Platform

CaptchaRuleClass in namespace Joomla\CMS\Form\Rule

Form Rule class for the Joomla Framework.

ColorRuleClass in namespace Joomla\CMS\Form\Rule

Form Rule class for the Joomla Platform.

CssIdentifierRuleClass in namespace Joomla\CMS\Form\Rule

Form Rule class for the Joomla Platform.

CssIdentifierSubstringRuleClass in namespace Joomla\CMS\Form\Rule

Form Rule class for the Joomla Platform.

HTMLHelper::call() — Method in class HTMLHelper

Function caller method

HTMLHelper::cleanImageURL() — Method in class HTMLHelper

Gets a URL, cleans the Joomla specific params and returns an object

HTMLHelper::calendar() — Method in class HTMLHelper

Displays a calendar control field

HTMLHelper::convertToRelativePath() — Method in class HTMLHelper

Method that takes a file path and converts it to a relative path

Behavior::core() — Method in class Behavior

Method to load core.js into the document head.

Behavior::combobox() — Method in class Behavior

Add unobtrusive JavaScript support for a combobox effect.

Behavior::calendartranslation() — Method in class Behavior

Internal method to translate the JavaScript Calendar

Bootstrap::carousel() — Method in class Bootstrap

Add javascript support for Bootstrap carousels

Bootstrap::collapse() — Method in class Bootstrap

Add javascript support for Bootstrap collapse

CategoryClass in namespace Joomla\CMS\HTML\Helpers

Utility class for categories

Category::categories() — Method in class Category

Returns an array of categories for the given extension.

ContentClass in namespace Joomla\CMS\HTML\Helpers

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

ContentLanguageClass in namespace Joomla\CMS\HTML\Helpers

Utility class working with content language select lists

Dropdown::checkin() — Method in class Dropdown

Append a checkin item to the current dropdown menu

Email::cloak() — Method in class Email

Simple JavaScript email cloaker

Form::csrf() — Method in class Form

Add CSRF form token to Joomla script options that developers can get it by Javascript.

FormBehavior::chosen() — Method in class FormBehavior

Method to load the Chosen JavaScript framework and supporting CSS into the document head

Grid::checkall() — Method in class Grid

Method to check all checkboxes in a grid

Grid::checkedOut() — Method in class Grid

Displays a checked out icon.

JGrid::checkedout() — Method in class JGrid

Returns a checked-out icon

Help::createUrl() — Method in class Help

Create a URL for a given help key reference

Help::createSiteList() — Method in class Help

Builds a list of the help sites which can be used in a select option.

CMSHelperClass in namespace Joomla\CMS\Helper

Base Helper class.

ContentHelperClass in namespace Joomla\CMS\Helper

Helper for standard content style extensions.

ContentHelper::countRelations() — Method in class ContentHelper

Adds Count relations for Category and Tag Managers

MediaHelper::checkFileExtension() — Method in class MediaHelper

Checks the file extension

MediaHelper::canUpload() — Method in class MediaHelper

Checks if the file can be uploaded

MediaHelper::countFiles() — Method in class MediaHelper

Counts the files and directories in a directory that are not php or html files.

ModuleHelper::cleanModuleList() — Method in class ModuleHelper

Clean the module list

ModuleHelper::createDummyModule() — Method in class ModuleHelper

Method to create a dummy module.

PublicFolderGeneratorHelper::createPublicFolder() — Method in class PublicFolderGeneratorHelper

Creates a public folder

TagsHelper::convertPathsToNames() — Method in class TagsHelper

Function that converts tags paths into paths of names

TagsHelper::createTagsFromField() — Method in class TagsHelper

Create any new tags by looking for #new# in the strings

UserGroupsHelper::count() — Method in class UserGroupsHelper

Count loaded user groups.

CurlTransportClass in namespace Joomla\CMS\Http\Transport

HTTP transport class for using cURL.

$ SocketTransport#connectionsProperty in class SocketTransport
SocketTransport::connect() — Method in class SocketTransport

Method to connect to a server and get the resource.

ContrastClass in namespace Joomla\CMS\Image\Filter

Image Filter class adjust the contrast of an image.

Image::createThumbnails() — Method in class Image

Method to create thumbnails from the current image and save them to disk. It allows creation by resizing or cropping the original image.

Image::createThumbs() — Method in class Image

Method to create thumbnails from the current image and save them to disk. It allows creation by resizing or cropping the original image.

Image::crop() — Method in class Image

Method to crop the current image.

Image::cropResize() — Method in class Image

Method to crop an image after resizing it to maintain proportions without having to do all the set up work.

CliClass in namespace Joomla\CMS\Input

Joomla! Input CLI Class

CookieClass in namespace Joomla\CMS\Input

Joomla! Input Cookie Class

$ Input#cookieProperty in class Input
ComponentAdapterClass in namespace Joomla\CMS\Installer\Adapter

Component installer

ComponentAdapter::checkExtensionInFilesystem() — Method in class ComponentAdapter

Method to check if the extension is present in the filesystem

ComponentAdapter::copyBaseFiles() — Method in class ComponentAdapter

Method to copy the extension's base files from the <files> tag(s) and the manifest file

ComponentAdapter::createExtensionRoot() — Method in class ComponentAdapter

Method to create the extension root path if necessary

FileAdapter::copyBaseFiles() — Method in class FileAdapter

Method to copy the extension's base files from the <files> tag(s) and the manifest file

$ LanguageAdapter#coreProperty in class LanguageAdapter

Core language pack flag

LanguageAdapter::copyBaseFiles() — Method in class LanguageAdapter

Method to copy the extension's base files from the <files> tag(s) and the manifest file

LanguageAdapter::createContentLanguage() — Method in class LanguageAdapter

Create an unpublished content language.

LibraryAdapter::checkExtensionInFilesystem() — Method in class LibraryAdapter

Method to check if the extension is present in the filesystem, flags the route as update if so

LibraryAdapter::copyBaseFiles() — Method in class LibraryAdapter

Method to copy the extension's base files from the <files> tag(s) and the manifest file

$ ModuleAdapter#clientIdProperty in class ModuleAdapter

The install client ID

ModuleAdapter::checkExistingExtension() — Method in class ModuleAdapter

Method to check if the extension is already present in the database

ModuleAdapter::copyBaseFiles() — Method in class ModuleAdapter

Method to copy the extension's base files from the <files> tag(s) and the manifest file

PackageAdapter::checkExtensionInFilesystem() — Method in class PackageAdapter

Method to check if the extension is present in the filesystem, flags the route as update if so

PackageAdapter::copyBaseFiles() — Method in class PackageAdapter

Method to copy the extension's base files from the <files> tag(s) and the manifest file

PackageAdapter::createExtensionRoot() — Method in class PackageAdapter

Method to create the extension root path if necessary

PluginAdapter::checkExistingExtension() — Method in class PluginAdapter

Method to check if the extension is already present in the database

PluginAdapter::copyBaseFiles() — Method in class PluginAdapter

Method to copy the extension's base files from the <files> tag(s) and the manifest file

PluginAdapter::createExtensionRoot() — Method in class PluginAdapter

Method to create the extension root path if necessary

$ TemplateAdapter#clientIdProperty in class TemplateAdapter

The install client ID

TemplateAdapter::checkExistingExtension() — Method in class TemplateAdapter

Method to check if the extension is already present in the database

TemplateAdapter::copyBaseFiles() — Method in class TemplateAdapter

Method to copy the extension's base files from the <files> tag(s) and the manifest file

Installer::copyFiles() — Method in class Installer
Copyfiles
Installer::copyManifest() — Method in class Installer

Copies the installation manifest file to the extension folder in the given client

Installer::cleanDiscoveredExtension() — Method in class Installer

Cleans up discovered extensions if they're being installed some other way

$ InstallerAdapter#changelogurlProperty in class InstallerAdapter

Changelog URL of extensions

$ InstallerAdapter#currentExtensionIdProperty in class InstallerAdapter

ID for the currently installed extension if present

InstallerAdapter::canUninstallPackageChild() — Method in class InstallerAdapter

Check if a package extension allows its child extensions to be uninstalled individually

InstallerAdapter::checkExistingExtension() — Method in class InstallerAdapter

Method to check if the extension is already present in the database

InstallerAdapter::checkExtensionInFilesystem() — Method in class InstallerAdapter

Method to check if the extension is present in the filesystem, flags the route as update if so

InstallerAdapter::copyBaseFiles() — Method in class InstallerAdapter

Method to copy the extension's base files from the <files> tag(s) and the manifest file

InstallerAdapter::createExtensionRoot() — Method in class InstallerAdapter

Method to create the extension root path if necessary

$ InstallerExtension#client_idProperty in class InstallerExtension

Client ID of the extension

$ InstallerExtension#clientProperty in class InstallerExtension

String representation of client. Valid for modules, templates and languages.

InstallerHelper::cleanupInstall() — Method in class InstallerHelper

Clean up temporary uploaded package and unpacked extension

$ InstallerScript#cliScriptFilesProperty in class InstallerScript

A list of CLI script files to be copied to the cli directory

$ LibraryManifest#creationdateProperty in class LibraryManifest

Creation date of the library

$ LibraryManifest#creationDateProperty in class LibraryManifest

Creation Date of the library

$ LibraryManifest#copyrightProperty in class LibraryManifest

Copyright notice for the library

CachingLanguageFactoryClass in namespace Joomla\CMS\Language

Caching factory for creating language objects. The requested languages are cached in memory.

CachingLanguageFactory::createLanguage() — Method in class CachingLanguageFactory

Method to get an instance of a language.

LanguageFactory::createLanguage() — Method in class LanguageFactory

Method to get an instance of a language.

LanguageFactoryInterface::createLanguage() — Method in class LanguageFactoryInterface

Method to get an instance of a language.

LanguageHelper::createLanguageList() — Method in class LanguageHelper

Builds a list of the system languages which can be used in a select option

LanguageHelper::createLanguageListInstall() — Method in class LanguageHelper

Builds a list of the system languages which can be used in a select option with both the native name and the english name

BaseLayout::clearDebugMessages() — Method in class BaseLayout

Clear the debug messages array

$ FileLayout#cacheProperty in class FileLayout

Cached layout paths

FileLayout::clearIncludePaths() — Method in class FileLayout

Clear the include paths

$ Log#configurationsProperty in class Log

Container for Logger configurations.

Log::createDelegatedLogger() — Method in class Log

Creates a delegated PSR-3 compatible logger from the current singleton instance. This method always returns a new delegated logger.

$ LogEntry#categoryProperty in class LogEntry

Application responsible for log entry.

$ LogEntry#contextProperty in class LogEntry

The message context.

$ LogEntry#callStackProperty in class LogEntry

Call stack and back trace of the logged call.

CallbackLoggerClass in namespace Joomla\CMS\Log\Logger

Joomla! Callback Log class

$ CallbackLogger#callbackProperty in class CallbackLogger

The function to call when an entry is added

DatabaseLogger::connect() — Method in class DatabaseLogger

Method to connect to the database server based on object properties.

AdminController::checkin() — Method in class AdminController

Check in of one or more records.

$ ApiController#contentTypeProperty in class ApiController

The content type of the item.

$ ApiController#contextProperty in class ApiController

The context for storing internal data, e.g. record.

BaseController::createFileName() — Method in class BaseController

Create the filename for a resource.

BaseController::checkEditId() — Method in class BaseController

Method to check whether an ID is in the edit list.

BaseController::createModel() — Method in class BaseController

Method to load and return a model object.

BaseController::createView() — Method in class BaseController

Method to load and return a view object. This method first looks in the current template directory for a match and, failing that, uses a default set path to load the view class file.

BaseController::checkToken() — Method in class BaseController

Checks for a form token in the request.

ControllerInterfaceClass in namespace Joomla\CMS\MVC\Controller

Joomla Platform CMS Interface

CheckinCheckoutClass in namespace Joomla\CMS\MVC\Controller\Exception

Checkin/checkout Exception

$ FormController#contextProperty in class FormController

The context for storing internal data, e.g. record.

FormController::cancel() — Method in class FormController

Method to cancel an edit.

ApiMVCFactory::createModel() — Method in class ApiMVCFactory

Method to load and return a model object.

ApiMVCFactory::createTable() — Method in class ApiMVCFactory

Method to load and return a table object.

LegacyFactory::createController() — Method in class LegacyFactory

Method to load and return a controller object.

LegacyFactory::createModel() — Method in class LegacyFactory

Method to load and return a model object.

LegacyFactory::createView() — Method in class LegacyFactory

Method to load and return a view object.

LegacyFactory::createTable() — Method in class LegacyFactory

Method to load and return a table object.

MVCFactory::createController() — Method in class MVCFactory

Method to load and return a controller object.

MVCFactory::createModel() — Method in class MVCFactory

Method to load and return a model object.

MVCFactory::createView() — Method in class MVCFactory

Method to load and return a view object.

MVCFactory::createTable() — Method in class MVCFactory

Method to load and return a table object.

MVCFactoryInterface::createController() — Method in class MVCFactoryInterface

Method to load and return a controller object.

MVCFactoryInterface::createModel() — Method in class MVCFactoryInterface

Method to load and return a model object.

MVCFactoryInterface::createView() — Method in class MVCFactoryInterface

Method to load and return a view object.

MVCFactoryInterface::createTable() — Method in class MVCFactoryInterface

Method to load and return a table object.

$ AdminModel#contentTypeProperty in class AdminModel

UCM Type corresponding to the current model class (re-usable in batch action methods, initialized via initBatch())

AdminModel::cleanupPostBatchCopy() — Method in class AdminModel

Function that can be overridden to do any data cleanup after batch copying data

AdminModel::canDelete() — Method in class AdminModel

Method to test whether a record can be deleted.

AdminModel::canEditState() — Method in class AdminModel

Method to test whether a record can have its state changed.

AdminModel::checkin() — Method in class AdminModel

Method override to check-in a record or an array of record

AdminModel::checkout() — Method in class AdminModel

Method override to check-out a record.

AdminModel::checkCategoryId() — Method in class AdminModel

Method to check the validity of the category ID for batch copy and move

BaseDatabaseModel::cleanCache() — Method in class BaseDatabaseModel

Clean the cache

FormModel::checkin() — Method in class FormModel

Method to checkin a row.

FormModel::checkout() — Method in class FormModel

Method to check-out a row for editing.

$ ListModel#cacheProperty in class ListModel

Internal memory based cache array of data.

$ ListModel#contextProperty in class ListModel

Context string for the model type. This is used to handle uniqueness when dealing with the getStoreId() method and caching data structures.

CanDoClass in namespace Joomla\CMS\MVC\View

A simple state holder class. This class acts for transition from CMSObject to Registry and should not be used directly. Instead of, use the Registry class.

CategoriesViewClass in namespace Joomla\CMS\MVC\View

Categories view base class.

CategoryFeedViewClass in namespace Joomla\CMS\MVC\View

Base feed View class for a category

CategoryViewClass in namespace Joomla\CMS\MVC\View

Base HTML View class for the a Category list

$ CategoryView#categoryProperty in class CategoryView

The category model object for this category

$ CategoryView#categoriesProperty in class CategoryView

The list of other categories for this extension.

$ CategoryView#childrenProperty in class CategoryView

Child objects

CategoryView::commonCategoryDisplay() — Method in class CategoryView

Method with common display elements used in category list displays

$ FormView#canDoProperty in class FormView

The actions the user is authorised to perform

$ ListView#canDoProperty in class ListView

The actions the user is authorised to perform

$ Mail#CharSetProperty in class Mail

Charset of the message.

Mail::clearAttachments() — Method in class Mail

Unset all file attachments from the email

MailHelper::cleanLine() — Method in class MailHelper

Cleans single line inputs.

MailHelper::cleanText() — Method in class MailHelper

Cleans multi-line inputs.

MailHelper::cleanBody() — Method in class MailHelper

Cleans any injected headers from the email body.

MailHelper::cleanSubject() — Method in class MailHelper

Cleans any injected headers from the subject string.

MailHelper::cleanAddress() — Method in class MailHelper

Verifies that an email address does not have any extra headers injected into it.

MailHelper::convertRelativeToAbsoluteUrls() — Method in class MailHelper

Convert relative (links, images sources) to absolute urls so that content is accessible in email

MailTemplate::createTemplate() — Method in class MailTemplate

Insert a new mail template into the system

MailerFactory::createMailer() — Method in class MailerFactory

Method to get an instance of a mailer. If the passed settings are null, then the mailer does use the internal configuration.

MailerFactoryInterface::createMailer() — Method in class MailerFactoryInterface

Method to get an instance of a mailer. If the passed settings are null, then the mailer does use the internal configuration.

$ AdministratorMenuItem#classProperty in class AdministratorMenuItem

The class of the menu item

MenuFactory::createMenu() — Method in class MenuFactory

Creates a new Menu object for the requested format.

MenuFactoryInterface::createMenu() — Method in class MenuFactoryInterface

Creates a new Menu object for the requested format.

$ MenuItem#component_idProperty in class MenuItem

The extension ID of the component this menu item is for

$ MenuItem#componentProperty in class MenuItem

The name of the component this menu item is for

$ Microdata#contentProperty in class Microdata

The Human content

Microdata::content() — Method in class Microdata

Setup a Human content or content for the Machines

CMSObjectClass in namespace Joomla\CMS\Object

Joomla Platform Object Class

$ Pathway#countProperty in class Pathway

Integer number of items in the pathway

CMSPluginClass in namespace Joomla\CMS\Plugin

Plugin Class

ArrayProxy::count() — Method in class ArrayProxy

Implementation of Countable interface

ArrayProxy::current() — Method in class ArrayProxy

Implementation of Iterator interface

ObjectProxy::current() — Method in class ObjectProxy

Implementation of Iterator interface

ObjectReadOnlyProxy::current() — Method in class ObjectReadOnlyProxy

Implementation of Iterator interface

ApiRouter::createCRUDRoutes() — Method in class ApiRouter

Creates routes map for CRUD

$ Router#cacheProperty in class Router

Caching of processed URIs

Router::createUri() — Method in class Router

Create a uri based on a full or partial URL string

$ SiteRouter#componentRoutersProperty in class SiteRouter

Component-router objects

ChangeItemClass in namespace Joomla\CMS\Schema

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

$ ChangeItem#checkQueryProperty in class ChangeItem

Check query: query used to check the db schema

$ ChangeItem#checkQueryExpectedProperty in class ChangeItem

Check query result: expected result of check query if database is up to date

$ ChangeItem#checkStatusProperty in class ChangeItem

Checked status

ChangeItem::check() — Method in class ChangeItem

Runs the check query and checks that 1 row is returned

ChangeSetClass in namespace Joomla\CMS\Schema

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

$ ChangeSet#changeItemsProperty in class ChangeSet

Array of ChangeItem objects

ChangeSet::check() — Method in class ChangeSet

Checks the database and returns an array of any errors found.

SchemaorgPluginTrait::convertToArray() — Method in class SchemaorgPluginTrait

To create an array from repeatable text field data

SchemaorgPluginTrait::checkAllowedAndForbiddenlist() — Method in class SchemaorgPluginTrait

Check if the context is listed in the allowed or forbidden lists and return the result.

CacheControllerClass in namespace Joomla\CMS\Service\Provider

Service provider for the cache controller dependency

CaptchaRegistryClass in namespace Joomla\CMS\Service\Provider

Service provider for the application's CaptchaRegistry dependency

ConfigClass in namespace Joomla\CMS\Service\Provider

Service provider for the application's config dependency

ConsoleClass in namespace Joomla\CMS\Service\Provider

Service provider for the application's console services

MetadataManager::createRecordIfNonExisting() — Method in class MetadataManager

Create the metadata record if it does not exist.

MetadataManager::createOrUpdateRecord() — Method in class MetadataManager

Create the metadata record if it does not exist.

Session::checkToken() — Method in class Session

Checks for a form token in the request.

Session::clear() — Method in class Session

Clears all variables from the session store

SessionFactory::createSessionHandler() — Method in class SessionFactory

Create a session handler based on the application configuration.

SessionFactory::configureSessionHandlerOptions() — Method in class SessionFactory

Resolve the options for the session handler.

JoomlaStorage::clear() — Method in class JoomlaStorage

Clears all variables from the session store

JoomlaStorage::close() — Method in class JoomlaStorage

Writes session data and ends session

$ DatabaseStorage#containerProperty in class DatabaseStorage
Asset::check() — Method in class Asset

Assert that the nested set data is valid.

CategoryClass in namespace Joomla\CMS\Table

Category table

Category::check() — Method in class Category

Override check function

ContentClass in namespace Joomla\CMS\Table

Content table

Content::check() — Method in class Content

Overloaded check function

ContentHistoryClass in namespace Joomla\CMS\Table

Content History table.

$ ContentHistory#convertToIntProperty in class ContentHistory

Array of object fields to convert to integers before calculating SHA1 hash. Some values are stored differently when an item is created than when the item is changed and saved. This works around that issue.

ContentTypeClass in namespace Joomla\CMS\Table

Tags table

ContentType::check() — Method in class ContentType

Overloaded check method to ensure data integrity.

CoreContentClass in namespace Joomla\CMS\Table

Core content table

CoreContent::check() — Method in class CoreContent

Overloaded check function

$ Extension#custom_dataProperty in class Extension

Custom data can be used by extension developers

Extension::check() — Method in class Extension

Overloaded check function

Language::check() — Method in class Language

Overloaded check method to ensure data integrity

Menu::check() — Method in class Menu

Overloaded check function

MenuType::check() — Method in class MenuType

Overloaded check function

Module::check() — Method in class Module

Overloaded check function.

Nested::check() — Method in class Nested

Checks that the object is valid and able to be stored.

Table::check() — Method in class Table

Method to perform sanity checks on the TableInterface instance properties to ensure they are safe to store in the database.

Table::checkOut() — Method in class Table

Method to check a row out if the necessary properties/fields exist.

Table::checkIn() — Method in class Table

Method to check a row in if the necessary properties/fields exist.

TableInterface::check() — Method in class TableInterface

Method to perform sanity checks on the TableInterface instance properties to ensure they are safe to store in the database.

Update::check() — Method in class Update

Overloaded check function

UpdateSite::check() — Method in class UpdateSite

Overloaded check function

User::check() — Method in class User

Validation and filtering

Usergroup::check() — Method in class Usergroup

Method to check the current record to save

ViewLevel::check() — Method in class ViewLevel

Method to check the current record to save

TagServiceInterface::countTagItems() — Method in class TagServiceInterface

Adds Count Items for Tag Manager.

TagServiceTrait::countTagItems() — Method in class TagServiceTrait

Adds Count Items for Tag Manager.

TaggableTableInterface::clearTagsHelper() — Method in class TaggableTableInterface

Clears a set tags helper

TaggableTableTrait::clearTagsHelper() — Method in class TaggableTableTrait

Clears the tags helper

$ AbstractGroupButton#childProperty in class AbstractGroupButton

The child Toolbar instance.

AbstractGroupButton::configure() — Method in class AbstractGroupButton

Add children buttons as dropdown.

ConfirmButtonClass in namespace Joomla\CMS\Toolbar\Button

Renders a standard button with a confirm dialog

CustomButtonClass in namespace Joomla\CMS\Toolbar\Button

Renders a custom button

HelpButton::component() — Method in class HelpButton
ContainerAwareToolbarFactoryClass in namespace Joomla\CMS\Toolbar

Default factory for creating toolbar objects

ContainerAwareToolbarFactory::createButton() — Method in class ContainerAwareToolbarFactory

Creates a new toolbar button.

ContainerAwareToolbarFactory::createToolbar() — Method in class ContainerAwareToolbarFactory

Creates a new Toolbar object.

CoreButtonsTraitClass in namespace Joomla\CMS\Toolbar

Enhance Toolbar class to add more pre-defined methods.

CoreButtonsTrait::checkin() — Method in class CoreButtonsTrait

Writes a checkin button for a given option.

CoreButtonsTrait::cancel() — Method in class CoreButtonsTrait

Writes a cancel button and invokes a cancel operation (eg a checkin).

CoreButtonsTrait::customHtml() — Method in class CoreButtonsTrait

Writes a custom HTML to toolbar.

Toolbar::createChild() — Method in class Toolbar

Create child toolbar.

Toolbar::customButton() — Method in class Toolbar
Toolbar::confirmButton() — Method in class Toolbar
ToolbarFactoryInterface::createButton() — Method in class ToolbarFactoryInterface

Creates a new toolbar button.

ToolbarFactoryInterface::createToolbar() — Method in class ToolbarFactoryInterface

Creates a new Toolbar object.

ToolbarHelper::custom() — Method in class ToolbarHelper

Writes a custom option and task button for the button bar.

ToolbarHelper::checkin() — Method in class ToolbarHelper

Writes a checkin button for a given option.

ToolbarHelper::cancel() — Method in class ToolbarHelper

Writes a cancel button and invokes a cancel operation (eg a checkin).

$ UCMType#core_content_idProperty in class UCMType
$ UCMType#core_type_aliasProperty in class UCMType
$ UCMType#core_titleProperty in class UCMType
$ UCMType#core_aliasProperty in class UCMType
$ UCMType#core_bodyProperty in class UCMType
$ UCMType#core_stateProperty in class UCMType
$ UCMType#core_checked_out_timeProperty in class UCMType
$ UCMType#core_checked_out_user_idProperty in class UCMType
$ UCMType#core_accessProperty in class UCMType
$ UCMType#core_paramsProperty in class UCMType
$ UCMType#core_featuredProperty in class UCMType
$ UCMType#core_metadataProperty in class UCMType
$ UCMType#core_created_user_idProperty in class UCMType
$ UCMType#core_created_by_aliasProperty in class UCMType
$ UCMType#core_created_timeProperty in class UCMType
$ UCMType#core_modified_user_idProperty in class UCMType
$ UCMType#core_modified_timeProperty in class UCMType
$ UCMType#core_languageProperty in class UCMType
$ UCMType#core_publish_upProperty in class UCMType
$ UCMType#core_publish_downProperty in class UCMType
$ UCMType#core_content_item_idProperty in class UCMType
$ UCMType#core_imagesProperty in class UCMType
$ UCMType#core_urlsProperty in class UCMType
$ UCMType#core_hitsProperty in class UCMType
$ UCMType#core_versionProperty in class UCMType
$ UCMType#core_orderingProperty in class UCMType
$ UCMType#core_metakeyProperty in class UCMType
$ UCMType#core_metadescProperty in class UCMType
$ UCMType#core_catidProperty in class UCMType
$ UCMType#core_typeidProperty in class UCMType
CollectionAdapterClass in namespace Joomla\CMS\Updater\Adapter

Collection Update Adapter Class

$ ExtensionAdapter#currentUpdateProperty in class ExtensionAdapter
TufAdapter::configureUpdateOptions() — Method in class TufAdapter

Configures default values or pass arguments to params

ConstraintCheckerClass in namespace Joomla\CMS\Updater

ConstraintChecker Class

$ ConstraintChecker#channelProperty in class ConstraintChecker

The channel to check the constraints against

ConstraintChecker::check() — Method in class ConstraintChecker

Checks whether the passed constraints are matched

ConstraintChecker::checkTargetplatform() — Method in class ConstraintChecker

Check the targetPlatform

ConstraintChecker::checkPhpMinimum() — Method in class ConstraintChecker

Check the minimum PHP version

ConstraintChecker::checkSupportedDatabases() — Method in class ConstraintChecker

Check the supported databases and versions

ConstraintChecker::checkStability() — Method in class ConstraintChecker

Check the stability

$ Update#clientProperty in class Update

Update manifest <client> element

$ Update#categoryProperty in class Update

Update manifest <category> element

$ Update#currentUpdateProperty in class Update

Object containing the current update data

$ Update#channelProperty in class Update

Current release channel

$ Update#compatibleVersionsProperty in class Update

Array with compatible versions used by the pre-update check

$ Update#changelogurlProperty in class Update
$ Uri#currentProperty in class Uri
Uri::current() — Method in class Uri

Returns the URL for the request, minus the query.

CurrentUserInterfaceClass in namespace Joomla\CMS\User

Interface to be implemented by classes depending on a current user.

CurrentUserTraitClass in namespace Joomla\CMS\User

Trait for classes which require a user to work with.

User::clearAccessRights() — Method in class User

Clears the access rights cache of this user

UserHelper::checkSuperUserInUsers() — Method in class UserHelper

Check if there is a super user in the user ids.

CoreAssetItemClass in namespace Joomla\CMS\WebAsset\AssetItem

Web Asset Item class for Core asset

WebAssetManager::calculateOrderOfActiveAssets() — Method in class WebAssetManager

Calculate weight of active Assets, by its Dependencies

WebAssetManager::callOnAttachCallback() — Method in class WebAssetManager

A helper method to call onAttachCallback for script assets that implements WebAssetAttachBehaviorInterface

WebAssetRegistry::createAsset() — Method in class WebAssetRegistry

Prepare new Asset instance.

$ Server#challengeSizeProperty in class Server

Random challenge size in bytes

$ Workflow#componentProperty in class Workflow

The booted component

Workflow::createAssociation() — Method in class Workflow

Creates an association for the workflow_associations table

WorkflowPluginTrait::checkAllowedAndForbiddenlist() — Method in class WorkflowPluginTrait

Check if the context is listed in the allowed of forbidden lists and return the result.

WorkflowPluginTrait::checkExtensionSupport() — Method in class WorkflowPluginTrait

Check if the context supports a specific functionality.

PasswordHash::crypt_private() — Method in class PasswordHash
PasswordHash::CheckPassword() — Method in class PasswordHash

D

Crypto::Decrypt() — Method in class Crypto
$ JLoader#deprecatedAliasesProperty in class JLoader

Holds a reference for all deprecated aliases (mainly for use by a logging platform).

JLoader::discover() — Method in class JLoader

Method to discover classes of a given type in a given path.

$ Rule#dataProperty in class Rule

A named array

$ Rules#dataProperty in class Rules

A named array.

$ AdapterInstance#dbProperty in class AdapterInstance
Database
AdministratorApplication::dispatch() — Method in class AdministratorApplication

Dispatch the application

AdministratorApplication::doExecute() — Method in class AdministratorApplication

Method to run the Web application routines.

ApiApplication::doExecute() — Method in class ApiApplication

Method to run the application routines.

ApiApplication::dispatch() — Method in class ApiApplication

Dispatch the application

$ CMSApplication#docOptionsProperty in class CMSApplication

Array of options for the \JDocument object

ConsoleApplication::doExecute() — Method in class ConsoleApplication

Method to run the application routines.

DaemonApplicationClass in namespace Joomla\CMS\Application

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

DaemonApplication::daemonize() — Method in class DaemonApplication

Method to put the application into the background.

DaemonApplication::detach() — Method in class DaemonApplication

This is truly where the magic happens. This is where we fork the process and kill the parent process, which is essentially what turns the application into a daemon.

$ SiteApplication#detect_browserProperty in class SiteApplication

Option to detect language by the browser

SiteApplication::dispatch() — Method in class SiteApplication

Dispatch the application

SiteApplication::doExecute() — Method in class SiteApplication

Method to run the Web application routines.

$ WebApplication#documentProperty in class WebApplication

The application document object.

Captcha::display() — Method in class Captcha

Get the HTML for the captcha.

CaptchaProviderInterface::display() — Method in class CaptchaProviderInterface

Gets the challenge HTML

$ CategoryNode#descriptionProperty in class CategoryNode

Description of the category.

FtpClient::delete() — Method in class FtpClient

Method to delete a path [file/folder] on the FTP server

RouterView::detachRule() — Method in class RouterView

Remove a build rule

$ AddUserCommand#defaultNameProperty in class AddUserCommand

The default command name

AddUserCommand::doExecute() — Method in class AddUserCommand

Internal function to execute the command.

$ AddUserToGroupCommand#defaultNameProperty in class AddUserToGroupCommand

The default command name

AddUserToGroupCommand::doExecute() — Method in class AddUserToGroupCommand

Internal function to execute the command.

$ ChangeUserPasswordCommand#defaultNameProperty in class ChangeUserPasswordCommand

The default command name

ChangeUserPasswordCommand::doExecute() — Method in class ChangeUserPasswordCommand

Internal function to execute the command.

$ CheckJoomlaUpdatesCommand#defaultNameProperty in class CheckJoomlaUpdatesCommand

The default command name

CheckJoomlaUpdatesCommand::doExecute() — Method in class CheckJoomlaUpdatesCommand

Internal function to execute the command.

$ CheckUpdatesCommand#defaultNameProperty in class CheckUpdatesCommand

The default command name

CheckUpdatesCommand::doExecute() — Method in class CheckUpdatesCommand

Internal function to execute the command.

$ CleanCacheCommand#defaultNameProperty in class CleanCacheCommand

The default command name

CleanCacheCommand::doExecute() — Method in class CleanCacheCommand

Internal function to execute the command.

$ CoreUpdateChannelCommand#defaultNameProperty in class CoreUpdateChannelCommand

The default command name

CoreUpdateChannelCommand::doExecute() — Method in class CoreUpdateChannelCommand

Internal function to execute the command.

DeleteUserCommandClass in namespace Joomla\CMS\Console

Console command for deleting a user

$ DeleteUserCommand#defaultNameProperty in class DeleteUserCommand

The default command name

DeleteUserCommand::doExecute() — Method in class DeleteUserCommand

Internal function to execute the command.

$ ExtensionDiscoverCommand#defaultNameProperty in class ExtensionDiscoverCommand

The default command name

ExtensionDiscoverCommand::doExecute() — Method in class ExtensionDiscoverCommand

Internal function to execute the command.

$ ExtensionDiscoverInstallCommand#defaultNameProperty in class ExtensionDiscoverInstallCommand

The default command name

ExtensionDiscoverInstallCommand::doExecute() — Method in class ExtensionDiscoverInstallCommand

Internal function to execute the command.

$ ExtensionDiscoverListCommand#defaultNameProperty in class ExtensionDiscoverListCommand

The default command name

ExtensionDiscoverListCommand::doExecute() — Method in class ExtensionDiscoverListCommand

Internal function to execute the command.

$ ExtensionInstallCommand#defaultNameProperty in class ExtensionInstallCommand

The default command name

ExtensionInstallCommand::doExecute() — Method in class ExtensionInstallCommand

Internal function to execute the command.

$ ExtensionRemoveCommand#defaultNameProperty in class ExtensionRemoveCommand

The default command name

ExtensionRemoveCommand::doExecute() — Method in class ExtensionRemoveCommand

Internal function to execute the command.

$ ExtensionsListCommand#defaultNameProperty in class ExtensionsListCommand

The default command name

ExtensionsListCommand::doExecute() — Method in class ExtensionsListCommand

Internal function to execute the command.

$ FinderIndexCommand#defaultNameProperty in class FinderIndexCommand

The default command name

FinderIndexCommand::doExecute() — Method in class FinderIndexCommand

Internal function to execute the command.

$ GetConfigurationCommand#defaultNameProperty in class GetConfigurationCommand

The default command name

GetConfigurationCommand::doExecute() — Method in class GetConfigurationCommand

Internal function to execute the command.

$ ListUserCommand#defaultNameProperty in class ListUserCommand

The default command name

ListUserCommand::doExecute() — Method in class ListUserCommand

Internal function to execute the command.

$ MaintenanceDatabaseCommand#defaultNameProperty in class MaintenanceDatabaseCommand

The default command name

MaintenanceDatabaseCommand::doExecute() — Method in class MaintenanceDatabaseCommand

Internal function to execute the command.

$ RemoveOldFilesCommand#defaultNameProperty in class RemoveOldFilesCommand

The default command name

RemoveOldFilesCommand::doExecute() — Method in class RemoveOldFilesCommand

Internal function to execute the command.

$ RemoveUserFromGroupCommand#defaultNameProperty in class RemoveUserFromGroupCommand

The default command name

RemoveUserFromGroupCommand::doExecute() — Method in class RemoveUserFromGroupCommand

Internal function to execute the command.

$ SessionGcCommand#defaultNameProperty in class SessionGcCommand

The default command name

SessionGcCommand::doExecute() — Method in class SessionGcCommand

Internal function to execute the command.

$ SessionMetadataGcCommand#defaultNameProperty in class SessionMetadataGcCommand

The default command name

SessionMetadataGcCommand::doExecute() — Method in class SessionMetadataGcCommand

Internal function to execute the command.

$ SetConfigurationCommand#defaultNameProperty in class SetConfigurationCommand

The default command name

SetConfigurationCommand::doExecute() — Method in class SetConfigurationCommand

Internal function to execute the command.

$ SiteCreatePublicFolderCommand#defaultNameProperty in class SiteCreatePublicFolderCommand

The default command name

SiteCreatePublicFolderCommand::doExecute() — Method in class SiteCreatePublicFolderCommand

Internal function to execute the command.

$ SiteDownCommand#defaultNameProperty in class SiteDownCommand

The default command name

SiteDownCommand::doExecute() — Method in class SiteDownCommand

Internal function to execute the command.

$ SiteUpCommand#defaultNameProperty in class SiteUpCommand

The default command name

SiteUpCommand::doExecute() — Method in class SiteUpCommand

Internal function to execute the command.

$ TasksListCommand#defaultNameProperty in class TasksListCommand

The default command name

TasksListCommand::doExecute() — Method in class TasksListCommand

Internal function to execute the command.

$ TasksRunCommand#defaultNameProperty in class TasksRunCommand

The default command name

TasksRunCommand::doExecute() — Method in class TasksRunCommand
$ TasksStateCommand#defaultNameProperty in class TasksStateCommand

The default command name

TasksStateCommand::doExecute() — Method in class TasksStateCommand

Internal function to execute the command.

$ UpdateCoreCommand#defaultNameProperty in class UpdateCoreCommand

The default command name

UpdateCoreCommand::doExecute() — Method in class UpdateCoreCommand

Internal function to execute the command.

UpdateCoreCommand::downloadFile() — Method in class UpdateCoreCommand

Downloads the Update file

CryptoCipher::decrypt() — Method in class CryptoCipher

Method to decrypt a data string.

SodiumCipher::decrypt() — Method in class SodiumCipher

Method to decrypt a data string.

DateClass in namespace Joomla\CMS\Date

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

$ Date#daysinmonthProperty in class Date

t - Number of days in the given month.

$ Date#dayofweekProperty in class Date

N - ISO-8601 numeric representation of the day of the week.

$ Date#dayofyearProperty in class Date

z - The day of the year (starting from 0).

$ Date#dayProperty in class Date

d - Day of the month, 2 digits with leading zeros.

Date::dayToString() — Method in class Date

Translates day of week number to a string.

AbstractModuleDispatcher::dispatch() — Method in class AbstractModuleDispatcher

Runs the dispatcher.

ApiDispatcher::dispatch() — Method in class ApiDispatcher

Dispatch a controller task. API Overrides to ensure there is no redirects.

ComponentDispatcher::dispatch() — Method in class ComponentDispatcher

Dispatch a controller task. Redirecting the user if appropriate.

DispatcherClass in namespace Joomla\CMS\Dispatcher

Base class for a Joomla Dispatcher

DispatcherInterfaceClass in namespace Joomla\CMS\Dispatcher

Joomla Platform CMS Dispatcher Interface

DispatcherInterface::dispatch() — Method in class DispatcherInterface

Runs the dispatcher.

LegacyComponentDispatcher::dispatch() — Method in class LegacyComponentDispatcher

Dispatch a controller task. Redirecting the user if appropriate.

ModuleDispatcher::dispatch() — Method in class ModuleDispatcher

Dispatches the dispatcher.

DocumentClass in namespace Joomla\CMS\Document

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

$ Document#descriptionProperty in class Document

Document description

$ Document#directionProperty in class Document

Contains the document direction setting

DocumentAwareInterfaceClass in namespace Joomla\CMS\Document

Interface to be implemented by classes depending on a document.

DocumentAwareTraitClass in namespace Joomla\CMS\Document

Defines the trait for a document aware class.

DocumentRendererClass in namespace Joomla\CMS\Document

Abstract class for a renderer

$ ErrorDocument#debugProperty in class ErrorDocument

Flag if debug mode has been enabled

$ FeedDocument#docsProperty in class FeedDocument

Docs feed element

$ FeedImage#descriptionProperty in class FeedImage

Title feed attribute

$ FeedItem#descriptionProperty in class FeedItem

Description item element

$ FeedItem#dateProperty in class FeedItem

Published date

$ JsonapiDocument#documentProperty in class JsonapiDocument

The JsonApi Document object.

$ OpensearchImage#dataProperty in class OpensearchImage

URL of the image or the image as base64 encoded value

PreloadManager::dnsPrefetch() — Method in class PreloadManager

Resolves a resource origin as early as possible.

PreloadManagerInterface::dnsPrefetch() — Method in class PreloadManagerInterface

Resolves a resource origin as early as possible.

AbstractEditorProvider::displayButtons() — Method in class AbstractEditorProvider

Helper method for rendering the editor buttons.

Editor::display() — Method in class Editor

Display the editor area.

EditorProviderInterface::display() — Method in class EditorProviderInterface

Gets the editor HTML markup

AesInterface::decrypt() — Method in class AesInterface

Decrypts a string. Returns the raw binary plaintext.

Mcrypt::decrypt() — Method in class Mcrypt

Decrypt encrypted data

OpenSSL::decrypt() — Method in class OpenSSL

Decrypts a string. Returns the raw binary plaintext.

Aes::decryptString() — Method in class Aes

Decrypts a ciphertext into a plaintext string using AES

Base32::decode() — Method in class Base32
toString
$ AbstractRenderer#documentProperty in class AbstractRenderer

The Document instance

DaemonForkEventClass in namespace Joomla\CMS\Event\Application

Class for Fork event for DaemonApplication

DaemonReceiveSignalEventClass in namespace Joomla\CMS\Event\Application

Class for ReceiveSignal event for DaemonApplication

DeleteEventClass in namespace Joomla\CMS\Event\Model

Class for Model event

DisplayEventClass in namespace Joomla\CMS\Event\View

Event class for WebAsset events

DummyPluginClass in namespace Joomla\CMS\Extension

Placeholder plugin.

$ Factory#datesProperty in class Factory

Container for Date instances

$ Factory#documentProperty in class Factory

Global document object

$ Factory#databaseProperty in class Factory

Global database object

$ Feed#descriptionProperty in class Feed

A phrase or sentence describing the feed.

$ FeedLink#descriptionProperty in class FeedLink

The description of the image.

File::delete() — Method in class File

Delete a file or array of files

Folder::delete() — Method in class Folder

Delete a folder.

$ Patcher#destinationsProperty in class Patcher
$ Stream#dirmodeProperty in class Stream

Directory Mode

Stream::deleteContextEntry() — Method in class Stream

Deletes a particular setting from a context

Stream::delete() — Method in class Stream

Delete a file

InputFilter::decodeFileData() — Method in class InputFilter

Method to decode a file data array.

InputFilter::decode() — Method in class InputFilter

Try to convert to plaintext

$ AccessiblemediaField#directoryProperty in class AccessiblemediaField

The directory.

$ ColorField#defaultProperty in class ColorField

Default color when there is no value.

$ ColorField#displayProperty in class ColorField

The type of value the slider should display: 'hue', 'saturation' or 'light'.

DatabaseconnectionFieldClass in namespace Joomla\CMS\Form\Field

Form Field class for the Joomla Platform.

$ FilelistField#directoryProperty in class FilelistField

The directory.

$ FolderlistField#directoryProperty in class FolderlistField

The directory.

$ LimitboxField#defaultLimitsProperty in class LimitboxField

Default options

$ MediaField#directoryProperty in class MediaField

The directory.

$ MenuitemField#disableProperty in class MenuitemField

The disabled status.

$ TextField#dirnameProperty in class TextField

The name of the form field direction (ltr or rtl).

$ Form#dataProperty in class Form

The Registry data store for form fields during display.

$ FormField#descriptionProperty in class FormField

The description text for the form field. Usually used in tooltips.

$ FormField#disabledProperty in class FormField

The disabled state for the form field. If true then the field will be disabled and user can't interact with the field.

$ FormField#defaultProperty in class FormField

The default value of the form field.

$ FormField#dataAttributesProperty in class FormField

The data-attribute name and values of the form field.

HTMLHelper::date() — Method in class HTMLHelper

Returns formatted date according to a given format and time zone.

$ ActionsDropdown#dropDownListProperty in class ActionsDropdown
ActionsDropdown::duplicate() — Method in class ActionsDropdown

Append a duplicate item to the current dropdown menu

ActionsDropdown::divider() — Method in class ActionsDropdown

Writes a divider between dropdown items

Bootstrap::dropdown() — Method in class Bootstrap

Add javascript support for Bootstrap dropdowns

DateClass in namespace Joomla\CMS\HTML\Helpers

Extended Utility class for handling date display.

DebugClass in namespace Joomla\CMS\HTML\Helpers

Extended Utility class for render debug information.

DraggableListClass in namespace Joomla\CMS\HTML\Helpers

HTML utility class for creating a sortable table list

DraggableList::draggable() — Method in class DraggableList

Method to load the Dragula script and make table sortable

DropdownClass in namespace Joomla\CMS\HTML\Helpers

HTML utility class for building a dropdown menu

$ Dropdown#dropDownListProperty in class Dropdown
Dropdown::divider() — Method in class Dropdown

Writes a divider between dropdown items

TagsHelper::deleteTagData() — Method in class TagsHelper

Method to delete the tag mappings and #__ucm_content record for an item

Image::destroy() — Method in class Image

Method to destroy an image handle and free the memory associated with the handle

$ Files#decodedDataProperty in class Files

The pivoted data from a $_FILES or compatible array.

Files::decodeData() — Method in class Files

Method to decode a data array.

ComponentAdapter::discover() — Method in class ComponentAdapter

Discover unregistered extensions.

LanguageAdapter::discover() — Method in class LanguageAdapter

Custom discover method Finds language files

LanguageAdapter::discover_install() — Method in class LanguageAdapter

Custom discover install method Basically updates the manifest cache and leaves everything alone

LibraryAdapter::discover() — Method in class LibraryAdapter

Custom discover method

ModuleAdapter::discover() — Method in class ModuleAdapter

Custom discover method

PluginAdapter::discover() — Method in class PluginAdapter

Custom discover method

TemplateAdapter::discover() — Method in class TemplateAdapter

Discover existing but uninstalled templates

Installer::discover_install() — Method in class Installer

Discovered package installation method

Installer::discover() — Method in class Installer

Extension discover method

InstallerAdapter::discover_install() — Method in class InstallerAdapter

Generic discover_install method for extensions

InstallerAdapter::doDatabaseTransactions() — Method in class InstallerAdapter

Method to handle database transactions for the installer

InstallerAdapter::doLoadLanguage() — Method in class InstallerAdapter

Load language files

InstallerHelper::downloadPackage() — Method in class InstallerHelper

Downloads a package

InstallerHelper::detectType() — Method in class InstallerHelper

Method to detect the extension type from a package directory

$ InstallerScript#deleteFilesProperty in class InstallerScript

A list of files to be deleted

$ InstallerScript#deleteFoldersProperty in class InstallerScript

A list of folders to be deleted

$ Manifest#descriptionProperty in class Manifest

Description of the extension

Language::debugFile() — Method in class Language

Debugs a language file

LanguageHelper::detectLanguage() — Method in class LanguageHelper

Tries to detect the language.

$ BaseLayout#dataProperty in class BaseLayout

Data for the layout

$ BaseLayout#debugMessagesProperty in class BaseLayout

Debug information messages

BaseLayout::debug() — Method in class BaseLayout

Render a layout with debug info

$ LayoutHelper#defaultBasePathProperty in class LayoutHelper

A default base path that will be used if none is provided when calling the render method.

LayoutHelper::debug() — Method in class LayoutHelper

Method to render a layout with debug info

DelegatingPsrLoggerClass in namespace Joomla\CMS\Log

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

$ LogEntry#dateProperty in class LogEntry

The date the message was logged.

DatabaseLoggerClass in namespace Joomla\CMS\Log\Logger

Joomla! MySQL Database Log class

$ DatabaseLogger#driverProperty in class DatabaseLogger

The name of the database driver to use for connecting to the database.

$ DatabaseLogger#databaseProperty in class DatabaseLogger

The name of the database table to use for the logger.

$ DatabaseLogger#dbProperty in class DatabaseLogger

The database driver object for the logger.

$ FormattedtextLogger#deferProperty in class FormattedtextLogger

If true, all writes will be deferred as long as possible.

$ FormattedtextLogger#deferredEntriesProperty in class FormattedtextLogger

If deferring, entries will be stored here prior to writing.

AdminController::delete() — Method in class AdminController

Removes an item.

ApiController::displayItem() — Method in class ApiController

Basic display of an item view

ApiController::displayList() — Method in class ApiController

Basic display of a list view

ApiController::delete() — Method in class ApiController

Removes an item.

$ BaseController#default_viewProperty in class BaseController

The default view for the display method.

$ BaseController#doTaskProperty in class BaseController

The mapped task that was performed.

BaseController::display() — Method in class BaseController

Typical view method for MVC based architecture

AdminModel::delete() — Method in class AdminModel

Method to delete one or more records.

BaseDatabaseModel::dispatchEvent() — Method in class BaseDatabaseModel

Dispatches the given event on the internal dispatcher, does a fallback to the global one.

DatabaseAwareTraitClass in namespace Joomla\CMS\MVC\Model

Database aware trait.

DatabaseModelInterfaceClass in namespace Joomla\CMS\MVC\Model

Interface for a database model.

$ AbstractView#documentProperty in class AbstractView

The active document object

AbstractView::display() — Method in class AbstractView

Execute and display a template script.

AbstractView::dispatchEvent() — Method in class AbstractView

Dispatches the given event on the internal dispatcher, does a fallback to the global one.

CategoriesView::display() — Method in class CategoriesView

Execute and display a template script.

CategoryFeedView::display() — Method in class CategoryFeedView

Execute and display a template script.

$ CategoryView#defaultPageTitleProperty in class CategoryView

Default title to use for page title

CategoryView::display() — Method in class CategoryView

Execute and display a template script.

FormView::display() — Method in class FormView

Execute and display a template script.

HtmlView::display() — Method in class HtmlView

Execute and display a template script.

$ JsonApiView#documentProperty in class JsonApiView

The active document object (Redeclared for typehinting)

JsonApiView::displayList() — Method in class JsonApiView

Execute and display a template script.

JsonApiView::displayItem() — Method in class JsonApiView

Execute and display a template script.

JsonView::display() — Method in class JsonView

Execute and display a template script.

ListView::display() — Method in class ListView

Execute and display a template script.

ViewInterface::display() — Method in class ViewInterface

Execute and display a template script.

$ MailTemplate#dataProperty in class MailTemplate
MailTemplate::deleteTemplate() — Method in class MailTemplate

Method to delete a mail template

$ AbstractMenu#defaultProperty in class AbstractMenu

Identifier of the default menu item. Key of the array is the language.

$ SiteMenu#dbProperty in class SiteMenu

Database driver

Microdata::display() — Method in class Microdata

This function handles the display logic.

Microdata::displayScope() — Method in class Microdata

Return the HTML of the current Scope

LegacyPropertyManagementTrait::def() — Method in class LegacyPropertyManagementTrait

Sets a default value if not already assigned

$ Pagination#dataProperty in class Pagination

Pagination data object

$ ArrayProxy#dataProperty in class ArrayProxy

Data source

$ ObjectProxy#dataProperty in class ObjectProxy

Data source

$ JsonResponse#dataProperty in class JsonResponse

The response data

Router::detachRule() — Method in class Router

Remove a rule

$ ChangeItem#dbProperty in class ChangeItem

DatabaseDriver object

$ ChangeSet#dbProperty in class ChangeSet

DatabaseDriver object

DatabaseClass in namespace Joomla\CMS\Service\Provider

Service provider for the application's database dependency

DispatcherClass in namespace Joomla\CMS\Service\Provider

Service provider for the application's event dispatcher dependency

DocumentClass in namespace Joomla\CMS\Service\Provider

Service provider for the application's document dependency

MetadataManager::deletePriorTo() — Method in class MetadataManager

Delete records with a timestamp prior to the given time.

SessionManager::destroySession() — Method in class SessionManager

Destroys the given session ID.

SessionManager::destroySessions() — Method in class SessionManager

Destroys the given session IDs.

DatabaseStorageClass in namespace Joomla\CMS\TUF
DatabaseStorage::delete() — Method in class DatabaseStorage
$ TufFetcher#dbProperty in class TufFetcher

The database driver

ContentHistory::deleteOldVersions() — Method in class ContentHistory

Utility method to remove the oldest versions of an item, saving only the most recent versions.

CoreContent::delete() — Method in class CoreContent

Override \Joomla\CMS\Table\Table delete method to include deleting corresponding row from #__ucm_base.

CoreContent::deleteByContentId() — Method in class CoreContent

Method to delete a row from the #__ucm_content table by content_item_id.

MenuType::delete() — Method in class MenuType

Method to delete a row from the database table by primary key value.

Nested::debug() — Method in class Nested

Sets the debug level on or off

Nested::delete() — Method in class Nested

Method to delete a node and, optionally, its child nodes from the table.

Table::delete() — Method in class Table

Method to delete a record.

TableInterface::delete() — Method in class TableInterface

Method to delete a record.

User::delete() — Method in class User

Method to delete a user, user groups, and any other necessary data from the database.

Usergroup::delete() — Method in class Usergroup

Delete this object and its dependencies

DropdownButtonClass in namespace Joomla\CMS\Toolbar\Button

Render dropdown buttons.

CoreButtonsTrait::divider() — Method in class CoreButtonsTrait

Writes a divider between dropdown menu items.

CoreButtonsTrait::delete() — Method in class CoreButtonsTrait

Writes a common 'delete' button.

Toolbar::dropdownButton() — Method in class Toolbar
ToolbarHelper::divider() — Method in class ToolbarHelper

Writes a divider between menu buttons

ToolbarHelper::deleteList() — Method in class ToolbarHelper

Writes a common 'delete' button for a list of records.

UCMContent::delete() — Method in class UCMContent

Delete content from the Core Content table

$ UCMType#dbProperty in class UCMType

The Database object

DownloadSourceClass in namespace Joomla\CMS\Updater

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

$ Update#descriptionProperty in class Update

Update manifest <description> element

$ Update#downloadsProperty in class Update

Update manifest <downloads> element

$ Update#downloadSourcesProperty in class Update

Update manifest <downloadsource> elements

$ Update#downloadurlProperty in class Update
User::defParam() — Method in class User

Method to set a default parameter if it does not exist

User::delete() — Method in class User

Method to delete the User object from the database

UserHelper::destroyUserSessions() — Method in class UserHelper

Destroy all active session for a given user id

Versioning::delete() — Method in class Versioning

Method to delete the history for an item.

$ WebAssetItem#dependenciesProperty in class WebAssetItem

Asset dependencies

$ WebAssetManager#dependenciesIsActualProperty in class WebAssetManager

Internal marker to keep track when need to recheck dependencies

WebAssetManager::disableAsset() — Method in class WebAssetManager

Deactivate an asset item, so it will not be attached to a Document

WebAssetManager::disablePresetItems() — Method in class WebAssetManager

Deactivate list of assets provided by Preset item.

WebAssetManager::disableStyle() — Method in class WebAssetManager
WebAssetManager::disableScript() — Method in class WebAssetManager
WebAssetManager::disablePreset() — Method in class WebAssetManager
WebAssetManagerInterface::disableAsset() — Method in class WebAssetManagerInterface

Deactivate an asset item, so it will not be attached to a Document

$ WebAssetRegistry#dataFilesNewProperty in class WebAssetRegistry

Files with Asset info. File path should be relative.

$ WebAssetRegistry#dataFilesParsedProperty in class WebAssetRegistry

List of parsed files

WebAssetRegistry::dispatchAssetChanged() — Method in class WebAssetRegistry

Dispatch an event to notify listeners about asset changes: new, remove, override Events:

  • onWebAssetRegistryChangedAssetNew When new asset added to the registry
  • onWebAssetRegistryChangedAssetOverride When the asset overridden
  • onWebAssetRegistryChangedAssetRemove When new asset was removed from the registry
$ Workflow#dbProperty in class Workflow

Database Driver

Workflow::deleteAssociation() — Method in class Workflow

Removes associations from the workflow_associations table

__TwigTemplate_0bf62896b95c7e97cd0f4eae5f5f6195::doGetParent() — Method in class __TwigTemplate_0bf62896b95c7e97cd0f4eae5f5f6195
__TwigTemplate_0bf62896b95c7e97cd0f4eae5f5f6195::doDisplay() — Method in class __TwigTemplate_0bf62896b95c7e97cd0f4eae5f5f6195
__TwigTemplate_3994fb5d5d826575e5e068ab43919da3::doGetParent() — Method in class __TwigTemplate_3994fb5d5d826575e5e068ab43919da3
__TwigTemplate_3994fb5d5d826575e5e068ab43919da3::doDisplay() — Method in class __TwigTemplate_3994fb5d5d826575e5e068ab43919da3
__TwigTemplate_4bcccb9f0894179cb357804bda58e4b3::doDisplay() — Method in class __TwigTemplate_4bcccb9f0894179cb357804bda58e4b3
__TwigTemplate_5043402560718bb1c61e09b845b77e36::doDisplay() — Method in class __TwigTemplate_5043402560718bb1c61e09b845b77e36
__TwigTemplate_79fb764e9da8ea996f0ce34ace2da336::doDisplay() — Method in class __TwigTemplate_79fb764e9da8ea996f0ce34ace2da336
__TwigTemplate_85e091843a2d5eb6b1597c2f89e0752c::doGetParent() — Method in class __TwigTemplate_85e091843a2d5eb6b1597c2f89e0752c
__TwigTemplate_85e091843a2d5eb6b1597c2f89e0752c::doDisplay() — Method in class __TwigTemplate_85e091843a2d5eb6b1597c2f89e0752c
__TwigTemplate_896e1a17f0353adb41deb8b45210ae94::doDisplay() — Method in class __TwigTemplate_896e1a17f0353adb41deb8b45210ae94
__TwigTemplate_93a051471fb2bd8bc386b2041ff7ba2b::doDisplay() — Method in class __TwigTemplate_93a051471fb2bd8bc386b2041ff7ba2b
__TwigTemplate_959903b26cb0d471d240abcbd9524242::doGetParent() — Method in class __TwigTemplate_959903b26cb0d471d240abcbd9524242
__TwigTemplate_959903b26cb0d471d240abcbd9524242::doDisplay() — Method in class __TwigTemplate_959903b26cb0d471d240abcbd9524242
__TwigTemplate_a53d5b9a592c30f5292fdf2cf5daaf44::doGetParent() — Method in class __TwigTemplate_a53d5b9a592c30f5292fdf2cf5daaf44
__TwigTemplate_a53d5b9a592c30f5292fdf2cf5daaf44::doDisplay() — Method in class __TwigTemplate_a53d5b9a592c30f5292fdf2cf5daaf44
__TwigTemplate_acdad90fc61f5e474deb98262a7dc3eb::doGetParent() — Method in class __TwigTemplate_acdad90fc61f5e474deb98262a7dc3eb
__TwigTemplate_acdad90fc61f5e474deb98262a7dc3eb::doDisplay() — Method in class __TwigTemplate_acdad90fc61f5e474deb98262a7dc3eb
__TwigTemplate_adbbf7f4f8572fd945270d87a68752a6::doGetParent() — Method in class __TwigTemplate_adbbf7f4f8572fd945270d87a68752a6
__TwigTemplate_adbbf7f4f8572fd945270d87a68752a6::doDisplay() — Method in class __TwigTemplate_adbbf7f4f8572fd945270d87a68752a6
__TwigTemplate_bc6db32d62004a1677f9a4af03635305::doGetParent() — Method in class __TwigTemplate_bc6db32d62004a1677f9a4af03635305
__TwigTemplate_bc6db32d62004a1677f9a4af03635305::doDisplay() — Method in class __TwigTemplate_bc6db32d62004a1677f9a4af03635305
__TwigTemplate_ebd3ded38a1374cfcb2671eaa14a1d29::doGetParent() — Method in class __TwigTemplate_ebd3ded38a1374cfcb2671eaa14a1d29
__TwigTemplate_ebd3ded38a1374cfcb2671eaa14a1d29::doDisplay() — Method in class __TwigTemplate_ebd3ded38a1374cfcb2671eaa14a1d29
__TwigTemplate_f39bca71236ed63ca7b7b0f776c66525::doGetParent() — Method in class __TwigTemplate_f39bca71236ed63ca7b7b0f776c66525
__TwigTemplate_f39bca71236ed63ca7b7b0f776c66525::doDisplay() — Method in class __TwigTemplate_f39bca71236ed63ca7b7b0f776c66525

E

Crypto::Encrypt() — Method in class Crypto
$ JLoader#extensionRootFoldersProperty in class JLoader

The root folders where extensions can be found.

JNamespacePsr4Map::exists() — Method in class JNamespacePsr4Map

Check if the file exists

JNamespacePsr4Map::ensureMapFileExists() — Method in class JNamespacePsr4Map

Check if the namespace mapping file exists, if not create it

CMSApplication::enqueueMessage() — Method in class CMSApplication

Enqueue a system message.

CMSApplication::execute() — Method in class CMSApplication

Execute the application.

CMSApplicationInterface::enqueueMessage() — Method in class CMSApplicationInterface

Enqueue a system message.

CliApplication::execute() — Method in class CliApplication

Execute the application.

CliApplication::enqueueMessage() — Method in class CliApplication

Enqueue a system message.

ConsoleApplication::execute() — Method in class ConsoleApplication

Execute the application.

ConsoleApplication::enqueueMessage() — Method in class ConsoleApplication

Enqueue a system message.

$ DaemonApplication#exitingProperty in class DaemonApplication
DaemonApplication::execute() — Method in class DaemonApplication

Execute the daemon.

EventAwareClass in namespace Joomla\CMS\Application

Trait for application classes which dispatch events

EventAwareInterfaceClass in namespace Joomla\CMS\Application

Interface defining application that can trigger Joomla 3.x style events

ExtensionNamespaceMapperClass in namespace Joomla\CMS\Application

Trait for application classes which ensures the namespace mapper exists and includes it.

WebApplication::execute() — Method in class WebApplication

Execute the application.

$ AssociationExtensionHelper#extensionProperty in class AssociationExtensionHelper

The extension name

$ AuthenticationResponse#error_messageProperty in class AuthenticationResponse

The error message

$ AuthenticationResponse#emailProperty in class AuthenticationResponse

The email address of the End User as specified in section 3.4.1 of [RFC2822]

$ CategoryNode#extensionProperty in class CategoryNode

The extension this category is associated with

$ Changelog#elementProperty in class Changelog

Update manifest <element> element

Changelog::endElement() — Method in class Changelog

Callback for closing the element

$ ComponentRecord#enabledProperty in class ComponentRecord

Indicates if this component is enabled

ExtensionDiscoverCommandClass in namespace Joomla\CMS\Console

Console command for discovering extensions

ExtensionDiscoverInstallCommandClass in namespace Joomla\CMS\Console

Console command for discovering extensions

ExtensionDiscoverListCommandClass in namespace Joomla\CMS\Console

Console command for list discovered extensions

ExtensionInstallCommandClass in namespace Joomla\CMS\Console

Console command for installing extensions

ExtensionRemoveCommandClass in namespace Joomla\CMS\Console

Console command for removing extensions

ExtensionsListCommandClass in namespace Joomla\CMS\Console

Console command for listing installed extensions

$ ExtensionsListCommand#extensionsProperty in class ExtensionsListCommand

Stores the installed Extensions

UpdateCoreCommand::extractFile() — Method in class UpdateCoreCommand

Extracts Update file

CryptoCipher::encrypt() — Method in class CryptoCipher

Method to encrypt a data string.

SodiumCipher::encrypt() — Method in class SodiumCipher

Method to encrypt a data string.

ErrorDocumentClass in namespace Joomla\CMS\Document

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

$ ErrorDocument#errorProperty in class ErrorDocument

Error Object

$ FeedDocument#editorProperty in class FeedDocument

Editor feed element

$ FeedDocument#editorEmailProperty in class FeedDocument

Editor email feed element

$ FeedItem#enclosureProperty in class FeedItem

Enclosure element

EditorClass in namespace Joomla\CMS\Editor

Editor class to handle WYSIWYG editors

EditorProviderInterfaceClass in namespace Joomla\CMS\Editor

Editor provider interface

EditorsRegistryClass in namespace Joomla\CMS\Editor

Editor Registry class

EditorsRegistryInterfaceClass in namespace Joomla\CMS\Editor

Interface for Editor Registry classes

EditorNotFoundExceptionClass in namespace Joomla\CMS\Editor\Exception

Exception class defining a missing element

AesInterface::encrypt() — Method in class AesInterface

Encrypts a string. Returns the raw binary ciphertext.

Mcrypt::encrypt() — Method in class Mcrypt

Encrypt the data

OpenSSL::encrypt() — Method in class OpenSSL

Encrypts a string. Returns the raw binary ciphertext.

Aes::encryptString() — Method in class Aes

Encrypts a string using AES

Base32::encode() — Method in class Base32
fromString
EditorButtonsSetupEventClass in namespace Joomla\CMS\Event\Editor

Editor setup event

EditorSetupEventClass in namespace Joomla\CMS\Event\Editor

Editor setup event

ErrorEventClass in namespace Joomla\CMS\Event

Event class for representing the application's onError event

ExportRequestEventClass in namespace Joomla\CMS\Event\Privacy

Class for Privacy events.

ExceptionHandlerClass in namespace Joomla\CMS\Exception

Displays the custom error page when an uncaught exception occurs.

ExtensionHelperClass in namespace Joomla\CMS\Extension

Extension Helper class.

$ ExtensionHelper#extensionsProperty in class ExtensionHelper

The loaded extensions.

ExtensionManagerInterfaceClass in namespace Joomla\CMS\Extension

Loads extensions.

ExtensionManagerTraitClass in namespace Joomla\CMS\Extension

Trait for classes which can load extensions

$ Feed#entriesProperty in class Feed
$ FeedParser#entryElementNameProperty in class FeedParser

The feed element name for the entry elements.

$ FeedPerson#emailProperty in class FeedPerson

The email address of the person.

$ RssParser#entryElementNameProperty in class RssParser
File::exists() — Method in class File

Wrapper for the standard file_exists function

Folder::exists() — Method in class Folder

Wrapper for the standard file_exists function

Stream::eof() — Method in class Stream

Work out if we're at the end of the file for a stream

InputFilter::emailToPunycode() — Method in class InputFilter

Function to punyencode utf8 mail when saving content

EditorFieldClass in namespace Joomla\CMS\Form\Field

A textarea field for content creation

$ EditorField#editorProperty in class EditorField

The Editor object.

$ EditorField#editorTypeProperty in class EditorField

The editorType of the editor.

EmailFieldClass in namespace Joomla\CMS\Form\Field

Form Field class for the Joomla Platform.

$ FilelistField#excludeProperty in class FilelistField

The exclude.

$ FolderlistField#excludeProperty in class FolderlistField

The exclude.

$ TransitionField#extensionProperty in class TransitionField

The component and section separated by ".".

$ UserField#excludedProperty in class UserField

Users to exclude from the list of users

$ WorkflowconditionField#extensionProperty in class WorkflowconditionField

The component and section separated by ".".

$ WorkflowstageField#extensionProperty in class WorkflowstageField

The component and section separated by ".".

$ Form#errorsProperty in class Form

The form object errors array.

$ FormField#elementProperty in class FormField

The SimpleXMLElement object of the <field> XML element that describes the form field.

$ FormHelper#entitiesProperty in class FormHelper

Static array of Form's entity objects for re-use.

EmailRuleClass in namespace Joomla\CMS\Form\Rule

Form Rule class for the Joomla Platform.

EqualsRuleClass in namespace Joomla\CMS\Form\Rule

Form Rule class for the Joomla Platform.

ExistsRuleClass in namespace Joomla\CMS\Form\Rule

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

HTMLHelper::extract() — Method in class HTMLHelper

Method to extract a key

AdminLanguage::existing() — Method in class AdminLanguage

Get a list of the available administrator language items.

Bootstrap::endAccordion() — Method in class Bootstrap

Close the current accordion

Bootstrap::endSlide() — Method in class Bootstrap

Close the current slide

Bootstrap::endTabSet() — Method in class Bootstrap

Close the current tab pane

Bootstrap::endTab() — Method in class Bootstrap

Close the current tab content panel

ContentLanguage::existing() — Method in class ContentLanguage

Get a list of the available content language items.

Dropdown::edit() — Method in class Dropdown

Append an edit item to the current dropdown menu

EmailClass in namespace Joomla\CMS\HTML\Helpers

Utility class for cloaking email addresses

$ Sidebar#entriesProperty in class Sidebar

Menu entries

UiTab::endTabSet() — Method in class UiTab

Close the current tab pane

UiTab::endTab() — Method in class UiTab

Close the current tab content panel

WorkflowStage::existing() — Method in class WorkflowStage

Get a list of the available workflow stages.

$ RouteHelper#extensionProperty in class RouteHelper
Backgroundfill::execute() — Method in class Backgroundfill

Method to apply a background color to an image resource.

Brightness::execute() — Method in class Brightness

Method to apply a filter to an image resource.

Contrast::execute() — Method in class Contrast

Method to apply a filter to an image resource.

EdgedetectClass in namespace Joomla\CMS\Image\Filter

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

Edgedetect::execute() — Method in class Edgedetect

Method to apply a filter to an image resource.

EmbossClass in namespace Joomla\CMS\Image\Filter

Image Filter class to emboss an image.

Emboss::execute() — Method in class Emboss

Method to apply a filter to an image resource.

Grayscale::execute() — Method in class Grayscale

Method to apply a filter to an image resource.

Negate::execute() — Method in class Negate

Method to apply a filter to an image resource.

Sketchy::execute() — Method in class Sketchy

Method to apply a filter to an image resource.

Smooth::execute() — Method in class Smooth

Method to apply a filter to an image resource.

ImageFilter::execute() — Method in class ImageFilter

Method to apply a filter to an image resource.

$ Cli#executableProperty in class Cli

The executable that was called to run the CLI script.

$ Input#envProperty in class Input
FileAdapter::extensionExistsInSystem() — Method in class FileAdapter

Function used to check if extension is already installed

$ Installer#extensionProperty in class Installer

Extension Table Entry

$ Installer#extension_messageProperty in class Installer

The extension message that appears

$ Installer#extraQueryProperty in class Installer

Backup extra_query during update_sites rebuild

$ InstallerAdapter#elementProperty in class InstallerAdapter

The unique identifier for the extension (e.g. mod_login)

$ InstallerAdapter#extensionProperty in class InstallerAdapter

Extension object.

$ InstallerAdapter#extensionMessageProperty in class InstallerAdapter

Messages rendered by custom scripts

$ InstallerScript#extensionProperty in class InstallerScript

The extension name. This should be set in the installer script.

LanguageHelper::exists() — Method in class LanguageHelper

Checks if a language exists.

$ Multilanguage#enabledProperty in class Multilanguage

Flag indicating multilanguage functionality is enabled.

BaseLayout::escape() — Method in class BaseLayout

Method to escape output.

LayoutInterface::escape() — Method in class LayoutInterface

Method to escape output.

EchoLoggerClass in namespace Joomla\CMS\Log\Logger

Joomla Echo logger class.

ApiController::edit() — Method in class ApiController

Method to edit an existing record.

BaseController::execute() — Method in class BaseController

Execute a controller task.

ControllerInterface::execute() — Method in class ControllerInterface

Execute a controller task.

FormController::edit() — Method in class FormController

Method to edit an existing record.

FormController::editAssociations() — Method in class FormController

Load item to edit associations in com_associations

$ AdminModel#event_after_deleteProperty in class AdminModel

The event to trigger after deleting the data.

$ AdminModel#event_after_saveProperty in class AdminModel

The event to trigger after saving the data.

$ AdminModel#event_before_deleteProperty in class AdminModel

The event to trigger before deleting the data.

$ AdminModel#event_before_saveProperty in class AdminModel

The event to trigger before saving the data.

$ AdminModel#event_before_change_stateProperty in class AdminModel

The event to trigger before changing the published state of the data.

$ AdminModel#event_change_stateProperty in class AdminModel

The event to trigger after changing the published state of the data.

$ AdminModel#event_before_batchProperty in class AdminModel

The event to trigger before batch.

AdminModel::editAssociations() — Method in class AdminModel

Method to load an item in com_associations.

$ BaseDatabaseModel#event_clean_cacheProperty in class BaseDatabaseModel

The event to trigger when cleaning cache.

$ FormModel#events_mapProperty in class FormModel

Maps events to plugin groups.

$ WorkflowBehaviorTrait#extensionProperty in class WorkflowBehaviorTrait

The name of the component.

WorkflowBehaviorTrait::enableWorkflowBatch() — Method in class WorkflowBehaviorTrait

Add the workflow batch to the command list. Can be overwritten by the child class

WorkflowBehaviorTrait::executeTransition() — Method in class WorkflowBehaviorTrait

Runs transition for item.

WorkflowModelInterface::executeTransition() — Method in class WorkflowModelInterface

Runs transition for item.

$ CategoryView#extensionProperty in class CategoryView

The name of the extension for the category

HtmlView::escape() — Method in class HtmlView

Escapes a value for output in a view script.

$ AdministratorMenuItem#elementProperty in class AdministratorMenuItem

The element type of the menu item

$ Microdata#enabledProperty in class Microdata

Used for checking if the library output is enabled or disabled

Microdata::enable() — Method in class Microdata

Enable or Disable the library output

EditorsRegistryClass in namespace Joomla\CMS\Service\Provider

Service provider for the application's EditorsRegistry dependency

PunycodeHelper::emailToPunycode() — Method in class PunycodeHelper

Transforms a UTF-8 email to a Punycode email This assumes a valid email address

PunycodeHelper::emailToUTF8() — Method in class PunycodeHelper

Transforms a Punycode email to a UTF-8 email This assumes a valid email address

ExtensionClass in namespace Joomla\CMS\Table

Extension table

CoreButtonsTrait::edit() — Method in class CoreButtonsTrait

Writes a common 'edit' button.

CoreButtonsTrait::editHtml() — Method in class CoreButtonsTrait

Writes a common 'editHtml' button.

CoreButtonsTrait::editCss() — Method in class CoreButtonsTrait

Writes a common 'editCss' button.

ToolbarButton::ensureUniqueId() — Method in class ToolbarButton

Make sure the id is unique

ToolbarHelper::editList() — Method in class ToolbarHelper

Writes a common 'edit' button for a list of records.

ToolbarHelper::editHtml() — Method in class ToolbarHelper

Writes a common 'edit' button for a template html.

ToolbarHelper::editCss() — Method in class ToolbarHelper

Writes a common 'edit' button for a template css.

ExtensionAdapterClass in namespace Joomla\CMS\Updater\Adapter

Extension class for updater

$ Update#elementProperty in class Update

Update manifest <element> element

$ Update#extra_queryProperty in class Update

Extra query for download URLs

$ User#emailProperty in class User

The email

WebAssetManager::enableDependencies() — Method in class WebAssetManager

Update Dependencies state for all active Assets or only for given

WebAssetRegistry::exists() — Method in class WebAssetRegistry

Check whether the asset exists in the registry.

WebAssetRegistryInterface::exists() — Method in class WebAssetRegistryInterface

Check whether the asset exists in the registry.

$ Workflow#extensionProperty in class Workflow

Name of the extension the workflow belong to

Workflow::executeTransition() — Method in class Workflow

Executes a transition to change the current state in the association table

WorkflowPluginTrait::enhanceWorkflowTransitionForm() — Method in class WorkflowPluginTrait

Add different parameter options to the transition view, we need when executing the transition

PasswordHash::encode64() — Method in class PasswordHash

F

$ JNamespacePsr4Map#fileProperty in class JNamespacePsr4Map

Path to the autoloader

AdministratorApplication::findOption() — Method in class AdministratorApplication

Return the application option string [main component].

$ ApiApplication#formatMapperProperty in class ApiApplication

Maps extension types to their

ColorStyle::fromString() — Method in class ColorStyle

Create a color style from a parameter string.

ConsoleApplication::flushAssets() — Method in class ConsoleApplication

Flush the media version to refresh versionable assets

DaemonApplication::fork() — Method in class DaemonApplication

Method to fork the process.

WebApplication::flushAssets() — Method in class WebApplication

Flush the media version to refresh versionable assets

$ AuthenticationResponse#fullnameProperty in class AuthenticationResponse

UTF-8 string free text representation of the End User's full name.

ActionButton::fetchIconClass() — Method in class ActionButton

Method to get the CSS class name for an icon identifier.

FeaturedButtonClass in namespace Joomla\CMS\Button

The FeaturedButton class.

CacheStorage::flush() — Method in class CacheStorage

Flush all existing items in storage.

FileStorageClass in namespace Joomla\CMS\Cache\Storage

File cache storage handler

MemcachedStorage::flush() — Method in class MemcachedStorage

Flush all existing items in storage.

$ Changelog#fixProperty in class Changelog

Update manifest <fix> element

$ Changelog#folderProperty in class Changelog

Update manifest <folder> element

FtpClientClass in namespace Joomla\CMS\Client

FTP client class

ComponentHelper::filterText() — Method in class ComponentHelper

Applies the global text filters to arbitrary text as per settings for current user groups

ExtensionDiscoverListCommand::filterExtensionsBasedOnState() — Method in class ExtensionDiscoverListCommand

Filters the extension state

FinderIndexCommandClass in namespace Joomla\CMS\Console

Console command Purges and rebuilds the index (search filters are preserved)

GetConfigurationCommand::formatConfig() — Method in class GetConfigurationCommand

Formats the configuration array into desired format

GetConfigurationCommand::formatConfigValue() — Method in class GetConfigurationCommand

Formats the Configuration value

$ Date#formatProperty in class Date

The format string to be applied when using the __toString() magic method.

Date::format() — Method in class Date

Gets the date as a formatted string.

$ Document#factoryProperty in class Document

Factory for creating JDocument API objects

FactoryClass in namespace Joomla\CMS\Document

Default factory for creating Document objects

FactoryInterfaceClass in namespace Joomla\CMS\Document

Interface defining a factory which can create Document objects

FeedDocumentClass in namespace Joomla\CMS\Document

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

FeedEnclosureClass in namespace Joomla\CMS\Document\Feed

Data object representing a feed enclosure

FeedImageClass in namespace Joomla\CMS\Document\Feed

Data object representing a feed image

FeedItemClass in namespace Joomla\CMS\Document\Feed

Data object representing a feed item

FeedRendererClass in namespace Joomla\CMS\Error\Renderer

RSS/Atom feed error page renderer

FinderEventInterfaceClass in namespace Joomla\CMS\Event\Finder

Interface class for finder events

FormEventClass in namespace Joomla\CMS\Event\Model

Class for Model Form event

FactoryClass in namespace Joomla\CMS

Joomla Platform Factory class.

FeedClass in namespace Joomla\CMS\Feed

Class to encapsulate a feed for the Joomla Platform.

FeedEntryClass in namespace Joomla\CMS\Feed

Class to encapsulate a feed entry for the Joomla Platform.

FeedFactoryClass in namespace Joomla\CMS\Feed

Feed factory class.

FeedLinkClass in namespace Joomla\CMS\Feed

Feed Link class.

FeedParserClass in namespace Joomla\CMS\Feed

Feed Parser class.

FeedParser::fetchNamespace() — Method in class FeedParser

Method to get a namespace object for a given namespace prefix.

FeedPersonClass in namespace Joomla\CMS\Feed

Feed Person class.

FieldsFormServiceInterfaceClass in namespace Joomla\CMS\Fields

The fields service.

FieldsServiceInterfaceClass in namespace Joomla\CMS\Fields

The fields service.

FieldsServiceTraitClass in namespace Joomla\CMS\Fields

Trait for component fields service.

FileClass in namespace Joomla\CMS\Filesystem

A File handling class

FilesystemHelperClass in namespace Joomla\CMS\Filesystem

File system helper

FilesystemHelper::ftpChmod() — Method in class FilesystemHelper

Quick FTP chmod

FilesystemHelper::fileUploadMaxSize() — Method in class FilesystemHelper

Calculates the maximum upload file size and returns string with unit or the size in bytes

FolderClass in namespace Joomla\CMS\Filesystem

A Folder handling class

Folder::files() — Method in class Folder

Utility function to read the files in a folder.

Folder::folders() — Method in class Folder

Utility function to read the folders in a folder.

Patcher::findHeader() — Method in class Patcher

Find the diff header

Patcher::findHunk() — Method in class Patcher

Find the next hunk of difference

$ Stream#filemodeProperty in class Stream

File Mode

$ Stream#filenameProperty in class Stream
Filename
$ Stream#filtersProperty in class Stream

Filters applied to the current stream

$ Stream#fhProperty in class Stream

File Handle

$ Stream#filesizeProperty in class Stream

File size

Stream::filesize() — Method in class Stream

Retrieve the file size of the path

$ CalendarField#formatProperty in class CalendarField

The format of date and time.

$ CalendarField#filterFormatProperty in class CalendarField

The format will be used to filter submitted date and time.

$ CalendarField#filterProperty in class CalendarField

The filter.

$ CalendarField#filltableProperty in class CalendarField

The fill table flag

CalendarField::filter() — Method in class CalendarField

Method to filter a field value.

$ CheckboxesField#forceMultipleProperty in class CheckboxesField

Flag to tell the field to always be in multiple values mode.

$ ColorField#formatProperty in class ColorField

The format.

FileFieldClass in namespace Joomla\CMS\Form\Field

Form Field class for the Joomla Platform.

FilelistFieldClass in namespace Joomla\CMS\Form\Field

Supports an HTML select list of files

$ FilelistField#fileFilterProperty in class FilelistField

The filename filter.

FolderlistFieldClass in namespace Joomla\CMS\Form\Field

Supports an HTML select list of folder

$ FolderlistField#folderFilterProperty in class FolderlistField

The folder name filter.

FrontendlanguageFieldClass in namespace Joomla\CMS\Form\Field

Provides a list of published content languages with home pages

$ MediaField#folderProperty in class MediaField

The folder.

$ PasswordField#forceProperty in class PasswordField

Whether to attach a password strength meter or not.

$ PluginsField#folderProperty in class PluginsField

The path to folder for plugins.

$ SubformField#formsourceProperty in class SubformField

Form source

SubformField::filter() — Method in class SubformField

Method to filter a field value.

IntarrayFilter::filter() — Method in class IntarrayFilter

Method to filter a field value.

RawFilter::filter() — Method in class RawFilter

Method to filter a field value.

RulesFilter::filter() — Method in class RulesFilter

Method to filter a field value.

SafehtmlFilter::filter() — Method in class SafehtmlFilter

Method to filter a field value.

TelFilter::filter() — Method in class TelFilter

Method to filter a field value.

UnsetFilter::filter() — Method in class UnsetFilter

Method to filter a field value.

UrlFilter::filter() — Method in class UrlFilter

Method to filter a field value.

FormClass in namespace Joomla\CMS\Form

Form Class for the Joomla Platform.

$ Form#formsProperty in class Form

Form instances.

Form::filter() — Method in class Form

Method to filter the form data.

Form::findField() — Method in class Form

Method to get a form field represented as an XML element object.

Form::findFieldsByFieldset() — Method in class Form

Method to get an array of <field> elements from the form XML document which are in a specified fieldset by name.

Form::findFieldsByGroup() — Method in class Form

Method to get an array of <field> elements from the form XML document which are in a control group by name.

Form::findGroup() — Method in class Form

Method to get a form field group represented as an XML element object.

FormFactoryClass in namespace Joomla\CMS\Form

Default factory for creating Form objects

FormFactoryAwareInterfaceClass in namespace Joomla\CMS\Form

Interface to be implemented by classes depending on a form factory.

FormFactoryAwareTraitClass in namespace Joomla\CMS\Form

Defines the trait for a FormFactoryInterface Aware Class.

FormFactoryInterfaceClass in namespace Joomla\CMS\Form

Interface defining a factory which can create Form objects

FormFieldClass in namespace Joomla\CMS\Form

Abstract Form Field class for the Joomla Platform.

$ FormField#formProperty in class FormField

The Form object of the form attached to the form field.

$ FormField#formControlProperty in class FormField

The form control prefix for field names from the Form object attached to the form field.

$ FormField#fieldnameProperty in class FormField

The name of the field.

FormField::filter() — Method in class FormField

Method to filter a field value.

FormFilterInterfaceClass in namespace Joomla\CMS\Form

Interface for a filter class.

FormFilterInterface::filter() — Method in class FormFilterInterface

Method to filter a field value.

FormHelperClass in namespace Joomla\CMS\Form

Form's helper class.

FormRuleClass in namespace Joomla\CMS\Form

Form Rule class for the Joomla Platform.

FilePathRuleClass in namespace Joomla\CMS\Form\Rule

Form Rule class for the Joomla Platform.

FolderPathExistsRuleClass in namespace Joomla\CMS\Form\Rule

Form Rule class for the Joomla CMS.

$ HTMLHelper#formatOptionsProperty in class HTMLHelper

Option values related to the generation of HTML output. Recognized options are: fmtDepth, integer. The current indent depth.

ActionsDropdown::feature() — Method in class ActionsDropdown

Append a feature item to the current dropdown menu

Behavior::formvalidator() — Method in class Behavior

Add unobtrusive JavaScript support for form validation.

Bootstrap::framework() — Method in class Bootstrap

Method to load the ALL the Bootstrap Components

Dropdown::featured() — Method in class Dropdown

Append a featured item to the current dropdown menu

FormClass in namespace Joomla\CMS\HTML\Helpers

Utility class for form elements

FormBehaviorClass in namespace Joomla\CMS\HTML\Helpers

Utility class for form related behaviors

Jquery::framework() — Method in class Jquery

Method to load the jQuery JavaScript framework into the document head

SearchTools::form() — Method in class SearchTools

Load searchtools for a specific form

$ Sidebar#filtersProperty in class Sidebar
Filters
RouteHelper::findItem() — Method in class RouteHelper

Method to find the item in the menu structure

$ Image#formatsProperty in class Image
Image::filter() — Method in class Image

Method to apply a filter to the image by type. Two examples are: grayscale and sketchy.

Image::flip() — Method in class Image

Method to flip the current image.

FilesClass in namespace Joomla\CMS\Input

Joomla! Input Files Class

$ Input#filesProperty in class Input
ComponentAdapter::finaliseInstall() — Method in class ComponentAdapter

Method to finalise the installation processing

ComponentAdapter::finaliseUninstall() — Method in class ComponentAdapter

Method to finalise the uninstallation processing

FileAdapterClass in namespace Joomla\CMS\Installer\Adapter

File installer

$ FileAdapter#folderListProperty in class FileAdapter

List of processed folders

$ FileAdapter#fileListProperty in class FileAdapter

List of processed files

FileAdapter::finaliseInstall() — Method in class FileAdapter

Method to finalise the installation processing

FileAdapter::finaliseUninstall() — Method in class FileAdapter

Method to finalise the uninstallation processing

LanguageAdapter::finaliseInstall() — Method in class LanguageAdapter

Method to finalise the installation processing

LanguageAdapter::finaliseUninstall() — Method in class LanguageAdapter

Method to finalise the uninstallation processing

LibraryAdapter::finaliseInstall() — Method in class LibraryAdapter

Method to finalise the installation processing

LibraryAdapter::finaliseUninstall() — Method in class LibraryAdapter

Method to finalise the uninstallation processing

ModuleAdapter::finaliseInstall() — Method in class ModuleAdapter

Method to finalise the installation processing

ModuleAdapter::finaliseUninstall() — Method in class ModuleAdapter

Method to finalise the uninstallation processing

PackageAdapter::finaliseInstall() — Method in class PackageAdapter

Method to finalise the installation processing

PackageAdapter::finaliseUninstall() — Method in class PackageAdapter

Method to finalise the uninstallation processing

PluginAdapter::finaliseInstall() — Method in class PluginAdapter

Method to finalise the installation processing

PluginAdapter::finaliseUninstall() — Method in class PluginAdapter

Method to finalise the uninstallation processing

TemplateAdapter::finaliseInstall() — Method in class TemplateAdapter

Method to finalise the installation processing

TemplateAdapter::finaliseUninstall() — Method in class TemplateAdapter

Method to finalise the uninstallation processing

Installer::findManifest() — Method in class Installer

Tries to find the package manifest file

Installer::findDeletedFiles() — Method in class Installer

Compares two "files" entries to find deleted files/folders

InstallerAdapter::finaliseInstall() — Method in class InstallerAdapter

Method to finalise the installation processing

InstallerAdapter::finaliseUninstall() — Method in class InstallerAdapter

Method to finalise the uninstallation processing

$ InstallerExtension#filenameProperty in class InstallerExtension

Filename of the extension

$ Manifest#filelistProperty in class Manifest

List of files in the extension

FileLayoutClass in namespace Joomla\CMS\Layout

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

$ FileLayout#fullPathProperty in class FileLayout

Full path to actual layout files, after possible template override check

Log::findLoggers() — Method in class Log

Method to find the loggers to use based on priority and category values.

FormattedtextLoggerClass in namespace Joomla\CMS\Log\Logger

Joomla! Formatted Text File Log class

$ FormattedtextLogger#formatProperty in class FormattedtextLogger

The format which each entry follows in the log file.

$ FormattedtextLogger#fieldsProperty in class FormattedtextLogger

The parsed fields from the format string.

FormattedtextLogger::formatLine() — Method in class FormattedtextLogger

Format a line for the log file.

$ W3cLogger#formatProperty in class W3cLogger

The format which each entry follows in the log file.

$ BaseController#factoryProperty in class BaseController

The factory.

FormControllerClass in namespace Joomla\CMS\MVC\Controller

Controller tailored to suit most form-based admin operations.

FormBehaviorTraitClass in namespace Joomla\CMS\MVC\Model

Trait which supports form behavior.

FormModelClass in namespace Joomla\CMS\MVC\Model

Prototype form model.

FormModelInterfaceClass in namespace Joomla\CMS\MVC\Model

Interface for a form model.

$ ListModel#filter_fieldsProperty in class ListModel

Valid filter fields or ordering.

$ ListModel#filterFormNameProperty in class ListModel

Name of the filter form to load

$ ListModel#filterBlacklistProperty in class ListModel

A list of filter variables to not merge into the model's state

$ ListModel#filterForbiddenListProperty in class ListModel

A list of forbidden filter variables to not merge into the model's state

FormViewClass in namespace Joomla\CMS\MVC\View

Base class for a Joomla Form View

$ FormView#formProperty in class FormView

The \JForm object

$ JsonApiView#fieldsToRenderItemProperty in class JsonApiView

The fields to render item in the documents

$ JsonApiView#fieldsToRenderListProperty in class JsonApiView

The fields to render items in the documents

$ ListView#filterFormProperty in class ListView

Form object for search filters

$ Microdata#fallbackTypeProperty in class Microdata

The Fallback Type

$ Microdata#fallbackPropertyProperty in class Microdata

The Fallback Property

Microdata::fallback() — Method in class Microdata

Setup a Fallback Type and Property

$ ChangeItem#fileProperty in class ChangeItem

Update file: full path file name where query was found

ChangeItem::fix() — Method in class ChangeItem

Runs the update query to apply the change to the database

$ ChangeSet#folderProperty in class ChangeSet

Folder where SQL update files will be found

ChangeSet::fix() — Method in class ChangeSet

Runs the update query to apply the change to the database

FormClass in namespace Joomla\CMS\Service\Provider

Service provider for the form dependency

PunycodeHelper::fromPunycode() — Method in class PunycodeHelper

Transforms a Punycode string to a UTF-8 string

ContentType::fieldmapExpand() — Method in class ContentType

Method to expand the field mapping

Extension::find() — Method in class Extension

Method to create and execute a SELECT WHERE query.

Update::find() — Method in class Update

Method to create and execute a SELECT WHERE query.

AbstractGroupButton::fetchId() — Method in class AbstractGroupButton

Get the button CSS Id.

BasicButton::fetchButton() — Method in class BasicButton

Fetch the HTML for the button

ConfirmButton::fetchButton() — Method in class ConfirmButton

Fetch the HTML for the button

CustomButton::fetchButton() — Method in class CustomButton

Fetch the HTML for the button

DropdownButton::fetchId() — Method in class DropdownButton

Get the button CSS Id.

HelpButton::fetchButton() — Method in class HelpButton

Fetches the button HTML code.

InlinehelpButton::fetchButton() — Method in class InlinehelpButton

Fetches the button HTML code.

LinkButton::fetchButton() — Method in class LinkButton

Fetch the HTML for the button

PopupButton::fetchButton() — Method in class PopupButton

Fetch the HTML for the button

PopupButton::footer() — Method in class PopupButton
SeparatorButton::fetchButton() — Method in class SeparatorButton

Empty implementation (not required for separator)

StandardButton::fetchButton() — Method in class StandardButton

Fetch the HTML for the button

StandardButton::fetchButtonClass() — Method in class StandardButton

Fetch button class for standard buttons.

$ Toolbar#factoryProperty in class Toolbar

Factory for creating Toolbar API objects

ToolbarButton::fetchId() — Method in class ToolbarButton

Get the button CSS Id.

ToolbarButton::fetchIconClass() — Method in class ToolbarButton

Method to get the CSS class name for an icon identifier

ToolbarButton::fetchButton() — Method in class ToolbarButton

Get the button

ToolbarButton::form() — Method in class ToolbarButton
ToolbarButton::formValidation() — Method in class ToolbarButton
UCMType::fieldmapExpand() — Method in class UCMType

Method to expand the field mapping

CollectionAdapter::findUpdate() — Method in class CollectionAdapter

Finds an update

ExtensionAdapter::findUpdate() — Method in class ExtensionAdapter

Finds an update.

TufAdapter::findUpdate() — Method in class TufAdapter

Finds an update.

$ ConstraintChecker#failedEnvironmentConstraintsProperty in class ConstraintChecker

This property holds information about failed environment constraints.

$ DownloadSource#formatProperty in class DownloadSource

The download file's format

$ Update#folderProperty in class Update
UpdateAdapter::findUpdate() — Method in class UpdateAdapter

Finds an update

Updater::findUpdates() — Method in class Updater

Finds the update for an extension. Any discovered updates are stored in the #__updates table.

FormValidateAssetItemClass in namespace Joomla\CMS\WebAsset\AssetItem

Web Asset Item class for form.validate asset

WebAssetManager::filterOutInlineAssets() — Method in class WebAssetManager

Helper method to filter an inline assets

WorkflowServiceInterface::filterTransitions() — Method in class WorkflowServiceInterface

Method to filter transitions by given id of state.

G

JLoader::getClassList() — Method in class JLoader

Method to get the list of registered classes and their respective file paths for the autoloader.

JLoader::getDeprecatedAliases() — Method in class JLoader

Method to get the list of deprecated class aliases.

JLoader::getNamespaces() — Method in class JLoader

Method to get the list of registered namespaces.

$ Access#groupsByUserProperty in class Access

Array of cached groups by user.

Access::getAssetAncestors() — Method in class Access

Method to recursively retrieve the list of parent Asset IDs for a particular Asset.

Access::getGroupPath() — Method in class Access

Gets the parent groups that a leaf group belongs to in its branch back to the root of the tree (including the leaf group id).

Access::getAssetRules() — Method in class Access

Method to return the Rules object for an asset. The returned object can optionally hold only the rules explicitly set for the asset or the summation of all inherited rules from parent assets and explicit rules.

Access::getAssetId() — Method in class Access

Method to get the asset id from the asset key.

Access::getAssetName() — Method in class Access

Method to get the asset name from the asset key.

Access::getExtensionNameFromAsset() — Method in class Access

Method to get the extension name from the asset name.

Access::getAssetType() — Method in class Access

Method to get the asset type from the asset name.

Access::getGroupTitle() — Method in class Access

Method to return the title of a user group

Access::getGroupsByUser() — Method in class Access

Method to return a list of user groups mapped to a user. The returned list can optionally hold only the groups explicitly mapped to the user or all groups both explicitly mapped and inherited by the user.

Access::getUsersByGroup() — Method in class Access

Method to return a list of user Ids contained in a Group

Access::getAuthorisedViewLevels() — Method in class Access

Method to return a list of view levels for which the user is authorised.

Access::getActionsFromFile() — Method in class Access

Method to return a list of actions from a file for which permissions can be set.

Access::getActionsFromData() — Method in class Access

Method to return a list of actions from a string or from an xml for which permissions can be set.

Rule::getData() — Method in class Rule

Get the data for the action.

Rules::getData() — Method in class Rules

Get the data for the action.

Rules::getAllowed() — Method in class Rules

Get the allowed actions for an identity.

Adapter::getDbo() — Method in class Adapter

Get the database connector object

Adapter::getAdapter() — Method in class Adapter

Return an adapter.

AdapterInstance::getParent() — Method in class AdapterInstance

Retrieves the parent object

AdministratorApplication::getRouter() — Method in class AdministratorApplication

Return a reference to the Router object.

AdministratorApplication::getTemplate() — Method in class AdministratorApplication

Gets the name of the current template.

ApiApplication::getTemplate() — Method in class ApiApplication

Gets the name of the current template.

ApiApplication::getApiRouter() — Method in class ApiApplication

Returns the application Router object.

ApplicationHelper::getComponentName() — Method in class ApplicationHelper

Return the name of the request component [main component]

ApplicationHelper::getHash() — Method in class ApplicationHelper

Provides a secure hash based on a seed

ApplicationHelper::getClientInfo() — Method in class ApplicationHelper

Gets information on a specific client id. This method will be useful in future versions when we start mapping applications in the database.

CliOutput::getProcessor() — Method in class CliOutput

Get a processor

ColorStyle::getStyle() — Method in class ColorStyle

Get the translated color code.

ColorStyle::getKnownColors() — Method in class ColorStyle

Get the known colors.

ColorStyle::getKnownOptions() — Method in class ColorStyle

Get the known options.

CMSApplication::getCfg() — Method in class CMSApplication

Gets a configuration value.

CMSApplication::getClientId() — Method in class CMSApplication

Gets the client id of the current running application.

CMSApplication::getInstance() — Method in class CMSApplication

Returns a reference to the global WebApplication object, only creating it if it doesn't already exist.

CMSApplication::getMenu() — Method in class CMSApplication

Get the menu object.

CMSApplication::getMessageQueue() — Method in class CMSApplication

Get the system message queue.

CMSApplication::getName() — Method in class CMSApplication

Gets the name of the current running application.

CMSApplication::getPathway() — Method in class CMSApplication

Returns the application Pathway object.

CMSApplication::getRouter() — Method in class CMSApplication

Returns the application Router object.

CMSApplication::getTemplate() — Method in class CMSApplication

Gets the name of the current template.

CMSApplication::getUserState() — Method in class CMSApplication

Gets a user state.

CMSApplication::getUserStateFromRequest() — Method in class CMSApplication

Gets the value of a user state variable.

CMSApplication::getFormToken() — Method in class CMSApplication

Method to determine a hash for anti-spoofing variable names

CMSApplicationInterface::getMessageQueue() — Method in class CMSApplicationInterface

Get the system message queue.

CMSApplicationInterface::getIdentity() — Method in class CMSApplicationInterface

Get the application identity.

CMSApplicationInterface::getInput() — Method in class CMSApplicationInterface

Method to get the application input object.

CMSApplicationInterface::getLanguage() — Method in class CMSApplicationInterface

Method to get the application language object.

CMSApplicationInterface::getName() — Method in class CMSApplicationInterface

Gets the name of the current running application.

CMSWebApplicationInterface::getDocument() — Method in class CMSWebApplicationInterface

Method to get the application document object.

CMSWebApplicationInterface::getMenu() — Method in class CMSWebApplicationInterface

Get the menu object.

CMSWebApplicationInterface::getRouter() — Method in class CMSWebApplicationInterface

Returns the application Router object.

CMSWebApplicationInterface::getUserState() — Method in class CMSWebApplicationInterface

Gets a user state.

CMSWebApplicationInterface::getUserStateFromRequest() — Method in class CMSWebApplicationInterface

Gets the value of a user state variable.

CliApplication::getInput() — Method in class CliApplication

Method to get the application input object.

CliApplication::getLanguage() — Method in class CliApplication

Method to get the application language object.

CliApplication::getInstance() — Method in class CliApplication

Returns a reference to the global CliApplication object, only creating it if it doesn't already exist.

CliApplication::getOutput() — Method in class CliApplication

Get an output object.

CliApplication::getCliInput() — Method in class CliApplication

Get a CLI input object.

CliApplication::getMessageQueue() — Method in class CliApplication

Get the system message queue.

CliApplication::getSession() — Method in class CliApplication

Method to get the application session object.

CliApplication::getConfig() — Method in class CliApplication

Retrieve the application configuration object.

ConsoleApplication::getName() — Method in class ConsoleApplication

Gets the name of the current running application.

ConsoleApplication::getDefaultCommands() — Method in class ConsoleApplication

Get the commands which should be registered by default to the application.

ConsoleApplication::getConfig() — Method in class ConsoleApplication

Retrieve the application configuration object.

ConsoleApplication::getInput() — Method in class ConsoleApplication

Method to get the application input object.

ConsoleApplication::getLanguage() — Method in class ConsoleApplication

Method to get the application language object.

ConsoleApplication::getMessageQueue() — Method in class ConsoleApplication

Get the system message queue.

ConsoleApplication::getSession() — Method in class ConsoleApplication

Method to get the application session object.

ConsoleApplication::getLongVersion() — Method in class ConsoleApplication

Get the long version string for the application.

ConsoleApplication::getRouter() — Method in class ConsoleApplication

Returns the application Router object.

ConsoleApplication::getDefaultInputDefinition() — Method in class ConsoleApplication

Builds the default input definition.

ConsoleApplication::getUserState() — Method in class ConsoleApplication

Gets a user state.

ConsoleApplication::getUserStateFromRequest() — Method in class ConsoleApplication

Gets the value of a user state variable.

DaemonApplication::gc() — Method in class DaemonApplication

Method to perform basic garbage collection and memory management in the sense of clearing the stat cache. We will probably call this method pretty regularly in our main loop.

EventAware::getDispatcher() — Method in class EventAware

Get the event dispatcher.

EventAware::getLogger() — Method in class EventAware

Get the logger.

EventAwareInterface::getDispatcher() — Method in class EventAwareInterface

Get the event dispatcher.

IdentityAware::getIdentity() — Method in class IdentityAware

Get the application identity.

SiteApplication::getDetectBrowser() — Method in class SiteApplication

Return the current state of the detect browser option.

SiteApplication::getLanguageFilter() — Method in class SiteApplication

Return the current state of the language filter.

SiteApplication::getParams() — Method in class SiteApplication

Get the application parameters

SiteApplication::getRouter() — Method in class SiteApplication

Return a reference to the Router object.

SiteApplication::getTemplate() — Method in class SiteApplication

Gets the name of the current template.

WebApplication::getInstance() — Method in class WebApplication

Returns a reference to the global WebApplication object, only creating it if it doesn't already exist.

WebApplication::getDocument() — Method in class WebApplication

Method to get the application document object.

WebApplication::getLanguage() — Method in class WebApplication

Method to get the application language object.

WebApplication::getConfig() — Method in class WebApplication

Retrieve the application configuration object.

AssociationExtensionHelper::getItemTypes() — Method in class AssociationExtensionHelper

Get the item types

AssociationExtensionHelper::getAssociationList() — Method in class AssociationExtensionHelper

Get the associated items for an item

AssociationExtensionHelper::getType() — Method in class AssociationExtensionHelper

Get information about the type

AssociationExtensionHelper::getTypeFields() — Method in class AssociationExtensionHelper

Get information about the fields the type provides

AssociationExtensionHelper::getTypeSupport() — Method in class AssociationExtensionHelper

Get information about the fields the type provides

AssociationExtensionHelper::getTypeTables() — Method in class AssociationExtensionHelper

Get information about the tables the type use

AssociationExtensionHelper::getTypeJoins() — Method in class AssociationExtensionHelper

Get information about the table joins for the type

AssociationExtensionHelper::getTypeTitle() — Method in class AssociationExtensionHelper

Get the type title

AssociationExtensionHelper::getTypeFieldName() — Method in class AssociationExtensionHelper

Get a table field name for a type

AssociationExtensionHelper::getSupportTemplate() — Method in class AssociationExtensionHelper

Get default values for support array

AssociationExtensionHelper::getFieldsTemplate() — Method in class AssociationExtensionHelper

Get default values for fields array

AssociationExtensionInterface::getAssociationsForItem() — Method in class AssociationExtensionInterface

Method to get the associations for a given item.

AssociationServiceInterface::getAssociationsExtension() — Method in class AssociationServiceInterface

Returns the associations extension helper class.

AssociationServiceTrait::getAssociationsExtension() — Method in class AssociationServiceTrait

Returns the associations extension helper class.

Authentication::getInstance() — Method in class Authentication

Returns the global authentication object, only creating it if it doesn't already exist.

$ AuthenticationResponse#genderProperty in class AuthenticationResponse

The End User's gender, "M" for male, "F" for female.

ProviderAwareAuthenticationPluginInterface::getProviderName() — Method in class ProviderAwareAuthenticationPluginInterface

Return provider name

ActionButton::getState() — Method in class ActionButton

Get state profile by value name.

ActionButton::getLayout() — Method in class ActionButton

Method to get property layout.

ActionButton::getOptions() — Method in class ActionButton

Method to get property options.

ActionButton::getOption() — Method in class ActionButton

Get an option value.

Cache::getInstance() — Method in class Cache

Returns a reference to a cache adapter object, always creating it

Cache::getStores() — Method in class Cache

Get the storage handlers

Cache::getCaching() — Method in class Cache

Get caching state

Cache::get() — Method in class Cache

Get cached data by ID and group

Cache::getAll() — Method in class Cache

Get a list of all cached data

Cache::gc() — Method in class Cache

Garbage collect expired cache data

Cache::getWorkarounds() — Method in class Cache

Perform workarounds on retrieved cached data

Cache::getPlatformPrefix() — Method in class Cache

Set a prefix cache key if device calls for separate caching

CacheController::getInstance() — Method in class CacheController

Returns a reference to a cache adapter object, always creating it

CacheControllerFactoryAwareTrait::getCacheControllerFactory() — Method in class CacheControllerFactoryAwareTrait

Get the CacheControllerFactoryInterface.

CacheStorage::getInstance() — Method in class CacheStorage

Returns a cache storage handler object.

CacheStorage::get() — Method in class CacheStorage

Get cached data by ID and group

CacheStorage::getAll() — Method in class CacheStorage

Get all cached data

CacheStorage::gc() — Method in class CacheStorage

Garbage collect expired cache data

CallbackController::get() — Method in class CallbackController

Executes a cacheable callback if not found in cache else returns cached output and result

OutputController::get() — Method in class OutputController

Get stored cached data by ID and group

PageController::get() — Method in class PageController

Get the cached page data

ViewController::get() — Method in class ViewController

Get the cached view data

ApcuStorage::get() — Method in class ApcuStorage

Get cached data by ID and group

ApcuStorage::getAll() — Method in class ApcuStorage

Get all cached data

ApcuStorage::gc() — Method in class ApcuStorage

Garbage collect expired cache data

$ CacheStorageHelper#groupProperty in class CacheStorageHelper

Cache data group

FileStorage::get() — Method in class FileStorage

Get cached data by ID and group

FileStorage::getAll() — Method in class FileStorage

Get all cached data

FileStorage::gc() — Method in class FileStorage

Garbage collect expired cache data

MemcachedStorage::getConnection() — Method in class MemcachedStorage

Create the Memcached connection

MemcachedStorage::get() — Method in class MemcachedStorage

Get cached data by ID and group

MemcachedStorage::getAll() — Method in class MemcachedStorage

Get all cached data

RedisStorage::getConnection() — Method in class RedisStorage

Create the Redis connection

RedisStorage::get() — Method in class RedisStorage

Get cached data by ID and group

RedisStorage::getAll() — Method in class RedisStorage

Get all cached data

Captcha::getInstance() — Method in class Captcha

Returns the global Captcha object, only creating it if it doesn't already exist.

CaptchaProviderInterface::getName() — Method in class CaptchaProviderInterface

Return Captcha name, CMD string.

CaptchaRegistry::getAll() — Method in class CaptchaRegistry

Return list of all registered elements

CaptchaRegistry::get() — Method in class CaptchaRegistry

Return element by name.

Categories::getInstance() — Method in class Categories

Returns a reference to a Categories object

Categories::get() — Method in class Categories

Loads a specific category and all its children in a CategoryNode object.

Categories::getExtension() — Method in class Categories

Returns the extension of the category.

Categories::getOptions() — Method in class Categories

Returns options.

CategoryInterface::get() — Method in class CategoryInterface

Loads a specific category and all its children in a CategoryNode object.

CategoryNode::getChildren() — Method in class CategoryNode

Get the children of this node

CategoryNode::getSibling() — Method in class CategoryNode

Returns the right or left sibling of a category

CategoryNode::getParams() — Method in class CategoryNode

Returns the category parameters

CategoryNode::getMetadata() — Method in class CategoryNode

Returns the category metadata

CategoryNode::getPath() — Method in class CategoryNode

Returns the category path to the root category

CategoryNode::getAuthor() — Method in class CategoryNode

Returns the user that created the category

CategoryNode::getNumItems() — Method in class CategoryNode

Returns the number of items.

CategoryServiceInterface::getCategory() — Method in class CategoryServiceInterface

Returns the category service.

CategoryServiceTrait::getCategory() — Method in class CategoryServiceTrait

Returns the category service.

CategoryServiceTrait::getTableNameForSection() — Method in class CategoryServiceTrait

Returns the table for the count items functions for the given section.

CategoryServiceTrait::getStateColumnForSection() — Method in class CategoryServiceTrait

Returns the state column for the count items functions for the given section.

Changelog::getStackLocation() — Method in class Changelog

Gets the reference to the current direct parent

Changelog::getLastTag() — Method in class Changelog

Get the last position in stack count

ClientHelper::getCredentials() — Method in class ClientHelper

Method to return the array of client layer configuration options

FtpClient::getInstance() — Method in class FtpClient

Returns the global FTP connector object, only creating it if it doesn't already exist.

FtpClient::get() — Method in class FtpClient

Method to get a file from the FTP server and save it to a local file

ComponentHelper::getComponent() — Method in class ComponentHelper

Get the component information.

ComponentHelper::getParams() — Method in class ComponentHelper

Gets the parameter object for the component

ComponentHelper::getComponents() — Method in class ComponentHelper

Get installed components

ComponentHelper::getComponentName() — Method in class ComponentHelper

Returns the component name (eg. com_content) for the given object based on the class name.

ComponentRecord::getParams() — Method in class ComponentRecord

Returns the menu item parameters

RouterView::getViews() — Method in class RouterView

Return an array of registered view objects

RouterView::getPath() — Method in class RouterView

Get the path of views from target view to root view including content items of a nestable view

RouterView::getRules() — Method in class RouterView

Get all currently attached rules

RouterView::getName() — Method in class RouterView

Method to return the name of the router

AddUserCommand::getGroupId() — Method in class AddUserCommand

Method to get groupId by groupName

AddUserCommand::getStringFromOption() — Method in class AddUserCommand

Method to get a value from option

AddUserCommand::getUserGroups() — Method in class AddUserCommand

Method to get a value from option

AddUserToGroupCommand::getGroups() — Method in class AddUserToGroupCommand

Method to get a value from option

AddUserToGroupCommand::getGroupId() — Method in class AddUserToGroupCommand

Method to get groupId by groupName

AddUserToGroupCommand::getUserId() — Method in class AddUserToGroupCommand

Method to get a user object

AddUserToGroupCommand::getStringFromOption() — Method in class AddUserToGroupCommand

Method to get a value from option

ChangeUserPasswordCommand::getStringFromOption() — Method in class ChangeUserPasswordCommand

Method to get a value from option

CheckJoomlaUpdatesCommand::getUpdateInfo() — Method in class CheckJoomlaUpdatesCommand

Gets the Update Information

CheckUpdatesCommand::getExtensionInfo() — Method in class CheckUpdatesCommand

Transforms extension arrays into required form

DeleteUserCommand::getStringFromOption() — Method in class DeleteUserCommand

Method to get a value from option

ExtensionDiscoverCommand::getNote() — Method in class ExtensionDiscoverCommand

Used for finding the text for the note

ExtensionDiscoverInstallCommand::getNote() — Method in class ExtensionDiscoverInstallCommand

Used for finding the text for the note

ExtensionsListCommand::getExtensions() — Method in class ExtensionsListCommand

Retrieves all extensions

ExtensionsListCommand::getExtensionsNameAndId() — Method in class ExtensionsListCommand

Transforms extension arrays into required form

GetConfigurationCommandClass in namespace Joomla\CMS\Console

Console command for displaying configuration options

GetConfigurationCommand::getGroups() — Method in class GetConfigurationCommand

Gets the defined option groups

WritableContainerLoader::get() — Method in class WritableContainerLoader

Loads a command.

WritableContainerLoader::getNames() — Method in class WritableContainerLoader

Get the names of the registered commands.

RemoveUserFromGroupCommand::getGroups() — Method in class RemoveUserFromGroupCommand

Method to get a value from option

RemoveUserFromGroupCommand::getGroupId() — Method in class RemoveUserFromGroupCommand

Method to get groupId by groupName

RemoveUserFromGroupCommand::getStringFromOption() — Method in class RemoveUserFromGroupCommand

Method to get a value from option

SetConfigurationCommand::getOptions() — Method in class SetConfigurationCommand

Collects the options array

SetConfigurationCommand::getInitialConfigurationOptions() — Method in class SetConfigurationCommand

Returns Default configuration Object

SiteCreatePublicFolderCommand::getStringFromOption() — Method in class SiteCreatePublicFolderCommand

Method to get a value from option

UpdateCoreCommand::getUpdateModel() — Method in class UpdateCoreCommand

Retrieves the Update model from com_joomlaupdate

CryptoCipher::generateKey() — Method in class CryptoCipher

Method to generate a new encryption key object.

SodiumCipher::generateKey() — Method in class SodiumCipher

Method to generate a new encryption key object.

$ Date#gmtProperty in class Date

Placeholder for a \DateTimeZone object with GMT as the time zone.

Date::getInstance() — Method in class Date

Proxy for new Date().

Date::getOffsetFromGmt() — Method in class Date

Get the time offset from GMT in hours or seconds.

AbstractModuleDispatcher::getLayoutData() — Method in class AbstractModuleDispatcher

Returns the layout data. This function can be overridden by subclasses to add more attributes for the layout.

ComponentDispatcher::getController() — Method in class ComponentDispatcher

Get a controller from the component

Dispatcher::getApplication() — Method in class Dispatcher

The application the dispatcher is working with.

Document::getInstance() — Method in class Document

Returns the global Document object, only creating it if it doesn't already exist.

Document::getType() — Method in class Document

Returns the document type

Document::getBuffer() — Method in class Document

Get the contents of the document buffer

Document::getMetaData() — Method in class Document

Gets a meta tag.

Document::getScriptOptions() — Method in class Document

Get script(s) options

Document::getCharset() — Method in class Document

Returns the document charset encoding.

Document::getLanguage() — Method in class Document

Returns the document language.

Document::getDirection() — Method in class Document

Returns the document direction declaration.

Document::getTitle() — Method in class Document

Return the title of the document.

Document::getMediaVersion() — Method in class Document

Return the media version

Document::getPreloadManager() — Method in class Document

Return the preload manager

Document::getWebAssetManager() — Method in class Document

Return WebAsset manager

Document::getBase() — Method in class Document

Return the base URI of the document.

Document::getDescription() — Method in class Document

Return the description of the document.

Document::getLink() — Method in class Document

Returns the document base url

Document::getGenerator() — Method in class Document

Returns the document generator

Document::getModifiedDate() — Method in class Document

Returns the document modified date

Document::getMimeEncoding() — Method in class Document

Return the document MIME encoding that is sent to the browser.

DocumentAwareTrait::getDocument() — Method in class DocumentAwareTrait

Get the Document.

DocumentRenderer::getContentType() — Method in class DocumentRenderer

Return the content type of the renderer

$ FeedItem#guidProperty in class FeedItem

Guid element

HtmlDocument::getHeadData() — Method in class HtmlDocument

Get the HTML document head data

HtmlDocument::getBuffer() — Method in class HtmlDocument

Get the contents of a document include

HtmlDocument::getToolbar() — Method in class HtmlDocument

Returns a toolbar object or null

HtmlDocument::getToolbars() — Method in class HtmlDocument

Returns the toolbar array

JsonDocument::getName() — Method in class JsonDocument

Returns the document name

PreloadManager::getLinkProvider() — Method in class PreloadManager

Get the link provider

PreloadManagerInterface::getLinkProvider() — Method in class PreloadManagerInterface

Get the link provider

XmlDocument::getName() — Method in class XmlDocument

Returns the document name

AbstractEditorProvider::getButtons() — Method in class AbstractEditorProvider

Load the editor buttons.

Button::getButtonName() — Method in class Button

Return Button name, CMD string.

Button::get() — Method in class Button

Return Button property.

Button::getOptions() — Method in class Button

Return Button options.

ButtonInterface::getButtonName() — Method in class ButtonInterface

Return Button name, CMD string.

ButtonInterface::get() — Method in class ButtonInterface

Return Button property or null.

ButtonInterface::getOptions() — Method in class ButtonInterface

Return Button options.

ButtonsRegistry::getAll() — Method in class ButtonsRegistry

Return list of all registered elements

ButtonsRegistryInterface::getAll() — Method in class ButtonsRegistryInterface

Return list of all registered elements

Editor::getInstance() — Method in class Editor

Returns the global Editor object, only creating it if it doesn't already exist.

Editor::getButtons() — Method in class Editor

Get the editor extended buttons (usually from plugins)

EditorProviderInterface::getName() — Method in class EditorProviderInterface

Return Editor name, CMD string.

EditorProviderInterface::getButtons() — Method in class EditorProviderInterface

Load the editor buttons.

EditorsRegistry::getAll() — Method in class EditorsRegistry

Return list of all registered elements

EditorsRegistry::get() — Method in class EditorsRegistry

Return element by name.

EditorsRegistryInterface::get() — Method in class EditorsRegistryInterface

Return element by name.

EditorsRegistryInterface::getAll() — Method in class EditorsRegistryInterface

Return list of all registered elements

AbstractAES::getZeroPadding() — Method in class AbstractAES

Returns null bytes to append to the string so that it's zero padded to the specified block size

AesInterface::getBlockSize() — Method in class AesInterface

Returns the encryption block size in bytes

Mcrypt::getBlockSize() — Method in class Mcrypt

Get the block size

OpenSSL::getBlockSize() — Method in class OpenSSL

Returns the encryption block size in bytes

Aes::getExpandedKey() — Method in class Aes

Get the expanded key

RandValInterface::generate() — Method in class RandValInterface

Returns a cryptographically secure random value.

Randval::generate() — Method in class Randval

Returns a cryptographically secure random value.

Totp::getPeriod() — Method in class Totp

Get the time period based on the $time timestamp and the Time Step defined. If $time is skipped or set to null the current timestamp will be used.

Totp::getCode() — Method in class Totp

Gets the TOTP passcode for a given secret key $secret and a given UNIX timestamp $time

Totp::getUrl() — Method in class Totp

Returns a QR code URL for easy setup of TOTP apps like Google Authenticator

Totp::generateSecret() — Method in class Totp

Generates a (semi-)random Secret Key for TOTP generation

Browser::getInstance() — Method in class Browser

Returns the global Browser object, only creating it if it doesn't already exist.

Browser::getPlatform() — Method in class Browser

Return the currently matched platform.

Browser::getBrowser() — Method in class Browser

Retrieve the current browser.

Browser::getMajor() — Method in class Browser

Retrieve the current browser's major version.

Browser::getMinor() — Method in class Browser

Retrieve the current browser's minor version.

Browser::getVersion() — Method in class Browser

Retrieve the current browser's version.

Browser::getAgentString() — Method in class Browser

Return the full browser agent string.

Browser::getHTTPProtocol() — Method in class Browser

Returns the server protocol in use on the current server.

AbstractRenderer::getDocument() — Method in class AbstractRenderer

Retrieve the Document instance attached to this renderer

AbstractRenderer::getRenderer() — Method in class AbstractRenderer

Get a renderer instance for the given type

RendererInterface::getDocument() — Method in class RendererInterface

Retrieve the Document instance attached to this renderer

AbstractEvent::getArgument() — Method in class AbstractEvent

Get an event argument value.

AfterExtensionBootEvent::getExtensionType() — Method in class AfterExtensionBootEvent

Get the event's extension type. Can be:

  • component
AfterExtensionBootEvent::getExtensionName() — Method in class AfterExtensionBootEvent

Get the event's extension name.

AfterExtensionBootEvent::getContainer() — Method in class AfterExtensionBootEvent

Get the event's container object

ApplicationConfigurationEvent::getConfiguration() — Method in class ApplicationConfigurationEvent

Get the configuration object

ApplicationDocumentEvent::getDocument() — Method in class ApplicationDocumentEvent

Get the event's document object

ApplicationEvent::getApplication() — Method in class ApplicationEvent

Get the event's application object

BeforeApiRouteEvent::getRouter() — Method in class BeforeApiRouteEvent

Get the event's document object

BeforeExecuteEvent::getContainer() — Method in class BeforeExecuteEvent

Get the event's container object

DaemonReceiveSignalEvent::getSignal() — Method in class DaemonReceiveSignalEvent

Get the event's signal object

BeforeExtensionBootEvent::getExtensionType() — Method in class BeforeExtensionBootEvent

Get the event's extension type. Can be:

  • component
BeforeExtensionBootEvent::getExtensionName() — Method in class BeforeExtensionBootEvent

Get the event's extension name.

BeforeExtensionBootEvent::getContainer() — Method in class BeforeExtensionBootEvent

Get the event's container object

AfterPurgeEvent::getGroup() — Method in class AfterPurgeEvent

Getter for the group.

CaptchaSetupEvent::getCaptchaRegistry() — Method in class CaptchaSetupEvent

Returns Captcha Registry instance.

AfterCheckinEvent::getTableName() — Method in class AfterCheckinEvent

Getter for the table name.

SubmitContactEvent::getContact() — Method in class SubmitContactEvent

Getter for the contact.

SubmitContactEvent::getData() — Method in class SubmitContactEvent

Getter for the data.

ValidateContactEvent::getContact() — Method in class ValidateContactEvent

Getter for the contact.

ValidateContactEvent::getData() — Method in class ValidateContactEvent

Getter for the data.

ContentEvent::getContext() — Method in class ContentEvent

Getter for the context argument.

ContentPrepareEvent::getItem() — Method in class ContentPrepareEvent

Getter for the item argument.

ContentPrepareEvent::getParams() — Method in class ContentPrepareEvent

Getter for the item argument.

ContentPrepareEvent::getPage() — Method in class ContentPrepareEvent

Getter for the page argument.

CoreEventAware::getEventClassByEventName() — Method in class CoreEventAware

Get the concrete event class name for the given event name.

AbstractPrepareFieldEvent::getField() — Method in class AbstractPrepareFieldEvent

Getter for the field.

AbstractPrepareFieldEvent::getContext() — Method in class AbstractPrepareFieldEvent

Getter for the context.

AbstractPrepareFieldEvent::getItem() — Method in class AbstractPrepareFieldEvent

Getter for the item.

AfterPrepareFieldEvent::getValue() — Method in class AfterPrepareFieldEvent

Getter for the value.

GetTypesEventClass in namespace Joomla\CMS\Event\CustomFields

Class for CustomFields events

PrepareDomEvent::getField() — Method in class PrepareDomEvent

Getter for the field.

PrepareDomEvent::getFieldset() — Method in class PrepareDomEvent

Getter for the fieldset.

PrepareDomEvent::getForm() — Method in class PrepareDomEvent

Getter for the form.

EditorButtonsSetupEvent::getButtonsRegistry() — Method in class EditorButtonsSetupEvent

Returns Buttons Registry instance.

EditorButtonsSetupEvent::getEditorType() — Method in class EditorButtonsSetupEvent

Getter for the Editor Type argument.

EditorButtonsSetupEvent::getDisabledButtons() — Method in class EditorButtonsSetupEvent

Getter for the disabled buttons argument.

EditorButtonsSetupEvent::getEditorId() — Method in class EditorButtonsSetupEvent

Getter for the Editor ID argument.

EditorButtonsSetupEvent::getAsset() — Method in class EditorButtonsSetupEvent

Getter for the asset argument.

EditorButtonsSetupEvent::getAuthor() — Method in class EditorButtonsSetupEvent

Getter for the author argument.

EditorSetupEvent::getEditorsRegistry() — Method in class EditorSetupEvent

Returns Editors Registry instance.

ErrorEvent::getApplication() — Method in class ErrorEvent

Get the event's application object

ErrorEvent::getError() — Method in class ErrorEvent

Get the event's error object

AfterInstallEvent::getInstaller() — Method in class AfterInstallEvent

Getter for the installer.

AfterInstallEvent::getEid() — Method in class AfterInstallEvent

Getter for the eid.

AfterJoomlaUpdateEvent::getOldVersion() — Method in class AfterJoomlaUpdateEvent

Getter for the oldVersion.

AfterUninstallEvent::getInstaller() — Method in class AfterUninstallEvent

Getter for the installer.

AfterUninstallEvent::getEid() — Method in class AfterUninstallEvent

Getter for the eid.

AfterUninstallEvent::getRemoved() — Method in class AfterUninstallEvent

Getter for the removed.

AfterUpdateEvent::getInstaller() — Method in class AfterUpdateEvent

Getter for the installer.

AfterUpdateEvent::getEid() — Method in class AfterUpdateEvent

Getter for the eid.

BeforeInstallEvent::getMethod() — Method in class BeforeInstallEvent

Getter for the method.

BeforeInstallEvent::getType() — Method in class BeforeInstallEvent

Getter for the type.

BeforeInstallEvent::getManifest() — Method in class BeforeInstallEvent

Getter for the manifest.

BeforeInstallEvent::getExtension() — Method in class BeforeInstallEvent

Getter for the extension.

BeforeUninstallEvent::getEid() — Method in class BeforeUninstallEvent

Getter for the eid.

BeforeUpdateEvent::getType() — Method in class BeforeUpdateEvent

Getter for the type.

BeforeUpdateEvent::getManifest() — Method in class BeforeUpdateEvent

Getter for the manifest.

GarbageCollectionEventClass in namespace Joomla\CMS\Event\Finder

Class for Finder events.

PrepareContentEvent::getItem() — Method in class PrepareContentEvent

Getter for the item.

ResultEvent::getItem() — Method in class ResultEvent

Getter for the item.

ResultEvent::getQuery() — Method in class ResultEvent

Getter for the query.

GenericEventClass in namespace Joomla\CMS\Event

This class gives a concrete implementation of the AbstractEvent class.

AfterInstallerEvent::getInstaller() — Method in class AfterInstallerEvent

Getter for the installer.

AfterInstallerEvent::getInstallerResult() — Method in class AfterInstallerEvent

Getter for the installer result.

AfterInstallerEvent::getMessage() — Method in class AfterInstallerEvent

Getter for the message.

BeforePackageDownloadEvent::getUrl() — Method in class BeforePackageDownloadEvent

Getter for the url.

BeforePackageDownloadEvent::getHeaders() — Method in class BeforePackageDownloadEvent

Getter for the headers.

InstallerEvent::getModel() — Method in class InstallerEvent

Getter for the model.

InstallerEvent::getPackage() — Method in class InstallerEvent

Getter for the package.

MailTemplateEvent::getTemplate() — Method in class MailTemplateEvent

Getter for the subject argument.

MailTemplateEvent::getTemplateId() — Method in class MailTemplateEvent

Getter for the templateId argument.

AfterGetMenuTypeOptionsEvent::getModel() — Method in class AfterGetMenuTypeOptionsEvent

Getter for the model.

AfterGetMenuTypeOptionsEvent::getItems() — Method in class AfterGetMenuTypeOptionsEvent

Getter for the items.

BeforeRenderMenuItemsViewEvent::getView() — Method in class BeforeRenderMenuItemsViewEvent

Getter for the view.

PreprocessMenuItemsEvent::getContext() — Method in class PreprocessMenuItemsEvent

Getter for the context.

PreprocessMenuItemsEvent::getItems() — Method in class PreprocessMenuItemsEvent

Getter for the items.

PreprocessMenuItemsEvent::getParams() — Method in class PreprocessMenuItemsEvent

Getter for the params.

PreprocessMenuItemsEvent::getEnabled() — Method in class PreprocessMenuItemsEvent

Getter for the enabled.

AfterCategoryChangeStateEvent::getExtension() — Method in class AfterCategoryChangeStateEvent

Getter for the extension.

AfterCleanCacheEvent::getDefaultGroup() — Method in class AfterCleanCacheEvent

Getter for the defaultgroup.

AfterCleanCacheEvent::getCacheBase() — Method in class AfterCleanCacheEvent

Getter for the cachebase.

AfterCleanCacheEvent::getResult() — Method in class AfterCleanCacheEvent

Getter for the result.

ChangeStateEvent::getPks() — Method in class ChangeStateEvent

Getter for the list of primary keys.

ChangeStateEvent::getValue() — Method in class ChangeStateEvent

Getter for the value state.

DeleteEvent::getItem() — Method in class DeleteEvent

Getter for the item.

FormEvent::getContext() — Method in class FormEvent

Getter for the context argument.

FormEvent::getForm() — Method in class FormEvent

Getter for the form.

FormEvent::getData() — Method in class FormEvent

Getter for the data.

ModelEvent::getContext() — Method in class ModelEvent

Getter for the context argument.

PrepareDataEvent::getData() — Method in class PrepareDataEvent

Getter for the data.

SaveEvent::getItem() — Method in class SaveEvent

Getter for the item.

SaveEvent::getIsNew() — Method in class SaveEvent

Getter for the isNew state.

SaveEvent::getData() — Method in class SaveEvent

Getter for the data.

AfterRenderModulesEvent::getContent() — Method in class AfterRenderModulesEvent

Getter for the content.

AfterRenderModulesEvent::getAttributes() — Method in class AfterRenderModulesEvent

Getter for the attributes argument.

ModuleListEvent::getModules() — Method in class ModuleListEvent

Getter for the subject argument.

RenderModuleEvent::getModule() — Method in class RenderModuleEvent

Getter for the subject argument.

RenderModuleEvent::getAttributes() — Method in class RenderModuleEvent

Getter for the attributes argument.

GetMethodClass in namespace Joomla\CMS\Event\MultiFactor

Concrete Event class for the onUserMultifactorGetMethod event

GetSetupClass in namespace Joomla\CMS\Event\MultiFactor

Concrete Event class for the onUserMultifactorGetSetup event

GetKeyEventClass in namespace Joomla\CMS\Event\PageCache

Class for PageCache events

AjaxEvent::getApplication() — Method in class AjaxEvent

Get the event's application object

AjaxEvent::getEventResult() — Method in class AjaxEvent

Get the event result.

BeforeCompileHeadEvent::getSchema() — Method in class BeforeCompileHeadEvent

Getter for the schema argument.

BeforeCompileHeadEvent::getContext() — Method in class BeforeCompileHeadEvent

Getter for the context argument.

PrepareDataEvent::getData() — Method in class PrepareDataEvent

Getter for the data argument.

PrepareDataEvent::getContext() — Method in class PrepareDataEvent

Getter for the context argument.

PrepareFormEvent::getForm() — Method in class PrepareFormEvent

Getter for the form argument.

PrepareSaveEvent::getData() — Method in class PrepareSaveEvent

Getter for the data argument.

PrepareSaveEvent::getContext() — Method in class PrepareSaveEvent

Getter for the context argument.

PrepareSaveEvent::getItem() — Method in class PrepareSaveEvent

Getter for the item argument.

PrepareSaveEvent::getIsNew() — Method in class PrepareSaveEvent

Getter for the isNew argument.

PrepareSaveEvent::getSchema() — Method in class PrepareSaveEvent

Getter for the schema argument.

GetStatsDataEventClass in namespace Joomla\CMS\Event\Plugin\System\Stats

Class for Stats plugin.

GetStatsDataEvent::getContext() — Method in class GetStatsDataEvent

Getter for the context argument.

CanRemoveDataEvent::getRequest() — Method in class CanRemoveDataEvent

Getter for the request.

CanRemoveDataEvent::getUser() — Method in class CanRemoveDataEvent

Getter for the user.

CheckPrivacyPolicyPublishedEvent::getPolicyInfo() — Method in class CheckPrivacyPolicyPublishedEvent

Getter for the policy check.

ExportRequestEvent::getRequest() — Method in class ExportRequestEvent

Getter for the request.

ExportRequestEvent::getUser() — Method in class ExportRequestEvent

Getter for the user.

RemoveDataEvent::getRequest() — Method in class RemoveDataEvent

Getter for the request.

RemoveDataEvent::getUser() — Method in class RemoveDataEvent

Getter for the user.

GetIconEventClass in namespace Joomla\CMS\Event\QuickIcon

Event class for the onGetIcon event.

GetOverviewEventClass in namespace Joomla\CMS\Event\SampleData

Cass for Sample data events

AbstractDeleteEvent::getUser() — Method in class AbstractDeleteEvent

Getter for the user.

AbstractLoginEvent::getAuthenticationResponse() — Method in class AbstractLoginEvent

Getter for the response.

AbstractLoginEvent::getOptions() — Method in class AbstractLoginEvent

Getter for the options.

AbstractLogoutEvent::getParameters() — Method in class AbstractLogoutEvent

Getter for the parameters.

AbstractLogoutEvent::getOptions() — Method in class AbstractLogoutEvent

Getter for the options.

AbstractResetEvent::getUser() — Method in class AbstractResetEvent

Getter for the user.

AbstractSaveEvent::getUser() — Method in class AbstractSaveEvent

Getter for the user.

AbstractSaveEvent::getIsNew() — Method in class AbstractSaveEvent

Getter for the isNew state.

AfterDeleteEvent::getDeletingResult() — Method in class AfterDeleteEvent

Getter for the deleting result.

AfterDeleteEvent::getErrorMessage() — Method in class AfterDeleteEvent

Getter for the error message.

AfterRemindEvent::getUser() — Method in class AfterRemindEvent

Getter for the user.

AfterSaveEvent::getSavingResult() — Method in class AfterSaveEvent

Getter for the saving result.

AfterSaveEvent::getErrorMessage() — Method in class AfterSaveEvent

Getter for the error message.

AuthenticationEvent::getAuthenticationResponse() — Method in class AuthenticationEvent

Getter for the response.

AuthenticationEvent::getCredentials() — Method in class AuthenticationEvent

Getter for the credentials.

AuthenticationEvent::getOptions() — Method in class AuthenticationEvent

Getter for the options.

AuthorisationEvent::getAuthenticationResponse() — Method in class AuthorisationEvent

Getter for the response.

AuthorisationEvent::getOptions() — Method in class AuthorisationEvent

Getter for the options.

AuthorisationFailureEvent::getAuthenticationResponse() — Method in class AuthorisationFailureEvent

Getter for the response.

AuthorisationFailureEvent::getOptions() — Method in class AuthorisationFailureEvent

Getter for the options.

BeforeSaveEvent::getData() — Method in class BeforeSaveEvent

Getter for the data.

LoginButtonsEvent::getFormId() — Method in class LoginButtonsEvent

Getter for the formId.

WebAssetRegistryAssetChanged::getAsset() — Method in class WebAssetRegistryAssetChanged

Return modified asset

WebAssetRegistryAssetChanged::getAssetType() — Method in class WebAssetRegistryAssetChanged

Return a type of modified asset

WebAssetRegistryAssetChanged::getChange() — Method in class WebAssetRegistryAssetChanged

Return a type of changes: new, remove, override

Component::getDispatcher() — Method in class Component

Returns the dispatcher for the given application.

ComponentInterface::getDispatcher() — Method in class ComponentInterface

Returns the dispatcher for the given application.

ExtensionHelper::getCoreExtensions() — Method in class ExtensionHelper

Gets the core extensions.

ExtensionHelper::getCoreExtensionIds() — Method in class ExtensionHelper

Returns an array of core extension IDs.

ExtensionHelper::getExtensionRecord() — Method in class ExtensionHelper

Returns an extension record for the given name.

ExtensionManagerTrait::getContainer() — Method in class ExtensionManagerTrait

Get the DI container.

LegacyComponent::getDispatcher() — Method in class LegacyComponent

Returns the dispatcher for the given application.

LegacyComponent::getMVCFactory() — Method in class LegacyComponent

Get the factory.

LegacyComponent::getCategory() — Method in class LegacyComponent

Returns the category service.

LegacyComponent::getContexts() — Method in class LegacyComponent

Returns valid contexts.

Module::getDispatcher() — Method in class Module

Returns the dispatcher for the given application, module and input.

Module::getHelper() — Method in class Module

Returns a helper instance for the given name.

ModuleInterface::getDispatcher() — Method in class ModuleInterface

Returns the dispatcher for the given application, module and input.

Factory::getApplication() — Method in class Factory

Get the global application object. When the global application doesn't exist, an exception is thrown.

Factory::getConfig() — Method in class Factory

Get a configuration object

Factory::getContainer() — Method in class Factory

Get a container object

Factory::getSession() — Method in class Factory

Get a session object.

Factory::getLanguage() — Method in class Factory

Get a language object.

Factory::getDocument() — Method in class Factory

Get a document object.

Factory::getUser() — Method in class Factory

Get a user object.

Factory::getCache() — Method in class Factory

Get a cache object

Factory::getDbo() — Method in class Factory

Get a database object.

Factory::getMailer() — Method in class Factory

Get a mailer object.

Factory::getDate() — Method in class Factory

Return the Date object

Factory::getStream() — Method in class Factory

Creates a new stream object with appropriate prefix

$ Feed#generatorProperty in class Feed

A string indicating the program used to generate the feed.

FeedFactory::getFeed() — Method in class FeedFactory

Method to load a URI into the feed reader for parsing.

FeedFactory::getParsers() — Method in class FeedFactory

Method to get the registered Parsers

FieldsServiceInterface::getContexts() — Method in class FieldsServiceInterface

Returns valid contexts.

File::getExt() — Method in class File

Gets the extension of a file name

FilesystemHelper::getWriteModes() — Method in class FilesystemHelper

Modes that require a write operation

FilesystemHelper::getSupported() — Method in class FilesystemHelper

Stream and Filter Support Operations

FilesystemHelper::getTransports() — Method in class FilesystemHelper

Returns a list of transports

FilesystemHelper::getFilters() — Method in class FilesystemHelper

Returns a list of filters

FilesystemHelper::getJStreams() — Method in class FilesystemHelper

Returns a list of J! streams

Patcher::getInstance() — Method in class Patcher

Method to get a patcher

Patcher::getSource() — Method in class Patcher

Get the lines of a source file

Patcher::getDestination() — Method in class Patcher

Get the lines of a destination file

Stream::gets() — Method in class Stream

Get a line from the stream source.

Stream::get_meta_data() — Method in class Stream

Get the stream metadata

Stream::getFileHandle() — Method in class Stream

Return the internal file handle

StringController::getRef() — Method in class StringController

Get reference

InputFilter::getInstance() — Method in class InputFilter

Returns an input filter object, only creating it if it doesn't already exist.

AccesslevelField::getOptions() — Method in class AccesslevelField

Method to get the field options.

AliastagField::getOptions() — Method in class AliastagField

Method to get a list of options for a list input.

AuthorField::getOptions() — Method in class AuthorField

Method to get the options to populate list

CachehandlerField::getOptions() — Method in class CachehandlerField

Method to get the field options.

CalendarField::getInput() — Method in class CalendarField

Method to get the field input markup.

CalendarField::getLayoutData() — Method in class CalendarField

Method to get the data to be passed to the layout for rendering.

CaptchaField::getInput() — Method in class CaptchaField

Method to get the field input.

CategoryField::getOptions() — Method in class CategoryField

Method to get the field options for category Use the extension attribute in a form to specify the.specific extension for which categories should be displayed.

CheckboxField::getLayoutData() — Method in class CheckboxField

Method to get the data to be passed to the layout for rendering.

CheckboxesField::getInput() — Method in class CheckboxesField

Method to get the radio button field input markup.

CheckboxesField::getLayoutData() — Method in class CheckboxesField

Method to get the data to be passed to the layout for rendering.

ChromestyleField::getGroups() — Method in class ChromestyleField

Method to get the list of template chrome style options grouped by template.

ChromestyleField::getTemplateModuleStyles() — Method in class ChromestyleField

Method to get the templates module styles.

ChromestyleField::getTemplates() — Method in class ChromestyleField

Return a list of templates

ColorField::getInput() — Method in class ColorField

Method to get the field input markup.

ColorField::getLayoutData() — Method in class ColorField

Method to get the data to be passed to the layout for rendering.

ColorField::getSimpleModeLayoutData() — Method in class ColorField

Method to get the data for the simple mode to be passed to the layout for rendering.

ColorField::getAdvancedModeLayoutData() — Method in class ColorField

Method to get the data for the advanced mode to be passed to the layout for rendering.

ColorField::getSliderModeLayoutData() — Method in class ColorField

Method to get the data for the slider

ComboField::getInput() — Method in class ComboField

Method to get the field input markup for a combo box field.

ComboField::getLayoutData() — Method in class ComboField

Method to get the data to be passed to the layout for rendering.

ComponentlayoutField::getInput() — Method in class ComponentlayoutField

Method to get the field input for a component layout field.

ComponentsField::getOptions() — Method in class ComponentsField

Method to get a list of options for a list input.

ContenthistoryField::getLayoutData() — Method in class ContenthistoryField

Get the data that is going to be passed to the layout

ContenthistoryField::getInput() — Method in class ContenthistoryField

Method to get the content history field input markup.

ContentlanguageField::getOptions() — Method in class ContentlanguageField

Method to get the field options for content languages.

ContenttypeField::getInput() — Method in class ContenttypeField

Method to get the field input for a list of content types.

ContenttypeField::getOptions() — Method in class ContenttypeField

Method to get a list of content types

DatabaseconnectionField::getOptions() — Method in class DatabaseconnectionField

Method to get the list of database options.

EditorField::getInput() — Method in class EditorField

Method to get the field input markup for the editor area

EditorField::getEditor() — Method in class EditorField

Method to get an Editor object based on the form field.

EmailField::getInput() — Method in class EmailField

Method to get the field input markup for email addresses.

EmailField::getLayoutData() — Method in class EmailField

Method to get the data to be passed to the layout for rendering.

FileField::getInput() — Method in class FileField

Method to get the field input markup for the file field.

FileField::getLayoutData() — Method in class FileField

Method to get the data to be passed to the layout for rendering.

FilelistField::getOptions() — Method in class FilelistField

Method to get the list of files for the field options.

FolderlistField::getOptions() — Method in class FolderlistField

Method to get the field options.

FrontendlanguageField::getOptions() — Method in class FrontendlanguageField

Method to get the field options for frontend published content languages with homes.

GroupedlistFieldClass in namespace Joomla\CMS\Form\Field

Form Field class for the Joomla Platform.

GroupedlistField::getGroups() — Method in class GroupedlistField

Method to get the field option groups.

GroupedlistField::getInput() — Method in class GroupedlistField

Method to get the field input markup for a grouped list.

HeadertagField::getOptions() — Method in class HeadertagField

Method to get the field options.

ImagelistField::getOptions() — Method in class ImagelistField

Method to get the list of images field options.

IntegerField::getOptions() — Method in class IntegerField

Method to get the field options.

LanguageField::getOptions() — Method in class LanguageField

Method to get the field options.

LimitboxField::getOptions() — Method in class LimitboxField

Method to get the options to populate to populate list

ListField::getInput() — Method in class ListField

Method to get the field input markup for a generic list.

ListField::getOptions() — Method in class ListField

Method to get the field options.

MediaField::getInput() — Method in class MediaField

Method to get the field input markup for a media selector.

MediaField::getLayoutData() — Method in class MediaField

Get the data that is going to be passed to the layout

MenuField::getGroups() — Method in class MenuField

Method to get the field option groups.

MenuitemField::getGroups() — Method in class MenuitemField

Method to get the field option groups.

MeterField::getInput() — Method in class MeterField

Method to get the field input markup.

MeterField::getLayoutData() — Method in class MeterField

Method to get the data to be passed to the layout for rendering.

ModalSelectField::getInput() — Method in class ModalSelectField

Method to get the field input markup.

ModalSelectField::getValueTitle() — Method in class ModalSelectField

Method to retrieve the title of selected item.

ModalSelectField::getLayoutData() — Method in class ModalSelectField

Method to get the data to be passed to the layout for rendering.

ModulelayoutField::getInput() — Method in class ModulelayoutField

Method to get the field input for module layouts.

ModuleorderField::getInput() — Method in class ModuleorderField

Method to get the field input markup for the moduleorder field.

ModuleorderField::getLayoutData() — Method in class ModuleorderField

Method to get the data to be passed to the layout for rendering.

ModulepositionField::getInput() — Method in class ModulepositionField

Method to get the field input markup.

ModuletagField::getOptions() — Method in class ModuletagField

Method to get the field options.

NoteField::getLabel() — Method in class NoteField

Method to get the field label markup.

NoteField::getInput() — Method in class NoteField

Method to get the field input markup.

NumberField::getInput() — Method in class NumberField

Method to get the field input markup.

NumberField::getLayoutData() — Method in class NumberField

Method to get the data to be passed to the layout for rendering.

OrderingField::getInput() — Method in class OrderingField

Method to get the field input markup.

OrderingField::getQuery() — Method in class OrderingField

Builds the query for the ordering list.

OrderingField::getItemId() — Method in class OrderingField

Retrieves the current Item's Id.

PasswordField::getInput() — Method in class PasswordField

Method to get the field input markup for password.

PasswordField::getLayoutData() — Method in class PasswordField

Method to get the data to be passed to the layout for rendering.

PluginsField::getOptions() — Method in class PluginsField

Method to get a list of options for a list input.

PredefinedlistField::getOptions() — Method in class PredefinedlistField

Method to get the options to populate list

RadioField::getLayoutData() — Method in class RadioField

Method to get the data to be passed to the layout for rendering.

RadiobasicField::getInput() — Method in class RadiobasicField

Method to get the radio button field input markup.

RadiobasicField::getLayoutData() — Method in class RadiobasicField

Method to get the data to be passed to the layout for rendering.

RangeField::getInput() — Method in class RangeField

Method to get the field input markup.

RangeField::getLayoutData() — Method in class RangeField

Method to get the data to be passed to the layout for rendering.

$ RulesField#groupsProperty in class RulesField

The groups

RulesField::getInput() — Method in class RulesField

Method to get the field input markup for Access Control Lists.

RulesField::getLayoutData() — Method in class RulesField

Method to get the data to be passed to the layout for rendering.

RulesField::getUserGroups() — Method in class RulesField

Get a list of the user groups.

SchemaorgComponentSectionsField::getOptions() — Method in class SchemaorgComponentSectionsField

Method to get a list of options for a list input.

SessionhandlerField::getOptions() — Method in class SessionhandlerField

Method to get the session handler field options.

SpacerField::getInput() — Method in class SpacerField

Method to get the field input markup for a spacer.

SpacerField::getLabel() — Method in class SpacerField

Method to get the field label markup for a spacer.

SpacerField::getTitle() — Method in class SpacerField

Method to get the field title.

SqlField::getOptions() — Method in class SqlField

Method to get the custom field options.

$ SubformField#groupByFieldsetProperty in class SubformField

Whether group subform fields by it`s fieldset

SubformField::getInput() — Method in class SubformField

Method to get the field input markup.

SubformField::getName() — Method in class SubformField

Method to get the name used for the field input tag.

TagField::getInput() — Method in class TagField

Method to get the field input for a tag field.

TagField::getOptions() — Method in class TagField

Method to get a list of tags

TelephoneField::getInput() — Method in class TelephoneField

Method to get the field input markup.

TelephoneField::getLayoutData() — Method in class TelephoneField

Method to get the data to be passed to the layout for rendering.

TemplatestyleField::getGroups() — Method in class TemplatestyleField

Method to get the list of template style options grouped by template.

TextField::getInput() — Method in class TextField

Method to get the field input markup.

TextField::getOptions() — Method in class TextField

Method to get the field options.

TextField::getLayoutData() — Method in class TextField

Method to get the data to be passed to the layout for rendering.

TextareaField::getInput() — Method in class TextareaField

Method to get the textarea field input markup.

TextareaField::getLayoutData() — Method in class TextareaField

Method to get the data to be passed to the layout for rendering.

TimeField::getInput() — Method in class TimeField

Method to get the field input markup.

TimeField::getLayoutData() — Method in class TimeField

Method to get the data to be passed to the layout for rendering.

TimezoneField::getGroups() — Method in class TimezoneField

Method to get the time zone field option groups.

TransitionField::getGroups() — Method in class TransitionField

Method to get a list of options for a list input.

UrlField::getInput() — Method in class UrlField

Method to get the field input markup.

UrlField::getLayoutData() — Method in class UrlField

Method to get the data to be passed to the layout for rendering.

$ UserField#groupsProperty in class UserField

Filtering groups

UserField::getInput() — Method in class UserField

Method to get the user field input markup.

UserField::getLayoutData() — Method in class UserField

Get the data that is going to be passed to the layout

UserField::getGroups() — Method in class UserField

Method to get the filtering groups (null means no filtering)

UserField::getExcluded() — Method in class UserField

Method to get the users to exclude from the list of users

UsergrouplistField::getOptions() — Method in class UsergrouplistField

Method to get the options to populate list

WorkflowComponentSectionsField::getOptions() — Method in class WorkflowComponentSectionsField

Method to get a list of options for a list input.

WorkflowconditionField::getOptions() — Method in class WorkflowconditionField

Method to get the field options.

WorkflowstageField::getGroups() — Method in class WorkflowstageField

Method to get the field option groups.

Form::getErrors() — Method in class Form

Return Exceptions thrown during the form validation process.

Form::getField() — Method in class Form

Method to get a form field represented as a FormField object.

Form::getFieldAttribute() — Method in class Form

Method to get an attribute value from a field XML element. If the attribute doesn't exist or is null then the optional default value will be used.

Form::getFieldset() — Method in class Form

Method to get an array of FormField objects in a given fieldset by name. If no name is given then all fields are returned.

Form::getFieldsets() — Method in class Form

Method to get an array of fieldset objects optionally filtered over a given field group.

Form::getFormControl() — Method in class Form

Method to get the form control. This string serves as a container for all form fields. For example, if there is a field named 'foo' and a field named 'bar' and the form control is empty the fields will be rendered like: <input name="foo" /> and <input name="bar" />. If the form control is set to 'joomla' however, the fields would be rendered like: <input name="joomla[foo]" /> and <input name="joomla[bar]" />.

Form::getGroup() — Method in class Form

Method to get an array of FormField objects in a given field group by name.

Form::getInput() — Method in class Form

Method to get a form field markup for the field input.

Form::getLabel() — Method in class Form

Method to get the label for a field input.

Form::getName() — Method in class Form

Method to get the form name.

Form::getValue() — Method in class Form

Method to get the value of a field.

Form::getInstance() — Method in class Form

Method to get an instance of a form.

Form::getAttribute() — Method in class Form

Returns the value of an attribute of the form itself

Form::getData() — Method in class Form

Getter for the form data

Form::getXml() — Method in class Form

Method to get the XML form object

Form::getFieldXml() — Method in class Form

Method to get a form field represented as an XML element object.

Form::getControlFields() — Method in class Form

Return array of control fields

FormFactoryAwareTrait::getFormFactory() — Method in class FormFactoryAwareTrait

Get the FormFactoryInterface.

$ FormField#groupProperty in class FormField

The group of the field.

$ FormField#generated_fieldnameProperty in class FormField

The string used for generated fields names

FormField::getId() — Method in class FormField

Method to get the id used for the field input tag.

FormField::getInput() — Method in class FormField

Method to get the field input markup.

FormField::getTitle() — Method in class FormField

Method to get the field title.

FormField::getLabel() — Method in class FormField

Method to get the field label markup.

FormField::getName() — Method in class FormField

Method to get the name used for the field input tag.

FormField::getFieldName() — Method in class FormField

Method to get the field name used.

FormField::getAttribute() — Method in class FormField

Method to get an attribute of the field

FormField::getDataAttributes() — Method in class FormField

Method to get data attributes. For example, data-user-type

FormField::getLayoutData() — Method in class FormField

Method to get the data to be passed to the layout for rendering.

FormField::getLayoutPaths() — Method in class FormField

Allow to override renderer include paths in child fields

FormField::getRenderer() — Method in class FormField

Get the renderer

RulesRule::getValueActions() — Method in class RulesRule

Method to get the list of permission action names from the form field value.

RulesRule::getFieldActions() — Method in class RulesRule

Method to get the list of possible permission action names for the form field.

HTMLHelper::getServiceRegistry() — Method in class HTMLHelper

Retrieves the service registry.

HTMLRegistryAwareTrait::getRegistry() — Method in class HTMLRegistryAwareTrait

Get the registry.

GridClass in namespace Joomla\CMS\HTML\Helpers

Utility class for creating HTML Grids

ListHelper::genericordering() — Method in class ListHelper

Returns an array of options

Select::genericlist() — Method in class Select

Generates an HTML selection list.

Select::groupedlist() — Method in class Select

Generates a grouped HTML selection list from nested arrays.

Sidebar::getEntries() — Method in class Sidebar

Returns an array of all submenu entries

Sidebar::getFilters() — Method in class Sidebar

Returns an array of all filters

Sidebar::getAction() — Method in class Sidebar

Get value for the action attribute of the filter form

User::groups() — Method in class User

Displays a list of user groups.

Registry::getService() — Method in class Registry

Get the service for a given key

AuthenticationHelper::getTwoFactorMethods() — Method in class AuthenticationHelper

No longer used

AuthenticationHelper::getLoginButtons() — Method in class AuthenticationHelper

Get additional login buttons to add in a login module. These buttons can be used for authentication methods external to Joomla such as WebAuthn, login with social media providers, login with third party providers or even login with third party Single Sign On (SSO) services.

CMSHelper::getCurrentLanguage() — Method in class CMSHelper

Gets the current language

CMSHelper::getLanguageId() — Method in class CMSHelper

Gets the associated language ID

CMSHelper::getRowData() — Method in class CMSHelper

Gets a row of data from a table

CMSHelper::getDataObject() — Method in class CMSHelper

Method to get an object containing all of the table columns and values.

ContentHelper::getActions() — Method in class ContentHelper

Gets a list of the actions that can be performed.

ContentHelper::getCurrentLanguage() — Method in class ContentHelper

Gets the current language

ContentHelper::getLanguageId() — Method in class ContentHelper

Gets the associated language ID

ContentHelper::getRowData() — Method in class ContentHelper

Gets a row of data from a table

HelperFactory::getHelper() — Method in class HelperFactory

Returns a helper instance for the given name.

HelperFactoryAwareTrait::getHelperFactory() — Method in class HelperFactoryAwareTrait

Get the HelperFactory.

HelperFactoryInterface::getHelper() — Method in class HelperFactoryInterface

Returns a helper instance for the given name.

LibraryHelper::getLibrary() — Method in class LibraryHelper

Get the library information.

LibraryHelper::getParams() — Method in class LibraryHelper

Gets the parameter object for the library

MediaHelper::getTypeIcon() — Method in class MediaHelper

Gets the file extension for purposed of using an icon

MediaHelper::getMimeType() — Method in class MediaHelper

Get the Mime type

MediaHelper::getCleanMediaFieldValue() — Method in class MediaHelper

Helper method get clean data for value stores in a Media form field by removing adapter information from the value if available (in this case, the value will have this format: images/headers/blue-flower.jpg#joomlaImage://local-images/headers/blue-flower.jpg?width=700&height=180)

ModuleHelper::getModule() — Method in class ModuleHelper

Get module by name (real, eg 'Breadcrumbs' or folder, eg 'mod_breadcrumbs')

ModuleHelper::getModules() — Method in class ModuleHelper

Get modules by position

ModuleHelper::getLayoutPath() — Method in class ModuleHelper

Get the path to a layout for a module

ModuleHelper::getModuleList() — Method in class ModuleHelper

Module list

ModuleHelper::getModuleById() — Method in class ModuleHelper

Get module by id

RouteHelper::getRoute() — Method in class RouteHelper

A method to get the route for a specific item

RouteHelper::getCategoryRoute() — Method in class RouteHelper

Fetches the category route

TagsHelper::getItemTags() — Method in class TagsHelper

Method to get a list of tags for an item, optionally with the tag data.

TagsHelper::getMultipleItemTags() — Method in class TagsHelper

Method to get a list of tags for multiple items, optionally with the tag data.

TagsHelper::getTagIds() — Method in class TagsHelper

Method to get a list of tags for a given item.

TagsHelper::getTagItemsQuery() — Method in class TagsHelper

Method to get a query to retrieve a detailed list of items for a tag.

TagsHelper::getTagNames() — Method in class TagsHelper

Function that converts tag ids to their tag names

TagsHelper::getTagTreeArray() — Method in class TagsHelper

Method to get an array of tag ids for the current tag and its children

TagsHelper::getTypes() — Method in class TagsHelper

Method to get a list of types with associated data.

TagsHelper::getTags() — Method in class TagsHelper

Function that converts tag ids to their tag id and tag names

UserGroupsHelper::getInstance() — Method in class UserGroupsHelper

Get the helper instance.

UserGroupsHelper::get() — Method in class UserGroupsHelper

Get a user group by its id.

UserGroupsHelper::getAll() — Method in class UserGroupsHelper

Get the list of existing user groups.

HttpFactory::getHttp() — Method in class HttpFactory

Method to create a JHttp instance.

HttpFactory::getAvailableDriver() — Method in class HttpFactory

Finds an available http transport object for communication

HttpFactory::getHttpTransports() — Method in class HttpFactory

Get the http transport handlers

CurlTransport::getResponse() — Method in class CurlTransport

Method to get a response object from a server response.

SocketTransport::getResponse() — Method in class SocketTransport

Method to get a response object from a server response.

StreamTransport::getResponse() — Method in class StreamTransport

Method to get a response object from a server response.

GrayscaleClass in namespace Joomla\CMS\Image\Filter

Image Filter class to transform an image to grayscale.

$ Image#generateBestQualityProperty in class Image
Image::getHandle() — Method in class Image

Get the image resource handle

Image::getImageFileProperties() — Method in class Image

Method to return a properties object for an image given a filesystem path.

Image::getOrientation() — Method in class Image

Method to detect whether an image's orientation is landscape, portrait or square.

Image::generateThumbs() — Method in class Image

Method to generate thumbnails from the current image. It allows creation by resizing or cropping the original image.

Image::getHeight() — Method in class Image

Method to get the height of the image in pixels.

Image::getWidth() — Method in class Image

Method to get the width of the image in pixels.

Image::getPath() — Method in class Image

Method to return the path

Image::getFilterInstance() — Method in class Image

Method to get an image filter instance of a specified type.

Files::get() — Method in class Files

Gets a value from the input data.

$ Input#getProperty in class Input
Input::getArray() — Method in class Input

Gets an array of values from the request.

Input::getArrayRecursive() — Method in class Input

Gets an array of values from the request.

Json::getRaw() — Method in class Json

Gets the raw JSON string from the request.

ComponentAdapter::getElement() — Method in class ComponentAdapter

Get the filtered extension element from the manifest

FileAdapter::getElement() — Method in class FileAdapter

Get the filtered extension element from the manifest

LanguageAdapter::getSefString() — Method in class LanguageAdapter

Gets a unique language SEF string.

LibraryAdapter::getElement() — Method in class LibraryAdapter

Get the filtered extension element from the manifest

ModuleAdapter::getElement() — Method in class ModuleAdapter

Get the filtered extension element from the manifest

PackageAdapter::getElement() — Method in class PackageAdapter

Get the filtered extension element from the manifest

$ PluginAdapter#groupProperty in class PluginAdapter

Group of the plugin

PluginAdapter::getElement() — Method in class PluginAdapter

Get the filtered extension element from the manifest

PluginAdapter::getScriptClassName() — Method in class PluginAdapter

Get the class name for the install adapter script.

Installer::getInstance() — Method in class Installer

Returns the global Installer object, only creating it if it doesn't already exist.

Installer::getRedirectUrl() — Method in class Installer

Get the redirect location

Installer::getManifest() — Method in class Installer

Get the installation manifest object

Installer::getPath() — Method in class Installer

Get an installer path by name

Installer::getParams() — Method in class Installer

Method to parse the parameters of an extension, build the JSON string for its default parameters, and return the JSON string.

Installer::generateManifestCache() — Method in class Installer

Generates a manifest cache

Installer::getAdapters() — Method in class Installer

Gets a list of available install adapters.

InstallerAdapter::getDiscoverInstallSupported() — Method in class InstallerAdapter

Checks if the adapter supports discover_install

InstallerAdapter::getElement() — Method in class InstallerAdapter

Get the filtered extension element from the manifest

InstallerAdapter::getManifest() — Method in class InstallerAdapter

Get the manifest object.

InstallerAdapter::getName() — Method in class InstallerAdapter

Get the filtered component name from the manifest

InstallerAdapter::getParent() — Method in class InstallerAdapter

Retrieves the parent installer

InstallerAdapter::getRoute() — Method in class InstallerAdapter

Get the install route being followed

InstallerAdapter::getScriptClassName() — Method in class InstallerAdapter

Get the class name for the install adapter script.

$ InstallerExtension#groupProperty in class InstallerExtension

The group name of the plugin. Not used for other known extension types (only plugins)

InstallerHelper::getFilenameFromUrl() — Method in class InstallerHelper

Gets a file name out of a url

InstallerScript::getInstances() — Method in class InstallerScript

Gets each instance of a module in the #__modules table

InstallerScript::getParam() — Method in class InstallerScript

Gets parameter value in the extensions row of the extension table

InstallerScript::getItemArray() — Method in class InstallerScript

Builds a standard select query to produce better DRY code in this script.

Associations::getAssociations() — Method in class Associations

Get the associations.

Language::getInstance() — Method in class Language

Returns a language object.

Language::getTransliterator() — Method in class Language

Getter for transliteration function

Language::getPluralSuffixes() — Method in class Language

Returns an array of suffixes for plural rules.

Language::getPluralSuffixesCallback() — Method in class Language

Getter for pluralSuffixesCallback function.

Language::getIgnoredSearchWords() — Method in class Language

Returns an array of ignored search words

Language::getIgnoredSearchWordsCallback() — Method in class Language

Getter for ignoredSearchWordsCallback function.

Language::getLowerLimitSearchWord() — Method in class Language

Returns a lower limit integer for length of search words

Language::getLowerLimitSearchWordCallback() — Method in class Language

Getter for lowerLimitSearchWordCallback function

Language::getUpperLimitSearchWord() — Method in class Language

Returns an upper limit integer for length of search words

Language::getUpperLimitSearchWordCallback() — Method in class Language

Getter for upperLimitSearchWordCallback function

Language::getSearchDisplayedCharactersNumber() — Method in class Language

Returns the number of characters displayed in search results.

Language::getSearchDisplayedCharactersNumberCallback() — Method in class Language

Getter for searchDisplayedCharactersNumberCallback function

Language::getTrace() — Method in class Language

Get a back trace.

Language::getPaths() — Method in class Language

Get a list of language files that have been loaded.

Language::getCalendar() — Method in class Language

Getter for the calendar type

LanguageAwareTrait::getLanguage() — Method in class LanguageAwareTrait

Get the Language.

LanguageHelper::getLanguages() — Method in class LanguageHelper

Get available languages

LanguageHelper::getInstalledLanguages() — Method in class LanguageHelper

Get a list of installed languages.

LanguageHelper::getContentLanguages() — Method in class LanguageHelper

Get a list of content languages.

LanguageHelper::getMetadata() — Method in class LanguageHelper

Returns an associative array holding the metadata.

LanguageHelper::getKnownLanguages() — Method in class LanguageHelper

Returns a list of known languages for an area

LanguageHelper::getLanguagePath() — Method in class LanguageHelper

Get the path to a language

Multilanguage::getSiteHomePages() — Method in class Multilanguage

Method to return a list of language home page menu items.

Text::getScriptStrings() — Method in class Text

Get the strings that have been loaded to the JavaScript language store.

BaseLayout::getOptions() — Method in class BaseLayout

Get the options

BaseLayout::getDebugMessages() — Method in class BaseLayout

Get the debug messages array

BaseLayout::get() — Method in class BaseLayout

Method to get the value from the data array

BaseLayout::getData() — Method in class BaseLayout

Get the data being rendered

FileLayout::getPath() — Method in class FileLayout

Method to finds the full real file path, checking possible overrides

FileLayout::getIncludePaths() — Method in class FileLayout

Get the active include paths

FileLayout::getLayoutId() — Method in class FileLayout

Get the active layout id

FileLayout::getSuffixes() — Method in class FileLayout

Get the active suffixes

FileLayout::getDefaultIncludePaths() — Method in class FileLayout

Get the default array of include paths

LoggerRegistry::getLoggerClass() — Method in class LoggerRegistry

Get the logger class for a given key

FormattedtextLogger::generateFileHeader() — Method in class FormattedtextLogger

Method to generate the log file header.

$ InMemoryLogger#groupProperty in class InMemoryLogger

Group name to store the entries

InMemoryLogger::getCollectedEntries() — Method in class InMemoryLogger

Returns a list of collected entries.

AdminController::getRedirectToListAppend() — Method in class AdminController

Gets the URL arguments to append to a list redirect.

BaseController::getInstance() — Method in class BaseController

Method to get a singleton controller instance.

BaseController::getModel() — Method in class BaseController

Method to get a model object, loading it if required.

BaseController::getName() — Method in class BaseController

Method to get the controller name

BaseController::getTask() — Method in class BaseController

Get the last task that is being performed or was most recently performed.

BaseController::getTasks() — Method in class BaseController

Gets the available tasks in the controller.

BaseController::getView() — Method in class BaseController

Method to get a reference to the current view and load it if necessary.

BaseController::getLogger() — Method in class BaseController

Get the logger.

BaseController::getDispatcher() — Method in class BaseController

Get the event dispatcher.

FormController::getModel() — Method in class FormController

Method to get a model object, loading it if required.

FormController::getRedirectToItemAppend() — Method in class FormController

Gets the URL arguments to append to an item redirect.

FormController::getRedirectToListAppend() — Method in class FormController

Gets the URL arguments to append to a list redirect.

MVCFactory::getClassName() — Method in class MVCFactory

Returns a standard classname, if the class doesn't exist null is returned.

MVCFactoryAwareTrait::getMVCFactory() — Method in class MVCFactoryAwareTrait

Returns the MVC factory.

MVCFactoryServiceInterface::getMVCFactory() — Method in class MVCFactoryServiceInterface

Get the factory.

MVCFactoryServiceTrait::getMVCFactory() — Method in class MVCFactoryServiceTrait

Get the factory.

AdminModel::generateNewTitle() — Method in class AdminModel

Method to change the title & alias.

AdminModel::getItem() — Method in class AdminModel

Method to get a single record.

AdminModel::getReorderConditions() — Method in class AdminModel

A protected method to get a set of ordering conditions.

AdminModel::generateTitle() — Method in class AdminModel

A method to preprocess generating a new title in order to allow tables with alternative names for alias and title to use the batch move and copy methods

BaseDatabaseModel::getTable() — Method in class BaseDatabaseModel

Method to get a table object, load it if necessary.

BaseDatabaseModel::getDispatcher() — Method in class BaseDatabaseModel

Get the event dispatcher.

BaseDatabaseModel::getDbo() — Method in class BaseDatabaseModel

Method to get the database driver object.

BaseModel::getName() — Method in class BaseModel

Method to get the model name

DatabaseAwareTrait::getDbo() — Method in class DatabaseAwareTrait

Get the database driver.

DatabaseModelInterface::getDbo() — Method in class DatabaseModelInterface

Method to get the database driver object.

FormBehaviorTrait::getFormFactory() — Method in class FormBehaviorTrait

Get the FormFactoryInterface.

FormModelInterface::getForm() — Method in class FormModelInterface

Method for getting a form.

ItemModel::getStoreId() — Method in class ItemModel

Method to get a store id based on model configuration state.

ItemModelInterface::getItem() — Method in class ItemModelInterface

Method to get an item.

LegacyModelLoaderTrait::getInstance() — Method in class LegacyModelLoaderTrait

Returns a Model object, always creating it

ListModel::getEmptyStateQuery() — Method in class ListModel

Provide a query to be used to evaluate if this is an Empty State, can be overridden in the model to provide granular control.

ListModel::getIsEmptyState() — Method in class ListModel

Is this an empty state, I.e: no items of this type regardless of the searched for states.

ListModel::getActiveFilters() — Method in class ListModel

Function to get the active filters

ListModel::getItems() — Method in class ListModel

Method to get an array of data items.

ListModel::getListQuery() — Method in class ListModel

Method to get an object implementing QueryInterface for retrieving the data set from a database.

ListModel::getPagination() — Method in class ListModel

Method to get a \JPagination object for the data set.

ListModel::getStoreId() — Method in class ListModel

Method to get a store id based on the model configuration state.

ListModel::getTotal() — Method in class ListModel

Method to get the total number of items for the data set.

ListModel::getStart() — Method in class ListModel

Method to get the starting number of items for the data set.

ListModel::getFilterForm() — Method in class ListModel

Get the filter form

ListModel::getUserStateFromRequest() — Method in class ListModel

Gets the value of a user state variable and sets it in the session

ListModelInterface::getItems() — Method in class ListModelInterface

Method to get an array of data items.

ModelInterface::getName() — Method in class ModelInterface

Method to get the model name.

State::get() — Method in class State

Get a registry value.

State::getProperties() — Method in class State

Returns an associative array of object properties.

StateBehaviorTrait::getState() — Method in class StateBehaviorTrait

Method to get state variables.

StatefulModelInterface::getState() — Method in class StatefulModelInterface

Method to get model state variables.

WorkflowBehaviorTrait::getStageForNewItem() — Method in class WorkflowBehaviorTrait

Try to load a workflow stage for newly created items which does not have a workflow assigned yet. If the category is not the carrier, overwrite it on your model and deliver your own carrier.

WorkflowModelInterface::getState() — Method in class WorkflowModelInterface

Method to get state variables.

WorkflowModelInterface::getName() — Method in class WorkflowModelInterface

Method to get the model name

WorkflowModelInterface::getTable() — Method in class WorkflowModelInterface

Method to get a table object, load it if necessary.

AbstractView::get() — Method in class AbstractView

Method to get data from a registered model or a property of the view

AbstractView::getModel() — Method in class AbstractView

Method to get the model object

AbstractView::getName() — Method in class AbstractView

Method to get the view name

AbstractView::getDocument() — Method in class AbstractView

Get the Document.

AbstractView::getDispatcher() — Method in class AbstractView

Get the event dispatcher.

CanDo::get() — Method in class CanDo

Get a registry value.

CanDo::getProperties() — Method in class CanDo

Returns an associative array of object properties.

OnGetApiFields::getAllPropertiesToRender() — Method in class OnGetApiFields

Get properties to render.

OnGetApiFields::getAllRelationsToRender() — Method in class OnGetApiFields

Get properties to render.

GenericDataExceptionClass in namespace Joomla\CMS\MVC\View

Exception class defining an error getting data from a model into a view

HtmlView::getLayout() — Method in class HtmlView

Get the layout.

HtmlView::getLayoutTemplate() — Method in class HtmlView

Get the layout template.

HtmlView::getForm() — Method in class HtmlView

Returns the form object

ViewInterface::getModel() — Method in class ViewInterface

Method to get the model object

ViewInterface::getName() — Method in class ViewInterface

Method to get the view name

MailDisabledException::getReason() — Method in class MailDisabledException

Method to return the reason why mail is disabled.

Mail::getInstance() — Method in class Mail

Returns the global email object, only creating it if it doesn't already exist.

MailTemplate::getTemplate() — Method in class MailTemplate

Get a specific mail template

MailTemplate::getAttachmentName() — Method in class MailTemplate

Check and if necessary fix the file name of an attachment so that the attached file has the same extension as the source file, and not a different file extension

MailerFactoryAwareTrait::getMailerFactory() — Method in class MailerFactoryAwareTrait

Get the MailerFactoryInterface.

AbstractMenu::getInstance() — Method in class AbstractMenu

Returns a Menu object

AbstractMenu::getItem() — Method in class AbstractMenu

Get menu item by id

AbstractMenu::getDefault() — Method in class AbstractMenu

Get the default item by language code.

AbstractMenu::getActive() — Method in class AbstractMenu

Get menu item by id.

AbstractMenu::getItems() — Method in class AbstractMenu

Gets menu items by attribute

AbstractMenu::getParams() — Method in class AbstractMenu

Gets the parameter object for a certain menu item

AbstractMenu::getMenu() — Method in class AbstractMenu

Getter for the menu array

AbstractMenu::getUser() — Method in class AbstractMenu

Internal getter for the user. Returns the injected one if any, or the current one if none.

MenuItem::getParams() — Method in class MenuItem

Returns the menu item parameters

SiteMenu::getItems() — Method in class SiteMenu

Gets menu items by attribute

SiteMenu::getDefault() — Method in class SiteMenu

Get menu item by id

Microdata::getType() — Method in class Microdata

Return the current $Type name

Microdata::getProperty() — Method in class Microdata

Return the current $Property name

Microdata::getContent() — Method in class Microdata

Return the current $content

Microdata::getMachineContent() — Method in class Microdata

Return the current $machineContent

Microdata::getFallbackType() — Method in class Microdata

Return the current $fallbackType

Microdata::getFallbackProperty() — Method in class Microdata

Return the current $fallbackProperty

Microdata::getTypes() — Method in class Microdata

Return an array with all available Types and Properties from the http://schema.org vocabulary

Microdata::getAvailableTypes() — Method in class Microdata

Return an array with all available Types from the http://schema.org vocabulary

Microdata::getExpectedTypes() — Method in class Microdata

Return the expected Types of the given Property

Microdata::getExpectedDisplayType() — Method in class Microdata

Return the expected display type: [normal|nested|meta] In which way to display the Property: normal -> itemprop="name" nested -> itemprop="director" itemscope itemtype="https://schema.org/Person" meta -> <meta itemprop="datePublished" content="1991-05-01">

LegacyErrorHandlingTrait::getError() — Method in class LegacyErrorHandlingTrait

Get the most recent error message.

LegacyErrorHandlingTrait::getErrors() — Method in class LegacyErrorHandlingTrait

Return all errors, if any.

LegacyPropertyManagementTrait::get() — Method in class LegacyPropertyManagementTrait

Returns a property of the object or the default value if the property is not set.

LegacyPropertyManagementTrait::getProperties() — Method in class LegacyPropertyManagementTrait

Returns an associative array of object properties.

Pagination::getAdditionalUrlParam() — Method in class Pagination

Method to get an additional URL parameter (if it exists) to be added to all pagination class generated links.

Pagination::getRowOffset() — Method in class Pagination

Return the rationalised offset for a row with a given index.

Pagination::getData() — Method in class Pagination

Return the pagination data object, only creating it if it doesn't already exist.

Pagination::getPagesCounter() — Method in class Pagination

Create and return the pagination pages counter string, ie. Page 2 of 4.

Pagination::getResultsCounter() — Method in class Pagination

Create and return the pagination result set counter string, e.g. Results 1-10 of 42

Pagination::getPagesLinks() — Method in class Pagination

Create and return the pagination page list string, ie. Previous, Next, 1 2 3 ... x.

Pagination::getPaginationLinks() — Method in class Pagination

Get the pagination links

Pagination::getPaginationPages() — Method in class Pagination

Create and return the pagination pages list, ie. Previous, Next, 1 2 3 ... x.

Pagination::getListFooter() — Method in class Pagination

Return the pagination footer.

Pagination::getLimitBox() — Method in class Pagination

Creates a dropdown box for selecting how many records to show per page.

Pathway::getInstance() — Method in class Pathway

Returns a Pathway object

Pathway::getPathway() — Method in class Pathway

Return the Pathway items array

Pathway::getPathwayNames() — Method in class Pathway

Create and return an array of the pathway names.

CMSPlugin::getApplication() — Method in class CMSPlugin

Returns the internal application or null when not set.

CMSPlugin::getLanguage() — Method in class CMSPlugin

Get the Language.

CMSPlugin::getDispatcher() — Method in class CMSPlugin

Get the event dispatcher.

PluginHelper::getLayoutPath() — Method in class PluginHelper

Get the path to a layout from a Plugin

PluginHelper::getPlugin() — Method in class PluginHelper

Get the plugin data of a specific type if no specific plugin is specified otherwise only the specific plugin data is returned.

Profiler::getInstance() — Method in class Profiler

Returns the global Profiler object, only creating it if it doesn't already exist.

Profiler::getMarks() — Method in class Profiler

Get all profiler marks.

Profiler::getBuffer() — Method in class Profiler

Get all profiler mark buffers.

ApiRouter::getRoutePath() — Method in class ApiRouter

Get the path from the route and remove and leading or trailing slash.

ApiRouter::getMatchingRoutes() — Method in class ApiRouter

Extract routes matching current route from all known routes.

Router::getInstance() — Method in class Router

Returns the global Router object, only creating it if it doesn't already exist.

Router::getVar() — Method in class Router

Get a router variable

Router::getVars() — Method in class Router

Get the router variable array

Router::getRules() — Method in class Router

Get all currently attached rules

SiteRouter::getComponentRouter() — Method in class SiteRouter

Get component router

SiteRouterAwareTrait::getSiteRouter() — Method in class SiteRouterAwareTrait

Get the site router.

ChangeItem::getInstance() — Method in class ChangeItem

Returns a reference to the ChangeItem object.

ChangeSet::getInstance() — Method in class ChangeSet

Returns a reference to the ChangeSet object, only creating it if it doesn't already exist.

ChangeSet::getStatus() — Method in class ChangeSet

Returns an array of results for this set

ChangeSet::getSchema() — Method in class ChangeSet

Gets the current database schema, based on the highest version number.

SchemaorgPluginTrait::getSubscribedEvents() — Method in class SchemaorgPluginTrait

Returns an array of events this subscriber will listen to.

SchemaorgServiceInterface::getSchemaorgContexts() — Method in class SchemaorgServiceInterface

Returns valid contexts.

SchemaorgServiceTrait::getMVCFactory() — Method in class SchemaorgServiceTrait

Get a MVC factory

OnGetApiAttributes::getAttributes() — Method in class OnGetApiAttributes

The properties to be rendered.

OnGetApiRelation::getRelationship() — Method in class OnGetApiRelation

Get properties to render.

JoomlaSerializer::getAttributes() — Method in class JoomlaSerializer

Get the attributes array.

JoomlaSerializer::getRelationship() — Method in class JoomlaSerializer

Get a relationship.

Session::getFormToken() — Method in class Session

Method to determine a hash for anti-spoofing variable names

Session::getHandlers() — Method in class Session

Get the available session handlers

Session::getInstance() — Method in class Session

Returns the global session object.

Session::get() — Method in class Session

Get data from the session store

JoomlaStorage::get() — Method in class JoomlaStorage

Get data from the session store

TufFetcher::getValidUpdate() — Method in class TufFetcher

Checks for updates and writes it into the database if they are valid. Then it gets the targets.json content and returns it

Category::getTypeAlias() — Method in class Category

Get the type alias for the history table

Content::getTypeAlias() — Method in class Content

Get the type alias for UCM features

ContentHistory::getSha1() — Method in class ContentHistory

Utility method to get the hash after removing selected values. This lets us detect changes other than modified date (which will change on every save).

ContentHistory::getHashMatch() — Method in class ContentHistory

Utility method to get a matching row based on the hash value and id columns.

ContentType::getTypeId() — Method in class ContentType

Method to get the id given the type alias

ContentType::getContentTable() — Method in class ContentType

Method to get the Table object for the content type from the table object.

Nested::getPath() — Method in class Nested

Method to get an array of nodes from a given node to its root.

Nested::getTree() — Method in class Nested

Method to get a node and all its child nodes.

Nested::getRootId() — Method in class Nested

Gets the ID of the root item in the tree

Table::getFields() — Method in class Table

Get the columns from database table.

Table::getInstance() — Method in class Table

Static method to get an instance of a Table class if it can be found in the table include paths.

Table::getTableName() — Method in class Table

Method to get the database table name for the class.

Table::getKeyName() — Method in class Table

Method to get the primary key field name for the table.

Table::getId() — Method in class Table

Returns the identity (primary key) value of this record

Table::getDbo() — Method in class Table

Method to get the DatabaseDriver object.

Table::getRules() — Method in class Table

Method to get the rules for the record.

Table::getNextOrder() — Method in class Table

Method to get the next ordering value for a group of rows defined by an SQL WHERE clause.

Table::getPrimaryKey() — Method in class Table

Get the primary key values for this table using passed in values as a default.

Table::getColumnAlias() — Method in class Table

Method to return the real name of a "special" column such as ordering, hits, published etc etc. In this way you are free to follow your db naming convention and use the built in \Joomla functions.

TableInterface::getDbo() — Method in class TableInterface

Method to get the DatabaseDriver object.

TableInterface::getKeyName() — Method in class TableInterface

Method to get the primary key field name for the table.

TableInterface::getId() — Method in class TableInterface

Returns the identity (primary key) value of this record

$ User#groupsProperty in class User

Associative array of group ids => group ids for the user

TagServiceTrait::getTableNameForSection() — Method in class TagServiceTrait

Returns the table for the count items functions for the given section.

TagServiceTrait::getStateColumnForSection() — Method in class TagServiceTrait

Returns the state column for the count items functions for the given section.

TaggableTableInterface::getTypeAlias() — Method in class TaggableTableInterface

Get the type alias for the tags mapping table

TaggableTableInterface::getTagsHelper() — Method in class TaggableTableInterface

Get the tags helper

TaggableTableTrait::getTagsHelper() — Method in class TaggableTableTrait

Get the tags helper

AbstractGroupButton::getChildToolbar() — Method in class AbstractGroupButton

Get child toolbar.

ConfirmButton::getAccessors() — Method in class ConfirmButton

Method to configure available option accessors.

ConfirmButton::getMessage() — Method in class ConfirmButton
CustomButton::getAccessors() — Method in class CustomButton

Method to configure available option accessors.

CustomButton::getHtml() — Method in class CustomButton
DropdownButton::getAccessors() — Method in class DropdownButton

Method to configure available option accessors.

DropdownButton::getToggleSplit() — Method in class DropdownButton
DropdownButton::getToggleButtonClass() — Method in class DropdownButton
HelpButton::getAccessors() — Method in class HelpButton

Method to configure available option accessors.

HelpButton::getRef() — Method in class HelpButton
HelpButton::getComponent() — Method in class HelpButton
HelpButton::getUseComponent() — Method in class HelpButton
HelpButton::getUrl() — Method in class HelpButton
InlinehelpButton::getAccessors() — Method in class InlinehelpButton

Method to configure available option accessors.

InlinehelpButton::getTargetclass() — Method in class InlinehelpButton
LinkButton::getAccessors() — Method in class LinkButton

Method to configure available option accessors.

LinkButton::getUrl() — Method in class LinkButton
LinkButton::getTarget() — Method in class LinkButton
PopupButton::getAccessors() — Method in class PopupButton

Method to configure available option accessors.

PopupButton::getUrl() — Method in class PopupButton
PopupButton::getIframeWidth() — Method in class PopupButton
PopupButton::getIframeHeight() — Method in class PopupButton
PopupButton::getBodyHeight() — Method in class PopupButton
PopupButton::getModalWidth() — Method in class PopupButton
PopupButton::getModalHeight() — Method in class PopupButton
PopupButton::getOnclose() — Method in class PopupButton
PopupButton::getTitle() — Method in class PopupButton
PopupButton::getFooter() — Method in class PopupButton
PopupButton::getSelector() — Method in class PopupButton
PopupButton::getListCheck() — Method in class PopupButton
PopupButton::getPopupType() — Method in class PopupButton
PopupButton::getTextHeader() — Method in class PopupButton
Toolbar::getInstance() — Method in class Toolbar

Returns the global Toolbar object, only creating it if it doesn't already exist.

Toolbar::getItems() — Method in class Toolbar

Get the list of toolbar links.

Toolbar::getName() — Method in class Toolbar

Get the name of the toolbar.

Toolbar::getButtonPath() — Method in class Toolbar

Get the lookup paths for button objects

ToolbarButton::getParent() — Method in class ToolbarButton

Get parent toolbar instance.

ToolbarButton::getOptions() — Method in class ToolbarButton

Get button options.

ToolbarButton::getOption() — Method in class ToolbarButton

Get single option value.

ToolbarButton::getName() — Method in class ToolbarButton

Get button name.

ToolbarButton::getLayout() — Method in class ToolbarButton

Get layout path.

ToolbarButton::getAccessors() — Method in class ToolbarButton

Method to configure available option accessors.

ToolbarButton::getText() — Method in class ToolbarButton
ToolbarButton::getTask() — Method in class ToolbarButton
ToolbarButton::getIcon() — Method in class ToolbarButton
ToolbarButton::getButtonClass() — Method in class ToolbarButton
ToolbarButton::getAttributes() — Method in class ToolbarButton
ToolbarButton::getOnclick() — Method in class ToolbarButton
ToolbarButton::getListCheck() — Method in class ToolbarButton
ToolbarButton::getListCheckMessage() — Method in class ToolbarButton
ToolbarButton::getForm() — Method in class ToolbarButton
ToolbarButton::getFormValidation() — Method in class ToolbarButton
ImmutableNodeInterface::getChildren() — Method in class ImmutableNodeInterface

Get the children of this node

ImmutableNodeInterface::getParent() — Method in class ImmutableNodeInterface

Get the parent of this node

ImmutableNodeInterface::getRoot() — Method in class ImmutableNodeInterface

Get the root of the tree

ImmutableNodeInterface::getSibling() — Method in class ImmutableNodeInterface

Returns the right or left sibling of a node

ImmutableNodeTrait::getChildren() — Method in class ImmutableNodeTrait

Get the children of this node

ImmutableNodeTrait::getParent() — Method in class ImmutableNodeTrait

Get the parent of this node

ImmutableNodeTrait::getRoot() — Method in class ImmutableNodeTrait

Get the root of the tree

ImmutableNodeTrait::getSibling() — Method in class ImmutableNodeTrait

Returns the right or left sibling of a node

UCMBase::getType() — Method in class UCMBase

Get the UCM Content type.

UCMContent::getPrimaryKey() — Method in class UCMContent

Get the value of the primary key from #__ucm_base

UCMType::getType() — Method in class UCMType

Get the Content Type

UCMType::getTypeByAlias() — Method in class UCMType

Get the Content Type from the alias

UCMType::getTypeByTable() — Method in class UCMType

Get the Content Type from the table class name

UCMType::getTypeId() — Method in class UCMType

Retrieves the UCM type ID

TufAdapter::getUpdateTargets() — Method in class TufAdapter

Finds targets.

ConstraintChecker::getFailedEnvironmentConstraints() — Method in class ConstraintChecker

Gets the failed constraints for further processing

$ Update#groupProperty in class Update

Update manifest <group> element

Update::getTargetVersion() — Method in class Update

Get extension's Joomla! target version

UpdateAdapter::getUpdateSiteName() — Method in class UpdateAdapter

Get the name of an update site. This is used in logging.

UpdateAdapter::getUpdateSiteResponse() — Method in class UpdateAdapter

Try to get the raw HTTP response from the update site, hopefully containing the update XML.

Updater::getInstance() — Method in class Updater

Returns a reference to the global Installer object, only creating it if it doesn't already exist.

Uri::getInstance() — Method in class Uri

Returns the global Uri object, only creating it if it doesn't already exist.

CurrentUserTrait::getCurrentUser() — Method in class CurrentUserTrait

Returns the current user, if none is set the identity of the global app is returned. This will change in 6.0 and an empty user will be returned.

$ User#groupsProperty in class User

Associative array of user names => group ids

$ User#guestProperty in class User

Guest status

User::getInstance() — Method in class User

Returns the global User object, only creating it if it doesn't already exist.

User::getParam() — Method in class User

Method to get a parameter value

User::getAuthorisedCategories() — Method in class User

Method to return a list of all categories that a user has permission for a given action

User::getAuthorisedViewLevels() — Method in class User

Gets an array of the authorised access levels for the user

User::getAuthorisedGroups() — Method in class User

Gets an array of the authorised user groups

User::getTimezone() — Method in class User

Method to get the user timezone.

User::getTable() — Method in class User

Method to get the user table object

UserFactoryAwareTrait::getUserFactory() — Method in class UserFactoryAwareTrait

Get the UserFactoryInterface.

UserHelper::getUserGroups() — Method in class UserHelper

Method to get a list of groups a user is in.

UserHelper::getProfile() — Method in class UserHelper

Gets the user profile information

UserHelper::getUserId() — Method in class UserHelper

Returns userid if a user exists

UserHelper::genRandomPassword() — Method in class UserHelper

Generate a random password

UserHelper::getShortHashedUserAgent() — Method in class UserHelper

Method to get a hashed user agent string that does not include browser version.

Utility::getMaxUploadSize() — Method in class Utility

Method to get the maximum allowed file size for the HTTP uploads based on the active PHP configuration

Version::getHelpVersion() — Method in class Version

Method to get the help file version.

Version::getShortVersion() — Method in class Version

Gets a "PHP standardized" version string for the current Joomla.

Version::getLongVersion() — Method in class Version

Gets a version string for the current Joomla with all release information.

Version::getUserAgent() — Method in class Version

Returns the user agent.

Version::generateMediaVersion() — Method in class Version

Generate a media version string for assets Public to allow third party developers to use it

Version::getMediaVersion() — Method in class Version

Gets a media version which is used to append to Joomla core media files.

VersionableTableInterface::getTypeAlias() — Method in class VersionableTableInterface

Get the type alias for the history table

Versioning::get() — Method in class Versioning

Method to get a list of available versions of this item.

WebAssetItem::getName() — Method in class WebAssetItem

Return Asset name

WebAssetItem::getVersion() — Method in class WebAssetItem

Return Asset version

WebAssetItem::getDependencies() — Method in class WebAssetItem

Return dependencies list

WebAssetItem::getUri() — Method in class WebAssetItem

Get the file path

WebAssetItem::getOption() — Method in class WebAssetItem

Get the option

WebAssetItem::getOptions() — Method in class WebAssetItem

Get all options

WebAssetItem::getAttribute() — Method in class WebAssetItem

Get the attribute

WebAssetItem::getAttributes() — Method in class WebAssetItem

Get all attributes

WebAssetItemInterface::getName() — Method in class WebAssetItemInterface

Return Asset name

WebAssetItemInterface::getVersion() — Method in class WebAssetItemInterface

Return Asset version

WebAssetItemInterface::getDependencies() — Method in class WebAssetItemInterface

Return dependencies list

WebAssetItemInterface::getUri() — Method in class WebAssetItemInterface

Get the URI of the asset

WebAssetItemInterface::getOption() — Method in class WebAssetItemInterface

Get the option

WebAssetItemInterface::getOptions() — Method in class WebAssetItemInterface

Get all options of the asset

WebAssetItemInterface::getAttribute() — Method in class WebAssetItemInterface

Get the attribute

WebAssetItemInterface::getAttributes() — Method in class WebAssetItemInterface

Get all attributes

WebAssetManager::getRegistry() — Method in class WebAssetManager

Get associated registry instance

WebAssetManager::getAssetState() — Method in class WebAssetManager

Get a state for the Asset

WebAssetManager::getAsset() — Method in class WebAssetManager

Helper method to get the asset from the registry.

WebAssetManager::getAssets() — Method in class WebAssetManager

Get all active assets, optionally sort them to follow the dependency Graph

WebAssetManager::getInlineRelation() — Method in class WebAssetManager

Helper method to calculate inline to non inline relation (before/after positions).

WebAssetManager::getManagerState() — Method in class WebAssetManager

Get the manager state. A collection of registry files and active asset names (per type).

WebAssetManager::getConnectionsGraph() — Method in class WebAssetManager

Build Graph of Outgoing and Incoming connections for given assets.

WebAssetManager::getDependenciesForAsset() — Method in class WebAssetManager

Return dependencies for Asset as array of WebAssetItem objects

WebAssetManagerInterface::getAssets() — Method in class WebAssetManagerInterface

Get all assets that was enabled for given type

WebAssetRegistry::get() — Method in class WebAssetRegistry

Get an existing Asset from a registry, by asset name and asset type.

WebAssetRegistry::getRegistryFiles() — Method in class WebAssetRegistry

Get a list of the registry files

WebAssetRegistryInterface::get() — Method in class WebAssetRegistryInterface

Get an existing Asset from a registry, by asset name and asset type.

Server::generatePublicKeyCredentialCreationOptions() — Method in class Server

Generate the Public Key credentials creation options.

Server::generatePublicKeyCredentialRequestOptions() — Method in class Server

Generate Public Key credential request options

Workflow::getConditionName() — Method in class Workflow

Returns the translated condition name, based on the given number

Workflow::getComponent() — Method in class Workflow

Returns the booted component

Workflow::getDefaultStageByCategory() — Method in class Workflow

Try to load a workflow default stage by category ID.

Workflow::getValidTransition() — Method in class Workflow

Check if a transition can be executed

Workflow::getAssociation() — Method in class Workflow

Loads an existing association item with state and item ID

WorkflowPluginTrait::getWorkflow() — Method in class WorkflowPluginTrait

Get the workflow for a given ID

WorkflowServiceInterface::getModelName() — Method in class WorkflowServiceInterface

Returns the model name, based on the context

WorkflowServiceInterface::getConditions() — Method in class WorkflowServiceInterface

Returns an array of possible conditions for the component.

WorkflowServiceInterface::getWorkflowTableBySection() — Method in class WorkflowServiceInterface

Returns a table name for the state association

WorkflowServiceInterface::getWorkflowContexts() — Method in class WorkflowServiceInterface

Returns valid contexts.

WorkflowServiceInterface::getCategoryWorkflowContext() — Method in class WorkflowServiceInterface

Returns the workflow context based on the given category section

WorkflowServiceTrait::getMVCFactory() — Method in class WorkflowServiceTrait

Get a MVC factory

WorkflowServiceTrait::getModelName() — Method in class WorkflowServiceTrait

Returns the model name, based on the context

WorkflowServiceTrait::getConditions() — Method in class WorkflowServiceTrait

Returns an array of possible conditions for the component.

PasswordHash::get_random_bytes() — Method in class PasswordHash
PasswordHash::gensalt_private() — Method in class PasswordHash
PasswordHash::gensalt_blowfish() — Method in class PasswordHash
__TwigTemplate_0bf62896b95c7e97cd0f4eae5f5f6195::getTemplateName() — Method in class __TwigTemplate_0bf62896b95c7e97cd0f4eae5f5f6195
__TwigTemplate_0bf62896b95c7e97cd0f4eae5f5f6195::getDebugInfo() — Method in class __TwigTemplate_0bf62896b95c7e97cd0f4eae5f5f6195
__TwigTemplate_0bf62896b95c7e97cd0f4eae5f5f6195::getSourceContext() — Method in class __TwigTemplate_0bf62896b95c7e97cd0f4eae5f5f6195
__TwigTemplate_3994fb5d5d826575e5e068ab43919da3::getTemplateName() — Method in class __TwigTemplate_3994fb5d5d826575e5e068ab43919da3
__TwigTemplate_3994fb5d5d826575e5e068ab43919da3::getDebugInfo() — Method in class __TwigTemplate_3994fb5d5d826575e5e068ab43919da3
__TwigTemplate_3994fb5d5d826575e5e068ab43919da3::getSourceContext() — Method in class __TwigTemplate_3994fb5d5d826575e5e068ab43919da3
__TwigTemplate_4bcccb9f0894179cb357804bda58e4b3::getTemplateName() — Method in class __TwigTemplate_4bcccb9f0894179cb357804bda58e4b3
__TwigTemplate_4bcccb9f0894179cb357804bda58e4b3::getDebugInfo() — Method in class __TwigTemplate_4bcccb9f0894179cb357804bda58e4b3
__TwigTemplate_4bcccb9f0894179cb357804bda58e4b3::getSourceContext() — Method in class __TwigTemplate_4bcccb9f0894179cb357804bda58e4b3
__TwigTemplate_5043402560718bb1c61e09b845b77e36::getTemplateName() — Method in class __TwigTemplate_5043402560718bb1c61e09b845b77e36
__TwigTemplate_5043402560718bb1c61e09b845b77e36::getDebugInfo() — Method in class __TwigTemplate_5043402560718bb1c61e09b845b77e36
__TwigTemplate_5043402560718bb1c61e09b845b77e36::getSourceContext() — Method in class __TwigTemplate_5043402560718bb1c61e09b845b77e36
__TwigTemplate_79fb764e9da8ea996f0ce34ace2da336::getTemplateName() — Method in class __TwigTemplate_79fb764e9da8ea996f0ce34ace2da336
__TwigTemplate_79fb764e9da8ea996f0ce34ace2da336::getDebugInfo() — Method in class __TwigTemplate_79fb764e9da8ea996f0ce34ace2da336
__TwigTemplate_79fb764e9da8ea996f0ce34ace2da336::getSourceContext() — Method in class __TwigTemplate_79fb764e9da8ea996f0ce34ace2da336
__TwigTemplate_85e091843a2d5eb6b1597c2f89e0752c::getTemplateName() — Method in class __TwigTemplate_85e091843a2d5eb6b1597c2f89e0752c
__TwigTemplate_85e091843a2d5eb6b1597c2f89e0752c::getDebugInfo() — Method in class __TwigTemplate_85e091843a2d5eb6b1597c2f89e0752c
__TwigTemplate_85e091843a2d5eb6b1597c2f89e0752c::getSourceContext() — Method in class __TwigTemplate_85e091843a2d5eb6b1597c2f89e0752c
__TwigTemplate_896e1a17f0353adb41deb8b45210ae94::getTemplateName() — Method in class __TwigTemplate_896e1a17f0353adb41deb8b45210ae94
__TwigTemplate_896e1a17f0353adb41deb8b45210ae94::getDebugInfo() — Method in class __TwigTemplate_896e1a17f0353adb41deb8b45210ae94
__TwigTemplate_896e1a17f0353adb41deb8b45210ae94::getSourceContext() — Method in class __TwigTemplate_896e1a17f0353adb41deb8b45210ae94
__TwigTemplate_93a051471fb2bd8bc386b2041ff7ba2b::getTemplateName() — Method in class __TwigTemplate_93a051471fb2bd8bc386b2041ff7ba2b
__TwigTemplate_93a051471fb2bd8bc386b2041ff7ba2b::getDebugInfo() — Method in class __TwigTemplate_93a051471fb2bd8bc386b2041ff7ba2b
__TwigTemplate_93a051471fb2bd8bc386b2041ff7ba2b::getSourceContext() — Method in class __TwigTemplate_93a051471fb2bd8bc386b2041ff7ba2b
__TwigTemplate_959903b26cb0d471d240abcbd9524242::getTemplateName() — Method in class __TwigTemplate_959903b26cb0d471d240abcbd9524242
__TwigTemplate_959903b26cb0d471d240abcbd9524242::getDebugInfo() — Method in class __TwigTemplate_959903b26cb0d471d240abcbd9524242
__TwigTemplate_959903b26cb0d471d240abcbd9524242::getSourceContext() — Method in class __TwigTemplate_959903b26cb0d471d240abcbd9524242
__TwigTemplate_a53d5b9a592c30f5292fdf2cf5daaf44::getTemplateName() — Method in class __TwigTemplate_a53d5b9a592c30f5292fdf2cf5daaf44
__TwigTemplate_a53d5b9a592c30f5292fdf2cf5daaf44::getDebugInfo() — Method in class __TwigTemplate_a53d5b9a592c30f5292fdf2cf5daaf44
__TwigTemplate_a53d5b9a592c30f5292fdf2cf5daaf44::getSourceContext() — Method in class __TwigTemplate_a53d5b9a592c30f5292fdf2cf5daaf44
__TwigTemplate_acdad90fc61f5e474deb98262a7dc3eb::getTemplateName() — Method in class __TwigTemplate_acdad90fc61f5e474deb98262a7dc3eb
__TwigTemplate_acdad90fc61f5e474deb98262a7dc3eb::getDebugInfo() — Method in class __TwigTemplate_acdad90fc61f5e474deb98262a7dc3eb
__TwigTemplate_acdad90fc61f5e474deb98262a7dc3eb::getSourceContext() — Method in class __TwigTemplate_acdad90fc61f5e474deb98262a7dc3eb
__TwigTemplate_adbbf7f4f8572fd945270d87a68752a6::getTemplateName() — Method in class __TwigTemplate_adbbf7f4f8572fd945270d87a68752a6
__TwigTemplate_adbbf7f4f8572fd945270d87a68752a6::getDebugInfo() — Method in class __TwigTemplate_adbbf7f4f8572fd945270d87a68752a6
__TwigTemplate_adbbf7f4f8572fd945270d87a68752a6::getSourceContext() — Method in class __TwigTemplate_adbbf7f4f8572fd945270d87a68752a6
__TwigTemplate_bc6db32d62004a1677f9a4af03635305::getTemplateName() — Method in class __TwigTemplate_bc6db32d62004a1677f9a4af03635305
__TwigTemplate_bc6db32d62004a1677f9a4af03635305::getDebugInfo() — Method in class __TwigTemplate_bc6db32d62004a1677f9a4af03635305
__TwigTemplate_bc6db32d62004a1677f9a4af03635305::getSourceContext() — Method in class __TwigTemplate_bc6db32d62004a1677f9a4af03635305
__TwigTemplate_ebd3ded38a1374cfcb2671eaa14a1d29::getTemplateName() — Method in class __TwigTemplate_ebd3ded38a1374cfcb2671eaa14a1d29
__TwigTemplate_ebd3ded38a1374cfcb2671eaa14a1d29::getDebugInfo() — Method in class __TwigTemplate_ebd3ded38a1374cfcb2671eaa14a1d29
__TwigTemplate_ebd3ded38a1374cfcb2671eaa14a1d29::getSourceContext() — Method in class __TwigTemplate_ebd3ded38a1374cfcb2671eaa14a1d29
__TwigTemplate_f39bca71236ed63ca7b7b0f776c66525::getTemplateName() — Method in class __TwigTemplate_f39bca71236ed63ca7b7b0f776c66525
__TwigTemplate_f39bca71236ed63ca7b7b0f776c66525::getDebugInfo() — Method in class __TwigTemplate_f39bca71236ed63ca7b7b0f776c66525
__TwigTemplate_f39bca71236ed63ca7b7b0f776c66525::getSourceContext() — Method in class __TwigTemplate_f39bca71236ed63ca7b7b0f776c66525

H

CryptoExceptionHandler::handler() — Method in class CryptoExceptionHandler
ApiApplication::handlePreflight() — Method in class ApiApplication

Handles preflight requests.

AssociationExtensionHelper::hasAssociationsSupport() — Method in class AssociationExtensionHelper

Checks if the extension supports associations

AssociationExtensionInterface::hasAssociationsSupport() — Method in class AssociationExtensionInterface

Checks if the extension supports associations

ChainedHandler::hashPassword() — Method in class ChainedHandler

Generate a hash for a plaintext password

MD5Handler::hashPassword() — Method in class MD5Handler

Generate a hash for a plaintext password

PHPassHandler::hashPassword() — Method in class PHPassHandler

Generate a hash for a plaintext password

CaptchaRegistry::has() — Method in class CaptchaRegistry

Check whether the element exists in the registry.

HttpBridgePostRequestMethodClass in namespace Joomla\CMS\Captcha\Google

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

$ CategoryNode#hitsProperty in class CategoryNode

Number of times the category has been viewed

ClientHelper::hasCredentials() — Method in class ClientHelper

Method to determine if client login credentials are present

WritableContainerLoader::has() — Method in class WritableContainerLoader

Checks if a command exists.

$ Date#hourProperty in class Date

H - 24-hour format of an hour with leading zeros.

$ FeedImage#heightProperty in class FeedImage

Title feed attribute

HtmlDocumentClass in namespace Joomla\CMS\Document

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

$ OpensearchImage#heightProperty in class OpensearchImage

The image's height

HeadRendererClass in namespace Joomla\CMS\Document\Renderer\Html

HTML document renderer for the document <head> element

EditorsRegistry::has() — Method in class EditorsRegistry

Check whether the element exists in the registry.

EditorsRegistryInterface::has() — Method in class EditorsRegistryInterface

Check whether the element exists in the registry.

Totp::hashToInt() — Method in class Totp

Extracts a part of a hash as an integer

AuthenticationFailedExceptionHandler::handle() — Method in class AuthenticationFailedExceptionHandler

Handle the provided exception.

CheckinCheckoutExceptionHandler::handle() — Method in class CheckinCheckoutExceptionHandler

Handle the provided exception.

InvalidParameterExceptionHandler::handle() — Method in class InvalidParameterExceptionHandler

Handle the provided exception.

InvalidRouteExceptionHandler::handle() — Method in class InvalidRouteExceptionHandler

Handle the provided exception.

NotAcceptableExceptionHandler::handle() — Method in class NotAcceptableExceptionHandler

Handle the provided exception.

NotAllowedExceptionHandler::handle() — Method in class NotAllowedExceptionHandler

Handle the provided exception.

ResourceNotFoundExceptionHandler::handle() — Method in class ResourceNotFoundExceptionHandler

Handle the provided exception.

SaveExceptionHandler::handle() — Method in class SaveExceptionHandler

Handle the provided exception.

SendEmailExceptionHandler::handle() — Method in class SendEmailExceptionHandler

Handle the provided exception.

HtmlRendererClass in namespace Joomla\CMS\Error\Renderer

HTML error page renderer

ExceptionHandler::handleUserDeprecatedErrors() — Method in class ExceptionHandler

Handles an error triggered with the E_USER_DEPRECATED level.

ExceptionHandler::handleException() — Method in class ExceptionHandler

Handles exceptions: logs errors and renders error page.

HelperFactoryClass in namespace Joomla\CMS\Extension\Service\Provider

Service provider for the service helper factory.

$ FeedLink#heightProperty in class FeedLink

The height of the image.

AtomParser::handleAuthor() — Method in class AtomParser

Method to handle the <author> element for the feed.

AtomParser::handleContributor() — Method in class AtomParser

Method to handle the <contributor> element for the feed.

AtomParser::handleGenerator() — Method in class AtomParser

Method to handle the <generator> element for the feed.

AtomParser::handleId() — Method in class AtomParser

Method to handle the <id> element for the feed.

AtomParser::handleLink() — Method in class AtomParser

Method to handle the <link> element for the feed.

AtomParser::handleRights() — Method in class AtomParser

Method to handle the <rights> element for the feed.

AtomParser::handleSubtitle() — Method in class AtomParser

Method to handle the <subtitle> element for the feed.

AtomParser::handleTitle() — Method in class AtomParser

Method to handle the <title> element for the feed.

AtomParser::handleUpdated() — Method in class AtomParser

Method to handle the <updated> element for the feed.

RssParser::handleCategory() — Method in class RssParser

Method to handle the <category> element for the feed.

RssParser::handleCloud() — Method in class RssParser

Method to handle the <cloud> element for the feed.

RssParser::handleCopyright() — Method in class RssParser

Method to handle the <copyright> element for the feed.

RssParser::handleDescription() — Method in class RssParser

Method to handle the <description> element for the feed.

RssParser::handleGenerator() — Method in class RssParser

Method to handle the <generator> element for the feed.

RssParser::handleImage() — Method in class RssParser

Method to handle the <image> element for the feed.

RssParser::handleLanguage() — Method in class RssParser

Method to handle the <language> element for the feed.

RssParser::handleLastBuildDate() — Method in class RssParser

Method to handle the <lastBuildDate> element for the feed.

RssParser::handleLink() — Method in class RssParser

Method to handle the <link> element for the feed.

RssParser::handleManagingEditor() — Method in class RssParser

Method to handle the <managingEditor> element for the feed.

RssParser::handleSkipDays() — Method in class RssParser

Method to handle the <skipDays> element for the feed.

RssParser::handleSkipHours() — Method in class RssParser

Method to handle the <skipHours> element for the feed.

RssParser::handlePubDate() — Method in class RssParser

Method to handle the <pubDate> element for the feed.

RssParser::handleTitle() — Method in class RssParser

Method to handle the <title> element for the feed.

RssParser::handleTtl() — Method in class RssParser

Method to handle the <ttl> element for the feed.

RssParser::handleWebmaster() — Method in class RssParser

Method to handle the <webmaster> element for the feed.

$ EditorField#heightProperty in class EditorField

The height of the editor.

$ EditorField#hideProperty in class EditorField

The hide of the editor.

$ FilelistField#hideNoneProperty in class FilelistField

The hideNone.

$ FilelistField#hideDefaultProperty in class FilelistField

The hideDefault.

$ FolderlistField#hideNoneProperty in class FolderlistField

The hideNone.

$ FolderlistField#hideDefaultProperty in class FolderlistField

The hideDefault.

HeadertagFieldClass in namespace Joomla\CMS\Form\Field

Form Field class for the Joomla! CMS.

HiddenFieldClass in namespace Joomla\CMS\Form\Field

Form Field class for the Joomla Platform.

$ ListField#headerProperty in class ListField

The header.

$ MediaField#heightProperty in class MediaField

Modal height.

$ NoteField#hiddenLabelProperty in class NoteField

Hide the label when rendering the form field.

$ NoteField#hiddenDescriptionProperty in class NoteField

Hide the description when rendering the form field.

$ SqlField#headerProperty in class SqlField

The header.

$ WorkflowconditionField#hideAllProperty in class WorkflowconditionField

Determinate if the "All" value should be added

$ FormField#hintProperty in class FormField

The hint text for the form field used to display hint inside the field.

$ FormField#hiddenProperty in class FormField

The hidden state for the form field.

$ FormField#hiddenLabelProperty in class FormField

Should the label be hidden when rendering the form field? This may be useful if you have the label rendering in a legend in your form field itself for radio buttons in a fieldset etc.

$ FormField#hiddenDescriptionProperty in class FormField

Should the description be hidden when rendering the form field? This may be useful if you have the description rendering in your form field itself for e.g. note fields.

HTMLHelperClass in namespace Joomla\CMS\HTML

Utility class for all HTML drawing classes

HTMLRegistryAwareTraitClass in namespace Joomla\CMS\HTML

Defines the trait for a HTML Registry aware class.

Behavior::highlighter() — Method in class Behavior

Highlight some words via Javascript.

Registry::hasService() — Method in class Registry

Check if the registry has a service for the given key

HelpClass in namespace Joomla\CMS\Help

Help system class

HelperFactoryClass in namespace Joomla\CMS\Helper

Namespace based implementation of the HelperFactoryInterface

HelperFactoryAwareInterfaceClass in namespace Joomla\CMS\Helper

Interface to be implemented by classes depending on a helper factory.

HelperFactoryAwareTraitClass in namespace Joomla\CMS\Helper

Defines the trait for a HelperFactory Aware Class.

HelperFactoryInterfaceClass in namespace Joomla\CMS\Helper

Factory to load helper classes.

UserGroupsHelper::has() — Method in class UserGroupsHelper

Check if a group is in the list.

HttpClass in namespace Joomla\CMS\Http

HTTP client class.

HttpFactoryClass in namespace Joomla\CMS\Http

HTTP factory class.

$ Image#handleProperty in class Image
$ ImageFilter#handleProperty in class ImageFilter
Language::hasKey() — Method in class Language

Determines is a key exists.

LoggerRegistry::hasLogger() — Method in class LoggerRegistry

Check if the registry has a logger for the given key

$ DatabaseLogger#hostProperty in class DatabaseLogger

The host name (or IP) of the server with which to connect for the logger.

BaseController::holdEditId() — Method in class BaseController

Method to add a record ID to the edit list.

$ ListModel#htmlFormNameProperty in class ListModel

Associated HTML form

$ FormView#helpLinkProperty in class FormView

The help link

HtmlViewClass in namespace Joomla\CMS\MVC\View

Base class for a Joomla Html View

$ ListView#helpLinkProperty in class ListView

The help link for the view

$ MenuItem#homeProperty in class MenuItem

Indicates if this menu item is the home or default page

Microdata::htmlMeta() — Method in class Microdata

Return Microdata semantics in a <meta> tag with content for machines.

Microdata::htmlSpan() — Method in class Microdata

Return Microdata semantics in a <span> tag.

Microdata::htmlDiv() — Method in class Microdata

Return Microdata semantics in a <div> tag.

Microdata::htmlTag() — Method in class Microdata

Return Microdata semantics in a specified tag.

Microdata::htmlScope() — Method in class Microdata

Return the HTML Scope

Microdata::htmlProperty() — Method in class Microdata

Return the HTML Property

$ Pagination#hideEmptyLimitstartProperty in class Pagination
HTMLRegistryClass in namespace Joomla\CMS\Service\Provider

Service provider for the HTML service registry

Session::has() — Method in class Session

Check whether data exists in the session store

JoomlaStorage::has() — Method in class JoomlaStorage

Check whether data exists in the session store

HttpLoaderClass in namespace Joomla\CMS\TUF
HttpLoaderExceptionClass in namespace Joomla\CMS\TUF
$ TufFetcher#httpClientProperty in class TufFetcher

The http client

Table::hasPrimaryKey() — Method in class Table

Validate that the primary key has been set.

Table::hit() — Method in class Table

Method to increment the hits for a row if the necessary property/field exists.

Table::hasField() — Method in class Table

Check if the record has a property (applying a column alias if it exists)

TableInterface::hasField() — Method in class TableInterface

Check if the record has a property (applying a column alias if it exists)

CustomButton::html() — Method in class CustomButton
HelpButtonClass in namespace Joomla\CMS\Toolbar\Button

Renders a help popup window button

CoreButtonsTrait::help() — Method in class CoreButtonsTrait

Writes a help button for a given option (opens a popup window).

Toolbar::helpButton() — Method in class Toolbar
ToolbarHelper::help() — Method in class ToolbarHelper

Writes a help button for a given option (opens a popup window).

ImmutableNodeInterface::hasChildren() — Method in class ImmutableNodeInterface

Test if this node has children

ImmutableNodeInterface::hasParent() — Method in class ImmutableNodeInterface

Test if this node has a parent

ImmutableNodeTrait::hasChildren() — Method in class ImmutableNodeTrait

Test if this node has children

ImmutableNodeTrait::hasParent() — Method in class ImmutableNodeTrait

Test if this node has a parent

UserHelper::hashPassword() — Method in class UserHelper

Hashes a password using the current encryption.

PasswordHash::HashPassword() — Method in class PasswordHash

I

InvalidCiphertextExceptionClass in namespace [Global Namespace]
$ JLoader#importedProperty in class JLoader

Container for already imported library paths.

JLoader::import() — Method in class JLoader

Loads a class from specified directories.

$ Access#identitiesProperty in class Access

Array of loaded user identities

AdministratorApplication::initialiseApp() — Method in class AdministratorApplication

Initialise the application.

$ BaseApplication#inputProperty in class BaseApplication

The application input object

CliInput::in() — Method in class CliInput

Get a value from standard input.

$ CMSApplication#instancesProperty in class CMSApplication

Application instances container.

CMSApplication::initialiseApp() — Method in class CMSApplication

Initialise the application.

CMSApplication::isHttpsForced() — Method in class CMSApplication

Checks if HTTPS is forced in the client configuration.

CMSApplication::isClient() — Method in class CMSApplication

Check the client interface by name.

CMSApplication::isCli() — Method in class CMSApplication

Flag if the application instance is a CLI or web based application.

CMSApplication::isTwoFactorAuthenticationRequired() — Method in class CMSApplication

No longer used

$ CMSApplicationInterface#inputProperty in class CMSApplicationInterface

{@deprecated 4.0 will be removed in 6.0} The Joomla Input property. Deprecated in favour of getInput()

CMSApplicationInterface::isClient() — Method in class CMSApplicationInterface

Check the client interface by name.

CMSApplicationInterface::isCli() — Method in class CMSApplicationInterface

Flag if the application instance is a CLI or web based application.

$ CliApplication#inputProperty in class CliApplication

The input.

$ CliApplication#instanceProperty in class CliApplication

The application instance.

CliApplication::in() — Method in class CliApplication

Get a value from standard input.

CliApplication::isClient() — Method in class CliApplication

Check the client interface by name.

CliApplication::isCli() — Method in class CliApplication

Flag if the application instance is a CLI or web based application.

$ ConsoleApplication#inputProperty in class ConsoleApplication

The input.

ConsoleApplication::isClient() — Method in class ConsoleApplication

Check the client interface by name.

ConsoleApplication::isCli() — Method in class ConsoleApplication

Flag if the application instance is a CLI or web based application.

DaemonApplication::isActive() — Method in class DaemonApplication

Check to see if the daemon is active. This does not assume that $this daemon is active, but only if an instance of the application is active as a daemon.

IdentityAwareClass in namespace Joomla\CMS\Application

Trait for application classes which are identity (user) aware

$ IdentityAware#identityProperty in class IdentityAware

The application identity object.

MultiFactorAuthenticationHandler::isHandlingMultiFactorAuthentication() — Method in class MultiFactorAuthenticationHandler

Handle the redirection to the Multi-factor Authentication captive login or setup page.

MultiFactorAuthenticationHandler::isMultiFactorAuthenticationPage() — Method in class MultiFactorAuthenticationHandler

Is this a page concerning the Multi-factor Authentication feature?

SiteApplication::initialiseApp() — Method in class SiteApplication

Initialise the application.

$ WebApplication#item_associationsProperty in class WebApplication

The item associations

$ WebApplication#instanceProperty in class WebApplication

The application instance.

$ AssociationExtensionHelper#itemTypesProperty in class AssociationExtensionHelper

Array of item types

$ Authentication#instanceProperty in class Authentication
ChainedHandler::isSupported() — Method in class ChainedHandler

Check that the password handler is supported in this environment

MD5Handler::isSupported() — Method in class MD5Handler

Check that the password handler is supported in this environment

PHPassHandler::isSupported() — Method in class PHPassHandler

Check that the password handler is supported in this environment

ProviderAwareAuthenticationPluginInterface::isPrimaryProvider() — Method in class ProviderAwareAuthenticationPluginInterface

Return if plugin acts as primary provider

CacheStorage::isSupported() — Method in class CacheStorage

Test to see if the storage handler is available.

ApcuStorage::isSupported() — Method in class ApcuStorage

Test to see if the storage handler is available.

MemcachedStorage::isSupported() — Method in class MemcachedStorage

Test to see if the storage handler is available.

RedisStorage::isSupported() — Method in class RedisStorage

Test to see if the storage handler is available.

RedisStorage::isConnected() — Method in class RedisStorage

Test to see if the Redis connection is available.

Captcha::initialise() — Method in class Captcha

Fire the onInit event to initialise the captcha plugin.

CaptchaRegistry::initRegistry() — Method in class CaptchaRegistry

Trigger event to allow register the element through plugins.

$ Categories#instancesProperty in class Categories

Array to hold the object instances

$ CategoryNode#idProperty in class CategoryNode

Primary key

$ FtpClient#instancesProperty in class FtpClient
FtpClient::isConnected() — Method in class FtpClient

Method to determine if the object is connected to an FTP server

ComponentHelper::isEnabled() — Method in class ComponentHelper

Checks if the component is enabled

ComponentHelper::isInstalled() — Method in class ComponentHelper

Checks if a component is installed

$ ComponentRecord#idProperty in class ComponentRecord

Primary key

$ ExtensionsListCommand#ioStyleProperty in class ExtensionsListCommand

SymfonyStyle Object

CryptoCipher::isSupported() — Method in class CryptoCipher

Check if the cipher is supported in this environment.

SodiumCipher::isSupported() — Method in class SodiumCipher

Check if the cipher is supported in this environment.

$ Date#isleapyearProperty in class Date

L - Whether it's a leap year.

$ Dispatcher#inputProperty in class Dispatcher

The input instance

$ Document#instancesProperty in class Document

Document instances container.

$ FeedDocument#imageProperty in class FeedDocument

Image feed element

$ FeedDocument#itemsProperty in class FeedDocument

The feed items collection

HtmlDocument::isHtml5() — Method in class HtmlDocument

Returns whether the document is set up to be output as HTML5

ImageDocumentClass in namespace Joomla\CMS\Document

ImageDocument class, provides an easy interface to output image data

$ XmlDocument#isDownloadProperty in class XmlDocument

Flag indicating the document should be downloaded (Content-Disposition = attachment) versus displayed inline

XmlDocument::isDownload() — Method in class XmlDocument

Check if this document is intended for download

ButtonsRegistry::initRegistry() — Method in class ButtonsRegistry

Initialise the registry, eg: auto-register elements.

ButtonsRegistryInterface::initRegistry() — Method in class ButtonsRegistryInterface

Initialise the registry, eg: auto-register elements.

$ Editor#instancesProperty in class Editor

Editor instances container.

Editor::initialise() — Method in class Editor

Initialise the editor

EditorsRegistry::initRegistry() — Method in class EditorsRegistry

Initial set up of the registry elements through plugins etc.

EditorsRegistryInterface::initRegistry() — Method in class EditorsRegistryInterface

Initial set up of the registry elements through plugins etc.

AesInterface::isSupported() — Method in class AesInterface

Is this adapter supported?

Mcrypt::isSupported() — Method in class Mcrypt

Is this adapter supported?

OpenSSL::isSupported() — Method in class OpenSSL

Is this adapter supported?

Aes::isSupported() — Method in class Aes

Is AES encryption supported by this PHP installation?

$ Browser#imagesProperty in class Browser

List of viewable image MIME subtypes.

$ Browser#instancesProperty in class Browser
Browser::identifyBrowserVersion() — Method in class Browser

Set browser version, not by engine version Fallback to use when no other method identify the engine version

Browser::isViewable() — Method in class Browser

Determines if a browser can display a given MIME type.

Browser::isBrowser() — Method in class Browser

Determine if the given browser is the same as the current.

Browser::isRobot() — Method in class Browser

Determines if the browser is a robot or not.

Browser::isMobile() — Method in class Browser

Determines if the browser is mobile version or not.

InvalidParameterExceptionHandlerClass in namespace Joomla\CMS\Error\JsonApi

Handler for invalid param

InvalidRouteExceptionHandlerClass in namespace Joomla\CMS\Error\JsonApi

Handler for routing errors that should give a 404

InstallerEventClass in namespace Joomla\CMS\Event\Installer

Class for Installer events

IsExcludedEventClass in namespace Joomla\CMS\Event\PageCache

Class for PageCache events

AuthenticationEvent::isStopped() — Method in class AuthenticationEvent

Tell if the event propagation is stopped.

ExceptionHandler::isException() — Method in class ExceptionHandler

Checks if given error belong to PHP exception class (\Throwable for PHP 7+, \Exception for PHP 5-).

$ Feed#imageProperty in class Feed

FeedLink object containing feed image properties.

$ FeedParser#inputFilterProperty in class FeedParser

The InputFilter

FeedParser::initialise() — Method in class FeedParser

Method to initialise the feed for parsing. If child parsers need to detect versions or other such things this is where you'll want to implement that logic.

AtomParser::initialise() — Method in class AtomParser

Method to initialise the feed for parsing. Here we detect the version and advance the stream reader so that it is ready to parse feed elements.

RssParser::initialise() — Method in class RssParser

Method to initialise the feed for parsing. Here we detect the version and advance the stream reader so that it is ready to parse feed elements.

ItunesRssParserClass in namespace Joomla\CMS\Feed\Parser\Rss

RSS Feed Parser Namespace handler for iTunes.

File::invalidateFileCache() — Method in class File

Invalidate opcache for a newly written/deleted file immediately, if opcache* functions exist and if this was a PHP file.

FilesystemHelper::isJoomlaStream() — Method in class FilesystemHelper

Determine if a stream is a Joomla stream.

$ Patcher#instanceProperty in class Patcher
Path::isOwner() — Method in class Path

Method to determine if script owns the path.

InputFilterClass in namespace Joomla\CMS\Filter

InputFilter is a class for filtering input from any data source

$ InputFilter#instancesProperty in class InputFilter

A container for InputFilter instances.

InputFilter::isSafeFile() — Method in class InputFilter

Checks an uploaded for suspicious naming and potential PHP contents which could indicate a hacking attempt.

ImagelistFieldClass in namespace Joomla\CMS\Form\Field

Supports an HTML select list of image

IntegerFieldClass in namespace Joomla\CMS\Form\Field

Form Field class for the Joomla Platform.

$ RulesField#isGlobalConfigProperty in class RulesField

The flag which indicates if it is the global config

$ TagField#isNestedProperty in class TagField

Flag to work with nested tag field

TagField::isNested() — Method in class TagField

Determine if the field has to be tagnested

TagField::isRemoteSearch() — Method in class TagField

Check whether need to enable AJAX search

$ TextField#inputmodeProperty in class TextField

The mode of input associated with the field.

IntarrayFilterClass in namespace Joomla\CMS\Form\Filter

Form Filter class for integer arrays

$ FormField#idProperty in class FormField

The document id for the form field.

$ FormField#inputProperty in class FormField

The input for the form field.

FormField::isDebugEnabled() — Method in class FormField

Is debug enabled for this field

$ HTMLHelper#includePathsProperty in class HTMLHelper

An array to hold included paths

HTMLHelper::isRegistered() — Method in class HTMLHelper

Test if the key is registered.

HTMLHelper::iframe() — Method in class HTMLHelper

Write a <iframe> element

HTMLHelper::includeRelativeFiles() — Method in class HTMLHelper

Compute the files to be included

HTMLHelper::image() — Method in class HTMLHelper

Write a <img> element

$ AdminLanguage#itemsProperty in class AdminLanguage

Cached array of the administrator language items.

$ Category#itemsProperty in class Category

Cached array of the category items.

$ ContentLanguage#itemsProperty in class ContentLanguage

Cached array of the content language items.

Dropdown::init() — Method in class Dropdown

Method to inject needed script

Grid::id() — Method in class Grid

Method to create a checkbox for a grid row.

IconsClass in namespace Joomla\CMS\HTML\Helpers

Utility class for icons.

JGrid::isdefault() — Method in class JGrid

Returns an isDefault state on a grid

ListHelper::images() — Method in class ListHelper

Build the select list to choose an image

$ Menu#itemsProperty in class Menu

Cached array of the menus items.

Select::integerlist() — Method in class Select

Generates a selection list of integers.

$ Tag#itemsProperty in class Tag

Cached array of the tag items.

LibraryHelper::isEnabled() — Method in class LibraryHelper

Checks if a library is enabled

MediaHelper::isImage() — Method in class MediaHelper

Checks if the file is an image

MediaHelper::imageResize() — Method in class MediaHelper

Calculate the size of a resized image

MediaHelper::isValidLocalDirectory() — Method in class MediaHelper

Method to check if the given directory is a directory configured in FileSystem - Local plugin

ModuleHelper::isEnabled() — Method in class ModuleHelper

Checks if a module is enabled. A given module will only be returned if it meets the following criteria: it is enabled, it is assigned to the current menu item or all items, and the user meets the access level requirements.

ModuleHelper::isAdminMultilang() — Method in class ModuleHelper

Method to determine if filtering by language is enabled in back-end for modules.

$ RouteHelper#idProperty in class RouteHelper
$ TagsHelper#itemTagsProperty in class TagsHelper

Array of item tags.

CurlTransport::isSupported() — Method in class CurlTransport

Method to check if HTTP transport cURL is available for use

SocketTransport::isSupported() — Method in class SocketTransport

Method to check if http transport socket available for use

StreamTransport::isSupported() — Method in class StreamTransport

Method to check if http transport stream available for use

ImageClass in namespace Joomla\CMS\Image

Class to manipulate an image.

Image::isLoaded() — Method in class Image

Method to determine whether or not an image has been loaded into the object.

Image::isTransparent() — Method in class Image

Method to determine whether or not the image has transparency.

ImageFilterClass in namespace Joomla\CMS\Image

Class to manipulate an image.

InputClass in namespace Joomla\CMS\Input

Joomla! Input Base Class

$ Input#inputsProperty in class Input

Input objects

$ ComponentAdapter#install_scriptProperty in class ComponentAdapter

For legacy installations this is a path to the PHP file that the scriptfile declaration in the manifest refers to.

$ LanguageAdapter#ignoreUninstallQueriesProperty in class LanguageAdapter

Flag indicating the uninstall process should not run SQL queries

LanguageAdapter::install() — Method in class LanguageAdapter

Custom install method

$ PackageAdapter#installedIdsProperty in class PackageAdapter

An array of extension IDs for each installed extension

InstallerClass in namespace Joomla\CMS\Installer

Joomla base installer class

$ Installer#instancesProperty in class Installer

JInstaller instances container.

Installer::isOverwrite() — Method in class Installer

Get the allow overwrite switch

Installer::isPackageUninstall() — Method in class Installer

Get whether this installer is uninstalling extensions which are part of a package

Installer::isUpgrade() — Method in class Installer

Get the upgrade switch

Installer::install() — Method in class Installer

Package installation method

Installer::isManifest() — Method in class Installer

Is the XML file a valid Joomla installation manifest file.

InstallerAdapterClass in namespace Joomla\CMS\Installer

Abstract adapter for the installer.

InstallerAdapter::install() — Method in class InstallerAdapter

Generic install method for extensions

InstallerExtensionClass in namespace Joomla\CMS\Installer

Extension object

$ InstallerExtension#idProperty in class InstallerExtension

Unique Identifier for the extension

InstallerHelperClass in namespace Joomla\CMS\Installer

Installer helper class

InstallerHelper::isChecksumValid() — Method in class InstallerHelper

Return the result of the checksum of a package with the SHA256/SHA384/SHA512 tags in the update server manifest

InstallerScriptClass in namespace Joomla\CMS\Installer

Base install script for use by extensions providing helper methods for common behaviours.

InstallerScriptInterfaceClass in namespace Joomla\CMS\Installer

Base install script interface for use by extensions providing helper methods for common behaviours.

InstallerScriptInterface::install() — Method in class InstallerScriptInterface

Function called after the extension is installed.

LegacyInstallerScript::install() — Method in class LegacyInstallerScript

Function called after the extension is installed.

Associations::isEnabled() — Method in class Associations

Method to determine if the language filter Associations parameter is enabled.

$ Language#ignoredSearchWordsCallbackProperty in class Language

Name of the ignoredSearchWordsCallback function for this language.

Multilanguage::isEnabled() — Method in class Multilanguage

Method to determine if the language filter plugin is enabled.

BaseLayout::isDebugEnabled() — Method in class BaseLayout

Check if debug mode is enabled

$ FileLayout#includePathsProperty in class FileLayout

Paths to search for layouts

$ Log#instanceProperty in class Log

The global Log instance.

FormattedtextLogger::initFile() — Method in class FormattedtextLogger

Method to initialise the log file. This will create the folder path to the file if it doesn't already exist and also get a new file header if the file doesn't already exist. If the file already exists it will simply open it for writing.

InMemoryLoggerClass in namespace Joomla\CMS\Log\Logger

Logger class that keeps all entries in memory

$ ApiController#itemsPerPageProperty in class ApiController

Items on a page

$ BaseController#inputProperty in class BaseController

Hold a JInput object for easier access to the input variables.

$ BaseController#instanceProperty in class BaseController

Instance container.

AdminModel::initBatch() — Method in class AdminModel

Method to initialize member variables used by batch methods and other methods like saveorder()

BaseDatabaseModel::isCheckedOut() — Method in class BaseDatabaseModel

Method to check if the given record is checked out by the current user

ItemModelClass in namespace Joomla\CMS\MVC\Model

Prototype item model.

ItemModelInterfaceClass in namespace Joomla\CMS\MVC\Model

Interface for an item model.

WorkflowBehaviorTrait::importWorkflowPlugins() — Method in class WorkflowBehaviorTrait

Import the Workflow plugins.

$ CategoriesView#itemsProperty in class CategoriesView

Category items data

$ CategoryView#itemsProperty in class CategoryView

Category items data

$ FormView#itemProperty in class FormView

The active item

FormView::initializeView() — Method in class FormView

Prepare view data

$ ListView#itemsProperty in class ListView

An array of items

ListView::initializeView() — Method in class ListView

Prepare view data

$ Mail#instancesProperty in class Mail

Mail instances container.

Mail::isHtml() — Method in class Mail

Sets message type to HTML

Mail::isSendmail() — Method in class Mail

Send messages using $Sendmail.

MailHelper::isEmailAddress() — Method in class MailHelper

Verifies that the string is in a proper email address format.

$ AbstractMenu#itemsProperty in class AbstractMenu

Array to hold the menu items

$ AbstractMenu#instancesProperty in class AbstractMenu

Menu instances container.

$ AdministratorMenuItem#iconProperty in class AdministratorMenuItem

The icon image of the menu item

$ AdministratorMenuItem#iconImageProperty in class AdministratorMenuItem

The icon image of the link

$ MenuItem#idProperty in class MenuItem

Primary key

$ MenuItem#imgProperty in class MenuItem

The image of the menu item

Microdata::isEnabled() — Method in class Microdata

Return 'true' if the library output is enabled

Microdata::isPropertyInType() — Method in class Microdata

Recursive function, control if the given Type has the given Property

Microdata::isTypeAvailable() — Method in class Microdata

Control if the given Type class is available

$ Pathway#instancesProperty in class Pathway

Pathway instances container.

PluginHelper::isEnabled() — Method in class PluginHelper

Checks if a plugin is enabled.

PluginHelper::importPlugin() — Method in class PluginHelper

Loads all the plugin files for a particular type if no specific plugin is specified otherwise only the specific plugin is loaded.

PluginHelper::import() — Method in class PluginHelper

Loads the plugin file.

$ Profiler#instancesProperty in class Profiler
$ ObjectProxy#iteratorProperty in class ObjectProxy

An iterator instance

$ Router#instancesProperty in class Router

Router instances container.

Router::isTainted() — Method in class Router

Return if the last parsed URL was tainted.

$ ChangeSet#instanceProperty in class ChangeSet

The singleton instance of this object

SchemaorgPluginTrait::isSupported() — Method in class SchemaorgPluginTrait

Check if the current plugin should execute schemaorg related activities

InputClass in namespace Joomla\CMS\Service\Provider

Service provider for the the Joomla Input object.

$ Asset#idProperty in class Asset

The primary key of the asset.

$ ContentHistory#ignoreChangesProperty in class ContentHistory

Array of object fields to unset from the data object before calculating SHA1 hash. This allows us to detect a meaningful change in the database row using the hash. This can be read from the #__content_types content_history_options column.

Nested::isLeaf() — Method in class Nested

Method to determine if a node is a leaf node in the tree (has no children).

Table::isCheckedOut() — Method in class Table

Method to determine if a row is checked out and therefore uneditable by a user.

InlinehelpButtonClass in namespace Joomla\CMS\Toolbar\Button

Renders a button to show / hide the inline help text

PopupButton::icon() — Method in class PopupButton
PopupButton::iframeWidth() — Method in class PopupButton
PopupButton::iframeHeight() — Method in class PopupButton
CoreButtonsTrait::inlinehelp() — Method in class CoreButtonsTrait

Writes a help button for a given option (opens a popup window).

$ Toolbar#instancesProperty in class Toolbar

Stores the singleton instances of various toolbar.

Toolbar::inlinehelpButton() — Method in class Toolbar
$ ToolbarButton#idCounterProperty in class ToolbarButton

Used to track an ids, to avoid duplication

ToolbarButton::icon() — Method in class ToolbarButton
ToolbarHelper::inlinehelp() — Method in class ToolbarHelper

Writes a help button for showing/hiding the inline help of a form

ImmutableNodeInterfaceClass in namespace Joomla\CMS\Tree

Interface for an immutable node class

ImmutableNodeTraitClass in namespace Joomla\CMS\Tree

Defines the trait for an Immutable Node Class.

$ Update#infourlProperty in class Update

Update manifest <infourl> element

$ Updater#instanceProperty in class Updater

Updater instance container.

$ Uri#instancesProperty in class Uri
Uri::isInternal() — Method in class Uri

Checks if the supplied URL is internal

$ User#isRootProperty in class User

A cached switch for if this user has root access rights.

$ User#idProperty in class User

Unique id

$ User#instancesProperty in class User
Version::isInDevelopmentState() — Method in class Version

Check if we are in development mode

Version::isCompatible() — Method in class Version

Compares two a "PHP standardized" version number against the current Joomla version.

InvalidActionExceptionClass in namespace Joomla\CMS\WebAsset\Exception

Exception class defining an Invalid Action error

WebAssetItem::isPathExternal() — Method in class WebAssetItem

Check if the Path is External

WebAssetItem::isPathAbsolute() — Method in class WebAssetItem

Check if the Path is relative to /media folder or absolute

WebAssetManager::isAssetActive() — Method in class WebAssetManager

Check whether the asset are enabled

WebAssetManagerInterface::isAssetActive() — Method in class WebAssetManagerInterface

Check whether the asset are enabled

WorkflowPluginTrait::isSupported() — Method in class WorkflowPluginTrait

Check if the current plugin should execute workflow related activities

WorkflowServiceInterface::isWorkflowActive() — Method in class WorkflowServiceInterface

Check if the workflow is active

WorkflowServiceTrait::isFunctionalityUsed() — Method in class WorkflowServiceTrait

Check if the functionality is used by a plugin

WorkflowServiceTrait::isWorkflowActive() — Method in class WorkflowServiceTrait

Check if the workflow is active

$ PasswordHash#itoa64Property in class PasswordHash
$ PasswordHash#iteration_count_log2Property in class PasswordHash
__TwigTemplate_0bf62896b95c7e97cd0f4eae5f5f6195::isTraitable() — Method in class __TwigTemplate_0bf62896b95c7e97cd0f4eae5f5f6195
__TwigTemplate_3994fb5d5d826575e5e068ab43919da3::isTraitable() — Method in class __TwigTemplate_3994fb5d5d826575e5e068ab43919da3
__TwigTemplate_4bcccb9f0894179cb357804bda58e4b3::isTraitable() — Method in class __TwigTemplate_4bcccb9f0894179cb357804bda58e4b3
__TwigTemplate_5043402560718bb1c61e09b845b77e36::isTraitable() — Method in class __TwigTemplate_5043402560718bb1c61e09b845b77e36
__TwigTemplate_79fb764e9da8ea996f0ce34ace2da336::isTraitable() — Method in class __TwigTemplate_79fb764e9da8ea996f0ce34ace2da336
__TwigTemplate_85e091843a2d5eb6b1597c2f89e0752c::isTraitable() — Method in class __TwigTemplate_85e091843a2d5eb6b1597c2f89e0752c
__TwigTemplate_896e1a17f0353adb41deb8b45210ae94::isTraitable() — Method in class __TwigTemplate_896e1a17f0353adb41deb8b45210ae94
__TwigTemplate_93a051471fb2bd8bc386b2041ff7ba2b::isTraitable() — Method in class __TwigTemplate_93a051471fb2bd8bc386b2041ff7ba2b
__TwigTemplate_959903b26cb0d471d240abcbd9524242::isTraitable() — Method in class __TwigTemplate_959903b26cb0d471d240abcbd9524242
__TwigTemplate_a53d5b9a592c30f5292fdf2cf5daaf44::isTraitable() — Method in class __TwigTemplate_a53d5b9a592c30f5292fdf2cf5daaf44
__TwigTemplate_acdad90fc61f5e474deb98262a7dc3eb::isTraitable() — Method in class __TwigTemplate_acdad90fc61f5e474deb98262a7dc3eb
__TwigTemplate_adbbf7f4f8572fd945270d87a68752a6::isTraitable() — Method in class __TwigTemplate_adbbf7f4f8572fd945270d87a68752a6
__TwigTemplate_bc6db32d62004a1677f9a4af03635305::isTraitable() — Method in class __TwigTemplate_bc6db32d62004a1677f9a4af03635305
__TwigTemplate_ebd3ded38a1374cfcb2671eaa14a1d29::isTraitable() — Method in class __TwigTemplate_ebd3ded38a1374cfcb2671eaa14a1d29
__TwigTemplate_f39bca71236ed63ca7b7b0f776c66525::isTraitable() — Method in class __TwigTemplate_f39bca71236ed63ca7b7b0f776c66525

J

JLoaderClass in namespace [Global Namespace]

Static class to handle loading of libraries.

JNamespacePsr4MapClass in namespace [Global Namespace]

Class JNamespacePsr4Map

$ WebApplication#JComponentTitleProperty in class WebApplication

The application component title.

JsonDocumentClass in namespace Joomla\CMS\Document

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

JsonapiDocumentClass in namespace Joomla\CMS\Document

JsonapiDocument class, provides an easy interface to parse output in JSON-API format.

JsonapiDocument::jsonSerialize() — Method in class JsonapiDocument

Serialize for JSON usage.

JsonRendererClass in namespace Joomla\CMS\Error\Renderer

JSON error page renderer

JsonapiRendererClass in namespace Joomla\CMS\Error\Renderer

JSON error page renderer

JGridClass in namespace Joomla\CMS\HTML\Helpers

Utility class for creating HTML Grids

JqueryClass in namespace Joomla\CMS\HTML\Helpers

Utility class for jQuery JavaScript behaviors

$ Input#jsonProperty in class Input
JsonClass in namespace Joomla\CMS\Input

Joomla! Input JSON Class

JsonApiViewClass in namespace Joomla\CMS\MVC\View

Base class for a Joomla Json List View

JsonViewClass in namespace Joomla\CMS\MVC\View

Base class for a Joomla Json View

JsonResponseClass in namespace Joomla\CMS\Response

JSON Response class.

JoomlaSerializerClass in namespace Joomla\CMS\Serializer

This class does the messy job of sanitising all the classes Joomla has that contain data and converting them into a standard array that can be consumed by the Tobscure library. It also throws appropriate plugin events to allow 3rd party extensions to add custom data and relations into these properties before they are rendered

JoomlaStorageClass in namespace Joomla\CMS\Session\Storage

Service provider for the application's session dependency

CoreButtonsTrait::jooa11y() — Method in class CoreButtonsTrait

Writes a jooa11y accessibility checker button for a given option (opens a popup window).

ToolbarHelper::jooa11y() — Method in class ToolbarHelper

Writes a jooa11y accessibility checker button for a given option (opens a popup window).

K

$ RouterViewConfiguration#keyProperty in class RouterViewConfiguration

Key of the view

$ PreprocessRules#keyProperty in class PreprocessRules

ID column in the table to read the information from

$ Aes#keyProperty in class Aes

The cipher key.

$ ColorField#keywordsProperty in class ColorField

The keywords (transparent,initial,inherit).

$ SqlField#keyFieldProperty in class SqlField

The keyField.

$ TimezoneField#keyFieldProperty in class TimezoneField

The keyField of timezone field.

Behavior::keepalive() — Method in class Behavior

Keep session alive, for example, while editing or creating an article.

$ FormView#keyNameProperty in class FormView

The item primary key name

ArrayProxy::key() — Method in class ArrayProxy

Implementation of Iterator interface

ObjectProxy::key() — Method in class ObjectProxy

Implementation of Iterator interface

KeepaliveAssetItemClass in namespace Joomla\CMS\WebAsset\AssetItem

Web Asset Item class for Keepalive asset

L

JLoader::load() — Method in class JLoader

Load the file for a class.

JLoader::loadByPsr4() — Method in class JLoader

Method to autoload classes that are namespaced to the PSR-4 standard.

JLoader::loadByPsr() — Method in class JLoader

Method to autoload classes that are namespaced to the PSR-4 standard.

JLoader::loadByAlias() — Method in class JLoader

Method to autoload classes that have been aliased using the registerAlias method.

JNamespacePsr4Map::load() — Method in class JNamespacePsr4Map

Load the PSR4 file

Adapter::loadAllAdapters() — Method in class Adapter

Loads all adapters.

AdministratorApplication::login() — Method in class AdministratorApplication

Login authentication function

CMSApplication::loadLibraryLanguage() — Method in class CMSApplication

Load the library language files for the application

CMSApplication::login() — Method in class CMSApplication

Login authentication function.

CMSApplication::logout() — Method in class CMSApplication

Logout authentication function.

CMSApplicationInterface::loadIdentity() — Method in class CMSApplicationInterface

Allows the application to load a custom or default identity.

$ CliApplication#languageProperty in class CliApplication

The application language object.

$ ConsoleApplication#languageProperty in class ConsoleApplication

The application language object.

DaemonApplication::loadConfiguration() — Method in class DaemonApplication

Load an object or array into the application configuration object.

IdentityAware::loadIdentity() — Method in class IdentityAware

Allows the application to load a custom or default identity.

$ SiteApplication#language_filterProperty in class SiteApplication

Option to filter by language

SiteApplication::loadLibraryLanguage() — Method in class SiteApplication

Load the library language files for the application

SiteApplication::login() — Method in class SiteApplication

Login authentication function

$ WebApplication#languageProperty in class WebApplication

The application language object.

WebApplication::loadDocument() — Method in class WebApplication

Allows the application to load a custom or default document.

WebApplication::loadLanguage() — Method in class WebApplication

Allows the application to load a custom or default language.

WebApplication::loadSession() — Method in class WebApplication

Allows the application to load a custom or default session.

WebApplication::loadSystemUris() — Method in class WebApplication

Method to load the system URI strings for the application.

$ AuthenticationResponse#languageProperty in class AuthenticationResponse

End User's preferred language as specified by ISO639.

ClassLoader::loadClass() — Method in class ClassLoader

Loads the given class or interface.

$ ActionButton#layoutProperty in class ActionButton

The layout path to render.

$ TransitionButton#layoutProperty in class TransitionButton

The layout path to render.

Cache::lock() — Method in class Cache

Set lock flag on cached item

CacheStorage::lock() — Method in class CacheStorage

Lock cached item

ApcuStorage::lock() — Method in class ApcuStorage

Lock cached item

FileStorage::lock() — Method in class FileStorage

Lock cached item

MemcachedStorage::lock() — Method in class MemcachedStorage

Lock cached item

MemcachedStorage::lockindex() — Method in class MemcachedStorage

Lock cache index

$ CategoryNode#lftProperty in class CategoryNode

The lft value for this category in the category tree

$ CategoryNode#levelProperty in class CategoryNode

The depth of this category's position in the category tree

$ CategoryNode#languageProperty in class CategoryNode

The language for the category in xx-XX format

$ Changelog#languageProperty in class Changelog

Update manifest <language> element

$ Changelog#latestProperty in class Changelog

Object containing the latest changelog data

Changelog::loadFromXml() — Method in class Changelog

Loads an XML file from a URL.

FtpClient::login() — Method in class FtpClient

Method to login to a server once connected

FtpClient::listNames() — Method in class FtpClient

Method to list the filenames of the contents of a directory on the FTP server

FtpClient::listDetails() — Method in class FtpClient

Method to list the contents of a directory on the FTP server

ComponentHelper::load() — Method in class ComponentHelper

Load the installed components into the components property.

$ RouterViewConfiguration#layoutsProperty in class RouterViewConfiguration

Layouts that are supported by this view

$ MenuRules#lookupProperty in class MenuRules

Lookup array of the menu items

ListUserCommandClass in namespace Joomla\CMS\Console

Console command to list existing users

AbstractModuleDispatcher::loadLanguage() — Method in class AbstractModuleDispatcher

Load the language.

ApiDispatcher::loadLanguage() — Method in class ApiDispatcher

Load the component's administrator language

ComponentDispatcher::loadLanguage() — Method in class ComponentDispatcher

Load the language

LegacyComponentDispatcherClass in namespace Joomla\CMS\Dispatcher

Base class for a legacy Joomla Dispatcher

$ Document#linkProperty in class Document

Document full URL

$ Document#languageProperty in class Document

Contains the document language setting

Document::loadRenderer() — Method in class Document

Load a renderer

ErrorDocument::loadRenderer() — Method in class ErrorDocument

Load a renderer

$ FeedDocument#lastBuildDateProperty in class FeedDocument

Lastbuild date feed element

$ FeedEnclosure#lengthProperty in class FeedEnclosure

Length enclosure element

$ FeedImage#linkProperty in class FeedImage

Link image attribute

$ FeedItem#linkProperty in class FeedItem

Link item element

$ PreloadManager#linkProviderProperty in class PreloadManager

The link provider

$ Browser#lowerAgentProperty in class Browser
AbstractRenderer::loadDocument() — Method in class AbstractRenderer

Create the Document object for this renderer

$ AfterPurgeEvent#legacyArgumentsOrderProperty in class AfterPurgeEvent

The argument names, in order expected by legacy plugins.

$ AfterCheckinEvent#legacyArgumentsOrderProperty in class AfterCheckinEvent

The argument names, in order expected by legacy plugins.

$ SubmitContactEvent#legacyArgumentsOrderProperty in class SubmitContactEvent

The argument names, in order expected by legacy plugins.

$ ValidateContactEvent#legacyArgumentsOrderProperty in class ValidateContactEvent

The argument names, in order expected by legacy plugins.

$ ContentEvent#legacyArgumentsOrderProperty in class ContentEvent

The argument names, in order expected by legacy plugins.

$ ContentPrepareEvent#legacyArgumentsOrderProperty in class ContentPrepareEvent

The argument names, in order expected by legacy plugins.

$ AbstractPrepareFieldEvent#legacyArgumentsOrderProperty in class AbstractPrepareFieldEvent

The argument names, in order expected by legacy plugins.

$ AfterPrepareFieldEvent#legacyArgumentsOrderProperty in class AfterPrepareFieldEvent

The argument names, in order expected by legacy plugins.

$ CustomFieldsEvent#legacyArgumentsOrderProperty in class CustomFieldsEvent

The argument names, in order expected by legacy plugins.

$ PrepareDomEvent#legacyArgumentsOrderProperty in class PrepareDomEvent

The argument names, in order expected by legacy plugins.

$ AbstractExtensionEvent#legacyArgumentsOrderProperty in class AbstractExtensionEvent

The argument names, in order expected by legacy plugins.

$ AbstractJoomlaUpdateEvent#legacyArgumentsOrderProperty in class AbstractJoomlaUpdateEvent

The argument names, in order expected by legacy plugins.

$ AfterInstallEvent#legacyArgumentsOrderProperty in class AfterInstallEvent

The argument names, in order expected by legacy plugins.

$ AfterJoomlaUpdateEvent#legacyArgumentsOrderProperty in class AfterJoomlaUpdateEvent

The argument names, in order expected by legacy plugins.

$ AfterUninstallEvent#legacyArgumentsOrderProperty in class AfterUninstallEvent

The argument names, in order expected by legacy plugins.

$ AfterUpdateEvent#legacyArgumentsOrderProperty in class AfterUpdateEvent

The argument names, in order expected by legacy plugins.

$ BeforeInstallEvent#legacyArgumentsOrderProperty in class BeforeInstallEvent

The argument names, in order expected by legacy plugins.

$ BeforeUninstallEvent#legacyArgumentsOrderProperty in class BeforeUninstallEvent

The argument names, in order expected by legacy plugins.

$ BeforeUpdateEvent#legacyArgumentsOrderProperty in class BeforeUpdateEvent

The argument names, in order expected by legacy plugins.

$ AbstractFinderEvent#legacyArgumentsOrderProperty in class AbstractFinderEvent

The argument names, in order expected by legacy plugins.

$ AfterSaveEvent#legacyArgumentsOrderProperty in class AfterSaveEvent

The argument names, in order expected by legacy plugins.

$ BeforeSaveEvent#legacyArgumentsOrderProperty in class BeforeSaveEvent

The argument names, in order expected by legacy plugins.

$ PrepareContentEvent#legacyArgumentsOrderProperty in class PrepareContentEvent

The argument names, in order expected by legacy plugins.

$ ResultEvent#legacyArgumentsOrderProperty in class ResultEvent

The argument names, in order expected by legacy plugins.

$ AfterInstallerEvent#legacyArgumentsOrderProperty in class AfterInstallerEvent

The argument names, in order expected by legacy plugins.

$ BeforePackageDownloadEvent#legacyArgumentsOrderProperty in class BeforePackageDownloadEvent

The argument names, in order expected by legacy plugins.

$ InstallerEvent#legacyArgumentsOrderProperty in class InstallerEvent

The argument names, in order expected by legacy plugins.

$ BeforeRenderingMailTemplateEvent#legacyArgumentsOrderProperty in class BeforeRenderingMailTemplateEvent

The argument names, in order expected by legacy plugins.

$ MailTemplateEvent#legacyArgumentsOrderProperty in class MailTemplateEvent

The argument names, in order expected by legacy plugins.

$ AfterGetMenuTypeOptionsEvent#legacyArgumentsOrderProperty in class AfterGetMenuTypeOptionsEvent

The argument names, in order expected by legacy plugins.

$ BeforeRenderMenuItemsViewEvent#legacyArgumentsOrderProperty in class BeforeRenderMenuItemsViewEvent

The argument names, in order expected by legacy plugins.

$ PreprocessMenuItemsEvent#legacyArgumentsOrderProperty in class PreprocessMenuItemsEvent

The argument names, in order expected by legacy plugins.

$ AfterCleanCacheEvent#legacyArgumentsOrderProperty in class AfterCleanCacheEvent

The argument names, in order expected by legacy plugins.

$ ChangeStateEvent#legacyArgumentsOrderProperty in class ChangeStateEvent

The argument names, in order expected by legacy plugins.

$ DeleteEvent#legacyArgumentsOrderProperty in class DeleteEvent

The argument names, in order expected by legacy plugins.

$ FormEvent#legacyArgumentsOrderProperty in class FormEvent

The argument names, in order expected by legacy plugins.

$ ModelEvent#legacyArgumentsOrderProperty in class ModelEvent

The argument names, in order expected by legacy plugins.

$ NormaliseRequestDataEvent#legacyArgumentsOrderProperty in class NormaliseRequestDataEvent

The argument names, in order expected by legacy plugins.

$ PrepareDataEvent#legacyArgumentsOrderProperty in class PrepareDataEvent

The argument names, in order expected by legacy plugins.

$ SaveEvent#legacyArgumentsOrderProperty in class SaveEvent

The argument names, in order expected by legacy plugins.

$ AfterRenderModulesEvent#legacyArgumentsOrderProperty in class AfterRenderModulesEvent

The argument names, in order expected by legacy plugins.

$ ModuleEvent#legacyArgumentsOrderProperty in class ModuleEvent

The argument names, in order expected by legacy plugins.

$ ModuleListEvent#legacyArgumentsOrderProperty in class ModuleListEvent

The argument names, in order expected by legacy plugins.

$ RenderModuleEvent#legacyArgumentsOrderProperty in class RenderModuleEvent

The argument names, in order expected by legacy plugins.

$ GetStatsDataEvent#legacyArgumentsOrderProperty in class GetStatsDataEvent

The argument names, in order expected by legacy plugins.

$ CanRemoveDataEvent#legacyArgumentsOrderProperty in class CanRemoveDataEvent

The argument names, in order expected by legacy plugins.

$ CheckPrivacyPolicyPublishedEvent#legacyArgumentsOrderProperty in class CheckPrivacyPolicyPublishedEvent

The argument names, in order expected by legacy plugins.

$ ExportRequestEvent#legacyArgumentsOrderProperty in class ExportRequestEvent

The argument names, in order expected by legacy plugins.

$ PrivacyEvent#legacyArgumentsOrderProperty in class PrivacyEvent

The argument names, in order expected by legacy plugins.

$ RemoveDataEvent#legacyArgumentsOrderProperty in class RemoveDataEvent

The argument names, in order expected by legacy plugins.

$ AbstractDeleteEvent#legacyArgumentsOrderProperty in class AbstractDeleteEvent

The argument names, in order expected by legacy plugins.

$ AbstractLoginEvent#legacyArgumentsOrderProperty in class AbstractLoginEvent

The argument names, in order expected by legacy plugins.

$ AbstractLogoutEvent#legacyArgumentsOrderProperty in class AbstractLogoutEvent

The argument names, in order expected by legacy plugins.

$ AbstractResetEvent#legacyArgumentsOrderProperty in class AbstractResetEvent

The argument names, in order expected by legacy plugins.

$ AbstractSaveEvent#legacyArgumentsOrderProperty in class AbstractSaveEvent

The argument names, in order expected by legacy plugins.

$ AfterDeleteEvent#legacyArgumentsOrderProperty in class AfterDeleteEvent

The argument names, in order expected by legacy plugins.

$ AfterLoginEvent#legacyArgumentsOrderProperty in class AfterLoginEvent

The argument names, in order expected by legacy plugins.

$ AfterLogoutEvent#legacyArgumentsOrderProperty in class AfterLogoutEvent

The argument names, in order expected by legacy plugins.

$ AfterRemindEvent#legacyArgumentsOrderProperty in class AfterRemindEvent

The argument names, in order expected by legacy plugins.

$ AfterSaveEvent#legacyArgumentsOrderProperty in class AfterSaveEvent

The argument names, in order expected by legacy plugins.

$ AuthenticationEvent#legacyArgumentsOrderProperty in class AuthenticationEvent

The argument names, in order expected by legacy plugins.

$ AuthorisationEvent#legacyArgumentsOrderProperty in class AuthorisationEvent

The argument names, in order expected by legacy plugins.

$ AuthorisationFailureEvent#legacyArgumentsOrderProperty in class AuthorisationFailureEvent

The argument names, in order expected by legacy plugins.

$ BeforeSaveEvent#legacyArgumentsOrderProperty in class BeforeSaveEvent

The argument names, in order expected by legacy plugins.

LoginButtonsEventClass in namespace Joomla\CMS\Event\User

Class for User event.

$ LoginButtonsEvent#legacyArgumentsOrderProperty in class LoginButtonsEvent

The argument names, in order expected by legacy plugins.

LoginEventClass in namespace Joomla\CMS\Event\User

Class for User event.

LoginFailureEventClass in namespace Joomla\CMS\Event\User

Class for User event.

LogoutEventClass in namespace Joomla\CMS\Event\User

Class for User event.

LogoutFailureEventClass in namespace Joomla\CMS\Event\User

Class for User event.

$ UserEvent#legacyArgumentsOrderProperty in class UserEvent

The argument names, in order expected by legacy plugins.

$ UserGroupAfterDeleteEvent#legacyArgumentsOrderProperty in class UserGroupAfterDeleteEvent

The argument names, in order expected by legacy plugins.

$ UserGroupBeforeDeleteEvent#legacyArgumentsOrderProperty in class UserGroupBeforeDeleteEvent

The argument names, in order expected by legacy plugins.

ExceptionHandler::logException() — Method in class ExceptionHandler

Logs exception, catching all possible errors during logging.

LegacyComponentClass in namespace Joomla\CMS\Extension

Access to component specific services.

$ Factory#languageProperty in class Factory

Global language object

$ FeedEntry#linksProperty in class FeedEntry

Links associated with the feed entry.

$ FeedLink#languageProperty in class FeedLink

The language of the resource found at the given URI.

$ FeedLink#lengthProperty in class FeedLink

The length of the resource in bytes.

$ FeedLink#linkProperty in class FeedLink

The link of the image.

Folder::listFolderTree() — Method in class Folder

Lists folder in format suitable for tree display.

$ StreamString#lenProperty in class StreamString

Length of the string

OutputFilter::linkXHTMLSafe() — Method in class OutputFilter

This method processes a string and replaces all instances of & with & in links only.

$ AccessiblemediaField#layoutProperty in class AccessiblemediaField

Layout to render

$ CalendarField#layoutProperty in class CalendarField

Name of the layout being used to render the field

$ CheckboxField#layoutProperty in class CheckboxField

Name of the layout being used to render the field

$ CheckboxesField#layoutProperty in class CheckboxesField

Name of the layout being used to render the field

$ ColorField#layoutProperty in class ColorField

Name of the layout being used to render the field

$ ComboField#layoutProperty in class ComboField

Name of the layout being used to render the field

$ ContenthistoryField#layoutProperty in class ContenthistoryField

Layout to render the label

$ EmailField#layoutProperty in class EmailField

Name of the layout being used to render the field

$ FileField#layoutProperty in class FileField

Name of the layout being used to render the field

$ GroupedlistField#layoutProperty in class GroupedlistField

Name of the layout being used to render the field

$ HiddenField#layoutProperty in class HiddenField

Name of the layout being used to render the field

LanguageFieldClass in namespace Joomla\CMS\Form\Field

Form Field class for the Joomla Platform.

LastvisitdaterangeFieldClass in namespace Joomla\CMS\Form\Field

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

LimitboxFieldClass in namespace Joomla\CMS\Form\Field

Field to load a list of possible item count limits

ListFieldClass in namespace Joomla\CMS\Form\Field

Form Field class for the Joomla Platform.

$ ListField#layoutProperty in class ListField

Name of the layout being used to render the field

$ MediaField#linkProperty in class MediaField

The link.

$ MediaField#layoutProperty in class MediaField

Layout to render

$ MenuitemField#languageProperty in class MenuitemField

The language.

$ MeterField#layoutProperty in class MeterField

Name of the layout being used to render the field

$ ModalSelectField#layoutProperty in class ModalSelectField

Layout to render

$ ModuleorderField#layoutProperty in class ModuleorderField

Name of the layout being used to render the field

$ ModuleorderField#linkedProperty in class ModuleorderField

The linked property

$ NumberField#layoutProperty in class NumberField

Name of the layout being used to render the field

$ PasswordField#layoutProperty in class PasswordField

Name of the layout being used to render the field

$ PasswordField#lockProperty in class PasswordField

Attach an unlock button and disable the input field, also remove the value from the output.

$ RadioField#layoutProperty in class RadioField

Name of the layout being used to render the field

$ RadiobasicField#layoutProperty in class RadiobasicField

Name of the layout being used to render the field

$ RangeField#layoutProperty in class RangeField

Name of the layout being used to render the field

$ RulesField#layoutProperty in class RulesField

Name of the layout being used to render the field

$ SubformField#layoutProperty in class SubformField

Layout to render the form

SubformField::loadSubForm() — Method in class SubformField

Loads the form instance for the subform.

SubformField::loadSubFormData() — Method in class SubformField

Binds given data to the subform and its elements.

$ TagField#layoutProperty in class TagField

Name of the layout being used to render the field

$ TelephoneField#layoutProperty in class TelephoneField

Name of the layout being used to render the field

$ TextField#layoutProperty in class TextField

Name of the layout being used to render the field

$ TextareaField#layoutProperty in class TextareaField

Name of the layout being used to render the field

$ TimeField#layoutProperty in class TimeField

Name of the layout being used to render the field

$ UrlField#layoutProperty in class UrlField

Name of the layout being used to render the field

$ UserField#layoutProperty in class UserField

Layout to render

Form::load() — Method in class Form

Method to load the form description from an XML string or object.

Form::loadFile() — Method in class Form

Method to load the form description from an XML file.

Form::loadField() — Method in class Form

Method to load, setup and return a FormField object based on field data.

$ FormField#labelProperty in class FormField

The label for the form field.

$ FormField#labelclassProperty in class FormField

The label's CSS class of the form field

$ FormField#layoutProperty in class FormField

Name of the layout being used to render the field

$ FormField#layoutDataProperty in class FormField

Cached data for layout rendering

FormHelper::loadFieldType() — Method in class FormHelper

Method to load a form field object given a type.

FormHelper::loadRuleType() — Method in class FormHelper

Method to load a form rule object given a type.

FormHelper::loadFilterType() — Method in class FormHelper

Method to load a form filter object given a type.

FormHelper::loadType() — Method in class FormHelper

Method to load a form entity object given a type.

FormHelper::loadFieldClass() — Method in class FormHelper

Attempt to import the FormField class file if it isn't already imported.

FormHelper::loadRuleClass() — Method in class FormHelper

Attempt to import the FormRule class file if it isn't already imported.

FormHelper::loadFilterClass() — Method in class FormHelper

Attempt to import the FormFilter class file if it isn't already imported.

FormHelper::loadClass() — Method in class FormHelper

Load a class for one of the form's entities of a particular type.

HTMLHelper::link() — Method in class HTMLHelper

Write a <a> element

Access::level() — Method in class Access

Displays a list of the available access view levels

$ Behavior#loadedProperty in class Behavior

Array containing information for loaded files

$ Bootstrap#loadedProperty in class Bootstrap
Bootstrap::loadCss() — Method in class Bootstrap

Loads CSS files needed by Bootstrap

$ DraggableList#loadedProperty in class DraggableList

Array containing information for loaded files

$ Dropdown#loadedProperty in class Dropdown
$ Form#loadedProperty in class Form

Array containing information for loaded files.

$ FormBehavior#loadedProperty in class FormBehavior
$ Jquery#loadedProperty in class Jquery

Array containing information for loaded files

LinksClass in namespace Joomla\CMS\HTML\Helpers

Utility class for icons.

Links::linksgroups() — Method in class Links

Method to generate html code for groups of lists of links

Links::links() — Method in class Links

Method to generate html code for a list of links

Links::link() — Method in class Links

Method to generate html code for a single link

ListHelperClass in namespace Joomla\CMS\HTML\Helpers

Utility class for creating different select lists

Menu::linkOptions() — Method in class Menu

Build the multiple select list for Menu Links/Pages

$ SearchTools#loadedProperty in class SearchTools
$ UiTab#loadedProperty in class UiTab
LibraryHelperClass in namespace Joomla\CMS\Helper

Library helper class

$ LibraryHelper#librariesProperty in class LibraryHelper

The component list cache

LibraryHelper::loadLibrary() — Method in class LibraryHelper

Load the installed library into the libraries property.

ModuleHelper::load() — Method in class ModuleHelper

Load published modules.

$ RouteHelper#lookupProperty in class RouteHelper
RouteHelper::lookupItem() — Method in class RouteHelper

Static alias to findItem() used to find the item in the menu structure

UserGroupsHelper::load() — Method in class UserGroupsHelper

Load a group from database.

UserGroupsHelper::loadAll() — Method in class UserGroupsHelper

Load all user groups from the database.

Image::loadFile() — Method in class Image

Method to load a file into the Image object as the resource.

ComponentAdapter::loadLanguage() — Method in class ComponentAdapter

Custom loadLanguage method

FileAdapter::loadLanguage() — Method in class FileAdapter

Custom loadLanguage method

LanguageAdapterClass in namespace Joomla\CMS\Installer\Adapter

Language installer

LibraryAdapterClass in namespace Joomla\CMS\Installer\Adapter

Library installer

LibraryAdapter::loadLanguage() — Method in class LibraryAdapter

Custom loadLanguage method

ModuleAdapter::loadLanguage() — Method in class ModuleAdapter

Custom loadLanguage method

PackageAdapter::loadLanguage() — Method in class PackageAdapter

Load language from a path

PluginAdapter::loadLanguage() — Method in class PluginAdapter

Custom loadLanguage method

TemplateAdapter::loadLanguage() — Method in class TemplateAdapter

Custom loadLanguage method

Installer::loadMD5Sum() — Method in class Installer

Loads an MD5SUMS file into an associative array

Installer::loadAdapter() — Method in class Installer

Method to load an adapter instance

LegacyInstallerScriptClass in namespace Joomla\CMS\Installer

Legacy installer script which delegates the methods to the internal instance when possible.

Manifest::loadManifestFromXml() — Method in class Manifest

Load a manifest from a file

Manifest::loadManifestFromData() — Method in class Manifest

Apply manifest data from a \SimpleXMLElement to the object.

LibraryManifestClass in namespace Joomla\CMS\Installer\Manifest

Joomla! Library Manifest File

$ LibraryManifest#librarynameProperty in class LibraryManifest

File system name of the library

$ LibraryManifest#licenseProperty in class LibraryManifest

License for the library

LibraryManifest::loadManifestFromData() — Method in class LibraryManifest

Apply manifest data from a \SimpleXMLElement to the object.

PackageManifest::loadManifestFromData() — Method in class PackageManifest

Apply manifest data from a \SimpleXMLElement to the object.

LanguageClass in namespace Joomla\CMS\Language

Languages/translation handler class

$ Language#languagesProperty in class Language

Array of Language objects

$ Language#lowerLimitSearchWordCallbackProperty in class Language

Name of the lowerLimitSearchWordCallback function for this language.

Language::load() — Method in class Language

Loads a single language file and appends the results to the existing strings

Language::loadLanguage() — Method in class Language

Loads a language file.

LanguageAwareInterfaceClass in namespace Joomla\CMS\Language

Interface to be implemented by classes depending on a language.

LanguageAwareTraitClass in namespace Joomla\CMS\Language

Defines the trait for a language aware class.

LanguageFactoryClass in namespace Joomla\CMS\Language

Default factory for creating language objects

LanguageFactoryInterfaceClass in namespace Joomla\CMS\Language

Interface defining a factory which can create language objects

LanguageHelperClass in namespace Joomla\CMS\Language

Language helper class

$ FileLayout#layoutIdProperty in class FileLayout

Dot separated path to the layout file, relative to base path

FileLayout::loadLanguageSuffixes() — Method in class FileLayout

Load the automatically generated language suffixes.

FileLayout::loadVersionSuffixes() — Method in class FileLayout

Load the automatically generated version suffixes.

LayoutHelperClass in namespace Joomla\CMS\Layout

Helper to render a Layout object, storing a base path

LayoutInterfaceClass in namespace Joomla\CMS\Layout

Interface to handle display layout

$ DelegatingPsrLogger#loggerProperty in class DelegatingPsrLogger

The Log instance to delegate messages to.

DelegatingPsrLogger::log() — Method in class DelegatingPsrLogger

Logs with an arbitrary level.

LogClass in namespace Joomla\CMS\Log

Joomla! Log Class

$ Log#loggersProperty in class Log

Container for Logger objects.

$ Log#lookupProperty in class Log

Lookup array for loggers.

$ Log#loggerRegistryProperty in class Log

The registry of available loggers

LogEntryClass in namespace Joomla\CMS\Log

Joomla! Log Entry class

LoggerClass in namespace Joomla\CMS\Log

Joomla! Logger Base Class

LoggerRegistryClass in namespace Joomla\CMS\Log

Service registry for loggers

$ EchoLogger#line_separatorProperty in class EchoLogger

Value to use at the end of an echoed log entry to separate lines.

$ InMemoryLogger#logEntriesProperty in class InMemoryLogger

List of collected log entries, grouped by $group

LegacyFactoryClass in namespace Joomla\CMS\MVC\Factory

Factory to create MVC objects in legacy mode.

FormBehaviorTrait::loadForm() — Method in class FormBehaviorTrait

Method to get a form object.

FormBehaviorTrait::loadFormData() — Method in class FormBehaviorTrait

Method to get the data that should be injected in the form.

LegacyModelLoaderTraitClass in namespace Joomla\CMS\MVC\Model

Trait which contains the legacy getInstance functionality

ListModelClass in namespace Joomla\CMS\MVC\Model

Model class for handling lists of items.

$ ListModel#lastQueryStoreIdProperty in class ListModel

The cache ID used when last populating $this->query

$ ListModel#listBlacklistProperty in class ListModel

A list of forbidden variables to not merge into the model's state

$ ListModel#listForbiddenListProperty in class ListModel

A list of forbidden variables to not merge into the model's state

ListModel::loadFormData() — Method in class ListModel

Method to get the data that should be injected in the form.

ListModelInterfaceClass in namespace Joomla\CMS\MVC\Model

Interface for a list model.

HtmlView::loadTemplate() — Method in class HtmlView

Load a template file -- first look in the templates folder for an override

HtmlView::loadHelper() — Method in class HtmlView

Load a helper file

ListViewClass in namespace Joomla\CMS\MVC\View

Base class for a Joomla List View

$ MailTemplate#languageProperty in class MailTemplate

Language of the mail template.

$ MailTemplate#layoutTemplateDataProperty in class MailTemplate

Layout mailtemplate options of the email

AbstractMenu::load() — Method in class AbstractMenu

Loads the menu items

AdministratorMenu::load() — Method in class AdministratorMenu

Loads the menu items

$ MenuItem#linkProperty in class MenuItem

The actual link the menu item refers to

$ MenuItem#levelProperty in class MenuItem

The relative level in the tree

$ MenuItem#languageProperty in class MenuItem

The assigned language for this item

$ SiteMenu#languageProperty in class SiteMenu

Language object

SiteMenu::load() — Method in class SiteMenu

Loads the entire menu table into memory.

Microdata::loadTypes() — Method in class Microdata

Load all available Types and Properties from the http://schema.org vocabulary contained in the types.json file

LegacyErrorHandlingTraitClass in namespace Joomla\CMS\Object

Trait which contains the legacy methods that formerly were inherited from \Joomla\CMS\Object\CMSObject to set and get errors in a class.

LegacyPropertyManagementTraitClass in namespace Joomla\CMS\Object

Trait which contains the legacy methods that formerly were inherited from \Joomla\CMS\Object\CMSObject to set and get properties of the current class.

$ Pagination#limitstartProperty in class Pagination
$ Pagination#limitProperty in class Pagination
$ PaginationObject#linkProperty in class PaginationObject
CMSPlugin::loadLanguage() — Method in class CMSPlugin

Loads the plugin language file

PluginHelper::load() — Method in class PluginHelper

Loads the published plugins.

Route::link() — Method in class Route

Translates an internal Joomla URL to a humanly readable URL.

LanguageClass in namespace Joomla\CMS\Service\Provider

Service provider for the language dependency

LoggerClass in namespace Joomla\CMS\Service\Provider

Service provider for the application's PSR-3 logger dependency

HttpLoader::load() — Method in class HttpLoader
Asset::loadByName() — Method in class Asset

Method to load an asset by its name.

LanguageClass in namespace Joomla\CMS\Table

Languages table.

$ Nested#levelProperty in class Nested

Object property holding the depth level of the node in the tree.

$ Nested#lftProperty in class Nested

Object property holding the left value of the node for managing its placement in the nested sets tree.

Table::load() — Method in class Table

Method to load a row from the database by primary key and bind the fields to the TableInterface instance properties.

TableInterface::load() — Method in class TableInterface

Method to load a row from the database by primary key and bind the fields to the TableInterface instance properties.

User::load() — Method in class User

Method to load a user, user groups, and any other necessary data from the database so that it can be bound to the user object.

$ BasicButton#layoutProperty in class BasicButton

Property layout.

$ DropdownButton#layoutProperty in class DropdownButton

Property layout.

$ InlinehelpButton#layoutProperty in class InlinehelpButton

Property layout.

LinkButtonClass in namespace Joomla\CMS\Toolbar\Button

Renders a link button

$ LinkButton#layoutProperty in class LinkButton

Property layout.

$ PopupButton#layoutProperty in class PopupButton

Property layout.

PopupButton::listCheck() — Method in class PopupButton
$ SeparatorButton#layoutProperty in class SeparatorButton

Property layout.

$ StandardButton#layoutProperty in class StandardButton

Property layout.

CoreButtonsTrait::link() — Method in class CoreButtonsTrait

Creates a button to redirect to a link.

Toolbar::loadButtonType() — Method in class Toolbar

Loads a button type.

Toolbar::linkButton() — Method in class Toolbar
$ ToolbarButton#layoutProperty in class ToolbarButton

The layout path to render this button.

ToolbarButton::layout() — Method in class ToolbarButton

Set layout path.

ToolbarButton::listCheck() — Method in class ToolbarButton
ToolbarButton::listCheckMessage() — Method in class ToolbarButton
ToolbarHelper::link() — Method in class ToolbarHelper

Creates a button to redirect to a link

$ ExtensionAdapter#latestProperty in class ExtensionAdapter
$ Update#latestProperty in class Update

Object containing the latest update data which meets the requirements

Update::loadFromTuf() — Method in class Update

Loads update information from a TUF repo.

Update::loadFromXml() — Method in class Update

Loads a XML file from a URL.

$ User#lastvisitDateProperty in class User

Date of last visit

$ User#lastResetTimeProperty in class User

Last Reset Time

User::load() — Method in class User

Method to load a User object by user id number

UserFactory::loadUserById() — Method in class UserFactory

Method to get an instance of a user for the given id.

UserFactory::loadUserByUsername() — Method in class UserFactory

Method to get an instance of a user for the given username.

UserFactoryInterface::loadUserById() — Method in class UserFactoryInterface

Method to get an instance of a user for the given id.

UserFactoryInterface::loadUserByUsername() — Method in class UserFactoryInterface

Method to get an instance of a user for the given username.

VersionableControllerTrait::loadhistory() — Method in class VersionableControllerTrait

Method to load a row from version history

VersionableModelTrait::loadHistory() — Method in class VersionableModelTrait

Method to load a row for editing from the version history table.

LangActiveAssetItemClass in namespace Joomla\CMS\WebAsset\AssetItem

Web Asset Item class for load asset file for active language.

$ WebAssetManager#lockedProperty in class WebAssetManager

Internal marker to check the manager state, to prevent use of the manager after an assets are rendered

WebAssetManager::lock() — Method in class WebAssetManager

Lock the manager to prevent further modifications

Server::loadAndCheckAttestationResponse() — Method in class Server

Check the attestation (authenticator registration) response data and determine if it's a valid key.

Server::loadAndCheckAssertionResponse() — Method in class Server

Check the assertion (authentication) response data and determine if it's valid for the user.

M

Rule::mergeIdentities() — Method in class Rule

Merges the identities

Rule::mergeIdentity() — Method in class Rule

Merges the values for an identity.

Rules::mergeCollection() — Method in class Rules

Method to merge a collection of Rules.

Rules::merge() — Method in class Rules

Method to merge actions with this object.

Rules::mergeAction() — Method in class Rules

Merges an array of identities for an action.

$ CMSApplication#messageQueueProperty in class CMSApplication

The application message queue.

$ CMSApplication#menusProperty in class CMSApplication

Menu instances container.

$ CliApplication#messagesProperty in class CliApplication

The application message queue.

MultiFactorAuthenticationHandlerClass in namespace Joomla\CMS\Application

Implements the code required for integrating with Joomla's Multi-factor Authentication.

MD5HandlerClass in namespace Joomla\CMS\Authentication\Password

Password handler for MD5 hashed passwords

Cache::makeId() — Method in class Cache

Create a safe ID for cached data from URL parameters

MemcachedStorageClass in namespace Joomla\CMS\Cache\Storage

Memcached cache storage handler

$ CategoryNode#metadescProperty in class CategoryNode

Metadata description

$ CategoryNode#metakeyProperty in class CategoryNode

Keywords for metadata

$ CategoryNode#metadataProperty in class CategoryNode

JSON string of other metadata

$ CategoryNode#modified_user_idProperty in class CategoryNode

The ID of the user who last modified the category

$ CategoryNode#modified_timeProperty in class CategoryNode

The time at which the category was modified

FtpClient::mkdir() — Method in class FtpClient

Method to create a directory on the FTP server

MissingComponentExceptionClass in namespace Joomla\CMS\Component\Exception

Exception class defining an error for a missing component

$ RouterBase#menuProperty in class RouterBase

Menu object to use in the router

MenuRulesClass in namespace Joomla\CMS\Component\Router\Rules

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

MaintenanceDatabaseCommandClass in namespace Joomla\CMS\Console

Console command maintenance database structure

$ Date#minuteProperty in class Date

i - Minutes with leading zeros.

$ Date#microsecondProperty in class Date

u - Microseconds with leading zeros.

$ Date#monthProperty in class Date

m - Numeric representation of a month, with leading zeros.

Date::monthToString() — Method in class Date

Translates month number to a string.

Date::modify() — Method in class Date
.
$ AbstractModuleDispatcher#moduleProperty in class AbstractModuleDispatcher

The module instance

$ ComponentDispatcher#mvcFactoryProperty in class ComponentDispatcher

The MVC factory

ModuleDispatcherClass in namespace Joomla\CMS\Dispatcher

Base class for a Joomla Module Dispatcher

ModuleDispatcherFactoryClass in namespace Joomla\CMS\Dispatcher

Namespace based implementation of the ModuleDispatcherFactoryInterface

ModuleDispatcherFactoryInterfaceClass in namespace Joomla\CMS\Dispatcher

Module dispatcher factory interface

$ Document#mediaVersionProperty in class Document

Media version added to assets

HtmlDocument::mergeHeadData() — Method in class HtmlDocument

Merge the HTML document head data

MessageRendererClass in namespace Joomla\CMS\Document\Renderer\Html

HTML document renderer for the system message queue

MetasRendererClass in namespace Joomla\CMS\Document\Renderer\Html

JDocument metas renderer

ModuleRendererClass in namespace Joomla\CMS\Document\Renderer\Html

HTML document renderer for a single module

ModulesRendererClass in namespace Joomla\CMS\Document\Renderer\Html

HTML document renderer for a module position

McryptClass in namespace Joomla\CMS\Encrypt\AES

Mcrypt implementation

$ OpenSSL#methodProperty in class OpenSSL

The encryption method to use

$ Browser#majorVersionProperty in class Browser
$ Browser#minorVersionProperty in class Browser
$ Browser#mobileProperty in class Browser
Browser::match() — Method in class Browser

Parses the user agent string and inititializes the object with all the known features and quirks for the given browser.

AuthenticationFailedExceptionHandler::manages() — Method in class AuthenticationFailedExceptionHandler

If the exception handler is able to format a response for the provided exception, then the implementation should return true.

CheckinCheckoutExceptionHandler::manages() — Method in class CheckinCheckoutExceptionHandler

If the exception handler is able to format a response for the provided exception, then the implementation should return true.

InvalidRouteExceptionHandler::manages() — Method in class InvalidRouteExceptionHandler

If the exception handler is able to format a response for the provided exception, then the implementation should return true.

NotAcceptableExceptionHandler::manages() — Method in class NotAcceptableExceptionHandler

If the exception handler is able to format a response for the provided exception, then the implementation should return true.

NotAllowedExceptionHandler::manages() — Method in class NotAllowedExceptionHandler

If the exception handler is able to format a response for the provided exception, then the implementation should return true.

ResourceNotFoundExceptionHandler::manages() — Method in class ResourceNotFoundExceptionHandler

If the exception handler is able to format a response for the provided exception, then the implementation should return true.

SaveExceptionHandler::manages() — Method in class SaveExceptionHandler

If the exception handler is able to format a response for the provided exception, then the implementation should return true.

SendEmailExceptionHandler::manages() — Method in class SendEmailExceptionHandler

If the exception handler is able to format a response for the provided exception, then the implementation should return true.

MailTemplateEventClass in namespace Joomla\CMS\Event\Mail

Base class for MailTemplate events

ModelEventClass in namespace Joomla\CMS\Event\Model

Base class for Model events

ModuleEventClass in namespace Joomla\CMS\Event\Module

Base class for Module events

ModuleListEventClass in namespace Joomla\CMS\Event\Module

Class for Module events

MVCComponentClass in namespace Joomla\CMS\Extension

MVC Component class.

ModuleClass in namespace Joomla\CMS\Extension

Access to module specific services.

ModuleInterfaceClass in namespace Joomla\CMS\Extension

Access to module specific services.

MVCFactoryClass in namespace Joomla\CMS\Extension\Service\Provider

Service provider for the service MVC factory.

ModuleClass in namespace Joomla\CMS\Extension\Service\Provider

Service provider for the service based modules.

ModuleDispatcherFactoryClass in namespace Joomla\CMS\Extension\Service\Provider

Service provider for the service dispatcher factory.

$ Factory#mailerProperty in class Factory

Global mailer object

FeedParser::moveToNextElement() — Method in class FeedParser

Method to move the stream parser to the next XML element node.

FeedParser::moveToClosingElement() — Method in class FeedParser

Method to move the stream parser to the closing XML node of the current element.

MediaRssParserClass in namespace Joomla\CMS\Feed\Parser\Rss

RSS Feed Parser Namespace handler for MediaRSS.

File::makeSafe() — Method in class File

Makes file name safe to use

File::move() — Method in class File

Moves a file

Folder::move() — Method in class Folder

Moves a folder.

Folder::makeSafe() — Method in class Folder

Makes path name safe to use.

Stream::move() — Method in class Stream

Moves a file

$ StreamString#modeProperty in class StreamString

The mode

$ CalendarField#maxlengthProperty in class CalendarField

The allowable maxlength of calendar field.

$ CalendarField#minyearProperty in class CalendarField

The minimum year number to subtract/add from the current year

$ CalendarField#maxyearProperty in class CalendarField

The maximum year number to subtract/add from the current year

MediaFieldClass in namespace Joomla\CMS\Form\Field

Provides a modal media selector including upload mechanism

MenuFieldClass in namespace Joomla\CMS\Form\Field

Supports an HTML select list of menus

MenuitemFieldClass in namespace Joomla\CMS\Form\Field

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

$ MenuitemField#menuTypeProperty in class MenuitemField

The menu type.

MeterFieldClass in namespace Joomla\CMS\Form\Field

Form Field class for the Joomla Platform.

$ MeterField#minProperty in class MeterField

The min value of the progress bar

$ MeterField#maxProperty in class MeterField

The max value of the progress bar

ModalSelectFieldClass in namespace Joomla\CMS\Form\Field

Provides a modal content selection

$ ModalSelectField#modalTitlesProperty in class ModalSelectField

List of titles for each modal type: select, edit, new

ModulelayoutFieldClass in namespace Joomla\CMS\Form\Field

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

ModuleorderFieldClass in namespace Joomla\CMS\Form\Field

Module Order field.

ModulepositionFieldClass in namespace Joomla\CMS\Form\Field

Module Position field.

ModuletagFieldClass in namespace Joomla\CMS\Form\Field

Module Tag field.

$ NumberField#maxProperty in class NumberField

The allowable maximum value of the field.

$ NumberField#minProperty in class NumberField

The allowable minimum value of the field.

$ PasswordField#minLengthProperty in class PasswordField

The allowable minimum length of password.

$ PasswordField#maxLengthProperty in class PasswordField

The allowable maxlength of password.

$ PasswordField#minIntegersProperty in class PasswordField

The allowable minimum length of integers.

$ PasswordField#minSymbolsProperty in class PasswordField

The allowable minimum length of symbols.

$ PasswordField#minUppercaseProperty in class PasswordField

The allowable minimum length of upper case characters.

$ PasswordField#minLowercaseProperty in class PasswordField

The allowable minimum length of lower case characters.

$ PasswordField#meterProperty in class PasswordField

Whether to attach a password strength meter or not.

$ SubformField#minProperty in class SubformField

Minimum items in repeat mode

$ SubformField#maxProperty in class SubformField

Maximum items in repeat mode

$ TextField#maxLengthProperty in class TextField

The allowable maxlength of the field.

$ TextareaField#maxlengthProperty in class TextareaField

The maximum number of characters in textarea.

$ TimeField#minProperty in class TimeField

The allowable minimal value of the field.

$ TimeField#maxProperty in class TimeField

The allowable maximal value of the field.

Form::mergeNode() — Method in class Form

Update the attributes of a child node

Form::mergeNodes() — Method in class Form

Merges new elements into a source <fields> element.

$ FormField#multipleProperty in class FormField

The multiple state for the form field. If true then multiple values are allowed for the field. Most often used for list field types.

$ FormRule#modifiersProperty in class FormRule

The regular expression modifiers to use when testing a form field value.

$ BooleanRule#modifiersProperty in class BooleanRule

The regular expression modifiers to use when testing a form field value.

ModuleLayoutRuleClass in namespace Joomla\CMS\Form\Rule

Form Rule class for the Joomla Platform.

HTMLHelper::mediaPath() — Method in class HTMLHelper

Look for path relatively to media folder.

Behavior::multiselect() — Method in class Behavior

JavaScript behavior to allow shift select in grids

Bootstrap::modal() — Method in class Bootstrap

Add javascript support for Bootstrap modal

Content::months() — Method in class Content

Returns an array of months.

MenuClass in namespace Joomla\CMS\HTML\Helpers

Utility class working with menu select lists

$ Menu#menusProperty in class Menu

Cached array of the menus.

Menu::menus() — Method in class Menu

Get a list of the available menus.

Menu::menuItems() — Method in class Menu

Returns an array of menu items grouped by menu.

Menu::menuItemList() — Method in class Menu

Displays an HTML select list of menu items.

MediaHelperClass in namespace Joomla\CMS\Helper

Media helper class

ModuleHelperClass in namespace Joomla\CMS\Helper

Module helper class

ModuleHelper::moduleCache() — Method in class ModuleHelper

Module cache helper

$ ComponentAdapter#manifest_scriptProperty in class ComponentAdapter

A path to the PHP file that the scriptfile declaration in the manifest refers to.

ModuleAdapterClass in namespace Joomla\CMS\Installer\Adapter

Module installer

$ Installer#manifestClassProperty in class Installer

The manifest trigger class

$ Installer#messageProperty in class Installer

The output from the install/uninstall scripts

$ Installer#manifestProperty in class Installer

The installation manifest XML object

$ InstallerAdapter#manifestProperty in class InstallerAdapter

Copy of the XML manifest file.

$ InstallerAdapter#manifest_scriptProperty in class InstallerAdapter

A path to the PHP file that the scriptfile declaration in the manifest refers to.

$ InstallerExtension#manifest_cacheProperty in class InstallerExtension

An object representation of the manifest file stored metadata

$ InstallerScript#minimumPhpProperty in class InstallerScript

Minimum PHP version required to install the extension

$ InstallerScript#minimumJoomlaProperty in class InstallerScript

Minimum Joomla! version required to install the extension

InstallerScript::moveCliFiles() — Method in class InstallerScript

Moves the CLI scripts into the CLI folder in the CMS

ManifestClass in namespace Joomla\CMS\Installer

Joomla! Package Manifest File

$ Manifest#manifest_fileProperty in class Manifest

Path to the manifest file

MultilanguageClass in namespace Joomla\CMS\Language

Utility class for multilang

$ LogEntry#messageProperty in class LogEntry

Message to be logged.

MessagequeueLoggerClass in namespace Joomla\CMS\Log\Logger

Joomla MessageQueue logger class.

$ ApiController#modelStateProperty in class ApiController

The model state to inject

$ BaseController#messageProperty in class BaseController

Redirect message.

$ BaseController#messageTypeProperty in class BaseController

Redirect message type.

$ BaseController#methodsProperty in class BaseController

Array of class methods

$ BaseController#model_prefixProperty in class BaseController

The prefix of the models

MVCFactoryClass in namespace Joomla\CMS\MVC\Factory

Factory to create MVC objects based on a namespace.

MVCFactoryAwareTraitClass in namespace Joomla\CMS\MVC\Factory

MVCFactory aware trait.

MVCFactoryInterfaceClass in namespace Joomla\CMS\MVC\Factory

Factory to create MVC objects.

MVCFactoryServiceInterfaceClass in namespace Joomla\CMS\MVC\Factory

Interface to be implemented by classes depending on a MVC factory.

MVCFactoryServiceTraitClass in namespace Joomla\CMS\MVC\Factory

Defines the trait for a MVC factory service class.

ModelExceptionInterfaceClass in namespace Joomla\CMS\MVC\Model\Exception

Interface that all exceptions stemming from the model should implement for processing by the controller.

ModelInterfaceClass in namespace Joomla\CMS\MVC\Model

Interface for a base model.

$ CategoryView#menuItemMatchCategoryProperty in class CategoryView

The flag to mark if the active menu item is linked to the category being displayed

MailDisabledExceptionClass in namespace Joomla\CMS\Mail\Exception

Exception class defining an error for disabled mail functionality.

MailClass in namespace Joomla\CMS\Mail

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

MailHelperClass in namespace Joomla\CMS\Mail

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

MailTemplateClass in namespace Joomla\CMS\Mail

Email Templating Class

$ MailTemplate#mailerProperty in class MailTemplate

Mailer object to send the actual mail.

MailerFactoryClass in namespace Joomla\CMS\Mail

Default factory for creating mailer objects.

MailerFactoryAwareInterfaceClass in namespace Joomla\CMS\Mail

Interface to be implemented by classes depending on a mailer factory.

MailerFactoryAwareTraitClass in namespace Joomla\CMS\Mail

Defines the trait for a MailerFactoryInterface aware class.

MailerFactoryInterfaceClass in namespace Joomla\CMS\Mail

Interface defining a factory which can create mailer objects.

MailerInterfaceClass in namespace Joomla\CMS\Mail

Provides a common interface to send emails with.

MenuFactoryClass in namespace Joomla\CMS\Menu

Default factory for creating Menu objects

MenuFactoryInterfaceClass in namespace Joomla\CMS\Menu

Interface defining a factory which can create Menu objects

MenuItemClass in namespace Joomla\CMS\Menu

Object representing a menu item

$ MenuItem#menutypeProperty in class MenuItem

The type of menu this item belongs to

MicrodataClass in namespace Joomla\CMS\Microdata

Joomla Platform class for interacting with Microdata semantics.

$ Microdata#machineContentProperty in class Microdata

The Machine content

Pathway::makeItem() — Method in class Pathway

Create and return a new pathway object.

$ Profiler#marksProperty in class Profiler
Profiler::mark() — Method in class Profiler

Output a time mark

$ JsonResponse#messageProperty in class JsonResponse

The main response message

$ JsonResponse#messagesProperty in class JsonResponse

Array of messages gathered in the Application object

$ SiteRouter#menuProperty in class SiteRouter

Current Menu-Object

$ ChangeItem#msgElementsProperty in class ChangeItem

Array with values for use in a Text::sprintf statement indicating what was checked

MysqlChangeItemClass in namespace Joomla\CMS\Schema\ChangeItem

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

MailerClass in namespace Joomla\CMS\Service\Provider

Service provider for the mailer dependency

MenuClass in namespace Joomla\CMS\Service\Provider

Service provider for the application's menu dependency

MetadataManagerListenerClass in namespace Joomla\CMS\Session\EventListener

Event listener for session events regarding the session metadata for users.

MetadataManagerClass in namespace Joomla\CMS\Session

Manager for optional session metadata.

MenuClass in namespace Joomla\CMS\Table

Menu table

MenuTypeClass in namespace Joomla\CMS\Table

Menu Types table

ModuleClass in namespace Joomla\CMS\Table

Module table

Nested::move() — Method in class Nested

Method to move a row in the ordering sequence of a group of rows defined by an SQL WHERE clause.

Nested::moveByReference() — Method in class Nested

Method to move a node and its children to a new location in the tree.

Table::move() — Method in class Table

Method to move a row in the ordering sequence of a group of rows defined by an SQL WHERE clause.

ConfirmButton::message() — Method in class ConfirmButton
PopupButton::modalWidth() — Method in class PopupButton
PopupButton::modalHeight() — Method in class PopupButton
CoreButtonsTrait::mediaManager() — Method in class CoreButtonsTrait

Writes a media_manager button.

CoreButtonsTrait::makeDefault() — Method in class CoreButtonsTrait

Writes a common 'default' button for a record.

ToolbarHelper::media_manager() — Method in class ToolbarHelper

Writes a media_manager button.

ToolbarHelper::makeDefault() — Method in class ToolbarHelper

Writes a common 'default' button for a record.

ToolbarHelper::modal() — Method in class ToolbarHelper

Displays a modal button

UCMBase::mapBase() — Method in class UCMBase

Method to map the base ucm fields

UCMContent::mapData() — Method in class UCMContent

Map the original content to the Core Content fields

$ Update#maintainerProperty in class Update

Update manifest <maintainer> element

$ Update#maintainerurlProperty in class Update

Update manifest <maintainerurl> element

$ Update#minimum_stabilityProperty in class Update

The minimum stability required for updates to be taken into account. The possible values are: 0 dev Development snapshots, nightly builds, pre-release versions and so on 1 alpha Alpha versions (work in progress, things are likely to be broken) 2 beta Beta versions (major functionality in place, show-stopper bugs are likely to be present) 3 rc Release Candidate versions (almost stable, minor bugs might be present) 4 stable Stable versions (production quality code)

$ UpdateAdapter#minimum_stabilityProperty in class UpdateAdapter

The minimum stability required for updates to be taken into account. The possible values are: 0 dev Development snapshots, nightly builds, pre-release versions and so on 1 alpha Alpha versions (work in progress, things are likely to be broken) 2 beta Beta versions (major functionality in place, show-stopper bugs are likely to be present) 3 rc Release Candidate versions (almost stable, minor bugs might be present) 4 stable Stable versions (production quality code)

__TwigTemplate_93a051471fb2bd8bc386b2041ff7ba2b::macro_class_category_name() — Method in class __TwigTemplate_93a051471fb2bd8bc386b2041ff7ba2b
__TwigTemplate_93a051471fb2bd8bc386b2041ff7ba2b::macro_namespace_link() — Method in class __TwigTemplate_93a051471fb2bd8bc386b2041ff7ba2b
__TwigTemplate_93a051471fb2bd8bc386b2041ff7ba2b::macro_class_link() — Method in class __TwigTemplate_93a051471fb2bd8bc386b2041ff7ba2b
__TwigTemplate_93a051471fb2bd8bc386b2041ff7ba2b::macro_method_link() — Method in class __TwigTemplate_93a051471fb2bd8bc386b2041ff7ba2b
__TwigTemplate_93a051471fb2bd8bc386b2041ff7ba2b::macro_property_link() — Method in class __TwigTemplate_93a051471fb2bd8bc386b2041ff7ba2b
__TwigTemplate_93a051471fb2bd8bc386b2041ff7ba2b::macro_hint_link() — Method in class __TwigTemplate_93a051471fb2bd8bc386b2041ff7ba2b
__TwigTemplate_93a051471fb2bd8bc386b2041ff7ba2b::macro_source_link() — Method in class __TwigTemplate_93a051471fb2bd8bc386b2041ff7ba2b
__TwigTemplate_93a051471fb2bd8bc386b2041ff7ba2b::macro_method_source_link() — Method in class __TwigTemplate_93a051471fb2bd8bc386b2041ff7ba2b
__TwigTemplate_93a051471fb2bd8bc386b2041ff7ba2b::macro_method_parameters_signature() — Method in class __TwigTemplate_93a051471fb2bd8bc386b2041ff7ba2b
__TwigTemplate_93a051471fb2bd8bc386b2041ff7ba2b::macro_function_parameters_signature() — Method in class __TwigTemplate_93a051471fb2bd8bc386b2041ff7ba2b
__TwigTemplate_93a051471fb2bd8bc386b2041ff7ba2b::macro_render_classes() — Method in class __TwigTemplate_93a051471fb2bd8bc386b2041ff7ba2b
__TwigTemplate_93a051471fb2bd8bc386b2041ff7ba2b::macro_breadcrumbs() — Method in class __TwigTemplate_93a051471fb2bd8bc386b2041ff7ba2b
__TwigTemplate_93a051471fb2bd8bc386b2041ff7ba2b::macro_deprecated() — Method in class __TwigTemplate_93a051471fb2bd8bc386b2041ff7ba2b
__TwigTemplate_93a051471fb2bd8bc386b2041ff7ba2b::macro_deprecations() — Method in class __TwigTemplate_93a051471fb2bd8bc386b2041ff7ba2b
__TwigTemplate_93a051471fb2bd8bc386b2041ff7ba2b::macro_internals() — Method in class __TwigTemplate_93a051471fb2bd8bc386b2041ff7ba2b
__TwigTemplate_93a051471fb2bd8bc386b2041ff7ba2b::macro_categories() — Method in class __TwigTemplate_93a051471fb2bd8bc386b2041ff7ba2b
__TwigTemplate_93a051471fb2bd8bc386b2041ff7ba2b::macro_todo() — Method in class __TwigTemplate_93a051471fb2bd8bc386b2041ff7ba2b
__TwigTemplate_93a051471fb2bd8bc386b2041ff7ba2b::macro_todos() — Method in class __TwigTemplate_93a051471fb2bd8bc386b2041ff7ba2b

N

$ JLoader#namespacesProperty in class JLoader

Container for namespace => path map.

NotAllowedClass in namespace Joomla\CMS\Access\Exception

Exception class defining a not allowed access

$ ColorProcessor#noColorsProperty in class ColorProcessor

Flag to remove color codes from the output

$ CMSApplication#nameProperty in class CMSApplication

The name of the application.

$ ConsoleApplication#nameProperty in class ConsoleApplication

The name of the application.

NotAcceptableClass in namespace Joomla\CMS\Application\Exception

Exception class defining a not acceptable class

$ CategoryNode#numitemsProperty in class CategoryNode

Number of items in this category or descendants of this category

$ Changelog#noteProperty in class Changelog

Update manifest <maintainer> element

$ ComponentRecord#namespaceProperty in class ComponentRecord

The extension namespace

$ RouterView#nameProperty in class RouterView

Name of the router of the component

$ RouterViewConfiguration#nameProperty in class RouterViewConfiguration

Name of the view

$ RouterViewConfiguration#nestableProperty in class RouterViewConfiguration

Is this view nestable?

NomenuRulesClass in namespace Joomla\CMS\Component\Router\Rules

Rule to process URLs without a menu item

$ ComponentDispatcherFactory#namespaceProperty in class ComponentDispatcherFactory

The extension namespace

$ XmlDocument#nameProperty in class XmlDocument

Document name

$ Button#nameProperty in class Button

Button name, CMD string.

NotAcceptableExceptionHandlerClass in namespace Joomla\CMS\Error\JsonApi

Handler for routing errors that should give a 406

NotAllowedExceptionHandlerClass in namespace Joomla\CMS\Error\JsonApi

Handler for permission errors that should give a 403

NormaliseRequestDataEventClass in namespace Joomla\CMS\Event\Model

Class for Model Form event.

NotifyActionLogClass in namespace Joomla\CMS\Event\MultiFactor

Concrete event class for the custom events used to notify the User Action Log plugin about Two Factor Authentication actions.

$ FeedParser#namespacesProperty in class FeedParser

Array of NamespaceParserInterface objects

$ FeedPerson#nameProperty in class FeedPerson

The full name of the person.

NamespaceParserInterfaceClass in namespace Joomla\CMS\Feed\Parser

Feed Namespace interface.

$ CaptchaField#namespaceProperty in class CaptchaField

The namespace of the captcha field.

NoteFieldClass in namespace Joomla\CMS\Form\Field

Form Field class for the Joomla Platform.

NumberFieldClass in namespace Joomla\CMS\Form\Field

Form Field class for the Joomla Platform.

$ RulesField#newItemProperty in class RulesField

The flag to indicate that it is a new item

$ Form#nameProperty in class Form

The name of the form instance.

$ FormField#nameProperty in class FormField

The name of the form field.

NotequalsRuleClass in namespace Joomla\CMS\Form\Rule

Form Rule class for the Joomla Platform.

NumberRuleClass in namespace Joomla\CMS\Form\Rule

Form Rule class for the Joomla Platform.

NumberClass in namespace Joomla\CMS\HTML\Helpers

HTML helper class for rendering numbers.

$ TagsHelper#newTagsProperty in class TagsHelper

The new tags as comma separated string or array.

NegateClass in namespace Joomla\CMS\Image\Filter

Image Filter class to negate the colors of an image.

$ InstallerAdapter#nameProperty in class InstallerAdapter

Name of the extension

$ InstallerExtension#namespaceProperty in class InstallerExtension

The namespace of the extension

$ Manifest#nameProperty in class Manifest

Name of the extension

$ BaseController#nameProperty in class BaseController

The name of the controller

$ BaseModel#nameProperty in class BaseModel

The model (base) name

$ MenuItem#noteProperty in class MenuItem

A note associated with the menu item

ArrayProxy::next() — Method in class ArrayProxy

Implementation of Iterator interface

ObjectProxy::next() — Method in class ObjectProxy

Implementation of Iterator interface

$ Asset#nameProperty in class Asset

The unique name of the asset.

NestedClass in namespace Joomla\CMS\Table

Table class supporting modified pre-order tree traversal behavior.

$ ToolbarButton#nameProperty in class ToolbarButton

Name of this button.

ToolbarButton::name() — Method in class ToolbarButton

Set button name.

NodeInterfaceClass in namespace Joomla\CMS\Tree

Interface for a node class

NodeTraitClass in namespace Joomla\CMS\Tree

Defines the trait for a Node Interface Trait Class.

$ Update#nameProperty in class Update

Update manifest <name> element

$ User#nameProperty in class User

The user's real name (or nickname)

$ BufferStreamHandler#nameProperty in class BufferStreamHandler

Buffer name

$ WebAssetItem#nameProperty in class WebAssetItem

Asset name

O

CliOutput::out() — Method in class CliOutput

Write a string to an output handler.

Stdout::out() — Method in class Stdout

Write a string to standard output

Xml::out() — Method in class Xml

Write a string to standard output.

$ CliApplication#outputProperty in class CliApplication

Output object

CliApplication::out() — Method in class CliApplication

Write a string to standard output.

$ ActionButton#optionsProperty in class ActionButton

Options of this button set.

$ CacheController#optionsProperty in class CacheController

Array of options

OutputControllerClass in namespace Joomla\CMS\Cache\Controller

Joomla Cache output type object

$ ComponentRecord#optionProperty in class ComponentRecord

The component name

$ Date#ordinalProperty in class Date

S - English ordinal suffix for the day of the month, 2 characters.

$ ComponentDispatcher#optionProperty in class ComponentDispatcher

The URL option for the component.

OpensearchDocumentClass in namespace Joomla\CMS\Document

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

OpensearchImageClass in namespace Joomla\CMS\Document\Opensearch

Data object representing an OpenSearch image

OpensearchUrlClass in namespace Joomla\CMS\Document\Opensearch

Data object representing an OpenSearch URL

$ Button#optionsProperty in class Button

Button options.

OpenSSLClass in namespace Joomla\CMS\Encrypt\AES

OpenSSL encryption class

$ OpenSSL#openSSLOptionsProperty in class OpenSSL

The OpenSSL options for encryption / decryption

AbstractImmutableEvent::offsetSet() — Method in class AbstractImmutableEvent

Set the value of an event argument.

AbstractImmutableEvent::offsetUnset() — Method in class AbstractImmutableEvent

Remove an event argument.

ApplicationConfigurationEvent::onSetSubject() — Method in class ApplicationConfigurationEvent

Setter for the subject argument.

ApplicationDocumentEvent::onSetDocument() — Method in class ApplicationDocumentEvent

Setter for the document argument.

ApplicationEvent::onSetSubject() — Method in class ApplicationEvent

Setter for the subject argument.

BeforeApiRouteEvent::onSetRouter() — Method in class BeforeApiRouteEvent

Setter for the router argument.

DaemonReceiveSignalEvent::onSetSignal() — Method in class DaemonReceiveSignalEvent

Setter for the signal argument.

AfterPurgeEvent::onSetSubject() — Method in class AfterPurgeEvent

Setter for the subject argument.

CaptchaSetupEvent::onSetSubject() — Method in class CaptchaSetupEvent

Setter for the subject argument

AfterCheckinEvent::onSetSubject() — Method in class AfterCheckinEvent

Setter for the subject argument.

SubmitContactEvent::onSetSubject() — Method in class SubmitContactEvent

Setter for the subject argument.

SubmitContactEvent::onSetData() — Method in class SubmitContactEvent

Setter for the data argument.

ValidateContactEvent::onSetSubject() — Method in class ValidateContactEvent

Setter for the subject argument.

ValidateContactEvent::onSetData() — Method in class ValidateContactEvent

Setter for the data argument.

ContentEvent::onSetContext() — Method in class ContentEvent

Setter for the context argument.

ContentPrepareEvent::onSetSubject() — Method in class ContentPrepareEvent

Setter for the subject argument.

ContentPrepareEvent::onSetParams() — Method in class ContentPrepareEvent

Setter for the params argument.

ContentPrepareEvent::onSetPage() — Method in class ContentPrepareEvent

Setter for the page argument.

AbstractPrepareFieldEvent::onSetContext() — Method in class AbstractPrepareFieldEvent

Setter for the context argument.

AbstractPrepareFieldEvent::onSetItem() — Method in class AbstractPrepareFieldEvent

Setter for the item argument.

CustomFieldsEvent::onSetSubject() — Method in class CustomFieldsEvent

Setter for the subject argument.

PrepareDomEvent::onSetFieldset() — Method in class PrepareDomEvent

Setter for the fieldset argument.

PrepareDomEvent::onSetForm() — Method in class PrepareDomEvent

Setter for the form argument.

EditorButtonsSetupEvent::onSetSubject() — Method in class EditorButtonsSetupEvent

Setter for the subject argument.

EditorButtonsSetupEvent::onSetEditorType() — Method in class EditorButtonsSetupEvent

Setter for the Editor Type argument.

EditorButtonsSetupEvent::onSetDisabledButtons() — Method in class EditorButtonsSetupEvent

Setter for the disabled buttons argument.

EditorButtonsSetupEvent::onSetEditorId() — Method in class EditorButtonsSetupEvent

Setter for the Editor ID argument.

EditorButtonsSetupEvent::onSetAsset() — Method in class EditorButtonsSetupEvent

Setter for the asset argument.

EditorButtonsSetupEvent::onSetAuthor() — Method in class EditorButtonsSetupEvent

Setter for the author argument.

EditorSetupEvent::onSetSubject() — Method in class EditorSetupEvent

Setter for the subject argument.

AfterInstallEvent::onSetInstaller() — Method in class AfterInstallEvent

Setter for the installer argument.

AfterInstallEvent::onSetEid() — Method in class AfterInstallEvent

Setter for the eid argument.

AfterJoomlaUpdateEvent::onSetOldVersion() — Method in class AfterJoomlaUpdateEvent

Pre-setter for the oldVersion argument.

AfterUninstallEvent::onSetInstaller() — Method in class AfterUninstallEvent

Setter for the installer argument.

AfterUninstallEvent::onSetEid() — Method in class AfterUninstallEvent

Setter for the eid argument.

AfterUninstallEvent::onSetRemoved() — Method in class AfterUninstallEvent

Setter for the removed argument.

AfterUpdateEvent::onSetInstaller() — Method in class AfterUpdateEvent

Setter for the installer argument.

AfterUpdateEvent::onSetEid() — Method in class AfterUpdateEvent

Setter for the eid argument.

BeforeInstallEvent::onSetMethod() — Method in class BeforeInstallEvent

Setter for the method argument.

BeforeInstallEvent::onSetType() — Method in class BeforeInstallEvent

Setter for the type argument.

BeforeInstallEvent::onSetManifest() — Method in class BeforeInstallEvent

Setter for the manifest argument.

BeforeInstallEvent::onSetExtension() — Method in class BeforeInstallEvent

Setter for the extension argument.

BeforeUninstallEvent::onSetEid() — Method in class BeforeUninstallEvent

Setter for the eid argument.

BeforeUpdateEvent::onSetType() — Method in class BeforeUpdateEvent

Setter for the type argument.

BeforeUpdateEvent::onSetManifest() — Method in class BeforeUpdateEvent

Setter for the manifest argument.

PrepareContentEvent::onSetSubject() — Method in class PrepareContentEvent

Setter for the subject argument.

ResultEvent::onSetSubject() — Method in class ResultEvent

Setter for the subject argument.

ResultEvent::onSetQuery() — Method in class ResultEvent

Setter for the query argument.

AfterInstallerEvent::onSetInstaller() — Method in class AfterInstallerEvent

Setter for the installer argument.

AfterInstallerEvent::onSetInstallerResult() — Method in class AfterInstallerEvent

Setter for the installerResult argument.

AfterInstallerEvent::onSetMessage() — Method in class AfterInstallerEvent

Setter for the message argument.

BeforePackageDownloadEvent::onSetUrl() — Method in class BeforePackageDownloadEvent

Setter for the url argument.

BeforePackageDownloadEvent::onSetHeaders() — Method in class BeforePackageDownloadEvent

Setter for the headers argument.

InstallerEvent::onSetSubject() — Method in class InstallerEvent

Setter for the subject argument.

InstallerEvent::onSetPackage() — Method in class InstallerEvent

Setter for the package argument.

MailTemplateEvent::onSetSubject() — Method in class MailTemplateEvent

Pre-Setter for the subject argument.

MailTemplateEvent::onGetSubject() — Method in class MailTemplateEvent

Pre-getter for the subject argument.

MailTemplateEvent::onSetTemplateId() — Method in class MailTemplateEvent

Pre-setter for the templateId argument.

MailTemplateEvent::onGetTemplateId() — Method in class MailTemplateEvent

Pre-getter for the templateId argument.

AfterGetMenuTypeOptionsEvent::onSetSubject() — Method in class AfterGetMenuTypeOptionsEvent

Setter for the subject argument.

AfterGetMenuTypeOptionsEvent::onSetItems() — Method in class AfterGetMenuTypeOptionsEvent

Setter for the items argument.

BeforeRenderMenuItemsViewEvent::onSetSubject() — Method in class BeforeRenderMenuItemsViewEvent

Setter for the subject argument.

PreprocessMenuItemsEvent::onSetContext() — Method in class PreprocessMenuItemsEvent

Setter for the context argument.

PreprocessMenuItemsEvent::onSetSubject() — Method in class PreprocessMenuItemsEvent

Setter for the subject argument.

PreprocessMenuItemsEvent::onSetParams() — Method in class PreprocessMenuItemsEvent

Setter for the registry argument.

PreprocessMenuItemsEvent::onSetEnabled() — Method in class PreprocessMenuItemsEvent

Setter for the enabled argument.

AfterCleanCacheEvent::onSetDefaultgroup() — Method in class AfterCleanCacheEvent

Setter for the defaultgroup argument.

AfterCleanCacheEvent::onSetCachebase() — Method in class AfterCleanCacheEvent

Setter for the cachebase argument.

AfterCleanCacheEvent::onSetResult() — Method in class AfterCleanCacheEvent

Setter for the result argument.

ChangeStateEvent::onSetSubject() — Method in class ChangeStateEvent

Setter for the subject argument.

ChangeStateEvent::onSetValue() — Method in class ChangeStateEvent

Setter for the value argument.

DeleteEvent::onSetSubject() — Method in class DeleteEvent

Setter for the subject argument.

FormEvent::onSetContext() — Method in class FormEvent

Setter for the context argument.

FormEvent::onSetSubject() — Method in class FormEvent

Setter for the subject argument.

FormEvent::onSetData() — Method in class FormEvent

Setter for the data argument.

ModelEvent::onSetContext() — Method in class ModelEvent

Setter for the context argument.

PrepareDataEvent::onSetData() — Method in class PrepareDataEvent

Setter for the data argument.

SaveEvent::onSetSubject() — Method in class SaveEvent

Setter for the subject argument.

SaveEvent::onSetIsNew() — Method in class SaveEvent

Setter for the isNew argument.

AfterRenderModulesEvent::onSetContent() — Method in class AfterRenderModulesEvent

Setter for the content argument.

AfterRenderModulesEvent::onSetAttributes() — Method in class AfterRenderModulesEvent

Setter for the attributes argument.

ModuleListEvent::onSetModules() — Method in class ModuleListEvent

Setter for the modules argument.

RenderModuleEvent::onSetSubject() — Method in class RenderModuleEvent

Setter for the subject argument.

RenderModuleEvent::onSetAttributes() — Method in class RenderModuleEvent

Setter for the attributes argument.

BeforeDisplayMethods::onSetUser() — Method in class BeforeDisplayMethods

Validate the value of the 'user' named parameter

Callback::onSetMethod() — Method in class Callback

Validate the value of the 'method' named parameter

Captive::onSetRecord() — Method in class Captive

Validate the value of the 'record' named parameter

GetSetup::onSetRecord() — Method in class GetSetup

Validate the value of the 'record' named parameter

SaveSetup::onSetRecord() — Method in class SaveSetup

Validate the value of the 'record' named parameter

SaveSetup::onSetInput() — Method in class SaveSetup

Validate the value of the 'record' named parameter

Validate::onSetRecord() — Method in class Validate

Validate the value of the 'record' named parameter

Validate::onSetUser() — Method in class Validate

Validate the value of the 'user' named parameter

Validate::onSetCode() — Method in class Validate

Validate the value of the 'code' named parameter

AjaxEvent::onSetSubject() — Method in class AjaxEvent

Setter for the subject argument.

BeforeCompileHeadEvent::onSetSubject() — Method in class BeforeCompileHeadEvent

Setter for the subject argument.

BeforeCompileHeadEvent::onSetContext() — Method in class BeforeCompileHeadEvent

Setter for the context argument.

PrepareDataEvent::onSetSubject() — Method in class PrepareDataEvent

Setter for the subject argument.

PrepareDataEvent::onSetContext() — Method in class PrepareDataEvent

Setter for the context argument.

PrepareFormEvent::onSetSubject() — Method in class PrepareFormEvent

Setter for the subject argument.

PrepareSaveEvent::onSetSubject() — Method in class PrepareSaveEvent

Setter for the subject argument.

PrepareSaveEvent::onSetContext() — Method in class PrepareSaveEvent

Setter for the context argument.

PrepareSaveEvent::onSetItem() — Method in class PrepareSaveEvent

Setter for the item argument.

PrepareSaveEvent::onSetIsNew() — Method in class PrepareSaveEvent

Setter for the isNew argument.

PrepareSaveEvent::onSetSchema() — Method in class PrepareSaveEvent

Setter for the schema argument.

GetStatsDataEvent::onSetContext() — Method in class GetStatsDataEvent

Setter for the context argument.

CanRemoveDataEvent::onSetSubject() — Method in class CanRemoveDataEvent

Setter for the subject argument.

CanRemoveDataEvent::onSetUser() — Method in class CanRemoveDataEvent

Setter for the user argument.

CheckPrivacyPolicyPublishedEvent::onSetSubject() — Method in class CheckPrivacyPolicyPublishedEvent

Setter for the subject argument.

ExportRequestEvent::onSetSubject() — Method in class ExportRequestEvent

Setter for the subject argument.

ExportRequestEvent::onSetUser() — Method in class ExportRequestEvent

Setter for the user argument.

RemoveDataEvent::onSetSubject() — Method in class RemoveDataEvent

Setter for the subject argument.

RemoveDataEvent::onSetUser() — Method in class RemoveDataEvent

Setter for the user argument.

GetIconEvent::onSetContext() — Method in class GetIconEvent

A method to validate the 'context' named parameter.

ResultAware::onSetResult() — Method in class ResultAware

Handle setting the result argument directly.

AbstractEvent::onSetSubject() — Method in class AbstractEvent

Setter for the subject argument

AfterLoadEvent::onSetResult() — Method in class AfterLoadEvent

Setter for the result argument

AfterLoadEvent::onSetRow() — Method in class AfterLoadEvent

Setter for the row argument

AfterMoveEvent::onSetRow() — Method in class AfterMoveEvent

Setter for the rows argument

AfterMoveEvent::onSetDelta() — Method in class AfterMoveEvent

Setter for the delta argument

AfterMoveEvent::onSetWhere() — Method in class AfterMoveEvent

Setter for the where argument

AfterReorderEvent::onSetWhere() — Method in class AfterReorderEvent

Setter for the where argument

AfterStoreEvent::onSetResult() — Method in class AfterStoreEvent

Setter for the result argument

BeforeBindEvent::onSetSrc() — Method in class BeforeBindEvent

Setter for the src argument

BeforeBindEvent::onSetIgnore() — Method in class BeforeBindEvent

Setter for the ignore argument

BeforeCheckoutEvent::onSetUserId() — Method in class BeforeCheckoutEvent

Setter for the userId argument

BeforeLoadEvent::onSetReset() — Method in class BeforeLoadEvent

Setter for the reset attribute

BeforeMoveEvent::onSetQuery() — Method in class BeforeMoveEvent

Setter for the query argument

BeforeMoveEvent::onSetDelta() — Method in class BeforeMoveEvent

Setter for the delta argument

BeforeMoveEvent::onSetWhere() — Method in class BeforeMoveEvent

Setter for the where argument

BeforePublishEvent::onSetQuery() — Method in class BeforePublishEvent

Setter for the pks argument

BeforePublishEvent::onSetState() — Method in class BeforePublishEvent

Setter for the state argument

BeforePublishEvent::onSetUserId() — Method in class BeforePublishEvent

Setter for the userId argument

BeforeReorderEvent::onSetQuery() — Method in class BeforeReorderEvent

Setter for the query argument

BeforeReorderEvent::onSetWhere() — Method in class BeforeReorderEvent

Setter for the where argument

BeforeStoreEvent::onSetUpdateNulls() — Method in class BeforeStoreEvent

Setter for the updateNulls attribute

ObjectCreateEventClass in namespace Joomla\CMS\Event\Table

Event class for \Joomla\CMS\Table\Table onObjectCreate event

SetNewTagsEvent::onSetReplaceTags() — Method in class SetNewTagsEvent

Setter for the replaceTags attribute

AbstractDeleteEvent::onSetSubject() — Method in class AbstractDeleteEvent

Setter for the subject argument.

AbstractLoginEvent::onSetSubject() — Method in class AbstractLoginEvent

Setter for the subject argument.

AbstractLoginEvent::onSetOptions() — Method in class AbstractLoginEvent

Setter for the options argument.

AbstractLogoutEvent::onSetSubject() — Method in class AbstractLogoutEvent

Setter for the subject argument.

AbstractLogoutEvent::onSetOptions() — Method in class AbstractLogoutEvent

Setter for the options argument.

AbstractResetEvent::onSetSubject() — Method in class AbstractResetEvent

Setter for the subject argument.

AbstractSaveEvent::onSetSubject() — Method in class AbstractSaveEvent

Setter for the subject argument.

AbstractSaveEvent::onSetIsNew() — Method in class AbstractSaveEvent

Setter for the isNew argument.

AfterDeleteEvent::onSetDeletingResult() — Method in class AfterDeleteEvent

Setter for the deletingResult argument.

AfterDeleteEvent::onSetErrorMessage() — Method in class AfterDeleteEvent

Setter for the errorMessage argument.

AfterRemindEvent::onSetSubject() — Method in class AfterRemindEvent

Setter for the subject argument.

AfterSaveEvent::onSetSavingResult() — Method in class AfterSaveEvent

Setter for the savingResult argument.

AfterSaveEvent::onSetErrorMessage() — Method in class AfterSaveEvent

Setter for the errorMessage argument.

AuthenticationEvent::onSetSubject() — Method in class AuthenticationEvent

Setter for the subject argument.

AuthenticationEvent::onSetCredentials() — Method in class AuthenticationEvent

Setter for the credentials argument.

AuthenticationEvent::onSetOptions() — Method in class AuthenticationEvent

Setter for the options argument.

AuthorisationEvent::onSetSubject() — Method in class AuthorisationEvent

Setter for the subject argument.

AuthorisationEvent::onSetOptions() — Method in class AuthorisationEvent

Setter for the options argument.

AuthorisationFailureEvent::onSetSubject() — Method in class AuthorisationFailureEvent

Setter for the subject argument.

AuthorisationFailureEvent::onSetOptions() — Method in class AuthorisationFailureEvent

Setter for the options argument.

BeforeSaveEvent::onSetData() — Method in class BeforeSaveEvent

Setter for the data argument.

LoginButtonsEvent::onSetSubject() — Method in class LoginButtonsEvent

Setter for the subject argument.

WebAssetRegistryAssetChanged::onSetSubject() — Method in class WebAssetRegistryAssetChanged

Setter for the subject argument

Feed::offsetExists() — Method in class Feed

Whether or not an offset exists. This method is executed when using isset() or empty() on objects implementing ArrayAccess.

Feed::offsetGet() — Method in class Feed

Returns the value at specified offset.

Feed::offsetSet() — Method in class Feed

Assigns a value to the specified offset.

Feed::offsetUnset() — Method in class Feed

Unsets an offset.

$ Stream#openmodeProperty in class Stream

The mode under which the file was opened

Stream::open() — Method in class Stream

Generic File Operations

$ StreamString#optionsProperty in class StreamString

Enter description here .

$ StreamString#openedPathProperty in class StreamString

Enter description here .

OutputFilterClass in namespace Joomla\CMS\Filter
OutputFilter
$ AuthorField#optionsProperty in class AuthorField

Cached array of the category items.

$ LimitboxField#optionsProperty in class LimitboxField

Cached array of the category items.

OrderingFieldClass in namespace Joomla\CMS\Form\Field

Ordering field.

$ PredefinedlistField#optionsProperty in class PredefinedlistField

Cached array of the category items.

$ PredefinedlistField#optionsFilterProperty in class PredefinedlistField

Allows to use only specific values of the predefined list

$ UsergrouplistField#optionsProperty in class UsergrouplistField

Cached array of the category items.

$ Form#optionsProperty in class Form

The form object options for use in rendering and validation.

$ FormField#onchangeProperty in class FormField

The javascript onchange of the form field.

$ FormField#onclickProperty in class FormField

The javascript onclick of the form field.

OptionsRuleClass in namespace Joomla\CMS\Form\Rule

Form Rule class for the Joomla Platform.

Bootstrap::offcanvas() — Method in class Bootstrap

Add javascript support for Bootstrap offcanvas

Category::options() — Method in class Category

Returns an array of categories for the given extension.

Grid::order() — Method in class Grid

Method to create an icon for saving a new ordering in a grid

JGrid::orderUp() — Method in class JGrid

Creates an order-up action icon.

JGrid::orderDown() — Method in class JGrid

Creates an order-down action icon.

ListHelper::ordering() — Method in class ListHelper

Build the select list for Ordering derived from a query

Menu::ordering() — Method in class Menu

Build the select list for Menu Ordering

$ Select#optionDefaultsProperty in class Select

Default values for options. Organized by option group.

Select::option() — Method in class Select

Create an object that represents an option in an option list.

Select::options() — Method in class Select

Generates the option tags for an HTML select list (with no select tag surrounding the options).

Tag::options() — Method in class Tag

Returns an array of tags.

$ TagsHelper#oldTagsProperty in class TagsHelper

The old tags as comma separated string or array.

$ ComponentAdapter#oldAdminFilesProperty in class ComponentAdapter

The list of current files for the Joomla! CMS administrator that are installed and is read from the manifest on disk in the update area to handle doing a diff and deleting files that are in the old files list and not in the new files list.

$ ComponentAdapter#oldApiFilesProperty in class ComponentAdapter

The list of current files for the Joomla! CMS API that are installed and is read from the manifest on disk in the update area to handle doing a diff and deleting files that are in the old files list and not in the new files list.

$ ComponentAdapter#oldFilesProperty in class ComponentAdapter

The list of current files that are installed and is read from the manifest on disk in the update area to handle doing a diff and deleting files that are in the old files list and not in the new files list.

PackageAdapter::onExtensionAfterInstall() — Method in class PackageAdapter

Handler for the onExtensionAfterInstall event

$ PluginAdapter#oldFilesProperty in class PluginAdapter

<files> element of the old extension manifest

$ Installer#overwriteProperty in class Installer

True if existing files can be overwritten

$ BaseLayout#optionsProperty in class BaseLayout

Options object

$ Logger#optionsProperty in class Logger

Options array for the Log instance.

$ AdminController#optionProperty in class AdminController

The URL option for the component.

$ ApiController#optionProperty in class ApiController

The URL option for the component.

$ FormController#optionProperty in class FormController

The URL option for the component.

$ BaseDatabaseModel#optionProperty in class BaseDatabaseModel

The URL option for the component.

$ AbstractView#optionProperty in class AbstractView

The URL option for the component. It is usually passed by controller while it creates the view

OnGetApiFieldsClass in namespace Joomla\CMS\MVC\View\Event

Event for getting extra API Fields and Relations to render with an entity

Pagination::orderUpIcon() — Method in class Pagination

Return the icon to move an item UP.

Pagination::orderDownIcon() — Method in class Pagination

Return the icon to move an item DOWN.

ArrayProxy::offsetExists() — Method in class ArrayProxy

Implementation of ArrayAccess interface

ArrayProxy::offsetGet() — Method in class ArrayProxy

Implementation of ArrayAccess interface

ArrayProxy::offsetSet() — Method in class ArrayProxy

Implementation of ArrayAccess interface

ArrayProxy::offsetUnset() — Method in class ArrayProxy

Implementation of ArrayAccess interface

ArrayReadOnlyProxy::offsetGet() — Method in class ArrayReadOnlyProxy

Implementation of ArrayAccess interface

ArrayReadOnlyProxy::offsetSet() — Method in class ArrayReadOnlyProxy

Implementation of ArrayAccess interface

ObjectProxyClass in namespace Joomla\CMS\Proxy

Object proxy class

ObjectReadOnlyProxyClass in namespace Joomla\CMS\Proxy

Object read-only proxy class.

SchemaorgPluginTrait::onSchemaPrepareForm() — Method in class SchemaorgPluginTrait

Add a new option to the schema type in the item editing page

OnGetApiAttributesClass in namespace Joomla\CMS\Serializer\Events

Event for getting extra data attributes for an API Entity

OnGetApiRelationClass in namespace Joomla\CMS\Serializer\Events

Event for getting information on an API Relationship

MetadataManagerListener::onAfterSessionStart() — Method in class MetadataManagerListener

Listener for the session.start event.

Nested::orderUp() — Method in class Nested

Method to move a node one position to the left in the same level.

Nested::orderDown() — Method in class Nested

Method to move a node one position to the right in the same level.

PopupButton::onclose() — Method in class PopupButton
$ ToolbarButton#optionsProperty in class ToolbarButton

Button options.

ToolbarButton::onclick() — Method in class ToolbarButton
$ Update#otherUpdateInfoProperty in class Update

Object containing details if the latest update does not meet the PHP and DB version requirements

$ User#otpKeyProperty in class User

The otp key

$ User#otepProperty in class User

The otp

CoreAssetItem::onAttachCallback() — Method in class CoreAssetItem

Method called when asset attached to the Document.

FormValidateAssetItem::onAttachCallback() — Method in class FormValidateAssetItem

Method called when asset attached to the Document.

KeepaliveAssetItem::onAttachCallback() — Method in class KeepaliveAssetItem

Method called when asset attached to the Document.

TableColumnsAssetItem::onAttachCallback() — Method in class TableColumnsAssetItem

Method called when asset attached to the Document.

WebAssetAttachBehaviorInterface::onAttachCallback() — Method in class WebAssetAttachBehaviorInterface

Method called when asset attached to the Document.

$ WebAssetItem#optionsProperty in class WebAssetItem

Additional options for the asset

P

$ JLoader#prefixesProperty in class JLoader

Container for registered library class prefixes and path lookups.

$ Access#preloadedAssetTypesProperty in class Access

Array of asset types that have been preloaded

$ Access#preloadedAssetsProperty in class Access

Array of preloaded asset names and ids (key is the asset id).

Access::preload() — Method in class Access

Method to preload the Rules object for the given asset type.

Access::preloadPermissions() — Method in class Access

Method to retrieve the Asset Rule strings for this particular Asset Type and stores them for later usage in getAssetRules().

Access::preloadComponents() — Method in class Access

Method to preload the Rules objects for all components.

$ AdapterInstance#parentProperty in class AdapterInstance
Parent
AdministratorApplication::purgeMessages() — Method in class AdministratorApplication

Purge the jos_messages table of old messages

$ CliOutput#processorProperty in class CliOutput

Output processing object

ColorProcessor::process() — Method in class ColorProcessor

Process a string.

ProcessorInterfaceClass in namespace Joomla\CMS\Application\CLI\Output\Processor

Interface for a command line output processor

ProcessorInterface::process() — Method in class ProcessorInterface

Process the provided output into a string.

$ CMSApplication#profilerProperty in class CMSApplication

The profiler instance

$ CMSApplication#pathwayProperty in class CMSApplication

The pathway object

ConsoleApplication::populateHttpHost() — Method in class ConsoleApplication

Populates the HTTP_HOST and REQUEST_URI from the URL provided in the --live-site parameter.

$ DaemonApplication#parentIdProperty in class DaemonApplication
$ DaemonApplication#processIdProperty in class DaemonApplication
DaemonApplication::postFork() — Method in class DaemonApplication

Method to handle post-fork triggering of the onFork event.

DaemonApplication::pcntlChildExitStatus() — Method in class DaemonApplication

Method to return the exit code of a terminated child process.

DaemonApplication::pcntlFork() — Method in class DaemonApplication

Method to return the exit code of a terminated child process.

DaemonApplication::pcntlSignal() — Method in class DaemonApplication

Method to install a signal handler.

DaemonApplication::pcntlWait() — Method in class DaemonApplication

Method to wait on or return the status of a forked child.

$ Authentication#pluginTypeProperty in class Authentication

Plugin Type to run

$ AuthenticationResponse#passwordProperty in class AuthenticationResponse

Any UTF-8 string that the End User wants to use as a password.

$ AuthenticationResponse#postcodeProperty in class AuthenticationResponse

UTF-8 string free text that SHOULD conform to the End User's country's postal system.

PHPassHandlerClass in namespace Joomla\CMS\Authentication\Password

Password handler for PHPass hashed passwords

ProviderAwareAuthenticationPluginInterfaceClass in namespace Joomla\CMS\Authentication

Interface class defining the necessary methods for an authentication plugin to be provider aware Please note: might be deprecated with Joomla 4.2

ActionButton::preprocess() — Method in class ActionButton

Configure this object.

FeaturedButton::preprocess() — Method in class FeaturedButton

Configure this object.

PublishedButtonClass in namespace Joomla\CMS\Button

The PublishedButton class.

PublishedButton::preprocess() — Method in class PublishedButton

Configure this object.

PageControllerClass in namespace Joomla\CMS\Cache\Controller

Joomla! Cache page type object

$ CategoryNode#parent_idProperty in class CategoryNode

The id of the parent of category in the asset table, 0 for category root

$ CategoryNode#publishedProperty in class CategoryNode

The publication status of the category

$ CategoryNode#paramsProperty in class CategoryNode

JSON string of parameters

CategoryServiceInterface::prepareForm() — Method in class CategoryServiceInterface

Prepares the category form

CategoryServiceTrait::prepareForm() — Method in class CategoryServiceTrait

Prepares the category form

FtpClient::pwd() — Method in class FtpClient

Method to retrieve the current working directory on the FTP server

$ ComponentRecord#paramsProperty in class ComponentRecord

The component parameters

RouterBase::preprocess() — Method in class RouterBase

Generic method to preprocess a URL

RouterInterface::preprocess() — Method in class RouterInterface

Prepare-method for URLs This method is meant to validate and complete the URL parameters.

RouterInterface::parse() — Method in class RouterInterface

Parse method for URLs This method is meant to transform the human readable URL back into query parameters. It is only executed when SEF mode is switched on.

RouterLegacy::preprocess() — Method in class RouterLegacy

Generic preprocess function for missing or legacy component router

RouterLegacy::parse() — Method in class RouterLegacy

Generic parse function for missing or legacy component router

RouterView::preprocess() — Method in class RouterView

Generic method to preprocess a URL

RouterView::parse() — Method in class RouterView

Parse method for URLs

$ RouterViewConfiguration#parentProperty in class RouterViewConfiguration

Parentview of this one

$ RouterViewConfiguration#parent_keyProperty in class RouterViewConfiguration

Key of the parent view

$ RouterViewConfiguration#pathProperty in class RouterViewConfiguration

Path of views from this one to the root view

MenuRules::preprocess() — Method in class MenuRules

Finds the right Itemid for this query

MenuRules::parse() — Method in class MenuRules

Dummy method to fulfil the interface requirements

NomenuRules::preprocess() — Method in class NomenuRules

Dummy method to fulfil the interface requirements

NomenuRules::parse() — Method in class NomenuRules

Parse a menu-less URL

PreprocessRulesClass in namespace Joomla\CMS\Component\Router\Rules

Rule to prepare the query and add missing information

$ PreprocessRules#parent_keyProperty in class PreprocessRules

Parent ID column in the table to read the information from

PreprocessRules::preprocess() — Method in class PreprocessRules

Finds the correct Itemid for this query

PreprocessRules::parse() — Method in class PreprocessRules

Dummy method to fulfil the interface requirements

RulesInterface::preprocess() — Method in class RulesInterface

Prepares a query set to be handed over to the build() method.

RulesInterface::parse() — Method in class RulesInterface

Parses a URI to retrieve information for the right route through the component.

StandardRules::preprocess() — Method in class StandardRules

Dummy method to fulfil the interface requirements

StandardRules::parse() — Method in class StandardRules

Parse the URL

ExtensionDiscoverCommand::processDiscover() — Method in class ExtensionDiscoverCommand

Used for discovering extensions

ExtensionDiscoverInstallCommand::processDiscover() — Method in class ExtensionDiscoverInstallCommand

Used for discovering extensions

ExtensionInstallCommand::processPathInstallation() — Method in class ExtensionInstallCommand

Used for installing extension from a path

ExtensionInstallCommand::processUrlInstallation() — Method in class ExtensionInstallCommand

Used for installing extension from a URL

GetConfigurationCommand::processGroupOptions() — Method in class GetConfigurationCommand

Displays logically grouped options

GetConfigurationCommand::processSingleOption() — Method in class GetConfigurationCommand

Handles the command when a single option is requested

$ UpdateCoreCommand#progressBarProperty in class UpdateCoreCommand

Progress Bar object

UpdateCoreCommand::processUpdatePackage() — Method in class UpdateCoreCommand

Downloads and extracts the update Package

$ Document#preloadManagerProperty in class Document

Preload manager

$ Document#preloadTypesProperty in class Document

The supported preload types

Document::parse() — Method in class Document

Parses the document and prepares the buffers

Document::preloadAssets() — Method in class Document

Generate the Link header for assets configured for preloading

$ FeedDocument#pubDateProperty in class FeedDocument

Published date feed element

$ HtmlDocument#paramsProperty in class HtmlDocument

Registry of template parameters

HtmlDocument::parse() — Method in class HtmlDocument

Parses the template and populates the buffer

PreloadManagerClass in namespace Joomla\CMS\Document

Joomla! Preload Manager

PreloadManager::preload() — Method in class PreloadManager

Preloads a resource.

PreloadManager::preconnect() — Method in class PreloadManager

Initiates an early connection to a resource (DNS resolution, TCP handshake, TLS negotiation).

PreloadManager::prefetch() — Method in class PreloadManager

Indicates to the client that it should prefetch this resource.

PreloadManager::prerender() — Method in class PreloadManager

Indicates to the client that it should prerender this resource.

PreloadManagerInterfaceClass in namespace Joomla\CMS\Document

Joomla! Preload Manager Interface

PreloadManagerInterface::preload() — Method in class PreloadManagerInterface

Preloads a resource.

PreloadManagerInterface::preconnect() — Method in class PreloadManagerInterface

Initiates an early connection to a resource (DNS resolution, TCP handshake, TLS negotiation).

PreloadManagerInterface::prefetch() — Method in class PreloadManagerInterface

Indicates to the client that it should prefetch this resource.

PreloadManagerInterface::prerender() — Method in class PreloadManagerInterface

Indicates to the client that it should prerender this resource.

$ Button#propsProperty in class Button

Button properties.

$ Browser#platformProperty in class Browser
PrepareDomEventClass in namespace Joomla\CMS\Event\CustomFields

Class for CustomFields events

PrepareFieldEventClass in namespace Joomla\CMS\Event\CustomFields

Class for CustomFields events

PrepareContentEventClass in namespace Joomla\CMS\Event\Finder

Class for Finder events.

PreprocessMenuItemsEventClass in namespace Joomla\CMS\Event\Menu

Class for menu events

PrepareDataEventClass in namespace Joomla\CMS\Event\Model

Class for Model event.

PrepareFormEventClass in namespace Joomla\CMS\Event\Model

Class for Model Form event.

PrepareModuleListEventClass in namespace Joomla\CMS\Event\Module

Class for Module events.

PageCacheEventClass in namespace Joomla\CMS\Event\PageCache

Class for PageCache events

PrepareDataEventClass in namespace Joomla\CMS\Event\Plugin\System\Schemaorg

Class for SchemaPrepareDataEvent event Example: new PrepareDataEvent('onSchemaPrepareData', ['subject' => $data, 'context' => 'com_example.example']);

PrepareFormEventClass in namespace Joomla\CMS\Event\Plugin\System\Schemaorg

Class for SchemaPrepareFormEvent event Example: new PrepareFormEvent('onSchemaPrepareForm', ['subject' => $form]);

PrepareSaveEventClass in namespace Joomla\CMS\Event\Plugin\System\Schemaorg

Class for SchemaPrepareSaveEvent event Example: new PrepareFormEvent('onSchemaPrepareForm', ['subject' => $subject, 'context' => $context, 'item' => $table, 'isNew' => $isNew, 'schema' => $schema]);

PrivacyEventClass in namespace Joomla\CMS\Event\Privacy

Base class for Privacy events

$ ResultAware#preventSetArgumentResultProperty in class ResultAware

Disallow setting the result argument directly with setArgument() instead of going through addResult().

PluginInterfaceClass in namespace Joomla\CMS\Extension

Access to plugin specific services.

$ Feed#propertiesProperty in class Feed
$ Feed#publishedDateProperty in class Feed

The publication date for the feed content.

$ FeedEntry#propertiesProperty in class FeedEntry
$ FeedEntry#publishedDateProperty in class FeedEntry

The publication date for the feed entry.

$ FeedFactory#parsersProperty in class FeedFactory
FeedParser::parse() — Method in class FeedParser

Method to parse the feed into a JFeed object.

FeedParser::processElement() — Method in class FeedParser

Method to parse a specific feed element.

AtomParser::processFeedEntry() — Method in class AtomParser

Method to handle a <entry> element for the feed.

NamespaceParserInterface::processElementForFeed() — Method in class NamespaceParserInterface

Method to handle an element for the feed given that a certain namespace is present.

NamespaceParserInterface::processElementForFeedEntry() — Method in class NamespaceParserInterface

Method to handle the feed entry element for the feed given that a certain namespace is present.

RssParser::processFeedEntry() — Method in class RssParser

Method to handle a <item> element for the feed.

RssParser::processPerson() — Method in class RssParser

Method to parse a string with person data and return a FeedPerson object.

ItunesRssParser::processElementForFeed() — Method in class ItunesRssParser

Method to handle an element for the feed given that the itunes namespace is present.

ItunesRssParser::processElementForFeedEntry() — Method in class ItunesRssParser

Method to handle the feed entry element for the feed given that the itunes namespace is present.

MediaRssParser::processElementForFeed() — Method in class MediaRssParser

Method to handle an element for the feed given that the media namespace is present.

MediaRssParser::processElementForFeedEntry() — Method in class MediaRssParser

Method to handle the feed entry element for the feed given that the media namespace is present.

FieldsFormServiceInterface::prepareForm() — Method in class FieldsFormServiceInterface

Prepares the field form

FieldsServiceTrait::prepareForm() — Method in class FieldsServiceTrait

Prepares the fields form

PatcherClass in namespace Joomla\CMS\Filesystem

A Unified Diff Format Patcher class

$ Patcher#patchesProperty in class Patcher
PathClass in namespace Joomla\CMS\Filesystem

A Path handling class

$ Stream#processingmethodProperty in class Stream

Read Processing method

Stream::prependFilter() — Method in class Stream

Prepend a filter to the chain

$ StreamString#pathProperty in class StreamString

The path

$ StreamString#posProperty in class StreamString

Current position

$ AccessiblemediaField#previewProperty in class AccessiblemediaField

The preview.

$ AccessiblemediaField#previewWidthProperty in class AccessiblemediaField

The previewWidth.

$ AccessiblemediaField#previewHeightProperty in class AccessiblemediaField

The previewHeight.

$ CalendarField#parentclassProperty in class CalendarField

The parent class of the field

$ CaptchaField#pluginProperty in class CaptchaField

The plugin of the captcha field.

$ ColorField#positionProperty in class ColorField

The position.

$ ColorField#previewProperty in class ColorField

Shows preview of the selected color

$ EditorField#parentclassProperty in class EditorField

The parent class of the field

$ MediaField#previewProperty in class MediaField

The preview.

$ MediaField#previewWidthProperty in class MediaField

The previewWidth.

$ MediaField#previewHeightProperty in class MediaField

The previewHeight.

$ MediaField#parentclassProperty in class MediaField

The parent class of the field

$ MenuitemField#publishedProperty in class MenuitemField

The published status.

$ NumberField#parentclassProperty in class NumberField

The parent class of the field

PasswordFieldClass in namespace Joomla\CMS\Form\Field

Form Field class for the Joomla Platform.

PluginsFieldClass in namespace Joomla\CMS\Form\Field

Form Field class for the Joomla Framework.

PluginstatusFieldClass in namespace Joomla\CMS\Form\Field

Plugin Status field.

$ PluginstatusField#predefinedOptionsProperty in class PluginstatusField

Available statuses

PredefinedlistFieldClass in namespace Joomla\CMS\Form\Field

Form Field to load a list of predefined values

$ PredefinedlistField#predefinedOptionsProperty in class PredefinedlistField

Available predefined options

$ RedirectStatusField#predefinedOptionsProperty in class RedirectStatusField

Available statuses

$ RegistrationdaterangeField#predefinedOptionsProperty in class RegistrationdaterangeField

Available options

$ RulesField#parentAssetIdProperty in class RulesField

The parent asset Id

$ RulesField#parentclassProperty in class RulesField

The parent class of the field

SqlField::processQuery() — Method in class SqlField

Method to process the query from form.

$ StatusField#predefinedOptionsProperty in class StatusField

Available statuses

TagField::prepareOptionsNested() — Method in class TagField

Add "-" before nested tags, depending on level

$ UseractiveField#predefinedOptionsProperty in class UseractiveField

Available statuses

$ UserstateField#predefinedOptionsProperty in class UserstateField

Available statuses

Form::process() — Method in class Form

Method to process the form data.

Form::postProcess() — Method in class Form

Method to post-process form data.

$ FormField#patternProperty in class FormField

The pattern (Reg Ex) of value of the form field.

$ FormField#parentclassProperty in class FormField

The parent class of the field

FormField::postProcess() — Method in class FormField

Method to post-process a field value.

$ FormHelper#pathsProperty in class FormHelper

Array with paths where entities(field, rule, form) can be found.

$ FormHelper#prefixesProperty in class FormHelper

The class namespaces.

FormHelper::parseShowOnConditions() — Method in class FormHelper

Parse the show on conditions

PasswordRuleClass in namespace Joomla\CMS\Form\Rule

Form Rule class for the Joomla Platform.

ActionsDropdown::publish() — Method in class ActionsDropdown

Append a publish item to the current dropdown menu

Behavior::polyfill() — Method in class Behavior

Add javascript polyfills.

Bootstrap::popover() — Method in class Bootstrap

Add javascript support for Bootstrap popovers

Content::prepare() — Method in class Content

Fire onContentPrepare for content that isn't part of an article.

Dropdown::publish() — Method in class Dropdown

Append a publish item to the current dropdown menu

Grid::published() — Method in class Grid

Method to create a clickable icon to change the state of an item

JGrid::published() — Method in class JGrid

Returns a published state on a grid

JGrid::publishedOptions() — Method in class JGrid

Returns an array of standard published state filter options.

ListHelper::positions() — Method in class ListHelper

Select list of positions - generally used for location of images

PublicFolderGeneratorHelperClass in namespace Joomla\CMS\Helper

Admin Component Public Folder Generator Helper

TagsHelper::postStoreProcess() — Method in class TagsHelper

Function that handles saving tags used in a table class after a store()

TagsHelper::preStoreProcess() — Method in class TagsHelper

Function that preProcesses data from a table prior to a store() to ensure proper tag handling

UserGroupsHelper::populateGroupData() — Method in class UserGroupsHelper

Populate data for a specific user group.

$ Image#pathProperty in class Image
Image::prepareDimensions() — Method in class Image

Method to get the new dimensions for a resized image.

Cli::parseArguments() — Method in class Cli

Initialise the options and arguments

$ Input#postProperty in class Input
ComponentAdapter::parseOptionalTags() — Method in class ComponentAdapter

Method to parse optional tags in the manifest

ComponentAdapter::parseQueries() — Method in class ComponentAdapter

Method to parse the queries specified in the <sql> tags

ComponentAdapter::prepareDiscoverInstall() — Method in class ComponentAdapter

Prepares the adapter for a discover_install task

FileAdapter::parseOptionalTags() — Method in class FileAdapter

Method to parse optional tags in the manifest

FileAdapter::populateFilesAndFolderList() — Method in class FileAdapter

Function used to populate files and folder list

LibraryAdapter::parseOptionalTags() — Method in class LibraryAdapter

Method to parse optional tags in the manifest

LibraryAdapter::prepareDiscoverInstall() — Method in class LibraryAdapter

Prepares the adapter for a discover_install task

ModuleAdapter::parseOptionalTags() — Method in class ModuleAdapter

Method to parse optional tags in the manifest

ModuleAdapter::prepareDiscoverInstall() — Method in class ModuleAdapter

Prepares the adapter for a discover_install task

PackageAdapterClass in namespace Joomla\CMS\Installer\Adapter

Package installer

PackageAdapter::parseOptionalTags() — Method in class PackageAdapter

Method to parse optional tags in the manifest

PluginAdapterClass in namespace Joomla\CMS\Installer\Adapter

Plugin installer

PluginAdapter::parseOptionalTags() — Method in class PluginAdapter

Method to parse optional tags in the manifest

PluginAdapter::prepareDiscoverInstall() — Method in class PluginAdapter

Prepares the adapter for a discover_install task

TemplateAdapter::parseOptionalTags() — Method in class TemplateAdapter

Method to parse optional tags in the manifest

TemplateAdapter::parseQueries() — Method in class TemplateAdapter

Overloaded method to parse queries for template installations

TemplateAdapter::prepareDiscoverInstall() — Method in class TemplateAdapter

Prepares the adapter for a discover_install task

$ Installer#pathsProperty in class Installer

Array of paths needed by the installer

$ Installer#packageUninstallProperty in class Installer

Flag if the uninstall process was triggered by uninstalling a package

Installer::pushStep() — Method in class Installer

Pushes a step onto the installer stack for rolling back steps

Installer::parseQueries() — Method in class Installer

Backward compatible method to parse through a queries element of the installation manifest file and take appropriate action.

Installer::parseSQLFiles() — Method in class Installer

Method to extract the name of a discreet installation sql file from the installation manifest file.

Installer::parseSchemaUpdates() — Method in class Installer

Method to process the updates for an item

Installer::parseFiles() — Method in class Installer

Method to parse through a files element of the installation manifest and take appropriate action.

Installer::parseLanguages() — Method in class Installer

Method to parse through a languages element of the installation manifest and take appropriate action.

Installer::parseMedia() — Method in class Installer

Method to parse through a media element of the installation manifest and take appropriate action.

Installer::parseXMLInstallFile() — Method in class Installer

Parse a XML install manifest file.

$ InstallerAdapter#parentProperty in class InstallerAdapter

Installer used with this adapter

InstallerAdapter::parseQueries() — Method in class InstallerAdapter

Method to parse the queries specified in the <sql> tags

InstallerAdapter::parseOptionalTags() — Method in class InstallerAdapter

Method to parse optional tags in the manifest

InstallerAdapter::prepareDiscoverInstall() — Method in class InstallerAdapter

Prepares the adapter for a discover_install task

$ InstallerExtension#publishedProperty in class InstallerExtension

The status of the extension

$ InstallerExtension#paramsProperty in class InstallerExtension

An object representation of the extension params

$ InstallerScript#paramTableProperty in class InstallerScript

The table the parameters are stored in.

InstallerScript::preflight() — Method in class InstallerScript

Function called before extension installation/update/removal procedure commences

InstallerScriptInterface::preflight() — Method in class InstallerScriptInterface

Function called before extension installation/update/removal procedure commences.

InstallerScriptInterface::postflight() — Method in class InstallerScriptInterface

Function called after extension installation/update/removal procedure commences.

LegacyInstallerScript::preflight() — Method in class LegacyInstallerScript

Function called before extension installation/update/removal procedure commences.

LegacyInstallerScript::postflight() — Method in class LegacyInstallerScript

Function called after extension installation/update/removal procedure commences.

$ Manifest#packagerProperty in class Manifest

Packager of the extension

$ Manifest#packagerurlProperty in class Manifest

Packager's URL of the extension

PackageManifestClass in namespace Joomla\CMS\Installer\Manifest

Joomla! Package Manifest File

$ PackageManifest#packagenameProperty in class PackageManifest

Unique name of the package

$ Language#pluralSuffixesCallbackProperty in class Language

Name of the pluralSuffixesCallback function for this language.

Language::parse() — Method in class Language

Parses a language file.

LanguageHelper::parseIniFile() — Method in class LanguageHelper

Parse strings from a language file.

LanguageHelper::parseLanguageFiles() — Method in class LanguageHelper

Searches for language directories within a certain base dir.

LanguageHelper::parseXMLLanguageFile() — Method in class LanguageHelper

Parse XML file for language information.

Text::plural() — Method in class Text

Like Text::sprintf but tries to pluralise the string.

Text::printf() — Method in class Text

Passes a string through a printf.

$ DelegatingPsrLogger#priorityMapProperty in class DelegatingPsrLogger

Mapping array to map a PSR-3 level to a Joomla priority.

$ LogEntry#priorityProperty in class LogEntry

The priority of the message to be logged.

$ LogEntry#prioritiesProperty in class LogEntry

List of available log priority levels [Based on the Syslog default levels].

$ Logger#prioritiesProperty in class Logger

Translation array for LogEntry priorities to text strings.

$ DatabaseLogger#passwordProperty in class DatabaseLogger

The password to use for connecting to the database server.

$ DatabaseLogger#prefixProperty in class DatabaseLogger

The database table prefix of the database store logging entries.

$ FormattedtextLogger#pathProperty in class FormattedtextLogger

The full filesystem path for the log file.

FormattedtextLogger::parseFields() — Method in class FormattedtextLogger

Method to parse the format string into an array of fields.

$ SyslogLogger#prioritiesProperty in class SyslogLogger

Translation array for LogEntry priorities to SysLog priority names.

AdminController::postDeleteHook() — Method in class AdminController

Function that allows child controller access to model data after the item has been deleted.

AdminController::publish() — Method in class AdminController

Method to publish a list of items

ApiController::preprocessSaveData() — Method in class ApiController

Method to allow extended classes to manipulate the data to be saved for an extension.

$ BaseController#pathsProperty in class BaseController

The set of search directories for resources (views).

BaseController::prepareViewModel() — Method in class BaseController

Method to set the View Models

FormController::postSaveHook() — Method in class FormController

Function that allows child controller access to model data after the data has been saved.

AdminModel::populateState() — Method in class AdminModel

Stock method to auto-populate the model state.

AdminModel::prepareTable() — Method in class AdminModel

Prepare and sanitise the table data prior to saving.

AdminModel::publish() — Method in class AdminModel

Method to change the published state of one or more records.

$ BaseModel#pathsProperty in class BaseModel

The include paths

FormBehaviorTrait::preprocessData() — Method in class FormBehaviorTrait

Method to allow derived classes to preprocess the data.

FormBehaviorTrait::preprocessForm() — Method in class FormBehaviorTrait

Method to allow derived classes to preprocess the form.

ListModel::populateState() — Method in class ListModel

Method to auto-populate the model state.

StateBehaviorTrait::populateState() — Method in class StateBehaviorTrait

Method to auto-populate the state.

$ CategoriesView#pageHeadingProperty in class CategoriesView

Language key for default page heading

$ CategoriesView#paramsProperty in class CategoriesView

The category parameters

$ CategoriesView#parentProperty in class CategoriesView

The parent category

CategoriesView::prepareDocument() — Method in class CategoriesView

Prepares the document

$ CategoryView#paramsProperty in class CategoryView

The page parameters

$ CategoryView#paginationProperty in class CategoryView

Pagination object

CategoryView::prepareDocument() — Method in class CategoryView

Method to prepares the document

$ FormView#previewLinkProperty in class FormView

The preview link

JsonApiView::prepareItem() — Method in class JsonApiView

Prepare item before render.

$ ListView#paginationProperty in class ListView

The pagination object

$ MailTemplate#plain_dataProperty in class MailTemplate
$ MenuItem#paramsProperty in class MenuItem

The menu item parameters

$ MenuItem#parent_idProperty in class MenuItem

The parent menu item in the menu tree

$ Microdata#propertyProperty in class Microdata

The Property

Microdata::property() — Method in class Microdata

Setup a $Property

PaginationClass in namespace Joomla\CMS\Pagination

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

$ Pagination#prefixProperty in class Pagination
$ Pagination#pagesStartProperty in class Pagination
$ Pagination#pagesStopProperty in class Pagination
$ Pagination#pagesCurrentProperty in class Pagination
$ Pagination#pagesTotalProperty in class Pagination
$ Pagination#paramsFromRequestProperty in class Pagination

List of parameters that will be added from request automatically.

PaginationObjectClass in namespace Joomla\CMS\Pagination

Pagination object representing a particular item in the pagination lists.

$ PaginationObject#prefixProperty in class PaginationObject
PathwayClass in namespace Joomla\CMS\Pathway

Class to maintain a pathway.

$ Pathway#pathwayProperty in class Pathway

Array to hold the pathway item objects

$ CMSPlugin#paramsProperty in class CMSPlugin

A Registry object holding the parameters for the plugin

PluginHelperClass in namespace Joomla\CMS\Plugin

Plugin helper class

$ PluginHelper#pluginsProperty in class PluginHelper

A persistent cache of the loaded plugins.

ProfilerClass in namespace Joomla\CMS\Profiler

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

$ Profiler#prefixProperty in class Profiler
$ Profiler#previousTimeProperty in class Profiler
$ Profiler#previousMemProperty in class Profiler
ProxyInterfaceClass in namespace Joomla\CMS\Proxy

Interface for Proxy classes

AdministratorRouter::parse() — Method in class AdministratorRouter

Function to convert a route to an internal URI.

ApiRouter::parseApiRoute() — Method in class ApiRouter

Parse the given route and return the name of a controller mapped to the given route.

Router::parse() — Method in class Router

Function to convert a route to an internal URI

Router::processParseRules() — Method in class Router

Process the parsed router variables based on custom defined rules

Router::processBuildRules() — Method in class Router

Process the build uri query data based on custom defined rules

SiteRouter::parseCheckSSL() — Method in class SiteRouter

Force to SSL

SiteRouter::parseInit() — Method in class SiteRouter

Do some initial cleanup before parsing the URL

SiteRouter::parseFormat() — Method in class SiteRouter

Parse the format of the request

SiteRouter::parseSefRoute() — Method in class SiteRouter

Convert a sef route to an internal URI

SiteRouter::parseRawRoute() — Method in class SiteRouter

Convert a raw route to an internal URI

SiteRouter::parsePaginationData() — Method in class SiteRouter

Convert limits for pagination

PostgresqlChangeItemClass in namespace Joomla\CMS\Schema\ChangeItem

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

SchemaorgPrepareDateTrait::prepareDate() — Method in class SchemaorgPrepareDateTrait

Prepare date

SchemaorgPrepareDurationTrait::prepareDuration() — Method in class SchemaorgPrepareDurationTrait

Prepare duration

SchemaorgPrepareImageTrait::prepareImage() — Method in class SchemaorgPrepareImageTrait

Prepare media image files

PathwayClass in namespace Joomla\CMS\Service\Provider

Service provider for the application's pathway dependency

PunycodeHelperClass in namespace Joomla\CMS\String

Joomla Platform String Punycode Class

DatabaseStorage::persist() — Method in class DatabaseStorage
$ Nested#parent_idProperty in class Nested

Object property holding the primary key of the parent node. Provides adjacency list data for nodes.

Nested::publish() — Method in class Nested

Method to set the publishing state for a node or list of nodes in the database table. The method respects rows checked out by other users and will attempt to checkin rows that it can after adjustments are made. The method will not allow you to set a publishing state higher than any ancestor node and will not allow you to set a publishing state on a node with a checked out child.

Table::publish() — Method in class Table

Method to set the publishing state for a row or list of rows in the database table.

ConfirmButton::prepareOptions() — Method in class ConfirmButton

Prepare options for this button.

DropdownButton::prepareOptions() — Method in class DropdownButton

Prepare options for this button.

HelpButton::prepareOptions() — Method in class HelpButton

Prepare options for this button.

InlinehelpButton::prepareOptions() — Method in class InlinehelpButton

Prepare options for this button.

LinkButton::prepareOptions() — Method in class LinkButton

Prepare options for this button.

PopupButtonClass in namespace Joomla\CMS\Toolbar\Button

Renders a modal window button

PopupButton::prepareOptions() — Method in class PopupButton

Prepare options for this button.

PopupButton::popupType() — Method in class PopupButton
StandardButton::prepareOptions() — Method in class StandardButton

Prepare options for this button.

CoreButtonsTrait::preview() — Method in class CoreButtonsTrait

Writes a preview button for a given option (opens a popup window).

CoreButtonsTrait::publish() — Method in class CoreButtonsTrait

Writes a common 'publish' button.

CoreButtonsTrait::preferences() — Method in class CoreButtonsTrait

Writes a configuration button and invokes a cancel operation (eg a checkin).

Toolbar::prependButton() — Method in class Toolbar

Prepend a button to toolbar.

Toolbar::popupButton() — Method in class Toolbar
$ ToolbarButton#parentProperty in class ToolbarButton

Reference to the object that instantiated the element

ToolbarButton::prepareOptions() — Method in class ToolbarButton

Prepare options for this button.

ToolbarHelper::preview() — Method in class ToolbarHelper

Writes a preview button for a given option (opens a popup window).

ToolbarHelper::publish() — Method in class ToolbarHelper

Writes a common 'publish' button.

ToolbarHelper::publishList() — Method in class ToolbarHelper

Writes a common 'publish' button for a list of records.

ToolbarHelper::preferences() — Method in class ToolbarHelper

Writes a configuration button and invokes a cancel operation (eg a checkin).

$ CollectionAdapter#parentProperty in class CollectionAdapter

Tree of objects

$ CollectionAdapter#pop_parentProperty in class CollectionAdapter

Used to control if an item has a child or not

TufAdapter::processTufTarget() — Method in class TufAdapter
$ Update#php_minimumProperty in class Update
Uri::parse() — Method in class Uri

Parse a given URI and populate the class fields.

$ User#passwordProperty in class User

MD5 encrypted password

$ User#password_clearProperty in class User

Clear password, only available when a new password is set for a user

$ User#paramsProperty in class User

User parameters

$ BufferStreamHandler#positionProperty in class BufferStreamHandler

Stream position

Utility::parseAttributes() — Method in class Utility

Method to extract key/value pairs out of a string with XML style attributes

WebAssetRegistry::parseRegistryFiles() — Method in class WebAssetRegistry

Parse registered files

WebAssetRegistry::parseRegistryFile() — Method in class WebAssetRegistry

Parse registry file

PasswordHashClass in namespace [Global Namespace]
$ PasswordHash#portable_hashesProperty in class PasswordHash
PasswordHash::PasswordHash() — Method in class PasswordHash

Q

FtpClient::quit() — Method in class FtpClient

Method to quit and close the connection

$ SqlField#queryProperty in class SqlField

The query.

$ ListModel#queryProperty in class ListModel

An internal cache for the last query used.

JsonApiView::queryEncode() — Method in class JsonApiView

Encode square brackets in the URI query, according to JSON API specification.

$ MenuItem#queryProperty in class MenuItem

An array of the query string values for this item

$ ChangeItem#queryTypeProperty in class ChangeItem

Query type: To be used in building a language key for a message to tell user what was checked / changed Possible values: ADD_TABLE, ADD_COLUMN, CHANGE_COLUMN_TYPE, ADD_INDEX

R

Crypto::RuntimeTest() — Method in class Crypto
JLoader::register() — Method in class JLoader

Directly register a class to the autoload list.

JLoader::registerPrefix() — Method in class JLoader

Register a class prefix with lookup path. This will allow developers to register library packages with different class prefixes to the system autoloader. More than one lookup path may be registered for the same class prefix, but if this method is called with the reset flag set to true then any registered lookups for the given prefix will be overwritten with the current lookup path. When loaded, prefix paths are searched in a "last in, first out" order.

JLoader::registerAlias() — Method in class JLoader

Offers the ability for "just in time" usage of class_alias().

JLoader::registerNamespace() — Method in class JLoader

Register a namespace to the autoloader. When loaded, namespace paths are searched in a "last in, first out" order.

$ Access#rootAssetIdProperty in class Access

The root asset id.

RuleClass in namespace Joomla\CMS\Access

Rule class.

RulesClass in namespace Joomla\CMS\Access

Access rules class.

AdministratorApplication::render() — Method in class AdministratorApplication

Rendering is the process of pushing the document buffers into the template placeholders, retrieving data from the document and pushing it into the application response buffer.

AdministratorApplication::route() — Method in class AdministratorApplication

Route the application.

ApiApplication::render() — Method in class ApiApplication

Rendering is the process of pushing the document buffers into the template placeholders, retrieving data from the document and pushing it into the application response buffer.

ApiApplication::respond() — Method in class ApiApplication

Method to send the application response to the client. All headers will be sent prior to the main application output data.

ApiApplication::route() — Method in class ApiApplication

Route the application.

CMSApplication::redirect() — Method in class CMSApplication

Redirect to another URL.

CMSApplication::render() — Method in class CMSApplication

Rendering is the process of pushing the document buffers into the template placeholders, retrieving data from the document and pushing it into the application response buffer.

CMSApplication::route() — Method in class CMSApplication

Route the application.

$ DaemonApplication#runningProperty in class DaemonApplication
DaemonApplication::restart() — Method in class DaemonApplication

Restart daemon process.

EventAware::registerEvent() — Method in class EventAware

Registers a handler to a particular event group.

$ SiteApplication#registeredurlparamsProperty in class SiteApplication

The registered URL parameters.

SiteApplication::render() — Method in class SiteApplication

Rendering is the process of pushing the document buffers into the template placeholders, retrieving data from the document and pushing it into the application response buffer.

SiteApplication::route() — Method in class SiteApplication

Route the application.

WebApplication::render() — Method in class WebApplication

Rendering is the process of pushing the document buffers into the template placeholders, retrieving data from the document and pushing it into the application response buffer.

ActionButton::removeState() — Method in class ActionButton

Remove a state by value name.

ActionButton::render() — Method in class ActionButton

Render action button by item value.

FeaturedButton::render() — Method in class FeaturedButton

Render action button by item value.

PublishedButton::render() — Method in class PublishedButton

Render action button by item value.

TransitionButton::render() — Method in class TransitionButton

Render action button by item value.

Cache::remove() — Method in class Cache

Remove a cached data entry by ID and group

$ CacheStorage#rawnameProperty in class CacheStorage

The raw object name

CacheStorage::remove() — Method in class CacheStorage

Remove a cached data entry by ID and group

ApcuStorage::remove() — Method in class ApcuStorage

Remove a cached data entry by ID and group

FileStorage::remove() — Method in class FileStorage

Remove a cached data entry by ID and group

MemcachedStorage::remove() — Method in class MemcachedStorage

Remove a cached data entry by ID and group

RedisStorageClass in namespace Joomla\CMS\Cache\Storage

Redis cache storage handler for PECL

RedisStorage::remove() — Method in class RedisStorage

Remove a cached data entry by ID and group

$ CategoryNode#rgtProperty in class CategoryNode

The rgt value for this category in the category tree

$ Changelog#removeProperty in class Changelog

Update manifest <remove> element

FtpClient::reinit() — Method in class FtpClient

Method to reinitialise the server, ie. need to login again

FtpClient::rename() — Method in class FtpClient

Method to rename a file/folder on the FTP server

FtpClient::restart() — Method in class FtpClient

Method to restart data transfer at a given byte

FtpClient::read() — Method in class FtpClient

Method to read a file from the FTP server's contents into a buffer

ComponentHelper::renderComponent() — Method in class ComponentHelper

Render the component.

RouterBaseClass in namespace Joomla\CMS\Component\Router

Base component routing class

RouterFactoryClass in namespace Joomla\CMS\Component\Router

Default router factory.

RouterFactoryInterfaceClass in namespace Joomla\CMS\Component\Router

Router factory interface

RouterInterfaceClass in namespace Joomla\CMS\Component\Router

Component routing interface

RouterLegacyClass in namespace Joomla\CMS\Component\Router

Default routing class for missing or legacy component routers

RouterServiceInterfaceClass in namespace Joomla\CMS\Component\Router

The component router service.

RouterServiceTraitClass in namespace Joomla\CMS\Component\Router

Trait to implement AssociationServiceInterface

RouterViewClass in namespace Joomla\CMS\Component\Router

View-based component routing class

$ RouterView#rulesProperty in class RouterView

Array of rules

RouterView::registerView() — Method in class RouterView

Register the views of a component

RouterViewConfigurationClass in namespace Joomla\CMS\Component\Router

View-configuration class for the view-based component router

RouterViewConfiguration::removeLayout() — Method in class RouterViewConfiguration

Remove a layout from this view

$ MenuRules#routerProperty in class MenuRules

Router this rule belongs to

$ NomenuRules#routerProperty in class NomenuRules

Router this rule belongs to

RulesInterfaceClass in namespace Joomla\CMS\Component\Router\Rules

RouterRules interface for Joomla

$ StandardRules#routerProperty in class StandardRules

Router this rule belongs to

RemoveOldFilesCommandClass in namespace Joomla\CMS\Console

Console command for removing files which should have been cleared during an update

RemoveUserFromGroupCommandClass in namespace Joomla\CMS\Console

Console command to remove a user from a group

Document::render() — Method in class Document

Outputs the document

ErrorDocument::render() — Method in class ErrorDocument

Render the document

ErrorDocument::renderBacktrace() — Method in class ErrorDocument

Render the backtrace

$ FeedDocument#ratingProperty in class FeedDocument

Rating feed element

FeedDocument::render() — Method in class FeedDocument

Render the document

HtmlDocument::resetHeadData() — Method in class HtmlDocument

Reset the HTML document head data

HtmlDocument::render() — Method in class HtmlDocument

Outputs the template to the browser.

ImageDocument::render() — Method in class ImageDocument

Render the document.

JsonDocument::render() — Method in class JsonDocument

Render the document.

JsonapiDocument::render() — Method in class JsonapiDocument

Render the document.

OpensearchDocument::render() — Method in class OpensearchDocument

Render the document

$ OpensearchUrl#relProperty in class OpensearchUrl

Rel item element

RawDocumentClass in namespace Joomla\CMS\Document

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

RawDocument::render() — Method in class RawDocument

Render the document.

RendererInterfaceClass in namespace Joomla\CMS\Document

Interface for a document renderer

RendererInterface::render() — Method in class RendererInterface

Renders a script and returns the results as a string

AtomRenderer::render() — Method in class AtomRenderer

Render the feed.

RssRendererClass in namespace Joomla\CMS\Document\Renderer\Feed

RssRenderer is a feed that implements RSS 2.0 Specification

RssRenderer::render() — Method in class RssRenderer

Render the feed.

ComponentRenderer::render() — Method in class ComponentRenderer

Renders a component script and returns the results as a string

HeadRenderer::render() — Method in class HeadRenderer

Renders the document head and returns the results as a string

MessageRenderer::render() — Method in class MessageRenderer

Renders the error stack and returns the results as a string

MetasRenderer::render() — Method in class MetasRenderer

Renders the document metas and returns the results as a string

ModuleRenderer::render() — Method in class ModuleRenderer

Renders a module script and returns the results as a string

ModulesRenderer::render() — Method in class ModulesRenderer

Renders multiple modules script and returns the results as a string

ScriptsRenderer::render() — Method in class ScriptsRenderer

Renders the document script tags and returns the results as a string

StylesRenderer::render() — Method in class StylesRenderer

Renders the document stylesheets and style tags and returns the results as a string

XmlDocument::render() — Method in class XmlDocument

Render the document.

$ ButtonsRegistry#registryProperty in class ButtonsRegistry

List of registered elements

AbstractAES::resizeKey() — Method in class AbstractAES

Trims or zero-pads a key / IV

RandValInterfaceClass in namespace Joomla\CMS\Encrypt

Interface RandValInterface

RandvalClass in namespace Joomla\CMS\Encrypt

Generates cryptographically-secure random values.

$ Browser#robotsProperty in class Browser
ResourceNotFoundExceptionHandlerClass in namespace Joomla\CMS\Error\JsonApi

Handler for invalid resource requests that should give a 404

RendererInterfaceClass in namespace Joomla\CMS\Error

Interface defining the rendering engine for the error handling layer

RendererInterface::render() — Method in class RendererInterface

Render the error page for the given object

CliRenderer::render() — Method in class CliRenderer

Render the error for the given object.

HtmlRenderer::render() — Method in class HtmlRenderer

Render the error page for the given object

JsonRenderer::render() — Method in class JsonRenderer

Render the error page for the given object

JsonapiRenderer::render() — Method in class JsonapiRenderer

Render the error page for the given object

XmlRenderer::render() — Method in class XmlRenderer

Render the error page for the given object

ResultEventClass in namespace Joomla\CMS\Event\Finder

Class for Finder events.

RenderModuleEventClass in namespace Joomla\CMS\Event\Module

Class for Module events

RemoveDataEventClass in namespace Joomla\CMS\Event\Privacy

Class for Privacy events.

ReshapeArgumentsAwareClass in namespace Joomla\CMS\Event

A Trait to reshape arguments maintaining b/c with legacy plugin events.

ReshapeArgumentsAware::reshapeArguments() — Method in class ReshapeArgumentsAware

Reshape the arguments array to preserve b/c with legacy listeners

ResultAwareClass in namespace Joomla\CMS\Event\Result

This Trait partially implements the ResultAwareInterface for mutable and immutable events.

ResultAwareInterfaceClass in namespace Joomla\CMS\Event\Result

Defines an Event which has an append-only array argument named 'result'.

ResultTypeArrayAwareClass in namespace Joomla\CMS\Event\Result

This Trait partially implements the ResultAwareInterface for type checking.

$ ResultTypeArrayAware#resultIsNullableProperty in class ResultTypeArrayAware

Can the result attribute values also be NULL?

$ ResultTypeArrayAware#resultIsFalseableProperty in class ResultTypeArrayAware

Can the result attribute values also be boolean FALSE?

ResultTypeBooleanAwareClass in namespace Joomla\CMS\Event\Result

This Trait partially implements the ResultAwareInterface for type checking.

$ ResultTypeBooleanAware#resultIsNullableProperty in class ResultTypeBooleanAware

Can the result attribute values also be NULL?

ResultTypeFloatAwareClass in namespace Joomla\CMS\Event\Result

This Trait partially implements the ResultAwareInterface for type checking.

$ ResultTypeFloatAware#resultIsNullableProperty in class ResultTypeFloatAware

Can the result attribute values also be NULL?

$ ResultTypeFloatAware#resultIsFalseableProperty in class ResultTypeFloatAware

Can the result attribute values also be boolean FALSE?

ResultTypeIntegerAwareClass in namespace Joomla\CMS\Event\Result

This Trait partially implements the ResultAwareInterface for type checking.

$ ResultTypeIntegerAware#resultIsNullableProperty in class ResultTypeIntegerAware

Can the result attribute values also be NULL?

$ ResultTypeIntegerAware#resultIsFalseableProperty in class ResultTypeIntegerAware

Can the result attribute values also be boolean FALSE?

ResultTypeMixedAwareClass in namespace Joomla\CMS\Event\Result

This Trait partially implements the ResultAwareInterface for type checking.

ResultTypeNumericAwareClass in namespace Joomla\CMS\Event\Result

This Trait partially implements the ResultAwareInterface for type checking.

$ ResultTypeNumericAware#resultIsNullableProperty in class ResultTypeNumericAware

Can the result attribute values also be NULL?

$ ResultTypeNumericAware#resultIsFalseableProperty in class ResultTypeNumericAware

Can the result attribute values also be boolean FALSE?

ResultTypeObjectAwareClass in namespace Joomla\CMS\Event\Result

This Trait partially implements the ResultAwareInterface for type checking.

$ ResultTypeObjectAware#resultIsNullableProperty in class ResultTypeObjectAware

Can the result attribute values also be NULL?

$ ResultTypeObjectAware#resultIsFalseableProperty in class ResultTypeObjectAware

Can the result attribute values also be boolean FALSE?

$ ResultTypeObjectAware#resultAcceptableClassesProperty in class ResultTypeObjectAware

Acceptable class names for result values.

ResultTypeStringAwareClass in namespace Joomla\CMS\Event\Result

This Trait partially implements the ResultAwareInterface for type checking.

$ ResultTypeStringAware#resultIsNullableProperty in class ResultTypeStringAware

Can the result attribute values also be NULL?

$ ResultTypeStringAware#resultIsFalseableProperty in class ResultTypeStringAware

Can the result attribute values also be boolean FALSE?

ExceptionHandler::render() — Method in class ExceptionHandler

Render the error page based on an exception.

PluginInterface::registerListeners() — Method in class PluginInterface

Registers its listeners.

CategoryFactory::register() — Method in class CategoryFactory

Registers the service provider with a DI container.

ComponentDispatcherFactory::register() — Method in class ComponentDispatcherFactory

Registers the service provider with a DI container.

HelperFactory::register() — Method in class HelperFactory

Registers the service provider with a DI container.

MVCFactory::register() — Method in class MVCFactory

Registers the service provider with a DI container.

Module::register() — Method in class Module

Registers the service provider with a DI container.

ModuleDispatcherFactory::register() — Method in class ModuleDispatcherFactory

Registers the service provider with a DI container.

RouterFactoryClass in namespace Joomla\CMS\Extension\Service\Provider

Service provider for the service router factory.

RouterFactory::register() — Method in class RouterFactory

Registers the service provider with a DI container.

Feed::removeCategory() — Method in class Feed

Method to remove a category from the feed object.

Feed::removeContributor() — Method in class Feed

Method to remove a contributor from the feed object.

Feed::removeEntry() — Method in class Feed

Method to remove an entry from the feed object.

Feed::reverseItems() — Method in class Feed

Method to reverse the items if display is set to 'oldest first'

FeedEntry::removeCategory() — Method in class FeedEntry

Method to remove a category from the feed entry object.

FeedEntry::removeContributor() — Method in class FeedEntry

Method to remove a contributor from the feed entry object.

FeedEntry::removeLink() — Method in class FeedEntry

Method to remove a link from the feed entry object.

FeedFactory::registerParser() — Method in class FeedFactory

Method to register a FeedParser class for a given root tag name.

$ FeedLink#relationProperty in class FeedLink

The relationship between the feed and the linked resource.

FeedParser::registerNamespace() — Method in class FeedParser

Method to register a namespace handler object.

RssParserClass in namespace Joomla\CMS\Feed\Parser

RSS Feed Parser class.

FilesystemHelper::remotefsize() — Method in class FilesystemHelper

Remote file size function for streams that don't support it

$ Patcher#removalsProperty in class Patcher
Patcher::reset() — Method in class Patcher

Reset the patcher

$ Stream#readprefixProperty in class Stream

Prefix of the connection for reading

Stream::read() — Method in class Stream

Read a file

Stream::removeFilter() — Method in class Stream

Remove a filter, either by resource (handed out from the append or prepend function) or via getting the filter list)

$ FolderlistField#recursiveProperty in class FolderlistField

The recursive.

$ PasswordField#rulesProperty in class PasswordField

The rules flag.

RadioFieldClass in namespace Joomla\CMS\Form\Field

Form Field class for the Joomla Platform.

RadiobasicFieldClass in namespace Joomla\CMS\Form\Field

Form Field class for the Joomla Platform.

RangeFieldClass in namespace Joomla\CMS\Form\Field

Form Field class for the Joomla Platform.

RedirectStatusFieldClass in namespace Joomla\CMS\Form\Field

Redirect Status field.

RegistrationdaterangeFieldClass in namespace Joomla\CMS\Form\Field

Registration Date Range field.

RulesFieldClass in namespace Joomla\CMS\Form\Field

Form Field class for the Joomla Platform.

SpacerField::renderField() — Method in class SpacerField

Method to get a control group with label and input.

$ TextareaField#rowsProperty in class TextareaField

The number of rows in textarea.

RawFilterClass in namespace Joomla\CMS\Form\Filter

Form Filter class for raw values

RulesFilterClass in namespace Joomla\CMS\Form\Filter

Form Filter class for rules

$ Form#repeatProperty in class Form

Allows extensions to implement repeating elements

Form::renderField() — Method in class Form

Method to get a control group with label and input.

Form::renderFieldset() — Method in class Form

Method to get all control groups with label and input of a fieldset.

Form::removeField() — Method in class Form

Method to remove a field from the form definition.

Form::removeGroup() — Method in class Form

Method to remove a group from the form definition.

Form::reset() — Method in class Form

Method to reset the form data store and optionally the form XML definition.

Form::removeControlField() — Method in class Form

Remove control field

Form::renderControlFields() — Method in class Form

Render control fields

$ FormField#repeatProperty in class FormField

Allows extensions to create repeat elements

$ FormField#requiredProperty in class FormField

The required state for the form field. If true then there must be a value for the field to be considered valid.

$ FormField#readonlyProperty in class FormField

The readonly state for the form field. If true then the field will be readonly.

$ FormField#renderLayoutProperty in class FormField

Layout to render the form field

$ FormField#renderLabelLayoutProperty in class FormField

Layout to render the label

FormField::renderDataAttributes() — Method in class FormField

Method to render data attributes to html.

FormField::render() — Method in class FormField

Render a layout of this field

FormField::renderField() — Method in class FormField

Method to get a control group with label and input.

$ FormRule#regexProperty in class FormRule

The regular expression to use in testing a form field value.

$ BooleanRule#regexProperty in class BooleanRule

The regular expression to use in testing a form field value.

$ EmailRule#regexProperty in class EmailRule

The regular expression to use in testing a form field value.

$ ModuleLayoutRule#regexProperty in class ModuleLayoutRule

The regular expression to use in testing a module layout field value.

RegexRuleClass in namespace Joomla\CMS\Form\Rule

Form Rule class for the Joomla Platform.

RulesRuleClass in namespace Joomla\CMS\Form\Rule

Form Rule class for the Joomla Platform.

$ ShowOnRule#regexProperty in class ShowOnRule

The regular expression to use in testing a form field value.

$ HTMLHelper#registryProperty in class HTMLHelper

An array to hold method references

HTMLHelper::register() — Method in class HTMLHelper

Registers a function to be called with a specific key

ActionsDropdown::render() — Method in class ActionsDropdown

Method to render current dropdown menu

Bootstrap::renderModal() — Method in class Bootstrap

Method to render a Bootstrap modal

Date::relative() — Method in class Date

Function to convert a static time into a relative measurement

Dropdown::render() — Method in class Dropdown

Method to render current dropdown menu

Select::radiolist() — Method in class Select

Generates an HTML radio list.

Sidebar::render() — Method in class Sidebar

Render the sidebar.

RegistryClass in namespace Joomla\CMS\HTML

Service registry for JHtml services

Registry::register() — Method in class Registry

Register a service

ModuleHelper::renderModule() — Method in class ModuleHelper

Render the module.

ModuleHelper::renderRawModule() — Method in class ModuleHelper

Render the module content.

RouteHelperClass in namespace Joomla\CMS\Helper

Route Helper

$ TagsHelper#replaceTagsProperty in class TagsHelper

Whether up replace all tags or just add tags

ResponseClass in namespace Joomla\CMS\Http

HTTP response data object class.

CurlTransport::request() — Method in class CurlTransport

Send a request to the server and return a Response object with the response.

SocketTransport::request() — Method in class SocketTransport

Send a request to the server and return a Response object with the response.

StreamTransport::request() — Method in class StreamTransport

Send a request to the server and return a Response object with the response.

Image::resize() — Method in class Image

Method to resize the current image.

Image::rotate() — Method in class Image

Method to rotate the current image.

$ Input#requestProperty in class Input
ComponentAdapter::removeExtensionFiles() — Method in class ComponentAdapter

Removes this extension's files

ComponentAdapter::refreshManifestCache() — Method in class ComponentAdapter

Refreshes the extension table cache

FileAdapter::removeExtensionFiles() — Method in class FileAdapter

Removes this extension's files

FileAdapter::refreshManifestCache() — Method in class FileAdapter

Refreshes the extension table cache

LanguageAdapter::removeExtensionFiles() — Method in class LanguageAdapter

Removes this extension's files

LanguageAdapter::refreshManifestCache() — Method in class LanguageAdapter

Refreshes the extension table cache

LibraryAdapter::removeExtensionFiles() — Method in class LibraryAdapter

Removes this extension's files

LibraryAdapter::refreshManifestCache() — Method in class LibraryAdapter

Refreshes the extension table cache

ModuleAdapter::refreshManifestCache() — Method in class ModuleAdapter

Refreshes the extension table cache

ModuleAdapter::removeExtensionFiles() — Method in class ModuleAdapter

Removes this extension's files

$ PackageAdapter#resultsProperty in class PackageAdapter

The results of each installed extensions

PackageAdapter::removeExtensionFiles() — Method in class PackageAdapter

Removes this extension's files

PackageAdapter::refreshManifestCache() — Method in class PackageAdapter

Refreshes the extension table cache

PluginAdapter::removeExtensionFiles() — Method in class PluginAdapter

Removes this extension's files

PluginAdapter::refreshManifestCache() — Method in class PluginAdapter

Refreshes the extension table cache.

TemplateAdapter::removeExtensionFiles() — Method in class TemplateAdapter

Removes this extension's files

TemplateAdapter::refreshManifestCache() — Method in class TemplateAdapter

Refreshes the extension table cache

$ Installer#redirect_urlProperty in class Installer

The redirect URL if this extension (can be null if no redirect)

Installer::refreshManifestCache() — Method in class Installer

Refreshes the manifest cache stored in #__extensions

Installer::removeFiles() — Method in class Installer

Method to parse through a files element of the installation manifest and remove the files that were installed

$ InstallerAdapter#routeProperty in class InstallerAdapter

Install function routing

InstallerAdapter::removeExtensionFiles() — Method in class InstallerAdapter

Removes this extension's files

$ InstallerScript#releaseProperty in class InstallerScript

The version number of the extension.

InstallerScript::removeFiles() — Method in class InstallerScript

Remove the files and folders in the given array from

BaseLayout::resetOptions() — Method in class BaseLayout

Function to empty all the options

BaseLayout::render() — Method in class BaseLayout

Method to render the layout.

BaseLayout::renderDebugMessages() — Method in class BaseLayout

Render the list of debug messages

FileLayout::render() — Method in class FileLayout

Method to render the layout.

FileLayout::removeIncludePath() — Method in class FileLayout

Remove one path from the layout search

FileLayout::removeIncludePaths() — Method in class FileLayout

Remove one or more paths to exclude in layout search

LayoutHelper::render() — Method in class LayoutHelper

Method to render the layout.

LayoutInterface::render() — Method in class LayoutInterface

Method to render the layout.

Log::registerLogger() — Method in class Log

Register a logger to the registry

LoggerRegistry::register() — Method in class LoggerRegistry

Register a logger

AdminController::reorder() — Method in class AdminController

Changes the order of one or more records.

AdminController::runTransition() — Method in class AdminController

Method to run Transition by id of item.

$ BaseController#redirectProperty in class BaseController

URL for redirection.

BaseController::redirect() — Method in class BaseController

Redirects the browser or returns false if no redirect is set.

BaseController::registerDefaultTask() — Method in class BaseController

Register the default task to perform if a mapping is not found.

BaseController::registerTask() — Method in class BaseController

Register (map) a task to a method in the class.

BaseController::releaseEditId() — Method in class BaseController

Method to check whether an ID is in the edit list.

ResourceNotFoundClass in namespace Joomla\CMS\MVC\Controller\Exception

Exception class defining a resource not found exception

FormController::reload() — Method in class FormController

Method to reload a record.

AdminModel::reorder() — Method in class AdminModel

Method to adjust the ordering of a row.

AdminModel::redirectToAssociations() — Method in class AdminModel

Method to load an item in com_associations.

ListModel::refineSearchStringToRegex() — Method in class ListModel

Parse and transform the search string into a string fit for regex-ing arbitrary strings against

CategoryFeedView::reconcileNames() — Method in class CategoryFeedView

Method to reconcile non standard names from components to usage in this class.

$ CategoryView#runPluginsProperty in class CategoryView

Whether to run the standard Joomla plugin events.

$ JsonApiView#relationshipProperty in class JsonApiView

Item relationship

Mail::removeAttachment() — Method in class Mail

Unset file attachments specified by array index.

$ MailTemplate#recipientsProperty in class MailTemplate

List of recipients of the email

$ MailTemplate#replytoProperty in class MailTemplate

Reply To of the email

MailTemplate::replaceTags() — Method in class MailTemplate

Replace tags with their values recursively

$ MenuItem#routeProperty in class MenuItem

The computed path of the menu item based on the alias field, this is populated from the path field in the #__menu table

Microdata::resetParams() — Method in class Microdata

Reset all params

CMSPlugin::registerListeners() — Method in class CMSPlugin

Registers its listeners.

CMSPlugin::registerLegacyListener() — Method in class CMSPlugin

Registers a legacy event listener, i.e. a method which accepts individual arguments instead of an AbstractEvent in its arguments. This provides backwards compatibility to Joomla! 3.x-style plugins.

CMSPlugin::registerListener() — Method in class CMSPlugin

Registers a proper event listener, i.e. a method which accepts an AbstractEvent as its sole argument. This is the preferred way to implement plugins in Joomla! 4.x and will be the only possible method with Joomla! 5.x onwards.

ArrayProxy::rewind() — Method in class ArrayProxy

Implementation of Iterator interface

ObjectProxy::rewind() — Method in class ObjectProxy

Implementation of Iterator interface

ReadOnlyProxyInterfaceClass in namespace Joomla\CMS\Proxy

Interface for read-only Proxy classes

RouteNotFoundExceptionClass in namespace Joomla\CMS\Router\Exception

Exception class defining an error for a missing route

RouteClass in namespace Joomla\CMS\Router

Route handling class

RouterClass in namespace Joomla\CMS\Router

Class to create and parse routes

$ Router#rulesProperty in class Router

An array of rules

$ ChangeItem#rerunStatusProperty in class ChangeItem

Rerun status

Application::register() — Method in class Application

Registers the service provider with a DI container.

Authentication::register() — Method in class Authentication

Registers the service provider with a DI container.

CacheController::register() — Method in class CacheController

Registers the service provider with a DI container.

CaptchaRegistry::register() — Method in class CaptchaRegistry

Registers the service provider with a DI container.

Config::register() — Method in class Config

Registers the service provider with a DI container.

Console::register() — Method in class Console

Registers the service provider with a DI container.

Database::register() — Method in class Database

Registers the service provider with a DI container.

Dispatcher::register() — Method in class Dispatcher

Registers the service provider with a DI container.

Document::register() — Method in class Document

Registers the service provider with a DI container.

EditorsRegistry::register() — Method in class EditorsRegistry

Registers the service provider with a DI container.

Form::register() — Method in class Form

Registers the service provider with a DI container.

HTMLRegistry::register() — Method in class HTMLRegistry

Registers the service provider with a DI container.

Input::register() — Method in class Input

Registers the service provider with a DI container.

Language::register() — Method in class Language

Registers the service provider with a DI container.

Logger::register() — Method in class Logger

Registers the service provider with a DI container.

Mailer::register() — Method in class Mailer

Registers the service provider with a DI container.

Menu::register() — Method in class Menu

Registers the service provider with a DI container.

Pathway::register() — Method in class Pathway

Registers the service provider with a DI container.

RouterClass in namespace Joomla\CMS\Service\Provider

Service provider for the application's API router dependency

Router::register() — Method in class Router

Registers the service provider with a DI container.

Session::register() — Method in class Session

Registers the service provider with a DI container.

Toolbar::register() — Method in class Toolbar

Registers the service provider with a DI container.

User::register() — Method in class User

Registers the service provider with a DI container.

WebAssetRegistry::register() — Method in class WebAssetRegistry

Registers the service provider with a DI container.

JoomlaStorage::remove() — Method in class JoomlaStorage

Unset a variable from the session store

DatabaseStorage::read() — Method in class DatabaseStorage
$ Asset#rulesProperty in class Asset

The rules for the asset stored in a JSON string

Asset::rebuild() — Method in class Asset

Method to recursively rebuild the whole nested set tree.

$ Nested#rgtProperty in class Nested

Object property holding the right value of the node for managing its placement in the nested sets tree.

$ Nested#root_idProperty in class Nested

Cache for the root ID

Nested::rebuild() — Method in class Nested

Method to recursively rebuild the whole nested set tree.

Nested::rebuildPath() — Method in class Nested

Method to rebuild the node's path field from the alias values of the nodes from the current node to the root node of the tree.

Nested::reset() — Method in class Nested

Method to reset class properties to the defaults set in the class definition. It will ignore the primary key as well as any private class properties (except $_errors).

Nested::recursiveUpdatePublishedColumn() — Method in class Nested

Method to recursive update published column for children rows.

Table::reset() — Method in class Table

Method to reset class properties to the defaults set in the class definition.

Table::reorder() — Method in class Table

Method to compact the ordering values of rows in a group of rows defined by an SQL WHERE clause.

TableInterface::reset() — Method in class TableInterface

Method to reset class properties to the defaults set in the class definition.

Usergroup::rebuild() — Method in class Usergroup

Method to recursively rebuild the nested set tree.

CustomButton::renderButton() — Method in class CustomButton

Render button HTML.

HelpButton::ref() — Method in class HelpButton
PopupButton::renderButton() — Method in class PopupButton

Render button HTML.

Toolbar::render() — Method in class Toolbar

Render a toolbar.

Toolbar::renderButton() — Method in class Toolbar

Render a button.

ToolbarButton::render() — Method in class ToolbarButton

Get the HTML to render the button

ToolbarButton::renderButton() — Method in class ToolbarButton

Render button HTML.

NodeInterface::removeChild() — Method in class NodeInterface

Remove a specific child

NodeTrait::removeChild() — Method in class NodeTrait

Remove a specific child

$ Update#relationshipsProperty in class Update

Update manifest <relationships> element

$ Uri#rootProperty in class Uri
Uri::root() — Method in class Uri

Returns the root URI for the request.

Uri::reset() — Method in class Uri

Method to reset class static members for testing and other various issues.

$ User#registerDateProperty in class User

Date the user was registered

$ User#resetCountProperty in class User

Count since last Reset Time

$ User#requireResetProperty in class User

Flag to require the user's password be reset

UserHelper::removeUserFromGroup() — Method in class UserHelper

Method to remove a user from a group.

Version::refreshMediaVersion() — Method in class Version

Function to refresh the media version

WebAssetItem::resolvePath() — Method in class WebAssetItem

Resolve path

$ WebAssetManager#registryProperty in class WebAssetManager

The WebAsset Registry instance

WebAssetManager::reset() — Method in class WebAssetManager

Clears all collected items.

WebAssetManager::registerAsset() — Method in class WebAssetManager

Register a new asset.

WebAssetManager::registerStyle() — Method in class WebAssetManager
WebAssetManager::registerAndUseStyle() — Method in class WebAssetManager
WebAssetManager::registerScript() — Method in class WebAssetManager
WebAssetManager::registerAndUseScript() — Method in class WebAssetManager
WebAssetManager::registerPreset() — Method in class WebAssetManager
WebAssetManager::registerAndUsePreset() — Method in class WebAssetManager
WebAssetRegistry::remove() — Method in class WebAssetRegistry

Remove Asset from registry.

WebAssetRegistryInterface::remove() — Method in class WebAssetRegistryInterface

Remove Asset from registry.

$ PasswordHash#random_stateProperty in class PasswordHash

S

JLoader::setup() — Method in class JLoader

Method to setup the autoloaders for the Joomla Platform.

Adapter::setAdapter() — Method in class Adapter

Set an adapter by name

ApplicationHelper::stringURLSafe() — Method in class ApplicationHelper

This method transliterates a string into a URL safe string or returns a URL safe UTF-8 string based on the global configuration

CliOutput::setProcessor() — Method in class CliOutput

Set a processor

$ ColorProcessor#stripFilterProperty in class ColorProcessor

Regex used for removing color codes

$ ColorProcessor#stylesProperty in class ColorProcessor

Array of ColorStyle objects

ColorProcessor::stripColors() — Method in class ColorProcessor

Strip color tags from a string.

StdoutClass in namespace Joomla\CMS\Application\CLI\Output

Output handler for writing command line output to the stdout interface

$ CMSApplication#scopeProperty in class CMSApplication

The scope of the application.

CMSApplication::setUserState() — Method in class CMSApplication

Sets the value of a user state variable.

CMSApplication::setMenuFactory() — Method in class CMSApplication

Sets the internal menu factory.

CMSWebApplicationInterface::setUserState() — Method in class CMSWebApplicationInterface

Sets the value of a user state variable.

CliApplication::setOutput() — Method in class CliApplication

Set an output object.

ConsoleApplication::setSession() — Method in class ConsoleApplication

Sets the session for the application to use, if required.

ConsoleApplication::setName() — Method in class ConsoleApplication

Set the name of the application.

$ DaemonApplication#signalsProperty in class DaemonApplication
DaemonApplication::signal() — Method in class DaemonApplication

Method to handle POSIX signals.

DaemonApplication::stop() — Method in class DaemonApplication

Stop daemon process.

DaemonApplication::setupSignalHandlers() — Method in class DaemonApplication

Method to attach the DaemonApplication signal handler to the known signals. Applications can override these handlers by using the pcntl_signal() function and attaching a different callback method.

DaemonApplication::shutdown() — Method in class DaemonApplication

Method to shut down the daemon and optionally restart it.

SiteApplicationClass in namespace Joomla\CMS\Application

Joomla! Site Application class

SiteApplication::setDetectBrowser() — Method in class SiteApplication

Set the current state of the detect browser option.

SiteApplication::setLanguageFilter() — Method in class SiteApplication

Set the current state of the language filter.

SiteApplication::setTemplate() — Method in class SiteApplication

Overrides the default template that would be used

AssociationServiceTrait::setAssociationExtension() — Method in class AssociationServiceTrait

The association extension.

$ AuthenticationResponse#statusProperty in class AuthenticationResponse

Response status (see status codes)

$ ActionButton#statesProperty in class ActionButton

The button states profiles.

ActionButton::setLayout() — Method in class ActionButton

Method to set property template.

ActionButton::setOptions() — Method in class ActionButton

Method to set property options.

ActionButton::setOption() — Method in class ActionButton

Set option value.

Cache::setCaching() — Method in class Cache

Set caching enabled state

Cache::setLifeTime() — Method in class Cache

Set cache lifetime

Cache::store() — Method in class Cache

Store the cached data by ID and group

Cache::setWorkarounds() — Method in class Cache

Create workarounds for data to be cached

CacheControllerFactoryAwareInterface::setCacheControllerFactory() — Method in class CacheControllerFactoryAwareInterface

Set the cache controller factory to use.

CacheControllerFactoryAwareTrait::setCacheControllerFactory() — Method in class CacheControllerFactoryAwareTrait

Set the cache controller factory to use.

CacheStorage::store() — Method in class CacheStorage

Store the data to cache by ID and group

CallbackController::store() — Method in class CallbackController

Store data to cache by ID and group

OutputController::store() — Method in class OutputController

Store data to cache by ID and group

PageController::store() — Method in class PageController

Stop the cache buffer and store the cached data

ViewController::store() — Method in class ViewController

Store data to cache by ID and group

ApcuStorage::store() — Method in class ApcuStorage

Store the data to cache by ID and group

$ CacheStorageHelper#sizeProperty in class CacheStorageHelper

Cached item size

FileStorage::store() — Method in class FileStorage

Store the data to cache by ID and group

MemcachedStorage::store() — Method in class MemcachedStorage

Store the data to cache by ID and group

RedisStorage::store() — Method in class RedisStorage

Store the data to cache by ID and group

Captcha::setupField() — Method in class Captcha

Method to react on the setup of a captcha field. Gives the possibility to change the field and/or the XML element for the field.

CaptchaProviderInterface::setupField() — Method in class CaptchaProviderInterface

Method to react on the setup of a captcha field. Gives the possibility to change the field and/or the XML element for the field.

HttpBridgePostRequestMethod::submit() — Method in class HttpBridgePostRequestMethod

Submit the request with the specified parameters.

$ CategoryNode#slugProperty in class CategoryNode

Slug for the category (used in URL)

CategoryNode::setParent() — Method in class CategoryNode

Set the parent of this category

CategoryNode::setAllLoaded() — Method in class CategoryNode

Set to load all children

CategoryServiceTrait::setCategoryFactory() — Method in class CategoryServiceTrait

Sets the internal category factory.

SectionNotFoundExceptionClass in namespace Joomla\CMS\Categories

Representing when a category section cannot be found.

$ Changelog#securityProperty in class Changelog

Update manifest <security> element

$ Changelog#stackProperty in class Changelog

Element call stack

Changelog::setVersion() — Method in class Changelog

Set the version to match.

Changelog::startElement() — Method in class Changelog

XML Start Element callback

ClientHelper::setCredentials() — Method in class ClientHelper

Method to set client login credentials

ClientHelper::setCredentialsFromRequest() — Method in class ClientHelper

Determine whether input fields for client settings need to be shown

FtpClient::setOptions() — Method in class FtpClient

Set client options

FtpClient::syst() — Method in class FtpClient

Method to system string from the FTP server

FtpClient::store() — Method in class FtpClient

Method to store a file to the FTP server

FtpClient::size() — Method in class FtpClient

Get the size of the remote file.

ComponentRecord::setParams() — Method in class ComponentRecord

Sets the menu item parameters

RouterServiceTrait::setRouterFactory() — Method in class RouterServiceTrait

The router factory.

RouterViewConfiguration::setName() — Method in class RouterViewConfiguration

Set the name of the view

RouterViewConfiguration::setKey() — Method in class RouterViewConfiguration

Set the key-identifier for the view

RouterViewConfiguration::setParent() — Method in class RouterViewConfiguration

Set the parent view of this view

RouterViewConfiguration::setNestable() — Method in class RouterViewConfiguration

Set if this view is nestable or not

StandardRulesClass in namespace Joomla\CMS\Component\Router\Rules

Rule for the standard handling of component routing

CheckJoomlaUpdatesCommand::setUpdateInfo() — Method in class CheckJoomlaUpdatesCommand

Sets the Update Information

ExtensionsListCommand::setExtensions() — Method in class ExtensionsListCommand

Retrieves the extension from the model and sets the class variable

SessionGcCommandClass in namespace Joomla\CMS\Console

Console command for performing session garbage collection

SessionMetadataGcCommandClass in namespace Joomla\CMS\Console

Console command for performing session metadata garbage collection

SetConfigurationCommandClass in namespace Joomla\CMS\Console

Console command Setting Configuration options

SetConfigurationCommand::setOptions() — Method in class SetConfigurationCommand

Sets the options array

SetConfigurationCommand::saveConfiguration() — Method in class SetConfigurationCommand

Save the configuration file

SetConfigurationCommand::sanitizeOptions() — Method in class SetConfigurationCommand

Sanitize the options array for boolean

SiteCreatePublicFolderCommandClass in namespace Joomla\CMS\Console

Console command for creating a public folder

SiteDownCommandClass in namespace Joomla\CMS\Console

Console command wrapper for getting the site into offline mode

SiteUpCommandClass in namespace Joomla\CMS\Console

Console command wrapper for getting the site into offline mode

UpdateCoreCommand::setUpdateInfo() — Method in class UpdateCoreCommand

Sets the update Information

UpdateCoreCommand::setUpdateModel() — Method in class UpdateCoreCommand

Sets the Update Model

SodiumCipherClass in namespace Joomla\CMS\Crypt\Cipher

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

SodiumCipher::setNonce() — Method in class SodiumCipher

Set the nonce to use for encrypting/decrypting messages

Crypt::safeStrlen() — Method in class Crypt

Safely detect a string's length

Crypt::safeSubstr() — Method in class Crypt

Safely extract a substring

$ Date#stzProperty in class Date

Placeholder for a \DateTimeZone object with the default server time zone as the time zone.

$ Date#secondProperty in class Date

s - Seconds with leading zeros.

Date::setTimezone() — Method in class Date

Method to wrap the setTimezone() function and set the internal time zone object.

Date::sub() — Method in class Date

Subtracts an amount of days, months, years, hours, minutes and seconds from a Date object.

$ Document#scriptOptionsProperty in class Document

Array of scripts options

Document::setFactory() — Method in class Document

Set the factory instance

Document::setType() — Method in class Document

Set the document type

Document::setBuffer() — Method in class Document

Set the contents of the document buffer

Document::setMetaData() — Method in class Document

Sets or alters a meta tag.

Document::setCharset() — Method in class Document

Sets the document charset

Document::setLanguage() — Method in class Document

Sets the global document language declaration. Default is English (en-gb).

Document::setDirection() — Method in class Document

Sets the global document direction declaration. Default is left-to-right (ltr).

Document::setTitle() — Method in class Document

Sets the title of the document

Document::setMediaVersion() — Method in class Document

Set the assets version

Document::setPreloadManager() — Method in class Document

Set the preload manager

Document::setWebAssetManager() — Method in class Document

Set WebAsset manager

Document::setBase() — Method in class Document

Sets the base URI of the document

Document::setDescription() — Method in class Document

Sets the description of the document

Document::setLink() — Method in class Document

Sets the document link

Document::setGenerator() — Method in class Document

Sets the document generator

Document::setModifiedDate() — Method in class Document

Sets the document modified date

Document::setMimeEncoding() — Method in class Document

Sets the document MIME encoding that is sent to the browser.

Document::setLineEnd() — Method in class Document

Sets the line end style to Windows, Mac, Unix or a custom string.

Document::setTab() — Method in class Document

Sets the string used to indent HTML

DocumentAwareInterface::setDocument() — Method in class DocumentAwareInterface

Set the document to use.

DocumentAwareTrait::setDocument() — Method in class DocumentAwareTrait

Set the document to use.

ErrorDocument::setError() — Method in class ErrorDocument

Set error object

$ FeedDocument#syndicationURLProperty in class FeedDocument

Syndication URL feed element

$ FeedDocument#skipHoursProperty in class FeedDocument

Skiphours feed element

$ FeedDocument#skipDaysProperty in class FeedDocument

Skipdays feed element

$ FeedItem#sourceProperty in class FeedItem

Source element

FeedItem::setEnclosure() — Method in class FeedItem

Set the FeedEnclosure for this item

HtmlDocument::setHeadData() — Method in class HtmlDocument

Set the HTML document head data

HtmlDocument::setHtml5() — Method in class HtmlDocument

Sets whether the document should be output as HTML5

HtmlDocument::setBuffer() — Method in class HtmlDocument

Set the contents a document includes

HtmlDocument::setToolbar() — Method in class HtmlDocument

Adds a new or replace an existing toolbar object

JsonDocument::setName() — Method in class JsonDocument

Sets the document name

JsonapiDocument::setData() — Method in class JsonapiDocument

Set the data object.

JsonapiDocument::setErrors() — Method in class JsonapiDocument

Set the errors array.

JsonapiDocument::setJsonapi() — Method in class JsonapiDocument

Set the JSON-API array.

OpensearchDocument::setShortName() — Method in class OpensearchDocument

Sets the short name

PreloadManager::setLinkProvider() — Method in class PreloadManager

Set the link provider

PreloadManagerInterface::setLinkProvider() — Method in class PreloadManagerInterface

Set the link provider

ScriptsRendererClass in namespace Joomla\CMS\Document\Renderer\Html

JDocument head renderer

StylesRendererClass in namespace Joomla\CMS\Document\Renderer\Html

JDocument styles renderer

XmlDocument::setName() — Method in class XmlDocument

Sets the document name

XmlDocument::setDownload() — Method in class XmlDocument

Sets the document's download state

Button::set() — Method in class Button

Set Button property.

Button::setOptions() — Method in class Button

Set Button options.

ButtonInterface::set() — Method in class ButtonInterface

Set Button property.

ButtonInterface::setOptions() — Method in class ButtonInterface

Set Button options.

AesInterface::setEncryptionMode() — Method in class AesInterface

Sets the AES encryption mode.

Mcrypt::setEncryptionMode() — Method in class Mcrypt

Set the encryption mode

OpenSSL::setEncryptionMode() — Method in class OpenSSL

Sets the AES encryption mode.

Aes::setPassword() — Method in class Aes

Sets the password for this instance.

Browser::setBrowser() — Method in class Browser

Sets the current browser.

SaveExceptionHandlerClass in namespace Joomla\CMS\Error\JsonApi

Handler for invalid checkin/checkout exceptions

SendEmailExceptionHandlerClass in namespace Joomla\CMS\Error\JsonApi

Handler for error when send email

AbstractEvent::setArgument() — Method in class AbstractEvent

Add argument to event.

SubmitContactEventClass in namespace Joomla\CMS\Event\Contact

Class for Contact events

ErrorEvent::setError() — Method in class ErrorEvent

Set the event's error object

StartIndexEventClass in namespace Joomla\CMS\Event\Finder

Class for Finder events.

SaveEventClass in namespace Joomla\CMS\Event\Model

Class for Model event

BeforeDisplayMethods::setUser() — Method in class BeforeDisplayMethods

Validate the value of the 'user' named parameter

Callback::setMethod() — Method in class Callback

Validate the value of the 'method' named parameter

Captive::setRecord() — Method in class Captive

Validate the value of the 'record' named parameter

GetSetup::setRecord() — Method in class GetSetup

Validate the value of the 'record' named parameter

SaveSetupClass in namespace Joomla\CMS\Event\MultiFactor

Concrete Event class for the onUserMultifactorSaveSetup event

SaveSetup::setRecord() — Method in class SaveSetup

Validate the value of the 'record' named parameter

SaveSetup::setInput() — Method in class SaveSetup

Validate the value of the 'record' named parameter

Validate::setRecord() — Method in class Validate

Validate the value of the 'record' named parameter

Validate::setUser() — Method in class Validate

Validate the value of the 'user' named parameter

Validate::setCode() — Method in class Validate

Validate the value of the 'code' named parameter

SetCachingEventClass in namespace Joomla\CMS\Event\PageCache

Class for PageCache events

GetIconEvent::setContext() — Method in class GetIconEvent

A method to validate the 'context' named parameter.

ResultAware::setResult() — Method in class ResultAware

Handle setting the result argument directly.

SampleDataEventClass in namespace Joomla\CMS\Event\SampleData

Base class for Sample data events

AbstractEvent::setSubject() — Method in class AbstractEvent

Setter for the subject argument

AfterLoadEvent::setResult() — Method in class AfterLoadEvent

Setter for the result argument

AfterLoadEvent::setRow() — Method in class AfterLoadEvent

Setter for the row argument

AfterMoveEvent::setRow() — Method in class AfterMoveEvent

Setter for the rows argument

AfterMoveEvent::setDelta() — Method in class AfterMoveEvent

Setter for the delta argument

AfterMoveEvent::setWhere() — Method in class AfterMoveEvent

Setter for the where argument

AfterReorderEvent::setWhere() — Method in class AfterReorderEvent

Setter for the where argument

AfterStoreEvent::setResult() — Method in class AfterStoreEvent

Setter for the result argument

BeforeBindEvent::setSrc() — Method in class BeforeBindEvent

Setter for the src argument

BeforeBindEvent::setIgnore() — Method in class BeforeBindEvent

Setter for the ignore argument

BeforeCheckoutEvent::setUserId() — Method in class BeforeCheckoutEvent

Setter for the userId argument

BeforeLoadEvent::setReset() — Method in class BeforeLoadEvent

Setter for the reset attribute

BeforeMoveEvent::setQuery() — Method in class BeforeMoveEvent

Setter for the query argument

BeforeMoveEvent::setDelta() — Method in class BeforeMoveEvent

Setter for the delta argument

BeforeMoveEvent::setWhere() — Method in class BeforeMoveEvent

Setter for the where argument

BeforePublishEvent::setQuery() — Method in class BeforePublishEvent

Setter for the pks argument

BeforePublishEvent::setState() — Method in class BeforePublishEvent

Setter for the state argument

BeforePublishEvent::setUserId() — Method in class BeforePublishEvent

Setter for the userId argument

BeforeReorderEvent::setQuery() — Method in class BeforeReorderEvent

Setter for the query argument

BeforeReorderEvent::setWhere() — Method in class BeforeReorderEvent

Setter for the where argument

BeforeStoreEvent::setUpdateNulls() — Method in class BeforeStoreEvent

Setter for the updateNulls attribute

SetNewTagsEventClass in namespace Joomla\CMS\Event\Table

Event class for \Joomla\CMS\Table\Table onSetNewTags event

SetNewTagsEvent::setReplaceTags() — Method in class SetNewTagsEvent

Setter for the replaceTags attribute

WebAssetRegistryAssetChanged::setSubject() — Method in class WebAssetRegistryAssetChanged

Setter for the subject argument

WorkflowFunctionalityUsedEvent::setUsed() — Method in class WorkflowFunctionalityUsedEvent

Set used parameter to true

WorkflowTransitionEvent::setStopTransition() — Method in class WorkflowTransitionEvent

Set used parameter to true

$ Factory#sessionProperty in class Factory

Global session object

Feed::setAuthor() — Method in class Feed

Shortcut method to set the author for the feed object.

$ FeedEntry#sourceProperty in class FeedEntry

The feed from which the entry is sourced.

FeedEntry::setAuthor() — Method in class FeedEntry

Shortcut method to set the author for the feed entry object.

$ FeedParser#streamProperty in class FeedParser

The XMLReader stream object for the feed.

File::stripExt() — Method in class File

Strips the last extension off of a file name

$ Patcher#sourcesProperty in class Patcher
Patcher::splitLines() — Method in class Patcher

Separate CR or CRLF lines

StreamClass in namespace Joomla\CMS\Filesystem

Joomla! Stream Interface

Stream::seek() — Method in class Stream

Seek the file

Stream::setContextOptions() — Method in class Stream

Updates the context to the array

StreamStringClass in namespace Joomla\CMS\Filesystem\Streams

String Stream Wrapper

$ StreamString#statProperty in class StreamString

Statistics for a file

StreamString::stream_open() — Method in class StreamString

Method to open a file or URL.

StreamString::stream_stat() — Method in class StreamString

Method to retrieve information from a file resource

StreamString::stream_read() — Method in class StreamString

Method to read a given number of bytes starting at the current position and moving to the end of the string defined by the current position plus the given number.

StreamString::stream_write() — Method in class StreamString

Stream write, always returning false.

StreamString::stream_tell() — Method in class StreamString

Method to get the current position

StreamString::stream_eof() — Method in class StreamString

End of field check

StreamString::stream_seek() — Method in class StreamString

Stream offset

StreamString::stream_flush() — Method in class StreamString

Stream flush, always returns true.

StringControllerClass in namespace Joomla\CMS\Filesystem\Support

String Controller

InputFilter::stripUSC() — Method in class InputFilter

Recursively strip Unicode Supplementary Characters from the source. Not: objects cannot be filtered.

OutputFilter::stringJSSafe() — Method in class OutputFilter

This method processes a string and escapes it for use in JavaScript

OutputFilter::stringURLSafe() — Method in class OutputFilter

This method processes a string and replaces all accented UTF-8 characters by unaccented ASCII-7 "equivalents", whitespaces are replaced by hyphens and the string is lowercase.

AccessiblemediaField::setup() — Method in class AccessiblemediaField

Method to attach a Form object to the field.

$ CalendarField#showtimeProperty in class CalendarField

The show time flag

$ CalendarField#singleheaderProperty in class CalendarField

The single header flag

CalendarField::setup() — Method in class CalendarField

Method to attach a Form object to the field.

CaptchaField::setup() — Method in class CaptchaField

Method to attach a Form object to the field.

CheckboxField::setup() — Method in class CheckboxField

Method to attach a Form object to the field.

CheckboxesField::setup() — Method in class CheckboxesField

Method to attach a Form object to the field.

ChromestyleField::setup() — Method in class ChromestyleField

Method to attach a Form object to the field.

$ ColorField#saveFormatProperty in class ColorField

Color format to use when value gets saved

$ ColorField#splitProperty in class ColorField

The split.

ColorField::setup() — Method in class ColorField

Method to attach a Form object to the field.

EditorField::setup() — Method in class EditorField

Method to attach a Form object to the field.

FileField::setup() — Method in class FileField

Method to attach a Form object to the field.

$ FilelistField#stripExtProperty in class FilelistField

The stripExt.

FilelistField::setup() — Method in class FilelistField

Method to attach a Form object to the field.

FolderlistField::setup() — Method in class FolderlistField

Method to attach a Form object to the field.

ListField::setup() — Method in class ListField

Method to attach a Form object to the field.

MediaField::setup() — Method in class MediaField

Method to attach a Form object to the field.

MenuitemField::setup() — Method in class MenuitemField

Method to attach a Form object to the field.

$ MeterField#stripedProperty in class MeterField

The striped class for the progress bar

MeterField::setup() — Method in class MeterField

Method to attach a Form object to the field.

$ ModalSelectField#sql_title_tableProperty in class ModalSelectField

The table name to select the title related to the field value.

$ ModalSelectField#sql_title_columnProperty in class ModalSelectField

The column name in the $sql_title_table, to select the title related to the field value.

$ ModalSelectField#sql_title_keyProperty in class ModalSelectField

The key name in the $sql_title_table that represent the field value, to select the title related to the field value.

ModalSelectField::setup() — Method in class ModalSelectField

Method to attach a Form object to the field.

ModuleorderField::setup() — Method in class ModuleorderField

Method to attach a Form object to the field.

ModulepositionField::setup() — Method in class ModulepositionField

Method to attach a Form object to the field.

$ NumberField#stepProperty in class NumberField

The step by which value of the field increased or decreased.

NumberField::setup() — Method in class NumberField

Method to attach a Form object to the field.

OrderingField::setup() — Method in class OrderingField

Method to attach a Form object to the field.

PasswordField::setup() — Method in class PasswordField

Method to attach a Form object to the field.

PluginsField::setup() — Method in class PluginsField

Method to attach a Form object to the field.

PredefinedlistField::setup() — Method in class PredefinedlistField

Method to attach a Form object to the field.

$ RulesField#sectionProperty in class RulesField

The section.

RulesField::setup() — Method in class RulesField

Method to attach a Form object to the field.

SchemaorgComponentSectionsFieldClass in namespace Joomla\CMS\Form\Field

Form Field class for the Joomla Framework.

SessionhandlerFieldClass in namespace Joomla\CMS\Form\Field

Form Field class for the Joomla Platform.

SpacerFieldClass in namespace Joomla\CMS\Form\Field

Form Field class for the Joomla Platform.

SqlFieldClass in namespace Joomla\CMS\Form\Field

Supports a custom SQL select list

SqlField::setup() — Method in class SqlField

Method to attach a Form object to the field.

StatusFieldClass in namespace Joomla\CMS\Form\Field

Form Field to load a list of states

SubformFieldClass in namespace Joomla\CMS\Form\Field

The Field to load the form inside current form

SubformField::setup() — Method in class SubformField

Method to attach a Form object to the field.

TemplatestyleField::setup() — Method in class TemplatestyleField

Method to attach a Form object to the field.

TextField::setup() — Method in class TextField

Method to attach a Form object to the field.

TextareaField::setup() — Method in class TextareaField

Method to attach a Form object to the field.

$ TimeField#stepProperty in class TimeField

Steps between different values

TimeField::setup() — Method in class TimeField

Method to attach a Form object to the field.

TimezoneField::setup() — Method in class TimezoneField

Method to attach a Form object to the field.

TransitionField::setup() — Method in class TransitionField

Method to setup the extension

UserField::setup() — Method in class UserField

Method to attach a Form object to the field.

UsergrouplistField::setup() — Method in class UsergrouplistField

Method to attach a Form object to the field.

WorkflowconditionField::setup() — Method in class WorkflowconditionField

Method to attach a Form object to the field.

WorkflowstageField::setup() — Method in class WorkflowstageField

Method to attach a Form object to the field.

SafehtmlFilterClass in namespace Joomla\CMS\Form\Filter

Form Filter class for safe HTML

Form::setField() — Method in class Form

Method to set a field XML element to the form definition. If the replace flag is set then the field will be set whether it already exists or not. If it isn't set, then the field will not be replaced if it already exists.

Form::setFieldAttribute() — Method in class Form

Method to set an attribute value for a field XML element.

Form::setFields() — Method in class Form

Method to set some field XML elements to the form definition. If the replace flag is set then the fields will be set whether they already exists or not. If it isn't set, then the fields will not be replaced if they already exist.

Form::setValue() — Method in class Form

Method to set the value of a field. If the field does not exist in the form then the method will return false.

Form::syncPaths() — Method in class Form

Method to synchronize any field, form or rule paths contained in the XML document.

FormFactoryAwareInterface::setFormFactory() — Method in class FormFactoryAwareInterface

Set the form factory to use.

FormFactoryAwareTrait::setFormFactory() — Method in class FormFactoryAwareTrait

Set the form factory to use.

$ FormField#spellcheckProperty in class FormField

The spellcheck state for the form field.

$ FormField#sizeProperty in class FormField

The size of the form field.

$ FormField#showonProperty in class FormField

The conditions to show/hide the field.

FormField::setForm() — Method in class FormField

Method to attach a Form object to the field.

FormField::setup() — Method in class FormField

Method to attach a Form object to the field.

FormField::setValue() — Method in class FormField

Simple method to set the value

ShowOnRuleClass in namespace Joomla\CMS\Form\Rule

Form Rule class for the Joomla Platform.

SubformRuleClass in namespace Joomla\CMS\Form\Rule

Form rule to validate subforms field-wise.

$ HTMLHelper#serviceRegistryProperty in class HTMLHelper

The service registry for custom and overridden JHtml helpers

HTMLHelper::stylesheet() — Method in class HTMLHelper

Write a <link> element to load a CSS file

HTMLHelper::script() — Method in class HTMLHelper

Write a <script> element to load a JavaScript file

HTMLHelper::setFormatOptions() — Method in class HTMLHelper

Set format related options.

HTMLHelper::strftimeFormatToDateFormat() — Method in class HTMLHelper

Convert most popular strftime format to php date format as strftime is deprecated and we have to be able to provide same backward compatibility with existing format strings.

HTMLRegistryAwareTrait::setRegistry() — Method in class HTMLRegistryAwareTrait

Set the registry to use.

Bootstrap::scrollspy() — Method in class Bootstrap

Add javascript support for Bootstrap Scrollspy

Bootstrap::startAccordion() — Method in class Bootstrap

Add javascript support for Bootstrap accordions and insert the accordion

Bootstrap::startTabSet() — Method in class Bootstrap

Creates a tab pane

Dropdown::start() — Method in class Dropdown

Method to start a new dropdown menu

Grid::sort() — Method in class Grid

Method to sort a column in a grid

Grid::state() — Method in class Grid

Method to create a select list of states for filtering By default the filter shows only published and unpublished items

JGrid::state() — Method in class JGrid

Returns a state on a grid

SearchToolsClass in namespace Joomla\CMS\HTML\Helpers

Searchtools elements.

SearchTools::sort() — Method in class SearchTools

Method to sort a column in a grid

SelectClass in namespace Joomla\CMS\HTML\Helpers

Utility class for creating HTML select lists

SidebarClass in namespace Joomla\CMS\HTML\Helpers

Utility class to render a list view sidebar

Sidebar::setAction() — Method in class Sidebar

Set value for the action attribute of the filter form

SortableListClass in namespace Joomla\CMS\HTML\Helpers

HTML utility class for creating a sortable table list

SortableList::sortable() — Method in class SortableList

Method to load the Sortable script and make table sortable

StringHelperClass in namespace Joomla\CMS\HTML\Helpers

HTML helper class for rendering manipulated strings.

UiTab::startTabSet() — Method in class UiTab

Creates a core UI tab pane

HelperFactoryAwareInterface::setHelperFactory() — Method in class HelperFactoryAwareInterface

Sets the helper factory to use.

HelperFactoryAwareTrait::setHelperFactory() — Method in class HelperFactoryAwareTrait

Sets the helper factory to use.

LibraryHelper::saveParams() — Method in class LibraryHelper

Save the parameters object for the library

TagsHelper::searchTags() — Method in class TagsHelper

Function to search tags

UserGroupsHelper::setGroups() — Method in class UserGroupsHelper

Set the groups to be used as source.

SocketTransportClass in namespace Joomla\CMS\Http\Transport

HTTP transport class for using sockets directly.

StreamTransportClass in namespace Joomla\CMS\Http\Transport

HTTP transport class for using PHP streams.

Backgroundfill::sanitizeColor() — Method in class Backgroundfill

Method to sanitize color values and/or convert to an array

SketchyClass in namespace Joomla\CMS\Image\Filter

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

SmoothClass in namespace Joomla\CMS\Image\Filter

Image Filter class adjust the smoothness of an image.

Image::sanitizeHeight() — Method in class Image

Method to sanitize a height value.

Image::sanitizeOffset() — Method in class Image

Method to sanitize an offset value like left or top.

Image::sanitizeWidth() — Method in class Image

Method to sanitize a width value.

Image::setThumbnailGenerate() — Method in class Image

Method for set option of generate thumbnail method

Cli::serialize() — Method in class Cli

Method to serialize the input.

Cookie::set() — Method in class Cookie

Sets a value

Files::set() — Method in class Files

Sets a value.

$ Input#serverProperty in class Input
ComponentAdapter::setupInstallPaths() — Method in class ComponentAdapter

Method to do any prechecks and setup the install paths for the extension

ComponentAdapter::setupUninstall() — Method in class ComponentAdapter

Method to do any prechecks and setup the uninstall job

ComponentAdapter::setupUpdates() — Method in class ComponentAdapter

Method to setup the update routine for the adapter

ComponentAdapter::storeExtension() — Method in class ComponentAdapter

Method to store the extension to the database

$ FileAdapter#scriptElementProperty in class FileAdapter

<scriptfile> element of the extension manifest

$ FileAdapter#supportsDiscoverInstallProperty in class FileAdapter

Flag if the adapter supports discover installs

FileAdapter::setupInstallPaths() — Method in class FileAdapter

Method to do any prechecks and setup the install paths for the extension

FileAdapter::setupUninstall() — Method in class FileAdapter

Method to do any prechecks and setup the uninstall job

FileAdapter::storeExtension() — Method in class FileAdapter

Method to store the extension to the database

LanguageAdapter::setupInstallPaths() — Method in class LanguageAdapter

Method to do any prechecks and setup the install paths for the extension

LanguageAdapter::setupUninstall() — Method in class LanguageAdapter

Method to do any prechecks and setup the uninstall job

LanguageAdapter::storeExtension() — Method in class LanguageAdapter

Method to store the extension to the database

LibraryAdapter::setupInstallPaths() — Method in class LibraryAdapter

Method to do any prechecks and setup the install paths for the extension

LibraryAdapter::setupUninstall() — Method in class LibraryAdapter

Method to do any prechecks and setup the uninstall job

LibraryAdapter::storeExtension() — Method in class LibraryAdapter

Method to store the extension to the database

$ ModuleAdapter#scriptElementProperty in class ModuleAdapter

<scriptfile> element of the extension manifest

ModuleAdapter::setupInstallPaths() — Method in class ModuleAdapter

Method to do any prechecks and setup the install paths for the extension

ModuleAdapter::setupUninstall() — Method in class ModuleAdapter

Method to do any prechecks and setup the uninstall job

ModuleAdapter::storeExtension() — Method in class ModuleAdapter

Method to store the extension to the database

$ PackageAdapter#supportsDiscoverInstallProperty in class PackageAdapter

Flag if the adapter supports discover installs

PackageAdapter::setupInstallPaths() — Method in class PackageAdapter

Method to do any prechecks and setup the install paths for the extension

PackageAdapter::setupUninstall() — Method in class PackageAdapter

Method to do any prechecks and setup the uninstall job

PackageAdapter::storeExtension() — Method in class PackageAdapter

Method to store the extension to the database

$ PluginAdapter#scriptElementProperty in class PluginAdapter

<scriptfile> element of the extension manifest

PluginAdapter::setupInstallPaths() — Method in class PluginAdapter

Method to do any prechecks and setup the install paths for the extension

PluginAdapter::setupUninstall() — Method in class PluginAdapter

Method to do any prechecks and setup the uninstall job

PluginAdapter::storeExtension() — Method in class PluginAdapter

Method to store the extension to the database

TemplateAdapter::setupInstallPaths() — Method in class TemplateAdapter

Method to do any prechecks and setup the install paths for the extension

TemplateAdapter::setupUninstall() — Method in class TemplateAdapter

Method to do any prechecks and setup the uninstall job

TemplateAdapter::storeExtension() — Method in class TemplateAdapter

Method to store the extension to the database

$ Installer#stepStackProperty in class Installer

Stack of installation steps

  • Used for installation rollback
Installer::splitSql() — Method in class Installer

Splits a string of multiple queries into an array of individual queries.

Installer::setOverwrite() — Method in class Installer

Set the allow overwrite switch

Installer::setRedirectUrl() — Method in class Installer

Set the redirect location

Installer::setPackageUninstall() — Method in class Installer

Set whether this installer is uninstalling extensions which are part of a package

Installer::setUpgrade() — Method in class Installer

Set the upgrade switch

Installer::setPath() — Method in class Installer

Sets an installer path by name

Installer::setupInstall() — Method in class Installer

Prepare for installation: this method sets the installation directory, finds and checks the installation file and verifies the installation type.

Installer::setSchemaVersion() — Method in class Installer

Set the schema version for an extension by looking at its latest update

$ InstallerAdapter#supportsDiscoverInstallProperty in class InstallerAdapter

Flag if the adapter supports discover installs

InstallerAdapter::setManifest() — Method in class InstallerAdapter

Set the manifest object.

InstallerAdapter::setRoute() — Method in class InstallerAdapter

Set the install route being followed

InstallerAdapter::setupInstallPaths() — Method in class InstallerAdapter

Method to do any prechecks and setup the install paths for the extension

InstallerAdapter::setupScriptfile() — Method in class InstallerAdapter

Setup the manifest script file for those adapters that use it.

InstallerAdapter::setupUninstall() — Method in class InstallerAdapter

Method to do any prechecks and setup the uninstall job

InstallerAdapter::setupUpdates() — Method in class InstallerAdapter

Method to setup the update routine for the adapter

InstallerAdapter::storeExtension() — Method in class InstallerAdapter

Method to store the extension to the database

InstallerScript::setParams() — Method in class InstallerScript

Sets parameter values in the extensions row of the extension table. Note that the this must be called separately for deleting and editing. Note if edit is called as a type then if the param doesn't exist it will be created

$ PackageManifest#scriptfileProperty in class PackageManifest

Scriptfile for the package

$ Language#stringsProperty in class Language
Translations
$ Language#searchDisplayedCharactersNumberCallbackProperty in class Language

Name of the searchDisplayedCharactersNumberCallback function for this language.

Language::setTransliterator() — Method in class Language

Set the transliteration function.

Language::setPluralSuffixesCallback() — Method in class Language

Set the pluralSuffixes function.

Language::setIgnoredSearchWordsCallback() — Method in class Language

Setter for the ignoredSearchWordsCallback function

Language::setLowerLimitSearchWordCallback() — Method in class Language

Setter for the lowerLimitSearchWordCallback function.

Language::setUpperLimitSearchWordCallback() — Method in class Language

Setter for the upperLimitSearchWordCallback function

Language::setSearchDisplayedCharactersNumberCallback() — Method in class Language

Setter for the searchDisplayedCharactersNumberCallback function.

LanguageAwareInterface::setLanguage() — Method in class LanguageAwareInterface

Set the language to use.

LanguageAwareTrait::setLanguage() — Method in class LanguageAwareTrait

Set the language to use.

LanguageHelper::saveToIniFile() — Method in class LanguageHelper

Save strings to a language file.

$ Text#stringsProperty in class Text

JavaScript strings

Text::sprintf() — Method in class Text

Passes a string thru a sprintf.

Text::script() — Method in class Text

Translate a string into the current language and stores it in the JavaScript language store.

BaseLayout::setOptions() — Method in class BaseLayout

Set the options

BaseLayout::set() — Method in class BaseLayout

Method to set a value in the data array. Example: $layout->set('items', $items);

BaseLayout::setData() — Method in class BaseLayout

Set the data passed the layout

BaseLayout::setDebug() — Method in class BaseLayout

Change the debug mode

FileLayout::setComponent() — Method in class FileLayout

Change the component for the search paths for layouts

FileLayout::setClient() — Method in class FileLayout

Function to initialise the application client

FileLayout::setLayoutId() — Method in class FileLayout

Set the active layout id

FileLayout::setIncludePaths() — Method in class FileLayout

Set the include paths to search for layouts

FileLayout::setSuffixes() — Method in class FileLayout

Set suffixes to search layouts

FileLayout::sublayout() — Method in class FileLayout

Render a layout with the same include paths & options

Log::setInstance() — Method in class Log

Returns a reference to the a Log object, only creating it if it doesn't already exist.

SyslogLoggerClass in namespace Joomla\CMS\Log\Logger

Joomla! Syslog Log class

AdminController::saveorder() — Method in class AdminController

Method to save the submitted ordering values for records.

AdminController::saveOrderAjax() — Method in class AdminController

Method to save the submitted ordering values for records via AJAX.

ApiController::save() — Method in class ApiController

Method to save a record.

BaseController::setMessage() — Method in class BaseController

Sets the internal message that is passed with a redirect

BaseController::setPath() — Method in class BaseController

Sets an entire array of search paths for resources.

BaseController::setRedirect() — Method in class BaseController

Set a URL for browser redirection.

SaveClass in namespace Joomla\CMS\MVC\Controller\Exception

Exception saving data

SendEmailClass in namespace Joomla\CMS\MVC\Controller\Exception

Send email Exception

FormController::save() — Method in class FormController

Method to save a record.

MVCFactoryAwareTrait::setMVCFactory() — Method in class MVCFactoryAwareTrait

Set the MVC factory.

MVCFactoryServiceTrait::setMVCFactory() — Method in class MVCFactoryServiceTrait

The MVC Factory.

AdminModel::save() — Method in class AdminModel

Method to save the form data.

AdminModel::saveorder() — Method in class AdminModel

Saves the manually set order of records.

BaseDatabaseModel::setDbo() — Method in class BaseDatabaseModel

Set the database driver.

DatabaseAwareTrait::setDbo() — Method in class DatabaseAwareTrait

Set the database driver.

StateClass in namespace Joomla\CMS\MVC\Model

A simple state holder class. This class acts for transition from CMSObject to Registry and should not be used directly. Instead of, use the Registry class.

StateBehaviorTraitClass in namespace Joomla\CMS\MVC\Model

Trait which supports state behavior

$ StateBehaviorTrait#stateProperty in class StateBehaviorTrait

A state object

StateBehaviorTrait::setState() — Method in class StateBehaviorTrait

Method to set state variables.

StatefulModelInterfaceClass in namespace Joomla\CMS\MVC\Model

Interface for a stateful model.

StatefulModelInterface::setState() — Method in class StatefulModelInterface

Method to set model state variables.

$ WorkflowBehaviorTrait#sectionProperty in class WorkflowBehaviorTrait

The section of the component.

WorkflowBehaviorTrait::setUpWorkflow() — Method in class WorkflowBehaviorTrait

Set Up the workflow

WorkflowModelInterface::setUpWorkflow() — Method in class WorkflowModelInterface

Set Up the workflow

AbstractView::setModel() — Method in class AbstractView

Method to add a model to the view. We support a multiple model single view system by which models are referenced by classname. A caveat to the classname referencing is that any classname prepended by \JModel will be referenced by the name without \JModel, eg. \JModelCategory is just Category.

AbstractView::setDocument() — Method in class AbstractView

Set the document to use.

$ CategoriesView#stateProperty in class CategoriesView

State data

$ CategoryView#stateProperty in class CategoryView

State data

OnGetApiFields::setType() — Method in class OnGetApiFields

Setter for the type argument

OnGetApiFields::setFields() — Method in class OnGetApiFields

Setter for the fields argument

OnGetApiFields::setRelations() — Method in class OnGetApiFields

Setter for the relations argument

$ FormView#stateProperty in class FormView

The model state

HtmlView::setLayout() — Method in class HtmlView

Sets the layout name to use

HtmlView::setLayoutExt() — Method in class HtmlView

Allows a different extension for the layout files to be used

HtmlView::setDocumentTitle() — Method in class HtmlView

Sets the document title according to Global Configuration options

$ JsonApiView#serializerProperty in class JsonApiView

Serializer data

$ ListView#stateProperty in class ListView

The model state

$ ListView#sidebarProperty in class ListView

The sidebar markup

$ ListView#supportsBatchProperty in class ListView

The flag which determine whether we want to show batch button

Mail::Send() — Method in class Mail

Send the mail

Mail::setSender() — Method in class Mail

Set the email sender.

Mail::setSubject() — Method in class Mail

Set the email subject.

Mail::setBody() — Method in class Mail

Set the email body.

Mail::sendMail() — Method in class Mail

Function to send an email

MailTemplate::setReplyTo() — Method in class MailTemplate

Set reply to for this mail

MailTemplate::send() — Method in class MailTemplate

Render and send the mail

MailerFactoryAwareInterface::setMailerFactory() — Method in class MailerFactoryAwareInterface

Set the mailer factory to use.

MailerFactoryAwareTrait::setMailerFactory() — Method in class MailerFactoryAwareTrait

Set the mailer factory to use.

MailerInterface::send() — Method in class MailerInterface

Send the mail. Throws an exception when something goes wrong.

MailerInterface::setSender() — Method in class MailerInterface

Set the email sender.

MailerInterface::setSubject() — Method in class MailerInterface

Set the email subject.

MailerInterface::setBody() — Method in class MailerInterface

Set the email body.

$ AbstractMenu#storedUserProperty in class AbstractMenu

User object to check access levels for

AbstractMenu::setUser() — Method in class AbstractMenu

Setter for the current user used to build menu.

AbstractMenu::setDefault() — Method in class AbstractMenu

Set the default item by id and language code.

AbstractMenu::setActive() — Method in class AbstractMenu

Set the default item by id

MenuItem::setParams() — Method in class MenuItem

Sets the menu item parameters

SiteMenuClass in namespace Joomla\CMS\Menu

Menu class

Microdata::setType() — Method in class Microdata

Set a new http://schema.org Type

Microdata::sanitizeType() — Method in class Microdata

Return the sanitized $Type

Microdata::sanitizeProperty() — Method in class Microdata

Return the sanitized $Property

LegacyErrorHandlingTrait::setError() — Method in class LegacyErrorHandlingTrait

Add an error message.

LegacyPropertyManagementTrait::set() — Method in class LegacyPropertyManagementTrait

Modifies a property of the object, creating it if it does not already exist.

LegacyPropertyManagementTrait::setProperties() — Method in class LegacyPropertyManagementTrait

Set the object properties based on a named array/hash.

Pagination::setUrlParamsFromRequest() — Method in class Pagination

Set URL parameters from request.

Pagination::setAdditionalUrlParam() — Method in class Pagination

Method to set an additional URL parameter to be added to all pagination class generated links.

Pathway::setPathway() — Method in class Pathway

Set the Pathway items array.

Pathway::setItemName() — Method in class Pathway

Set item name.

SitePathwayClass in namespace Joomla\CMS\Pathway

Class to manage the site application pathway.

CMSPlugin::setApplication() — Method in class CMSPlugin

Sets the application to use.

CMSPlugin::setLanguage() — Method in class CMSPlugin

Set the language to use.

CMSPlugin::setDispatcher() — Method in class CMSPlugin

Set the dispatcher to use.

$ Profiler#startProperty in class Profiler
Profiler::setStart() — Method in class Profiler

Sets the start time.

$ JsonResponse#successProperty in class JsonResponse

Determines whether the request was successful

Router::setVar() — Method in class Router

Set a router variable, creating it if it doesn't exist

Router::setVars() — Method in class Router

Set the router variable array

Router::setTainted() — Method in class Router

Set the currently parsed URL as tainted If a URL can be parsed, but not all parts were correct, (for example an ID was found, but the alias was wrong) the parsing can be marked as tainted. When the URL is marked as tainted, the router has to have returned correct data to create the right URL afterwards and can later do additional processing, like redirecting to the right URL.

SiteRouterClass in namespace Joomla\CMS\Router

Class to create and parse routes for the site application

SiteRouter::setComponentRouter() — Method in class SiteRouter

Set a router for a component

SiteRouterAwareInterfaceClass in namespace Joomla\CMS\Router

Interface for site router aware classes.

SiteRouterAwareInterface::setSiteRouter() — Method in class SiteRouterAwareInterface

Set the router to use.

SiteRouterAwareTraitClass in namespace Joomla\CMS\Router

Defines the trait for a Site Router Aware Class.

SiteRouterAwareTrait::setSiteRouter() — Method in class SiteRouterAwareTrait

Set the router to use.

SchemaorgPluginTraitClass in namespace Joomla\CMS\Schemaorg

Trait for component schemaorg plugins.

SchemaorgPrepareDateTraitClass in namespace Joomla\CMS\Schemaorg

Prepare dates to be valid for JSON-LD output

SchemaorgPrepareDurationTraitClass in namespace Joomla\CMS\Schemaorg

Prepare duration to be valid for JSON-LD output

SchemaorgPrepareImageTraitClass in namespace Joomla\CMS\Schemaorg

Prepare images to be valid for JSON-LD output

SchemaorgServiceInterfaceClass in namespace Joomla\CMS\Schemaorg

The schemaorg service.

SchemaorgServiceTraitClass in namespace Joomla\CMS\Schemaorg

Trait for component schemaorg service.

OnGetApiRelation::setRelationship() — Method in class OnGetApiRelation

Set relationship object that should be rendered.

SessionClass in namespace Joomla\CMS\Service\Provider

Service provider for the application's session dependency

SessionClass in namespace Joomla\CMS\Session

Class for managing HTTP sessions

Session::set() — Method in class Session

Set data into the session store.

SessionFactoryClass in namespace Joomla\CMS\Session

Factory for creating session API objects

SessionManagerClass in namespace Joomla\CMS\Session

Manager for interacting with the session handler to perform updates on sessions.

JoomlaStorage::set() — Method in class JoomlaStorage

Set data into the session store

JoomlaStorage::setCookieParams() — Method in class JoomlaStorage

Set session cookie parameters

JoomlaStorage::setOptions() — Method in class JoomlaStorage

Sets session options

JoomlaStorage::start() — Method in class JoomlaStorage

Start a session

StringableInterfaceClass in namespace Joomla\CMS\String

A transitioning interface to PHP implicit \Stringable interface

Category::store() — Method in class Category

Overridden Table::store to set created/modified and user id.

Content::store() — Method in class Content

Overrides Table::store to set modified data and user id.

ContentHistory::store() — Method in class ContentHistory

Overrides Table::store to set modified hash, user id, and save date.

ContentType::store() — Method in class ContentType

Overridden Table::store.

CoreContent::store() — Method in class CoreContent

Overrides Table::store to set modified data and user id.

CoreContent::storeUcmBase() — Method in class CoreContent

Insert or update row in ucm_base table

Language::store() — Method in class Language

Overrides Table::store to check unique fields.

Menu::store() — Method in class Menu

Overloaded store function

MenuType::store() — Method in class MenuType

Method to store a row in the database from the Table instance properties.

Module::store() — Method in class Module

Stores a module.

Nested::setLocation() — Method in class Nested

Method to set the location of a node in the tree object. This method does not save the new location to the database, but will set it in the object so that when the node is stored it will be stored in the new location.

Nested::store() — Method in class Nested

Method to store a node in the database table.

Nested::saveorder() — Method in class Nested

Method to update order of table rows

Table::setDbo() — Method in class Table

Method to set the DatabaseDriver object.

Table::setRules() — Method in class Table

Method to set rules for the record.

Table::store() — Method in class Table

Method to store a row in the database from the TableInterface instance properties.

Table::save() — Method in class Table

Method to provide a shortcut to binding, checking and storing a Table instance to the database table.

Table::setColumnAlias() — Method in class Table

Method to register a column alias for a "special" column.

TableInterface::store() — Method in class TableInterface

Method to store a row in the database from the TableInterface instance properties.

User::store() — Method in class User

Method to store a row in the database from the Table instance properties.

User::setLastVisit() — Method in class User

Updates last visit time of user

Usergroup::store() — Method in class Usergroup

Inserts a new row if id is zero or updates an existing row in the database table

TaggableTableInterface::setTagsHelper() — Method in class TaggableTableInterface

Set the tags helper

TaggableTableTrait::setTagsHelper() — Method in class TaggableTableTrait

Set the tags helper

PopupButton::selector() — Method in class PopupButton
SeparatorButtonClass in namespace Joomla\CMS\Toolbar\Button

Renders a button separator

StandardButtonClass in namespace Joomla\CMS\Toolbar\Button

Renders a standard button

CoreButtonsTrait::save() — Method in class CoreButtonsTrait

Writes a save button for a given option.

CoreButtonsTrait::save2new() — Method in class CoreButtonsTrait

Writes a save and create new button for a given option.

CoreButtonsTrait::save2copy() — Method in class CoreButtonsTrait

Writes a save as copy button for a given option.

Toolbar::setFactory() — Method in class Toolbar

Set the factory instance

Toolbar::setItems() — Method in class Toolbar

Set the button list.

Toolbar::standardButton() — Method in class Toolbar
Toolbar::separatorButton() — Method in class Toolbar
ToolbarButton::setParent() — Method in class ToolbarButton

Set parent Toolbar instance.

ToolbarButton::setOptions() — Method in class ToolbarButton

Set all options.

ToolbarButton::setOption() — Method in class ToolbarButton

Set option value.

ToolbarHelper::spacer() — Method in class ToolbarHelper

Writes a spacer cell.

ToolbarHelper::save() — Method in class ToolbarHelper

Writes a save button for a given option.

ToolbarHelper::save2new() — Method in class ToolbarHelper

Writes a save and create new button for a given option.

ToolbarHelper::save2copy() — Method in class ToolbarHelper

Writes a save as copy button for a given option.

ToolbarHelper::saveGroup() — Method in class ToolbarHelper

Writes a save button for a given option, with an additional dropdown

NodeInterface::setParent() — Method in class NodeInterface

Set the parent of this node

NodeInterface::setSibling() — Method in class NodeInterface

Function to set the left or right sibling of a node

NodeTrait::setParent() — Method in class NodeTrait

Set the parent of this node

NodeTrait::setSibling() — Method in class NodeTrait

Function to set the left or right sibling of a node

UCMBase::store() — Method in class UCMBase

Store data to the appropriate table

UCMContent::save() — Method in class UCMContent

Method to save the data

UCMContent::store() — Method in class UCMContent

Store data to the appropriate table

ExtensionAdapter::stabilityTagToInteger() — Method in class ExtensionAdapter

Converts a tag to numeric stability representation. If the tag doesn't represent a known stability level (one of dev, alpha, beta, rc, stable) it is ignored.

ConstraintChecker::stabilityToInteger() — Method in class ConstraintChecker

Converts a tag to numeric stability representation. If the tag doesn't represent a known stability level (one of dev, alpha, beta, rc, stable) it is ignored.

$ Update#stackProperty in class Update

Element call stack

$ Update#stateStoreProperty in class Update

Unused state array

$ Update#stabilityProperty in class Update
$ Update#supported_databasesProperty in class Update
$ Update#sha256Property in class Update
$ Update#sha384Property in class Update
$ Update#sha512Property in class Update
$ Update#sectionProperty in class Update
Update::stabilityTagToInteger() — Method in class Update

Converts a tag to numeric stability representation. If the tag doesn't represent a known stability level (one of dev, alpha, beta, rc, stable) it is ignored.

Update::setTargetVersion() — Method in class Update

Set extension's Joomla! target version

$ UpdateAdapter#stackProperty in class UpdateAdapter

Element call stack

CurrentUserInterface::setCurrentUser() — Method in class CurrentUserInterface

Sets the current user.

CurrentUserTrait::setCurrentUser() — Method in class CurrentUserTrait

Sets the current user.

$ User#sendEmailProperty in class User

Should this user receive system email

User::setParam() — Method in class User

Method to set a parameter

User::setLastVisit() — Method in class User

Pass through method to the table for setting the last visit date

User::setParameters() — Method in class User

Method to get the user parameters

User::save() — Method in class User

Method to save the User object to the database

UserFactoryAwareInterface::setUserFactory() — Method in class UserFactoryAwareInterface

Set the user factory to use.

UserFactoryAwareTrait::setUserFactory() — Method in class UserFactoryAwareTrait

Set the user factory to use.

UserHelper::setUserGroups() — Method in class UserHelper

Method to set the groups for a user.

BufferStreamHandler::stream_register() — Method in class BufferStreamHandler

Function to register the stream wrapper

BufferStreamHandler::stream_open() — Method in class BufferStreamHandler

Function to open file or url

BufferStreamHandler::stream_read() — Method in class BufferStreamHandler

Read stream

BufferStreamHandler::stream_write() — Method in class BufferStreamHandler

Write stream

BufferStreamHandler::stream_tell() — Method in class BufferStreamHandler

Function to get the current position of the stream

BufferStreamHandler::stream_eof() — Method in class BufferStreamHandler

Function to test for end of file pointer

BufferStreamHandler::stream_seek() — Method in class BufferStreamHandler

The read write position updates in response to $offset and $whence

BufferStreamHandler::seek_set() — Method in class BufferStreamHandler

Set the position to the offset

BufferStreamHandler::seek_cur() — Method in class BufferStreamHandler

Adds the offset to current position

BufferStreamHandler::seek_end() — Method in class BufferStreamHandler

Sets the position to the end of the current buffer + offset

Version::setMediaVersion() — Method in class Version

Sets the media version which is used to append to Joomla core media files.

Versioning::store() — Method in class Versioning

Method to save a version snapshot to the content history table.

WebAssetItem::setOption() — Method in class WebAssetItem

Set the option

WebAssetItem::setAttribute() — Method in class WebAssetItem

Set the attribute

WebAssetItemInterface::setOption() — Method in class WebAssetItemInterface

Set the option

WebAssetItemInterface::setAttribute() — Method in class WebAssetItemInterface

Set the attribute

$ WebAssetManager#sortedAssetsProperty in class WebAssetManager

A cache holder for list of sorted assets, used by getAssets() method This is emptied when dependencies actualised, see enableDependencies() method

ServerClass in namespace Joomla\CMS\WebAuthn

WebAuthn server abstraction Class.

Server::setSelectedAlgorithms() — Method in class Server

Set the allowed COSE algorithms

Server::setExtensionOutputCheckerHandler() — Method in class Server

Set the authentication extension output checker

WorkflowServiceInterface::supportFunctionality() — Method in class WorkflowServiceInterface

Check if the functionality is supported by the context

WorkflowServiceTrait::supportFunctionality() — Method in class WorkflowServiceTrait

Check if the functionality is supported by the component The variable $supportFunctionality has the following structure [ 'core.featured' => [ 'com_content.article', ], 'core.state' => [ 'com_content.article', ], ]

T

$ ColorProcessor#tagFilterProperty in class ColorProcessor

Regex to match tags

$ CMSApplication#templateProperty in class CMSApplication

Currently active template

CMSApplication::toString() — Method in class CMSApplication

Sends all headers prior to returning the string

EventAware::triggerEvent() — Method in class EventAware

Calls all handlers associated with an event group.

EventAwareInterface::triggerEvent() — Method in class EventAwareInterface

Calls all handlers associated with an event group.

$ AuthenticationResponse#typeProperty in class AuthenticationResponse

The type of authentication that was successful

$ AuthenticationResponse#timezoneProperty in class AuthenticationResponse

ASCII string from TimeZone database

TransitionButtonClass in namespace Joomla\CMS\Button

The PublishedButton class.

$ CategoryNode#titleProperty in class CategoryNode

The menu title for the category (a short name)

$ Changelog#typeProperty in class Changelog

Update manifest <type> element

$ PreprocessRules#tableProperty in class PreprocessRules

DB Table to read the information from

TasksListCommandClass in namespace Joomla\CMS\Console

Console command to list scheduled tasks.

TasksRunCommandClass in namespace Joomla\CMS\Console

Console command to run scheduled tasks.

TasksStateCommandClass in namespace Joomla\CMS\Console

Console command to change the state of tasks.

Crypt::timingSafeCompare() — Method in class Crypt

A timing safe comparison method.

$ Date#tzProperty in class Date

The \DateTimeZone object for usage in rending dates as strings.

Date::toISO8601() — Method in class Date

Gets the date as an ISO 8601 string. IETF RFC 3339 defines the ISO 8601 format and it can be found at the IETF Web site.

Date::toSql() — Method in class Date

Gets the date as an SQL datetime string.

Date::toRFC822() — Method in class Date

Gets the date as an RFC 822 string. IETF RFC 2822 supercedes RFC 822 and its definition can be found at the IETF Web site.

Date::toUnix() — Method in class Date

Gets the date as UNIX time stamp.

$ Document#titleProperty in class Document

Document title

$ FeedDocument#ttlProperty in class FeedDocument

TTL feed attribute

$ FeedEnclosure#typeProperty in class FeedEnclosure

Type enclosure element

$ FeedImage#titleProperty in class FeedImage

Title image attribute

$ FeedItem#titleProperty in class FeedItem

Title item element

$ HtmlDocument#templateProperty in class HtmlDocument

Name of the template

JsonapiDocument::toArray() — Method in class JsonapiDocument

Map everything to arrays.

$ OpensearchImage#typeProperty in class OpensearchImage

The images MIME type

$ OpensearchUrl#typeProperty in class OpensearchUrl

Type item element

$ OpensearchUrl#templateProperty in class OpensearchUrl

Template item element. Has to contain the {searchTerms} parameter to work.

TotpClass in namespace Joomla\CMS\Encrypt

This class provides an RFC6238-compliant Time-based One Time Passwords, compatible with Google Authenticator (with PassCodeLength = 6 and TimePeriod = 30).

$ AbstractRenderer#typeProperty in class AbstractRenderer

The format (type) of the error page

$ CliRenderer#typeProperty in class CliRenderer

The format (type)

$ HtmlRenderer#typeProperty in class HtmlRenderer

The format (type) of the error page

$ JsonRenderer#typeProperty in class JsonRenderer

The format (type) of the error page

$ JsonapiRenderer#typeProperty in class JsonapiRenderer

The format (type) of the error page

$ XmlRenderer#typeProperty in class XmlRenderer

The format (type) of the error page

AjaxChallenge::typeCheckResult() — Method in class AjaxChallenge

Make sure the result is valid JSON or boolean false

CanRemoveDataEvent::typeCheckResult() — Method in class CanRemoveDataEvent

Checks the type of the data being appended to the result argument.

ExportRequestEvent::typeCheckResult() — Method in class ExportRequestEvent

Checks the type of the data being appended to the result argument.

ResultAwareInterface::typeCheckResult() — Method in class ResultAwareInterface

Checks the type of the data being appended to the result argument.

ResultTypeArrayAware::typeCheckResult() — Method in class ResultTypeArrayAware

Checks the type of the data being appended to the result argument.

ResultTypeBooleanAware::typeCheckResult() — Method in class ResultTypeBooleanAware

Checks the type of the data being appended to the result argument.

ResultTypeFloatAware::typeCheckResult() — Method in class ResultTypeFloatAware

Checks the type of the data being appended to the result argument.

ResultTypeIntegerAware::typeCheckResult() — Method in class ResultTypeIntegerAware

Checks the type of the data being appended to the result argument.

ResultTypeMixedAware::typeCheckResult() — Method in class ResultTypeMixedAware

Checks the type of the data being appended to the result argument.

ResultTypeNumericAware::typeCheckResult() — Method in class ResultTypeNumericAware

Checks the type of the data being appended to the result argument.

ResultTypeObjectAware::typeCheckResult() — Method in class ResultTypeObjectAware

Checks the type of the data being appended to the result argument.

ResultTypeStringAware::typeCheckResult() — Method in class ResultTypeStringAware

Checks the type of the data being appended to the result argument.

AuthorisationEvent::typeCheckResult() — Method in class AuthorisationEvent

Checks the type of the data being appended to the result argument.

$ Feed#titleProperty in class Feed

A human readable title for the feed.

$ FeedEntry#titleProperty in class FeedEntry

A human readable title for the feed entry.

$ FeedLink#typeProperty in class FeedLink

The resource type.

$ FeedLink#titleProperty in class FeedLink

The title of the resource.

$ FeedPerson#typeProperty in class FeedPerson

The type of person.

Stream::tell() — Method in class Stream

Returns the current position of the file read/write pointer.

$ AccessiblemediaField#typeProperty in class AccessiblemediaField

The form field type.

$ AccesslevelField#typeProperty in class AccesslevelField

The form field type.

$ AliastagField#typeProperty in class AliastagField

The field type.

$ AuthorField#typeProperty in class AuthorField

The form field type.

$ CachehandlerField#typeProperty in class CachehandlerField

The form field type.

$ CalendarField#typeProperty in class CalendarField

The form field type.

$ CalendarField#todaybuttonProperty in class CalendarField

The today button flag

$ CalendarField#timeformatProperty in class CalendarField

The time format

$ CaptchaField#typeProperty in class CaptchaField

The field type.

$ CategoryField#typeProperty in class CategoryField

The form field type.

$ CheckboxField#typeProperty in class CheckboxField

The form field type.

$ CheckboxesField#typeProperty in class CheckboxesField

The form field type.

$ ChromestyleField#typeProperty in class ChromestyleField

The form field type.

$ ColorField#typeProperty in class ColorField

The form field type.

$ ComboField#typeProperty in class ComboField

The form field type.

$ ComponentlayoutField#typeProperty in class ComponentlayoutField

The form field type.

$ ComponentsField#typeProperty in class ComponentsField

The form field type.

$ ContenthistoryField#typeProperty in class ContenthistoryField

The form field type.

$ ContentlanguageField#typeProperty in class ContentlanguageField

The form field type.

$ ContenttypeField#typeProperty in class ContenttypeField

A flexible tag list that respects access controls

$ DatabaseconnectionField#typeProperty in class DatabaseconnectionField

The form field type.

$ EditorField#typeProperty in class EditorField

The form field type.

$ EmailField#typeProperty in class EmailField

The form field type.

$ FileField#typeProperty in class FileField

The form field type.

$ FilelistField#typeProperty in class FilelistField

The form field type.

$ FolderlistField#typeProperty in class FolderlistField

The form field type.

$ FrontendlanguageField#typeProperty in class FrontendlanguageField

The form field type.

$ GroupedlistField#typeProperty in class GroupedlistField

The form field type.

$ HeadertagField#typeProperty in class HeadertagField

The form field type.

$ HiddenField#typeProperty in class HiddenField

The form field type.

$ ImagelistField#typeProperty in class ImagelistField

The form field type.

$ IntegerField#typeProperty in class IntegerField

The form field type.

$ LanguageField#typeProperty in class LanguageField

The form field type.

$ LimitboxField#typeProperty in class LimitboxField

The form field type.

$ ListField#typeProperty in class ListField

The form field type.

$ MediaField#typeProperty in class MediaField

The form field type.

$ MediaField#typesProperty in class MediaField

Comma separated types of files for Media Manager Possible values: images,audios,videos,documents

$ MenuField#typeProperty in class MenuField

The form field type.

$ MenuitemField#typeProperty in class MenuitemField

The form field type.

$ MeterField#typeProperty in class MeterField

The form field type.

$ ModalSelectField#typeProperty in class ModalSelectField

The form field type.

$ ModulelayoutField#typeProperty in class ModulelayoutField

The form field type.

$ ModuleorderField#typeProperty in class ModuleorderField

The form field type.

$ ModulepositionField#typeProperty in class ModulepositionField

The form field type.

$ ModuletagField#typeProperty in class ModuletagField

The form field type.

$ NoteField#typeProperty in class NoteField

The form field type.

$ NumberField#typeProperty in class NumberField

The form field type.

$ OrderingField#typeProperty in class OrderingField

The form field type.

$ PasswordField#typeProperty in class PasswordField

The form field type.

$ PasswordField#thresholdProperty in class PasswordField

The threshold of password field.

$ PluginsField#typeProperty in class PluginsField

The field type.

$ PluginstatusField#typeProperty in class PluginstatusField

The form field type.

$ PredefinedlistField#typeProperty in class PredefinedlistField

The form field type.

$ PredefinedlistField#translateProperty in class PredefinedlistField

Translate options labels ?

$ RadioField#typeProperty in class RadioField

The form field type.

$ RadiobasicField#typeProperty in class RadiobasicField

The form field type.

$ RangeField#typeProperty in class RangeField

The form field type.

$ RedirectStatusField#typeProperty in class RedirectStatusField

The form field type.

$ RegistrationdaterangeField#typeProperty in class RegistrationdaterangeField

The form field type.

$ RulesField#typeProperty in class RulesField

The form field type.

$ SchemaorgComponentSectionsField#typeProperty in class SchemaorgComponentSectionsField

The form field type.

$ SessionhandlerField#typeProperty in class SessionhandlerField

The form field type.

$ SpacerField#typeProperty in class SpacerField

The form field type.

$ SqlField#typeProperty in class SqlField

The form field type.

$ SqlField#translateProperty in class SqlField

The translate.

$ StatusField#typeProperty in class StatusField

The form field type.

$ SubformField#typeProperty in class SubformField

The form field type.

TagFieldClass in namespace Joomla\CMS\Form\Field

List of Tags field.

$ TagField#typeProperty in class TagField

A flexible tag list that respects access controls

TelephoneFieldClass in namespace Joomla\CMS\Form\Field

Form Field class for the Joomla Platform.

$ TelephoneField#typeProperty in class TelephoneField

The form field type.

TemplatestyleFieldClass in namespace Joomla\CMS\Form\Field

Supports a select grouped list of template styles

$ TemplatestyleField#typeProperty in class TemplatestyleField

The form field type.

$ TemplatestyleField#templateProperty in class TemplatestyleField

The template.

TextFieldClass in namespace Joomla\CMS\Form\Field

Form Field class for the Joomla Platform.

$ TextField#typeProperty in class TextField

The form field type.

TextareaFieldClass in namespace Joomla\CMS\Form\Field

Form Field class for the Joomla Platform.

$ TextareaField#typeProperty in class TextareaField

The form field type.

TimeFieldClass in namespace Joomla\CMS\Form\Field

Form Field class for the Joomla Platform.

$ TimeField#typeProperty in class TimeField

The form field type.

TimezoneFieldClass in namespace Joomla\CMS\Form\Field

Form Field class for the Joomla Platform.

$ TimezoneField#typeProperty in class TimezoneField

The form field type.

TransitionFieldClass in namespace Joomla\CMS\Form\Field

Workflow Transitions field.

$ TransitionField#typeProperty in class TransitionField

The form field type.

$ UrlField#typeProperty in class UrlField

The form field type.

$ UserField#typeProperty in class UserField

The form field type.

$ UseractiveField#typeProperty in class UseractiveField

The form field type.

$ UsergrouplistField#typeProperty in class UsergrouplistField

The form field type.

$ UserstateField#typeProperty in class UserstateField

The form field type.

$ WorkflowComponentSectionsField#typeProperty in class WorkflowComponentSectionsField

The form field type.

$ WorkflowconditionField#typeProperty in class WorkflowconditionField

The form field type.

$ WorkflowstageField#typeProperty in class WorkflowstageField

The form field type.

TelFilterClass in namespace Joomla\CMS\Form\Filter

Form Filter class for phone numbers

$ FormField#translateLabelProperty in class FormField

True to translate the field label string.

$ FormField#translateDescriptionProperty in class FormField

True to translate the field description string.

$ FormField#translateHintProperty in class FormField

True to translate the field hint string.

$ FormField#typeProperty in class FormField

The form field type.

FormRule::test() — Method in class FormRule

Method to test the value.

CalendarRule::test() — Method in class CalendarRule

Method to test the calendar value for a valid parts.

CaptchaRule::test() — Method in class CaptchaRule

Method to test if the Captcha is correct.

ColorRule::test() — Method in class ColorRule

Method to test for a valid color in hexadecimal.

CssIdentifierRule::test() — Method in class CssIdentifierRule

Method to test if the file path is valid

CssIdentifierSubstringRule::test() — Method in class CssIdentifierSubstringRule

Method to test if a string is a valid CSS identifier substring

EmailRule::test() — Method in class EmailRule

Method to test the value.

EqualsRule::test() — Method in class EqualsRule

Method to test if two values are equal. To use this rule, the form XML needs a validate attribute of equals and a field attribute that is equal to the field to test against.

ExistsRule::test() — Method in class ExistsRule

Method to test the value.

FilePathRule::test() — Method in class FilePathRule

Method to test if the file path is valid

FolderPathExistsRule::test() — Method in class FolderPathExistsRule

Method to test if the folder path is valid and points to an existing folder below the Joomla root

NotequalsRule::test() — Method in class NotequalsRule

Method to test if two values are not equal. To use this rule, the form XML needs a validate attribute of equals and a field attribute that is equal to the field to test against.

NumberRule::test() — Method in class NumberRule

Method to test the range for a number value using min and max attributes.

OptionsRule::test() — Method in class OptionsRule

Method to test the value.

PasswordRule::test() — Method in class PasswordRule

Method to test if two values are not equal. To use this rule, the form XML needs a validate attribute of equals and a field attribute that is equal to the field to test against.

RegexRule::test() — Method in class RegexRule

Method to test the value.

RulesRule::test() — Method in class RulesRule

Method to test the value.

ShowOnRule::test() — Method in class ShowOnRule

Method to test the value.

SubformRule::test() — Method in class SubformRule

Method to test given values for a subform.

TelRuleClass in namespace Joomla\CMS\Form\Rule

Form Rule class for the Joomla Platform

TelRule::test() — Method in class TelRule

Method to test the url for a valid parts.

TimeRuleClass in namespace Joomla\CMS\Form\Rule

Form Rule class for the Joomla Platform.

TimeRule::test() — Method in class TimeRule

Method to test the range for a number value using min and max attributes.

UrlRule::test() — Method in class UrlRule

Method to test an external or internal url for all valid parts.

UserIdRule::test() — Method in class UserIdRule

Method to test the value.

UsernameRule::test() — Method in class UsernameRule

Method to test the value.

HTMLHelper::tooltip() — Method in class HTMLHelper

Creates a tooltip with an image as button

HTMLHelper::tooltipText() — Method in class HTMLHelper

Converts a double colon separated string or 2 separate strings to a string ready for bootstrap tooltips

ActionsDropdown::trash() — Method in class ActionsDropdown

Append a trash item to the current dropdown menu

Bootstrap::tab() — Method in class Bootstrap

Add javascript support for Bootstrap tab

Bootstrap::tooltip() — Method in class Bootstrap

Add javascript support for Bootstrap tooltips

Bootstrap::toast() — Method in class Bootstrap

Add javascript support for Bootstrap toasts

Dropdown::trash() — Method in class Dropdown

Append a trash item to the current dropdown menu

Form::token() — Method in class Form

Displays a hidden token field to reduce the risk of CSRF exploits

Jquery::token() — Method in class Jquery

Auto set CSRF token to ajaxSetup so all jQuery ajax call will contains CSRF token.

Menu::treerecurse() — Method in class Menu

Build the list representing the menu tree

StringHelper::truncate() — Method in class StringHelper

Truncates text blocks over the specified character limit and closes all open HTML tags. The method will optionally not truncate an individual word, it will find the first space that is within the limit and truncate at that point. This method is UTF-8 safe.

StringHelper::truncateComplex() — Method in class StringHelper

Method to extend the truncate method to more complex situations

TagClass in namespace Joomla\CMS\HTML\Helpers

Utility class for tags

Tag::tags() — Method in class Tag

Returns an array of tags.

TelephoneClass in namespace Joomla\CMS\HTML\Helpers

HTML helper class for rendering telephone numbers.

Telephone::tel() — Method in class Telephone

Converts strings of integers into more readable telephone format

MediaHelper::toBytes() — Method in class MediaHelper

Small helper function that properly converts any configuration options to their byte representation.

TagsHelperClass in namespace Joomla\CMS\Helper

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

$ TagsHelper#tagsChangedProperty in class TagsHelper

Helper object for storing and deleting tag information.

$ TagsHelper#typeAliasProperty in class TagsHelper

Alias for querying mapping and content type table.

$ TagsHelper#tagsProperty in class TagsHelper

The tags as comma separated string or array.

TagsHelper::tagDeleteInstances() — Method in class TagsHelper

Method to delete all instances of a tag from the mapping table. Generally used when a tag is deleted.

TagsHelper::tagItem() — Method in class TagsHelper

Method to add or update tags associated with an item.

UserGroupsHelper::total() — Method in class UserGroupsHelper

Get total available user groups in database.

TransportInterfaceClass in namespace Joomla\CMS\Http

HTTP transport class interface.

Image::toFile() — Method in class Image

Method to write the current image out to a file or output directly.

$ LanguageAdapter#tagProperty in class LanguageAdapter

The language tag for the package

PackageAdapter::triggerManifestScript() — Method in class PackageAdapter

Executes a custom install script method

TemplateAdapterClass in namespace Joomla\CMS\Installer\Adapter

Template installer

$ InstallerAdapter#typeProperty in class InstallerAdapter

The type of adapter in use

InstallerAdapter::triggerManifestScript() — Method in class InstallerAdapter

Executes a custom install script method

$ InstallerExtension#typeProperty in class InstallerExtension

Type of the extension

$ Language#transliteratorProperty in class Language

Name of the transliterator function for this language.

Language::transliterate() — Method in class Language

Transliterate function

TextClass in namespace Joomla\CMS\Language

Text handling class.

TransliterateClass in namespace Joomla\CMS\Language

Class to transliterate strings

$ DatabaseLogger#tableProperty in class DatabaseLogger

The database table to use for logging entries.

$ AdminController#text_prefixProperty in class AdminController

The prefix to use with controller messages.

$ ApiController#text_prefixProperty in class ApiController

The prefix to use with controller messages.

$ BaseController#taskProperty in class BaseController

Current or most recently performed task.

$ BaseController#taskMapProperty in class BaseController

Array of class methods to call for a given task.

$ FormController#text_prefixProperty in class FormController

The prefix to use with controller messages.

$ AdminModel#typeAliasProperty in class AdminModel

The type alias for this content type (for example, 'com_content.article').

$ AdminModel#text_prefixProperty in class AdminModel

The prefix to use with controller messages.

$ AdminModel#tableProperty in class AdminModel

A \Joomla\CMS\Table\Table instance (of appropriate type) to manage the DB records (re-usable in batch methods & saveorder(), initialized via initBatch())

$ AdminModel#tableClassNameProperty in class AdminModel

The class name of the \Joomla\CMS\Table\Table instance managing the DB records (re-usable in batch methods & saveorder(), initialized via initBatch())

$ AdminModel#typeProperty in class AdminModel

DB data of UCM Type corresponding to the current model class (re-usable in batch action methods, initialized via initBatch())

$ FormView#toolbarTitleProperty in class FormView

The toolbar title

$ FormView#toolbarIconProperty in class FormView

The toolbar icon

$ JsonApiView#typeProperty in class JsonApiView

The content type

$ ListView#toolbarTitleProperty in class ListView

The toolbar title

$ ListView#toolbarIconProperty in class ListView

The toolbar icon

$ MailTemplate#template_idProperty in class MailTemplate

Identifier of the mail template.

$ AdministratorMenuItem#targetProperty in class AdministratorMenuItem

The target attribute of the link

$ MenuItem#titleProperty in class MenuItem

The display title of the menu item

$ MenuItem#typeProperty in class MenuItem

The type of link

$ MenuItem#template_style_idProperty in class MenuItem

The optional template style applied to this menu item

$ MenuItem#treeProperty in class MenuItem

The tree of parent menu items

$ Microdata#typesProperty in class Microdata

Array with all available Types and Properties from the http://schema.org vocabulary

$ Microdata#typeProperty in class Microdata

The Type

$ Pagination#totalProperty in class Pagination
$ PaginationObject#textProperty in class PaginationObject
$ Router#taintedProperty in class Router

Flag to mark the last parsed URL as tainted If a URL could be read, but has errors, this flag can be set to true to mark the URL as erroneous.

ToolbarClass in namespace Joomla\CMS\Service\Provider

Service provider for the application's toolbar dependency

PunycodeHelper::toPunycode() — Method in class PunycodeHelper

Transforms a UTF-8 string to a Punycode string

$ DatabaseStorage#tableProperty in class DatabaseStorage

The TUF table object

TufFetcherClass in namespace Joomla\CMS\TUF
$ Asset#titleProperty in class Asset

The human readable title of the asset.

TableClass in namespace Joomla\CMS\Table

Abstract Table class

$ Table#typeAliasProperty in class Table

The UCM type alias. Used for tags, content versioning etc. Leave blank to effectively disable these features.

TableInterfaceClass in namespace Joomla\CMS\Table

Table class interface.

TufClass in namespace Joomla\CMS\Table

TUF map table

TagApiSerializerTraitClass in namespace Joomla\CMS\Tag

Trait for implementing tags in an API Serializer

TagApiSerializerTrait::tags() — Method in class TagApiSerializerTrait

Build tags relationship

TagServiceInterfaceClass in namespace Joomla\CMS\Tag

Access to component specific tagging information.

TagServiceTraitClass in namespace Joomla\CMS\Tag

Trait for component tags service.

TaggableTableInterfaceClass in namespace Joomla\CMS\Tag

Interface for a taggable Table class

TaggableTableTraitClass in namespace Joomla\CMS\Tag

Defines the trait for a Taggable Table Class.

$ TaggableTableTrait#tagsHelperProperty in class TaggableTableTrait

The tags helper property

DropdownButton::toggleSplit() — Method in class DropdownButton
DropdownButton::toggleButtonClass() — Method in class DropdownButton
InlinehelpButton::targetclass() — Method in class InlinehelpButton
LinkButton::target() — Method in class LinkButton
PopupButton::title() — Method in class PopupButton
PopupButton::textHeader() — Method in class PopupButton
CoreButtonsTrait::trash() — Method in class CoreButtonsTrait

Writes a common 'trash' button.

ToolbarClass in namespace Joomla\CMS\Toolbar

ToolBar handler

ToolbarButtonClass in namespace Joomla\CMS\Toolbar

The ToolbarButton class.

ToolbarButton::text() — Method in class ToolbarButton
ToolbarButton::task() — Method in class ToolbarButton
ToolbarFactoryInterfaceClass in namespace Joomla\CMS\Toolbar

Interface for creating toolbar objects

ToolbarHelperClass in namespace Joomla\CMS\Toolbar

Utility class for the button bar.

ToolbarHelper::title() — Method in class ToolbarHelper

Title cell.

ToolbarHelper::trash() — Method in class ToolbarHelper

Writes a common 'trash' button for a list of records.

$ UCMBase#typeProperty in class UCMBase

The UCM type object

$ UCMContent#tableProperty in class UCMContent

The related table object

$ UCMType#typeProperty in class UCMType

The UCM Type

TufAdapterClass in namespace Joomla\CMS\Updater\Adapter

TUF Update Adapter Class

$ DownloadSource#typeProperty in class DownloadSource

The download type

$ Update#typeProperty in class Update

Update manifest <type> element

$ Update#tagsProperty in class Update

Update manifest <tags> element

$ Update#targetplatformProperty in class Update

Update manifest <targetplatform> element

$ Update#tagProperty in class Update
UpdateAdapter::toggleUpdateSite() — Method in class UpdateAdapter

Toggles the enabled status of an update site. Update sites are disabled before getting the update information from their URL and enabled afterwards. If the URL fetch fails with a PHP fatal error (e.g. timeout) the faulty update site will remain disabled the next time we attempt to load the update information.

$ User#typeAliasProperty in class User

The type alias

TableColumnsAssetItemClass in namespace Joomla\CMS\WebAsset\AssetItem

Web Asset Item class for tables.column asset

$ Server#timeoutProperty in class Server

Default WebAuthn timeout in milliseconds

U

$ Access#userGroupsProperty in class Access

Array of user groups.

$ Access#userGroupPathsProperty in class Access

Array of user group paths.

$ AuthenticationResponse#usernameProperty in class AuthenticationResponse

Any UTF-8 string that the End User wants to use as a username.

$ ActionButton#unknownStateProperty in class ActionButton

Default options for unknown state.

Cache::unlock() — Method in class Cache

Unset lock flag on cached item

CacheStorage::unlock() — Method in class CacheStorage

Unlock cached item

UnsupportedCacheExceptionClass in namespace Joomla\CMS\Cache\Exception

Exception class defining an unsupported cache storage object

ApcuStorage::unlock() — Method in class ApcuStorage

Unlock cached item

CacheStorageHelper::updateSize() — Method in class CacheStorageHelper

Increase cache items count.

FileStorage::unlock() — Method in class FileStorage

Unlock cached item

MemcachedStorage::unlock() — Method in class MemcachedStorage

Unlock cached item

MemcachedStorage::unlockindex() — Method in class MemcachedStorage

Unlock cache index

UpdateCoreCommandClass in namespace Joomla\CMS\Console

Console command for updating Joomla! core

$ UpdateCoreCommand#updateInfoProperty in class UpdateCoreCommand

Update Information

$ UpdateCoreCommand#updateModelProperty in class UpdateCoreCommand

Update Model

$ FeedEnclosure#urlProperty in class FeedEnclosure

URL enclosure element

$ FeedImage#urlProperty in class FeedImage

URL image attribute

SubmitContactEvent::updateData() — Method in class SubmitContactEvent

Update the data.

AfterPrepareFieldEvent::updateValue() — Method in class AfterPrepareFieldEvent

Update the value.

AfterInstallerEvent::updateInstallerResult() — Method in class AfterInstallerEvent

Update the installerResult.

AfterInstallerEvent::updateMessage() — Method in class AfterInstallerEvent

Update the message.

BeforePackageDownloadEvent::updateUrl() — Method in class BeforePackageDownloadEvent

Update the url.

BeforePackageDownloadEvent::updateHeaders() — Method in class BeforePackageDownloadEvent

Update the headers.

InstallerEvent::updatePackage() — Method in class InstallerEvent

Update the package.

AfterGetMenuTypeOptionsEvent::updateItems() — Method in class AfterGetMenuTypeOptionsEvent

Update the items.

PreprocessMenuItemsEvent::updateItems() — Method in class PreprocessMenuItemsEvent

Update the items.

BeforeValidateDataEvent::updateData() — Method in class BeforeValidateDataEvent

Update the data.

PrepareDataEvent::updateData() — Method in class PrepareDataEvent

Update the data.

AfterRenderModulesEvent::updateContent() — Method in class AfterRenderModulesEvent

Setter for the content.

ModuleListEvent::updateModules() — Method in class ModuleListEvent

Update the modules.

RenderModuleEvent::updateAttributes() — Method in class RenderModuleEvent

Update the attributes.

AjaxEvent::updateEventResult() — Method in class AjaxEvent

Update the result of the event.

CheckPrivacyPolicyPublishedEvent::updatePolicyInfo() — Method in class CheckPrivacyPolicyPublishedEvent

Update the PolicyInfo.

UserEventClass in namespace Joomla\CMS\Event\User

Base class for User events

UserGroupAfterDeleteEventClass in namespace Joomla\CMS\Event\User

Class for Model event.

UserGroupBeforeDeleteEventClass in namespace Joomla\CMS\Event\User

Class for Model event.

$ Feed#updatedDateProperty in class Feed

The last time the content of the feed changed.

$ Feed#uriProperty in class Feed

Universal, permanent identifier for the feed.

$ FeedEntry#updatedDateProperty in class FeedEntry

The last time the content of the feed entry changed.

$ FeedEntry#uriProperty in class FeedEntry

Universal, permanent identifier for the feed entry.

$ FeedLink#uriProperty in class FeedLink

The URI to the linked resource.

$ FeedPerson#uriProperty in class FeedPerson

The URI for the person.

File::upload() — Method in class File

Moves an uploaded file to a destination folder

Stream::upload() — Method in class Stream

Upload a file

StreamString::url_stat() — Method in class StreamString

Method to retrieve information about a file.

$ ModalSelectField#urlsProperty in class ModalSelectField

Urls for modal: select, edit, new

UrlFieldClass in namespace Joomla\CMS\Form\Field

Form Field class for the Joomla Platform.

UserFieldClass in namespace Joomla\CMS\Form\Field

Field to select a user ID from a modal list.

UseractiveFieldClass in namespace Joomla\CMS\Form\Field

Field to show a list of available user active statuses

UsergrouplistFieldClass in namespace Joomla\CMS\Form\Field

Field to load a dropdown list of available user groups

UserstateFieldClass in namespace Joomla\CMS\Form\Field

Field to load a list of available users statuses

UnsetFilterClass in namespace Joomla\CMS\Form\Filter

Form Filter class to unset

UrlFilterClass in namespace Joomla\CMS\Form\Filter

Form Filter class for URLs

UrlRuleClass in namespace Joomla\CMS\Form\Rule

Form Rule class for the Joomla Platform.

UserIdRuleClass in namespace Joomla\CMS\Form\Rule

Form Rule class for the Joomla Platform.

UsernameRuleClass in namespace Joomla\CMS\Form\Rule

Form Rule class for the Joomla Platform.

HTMLHelper::unregister() — Method in class HTMLHelper

Removes a key for a method from registry.

Access::usergroup() — Method in class Access

Displays a list of the available user groups.

Access::usergroups() — Method in class Access

Returns a UL list of user groups with checkboxes

ActionsDropdown::unpublish() — Method in class ActionsDropdown

Append an unpublish item to the current dropdown menu

ActionsDropdown::unfeature() — Method in class ActionsDropdown

Append an unfeature item to the current dropdown menu

ActionsDropdown::unarchive() — Method in class ActionsDropdown

Append an unarchive item to the current dropdown menu

ActionsDropdown::untrash() — Method in class ActionsDropdown

Append an untrash item to the current dropdown menu

Dropdown::unpublish() — Method in class Dropdown

Append an unpublish item to the current dropdown menu

Dropdown::unfeatured() — Method in class Dropdown

Append an unfeatured item to the current dropdown menu

Dropdown::unarchive() — Method in class Dropdown

Append an unarchive item to the current dropdown menu

Dropdown::untrash() — Method in class Dropdown

Append an untrash item to the current dropdown menu

ListHelper::users() — Method in class ListHelper

Select list of active users

UiTabClass in namespace Joomla\CMS\HTML\Helpers

Utility class for the Joomla core UI Tab element.

UserClass in namespace Joomla\CMS\HTML\Helpers

Utility class working with users

User::userlist() — Method in class User

Get a list of users.

TagsHelper::unTagItem() — Method in class TagsHelper

Method to untag an item

UserGroupsHelperClass in namespace Joomla\CMS\Helper

Helper to deal with user groups.

UnparsableImageExceptionClass in namespace Joomla\CMS\Image\Exception

Exception thrown when an image has no known properties.

Cli::unserialize() — Method in class Cli

Method to unserialize the input.

Input::unserialize() — Method in class Input

Method to unserialize the input.

LanguageAdapter::update() — Method in class LanguageAdapter

Custom update method

$ Installer#upgradeProperty in class Installer

True if package is an upgrade

Installer::update() — Method in class Installer

Package update method

Installer::uninstall() — Method in class Installer

Package uninstallation method

Installer::updateSchemaTable() — Method in class Installer

Update the schema table with the latest version

InstallerAdapter::uninstall() — Method in class InstallerAdapter

Generic update method for extensions

InstallerAdapter::update() — Method in class InstallerAdapter

Generic update method for extensions

InstallerHelper::unpack() — Method in class InstallerHelper

Unpacks a file and verifies it as a Joomla element package Supports .gz .tar .tar.gz and .zip

InstallerScriptInterface::update() — Method in class InstallerScriptInterface

Function called after the extension is updated.

InstallerScriptInterface::uninstall() — Method in class InstallerScriptInterface

Function called after the extension is uninstalled.

LegacyInstallerScript::update() — Method in class LegacyInstallerScript

Function called after the extension is updated.

LegacyInstallerScript::uninstall() — Method in class LegacyInstallerScript

Function called after the extension is uninstalled.

$ Manifest#updateProperty in class Manifest

Update site for the extension

$ PackageManifest#urlProperty in class PackageManifest

Website for the package

$ Language#upperLimitSearchWordCallbackProperty in class Language

Name of the upperLimitSearchWordCallback function for this language.

Transliterate::utf8_latin_to_ascii() — Method in class Transliterate

Returns strings transliterated from UTF-8 to Latin

$ DatabaseLogger#userProperty in class DatabaseLogger

The database server user to connect as for the logger.

BaseController::unregisterTask() — Method in class BaseController

Unregister (unmap) a task in the class.

$ AdminModel#userProperty in class AdminModel

The user performing the actions (re-usable in batch methods & saveorder(), initialized via initBatch())

Mail::useSendmail() — Method in class Mail

Use sendmail for sending the email

Mail::useSmtp() — Method in class Mail

Use SMTP for sending the email

$ MailTemplate#unsafe_tagsProperty in class MailTemplate
MailTemplate::updateTemplate() — Method in class MailTemplate

Update an existing mail template

$ ChangeItem#updateQueryProperty in class ChangeItem

Update query: query used to change the db schema (one line from the file)

UserClass in namespace Joomla\CMS\Service\Provider

Service provider for the user dependency

UnsupportedStorageExceptionClass in namespace Joomla\CMS\Session\Exception

Exception class defining an unsupported session storage object

PunycodeHelper::urlToPunycode() — Method in class PunycodeHelper

Transforms a UTF-8 URL to a Punycode URL

PunycodeHelper::urlToUTF8() — Method in class PunycodeHelper

Transforms a Punycode URL to a UTF-8 URL

UcmClass in namespace Joomla\CMS\Table

UCM map table

UpdateClass in namespace Joomla\CMS\Table

Update table Stores updates temporarily

UpdateSiteClass in namespace Joomla\CMS\Table

Update site table Stores the update sites for extensions

UserClass in namespace Joomla\CMS\Table

Users table

UsergroupClass in namespace Joomla\CMS\Table

Usergroup table class.

HelpButton::useComponent() — Method in class HelpButton
HelpButton::url() — Method in class HelpButton
LinkButton::url() — Method in class LinkButton
PopupButton::url() — Method in class PopupButton
CoreButtonsTrait::unpublish() — Method in class CoreButtonsTrait

Writes a common 'unpublish' button.

CoreButtonsTrait::unarchive() — Method in class CoreButtonsTrait

Writes a common 'unarchive' button.

ToolbarHelper::unpublish() — Method in class ToolbarHelper

Writes a common 'unpublish' button.

ToolbarHelper::unpublishList() — Method in class ToolbarHelper

Writes a common 'unpublish' button for a list of records.

ToolbarHelper::unarchiveList() — Method in class ToolbarHelper

Writes an unarchive button for a list of records.

UCMClass in namespace Joomla\CMS\UCM

Interface to handle UCM

UCMBaseClass in namespace Joomla\CMS\UCM

Base class for implementing UCM

UCMContentClass in namespace Joomla\CMS\UCM

Base class for implementing UCM

$ UCMContent#ucmDataProperty in class UCMContent

The UCM data array

UCMTypeClass in namespace Joomla\CMS\UCM

UCM Class for handling content types

$ CollectionAdapter#update_sitesProperty in class CollectionAdapter

A list of discovered update sites

$ CollectionAdapter#updatesProperty in class CollectionAdapter

A list of discovered updates

$ DownloadSource#urlProperty in class DownloadSource

The URL to retrieve the package from

UpdateClass in namespace Joomla\CMS\Updater

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

UpdateAdapterClass in namespace Joomla\CMS\Updater

UpdateAdapter class.

$ UpdateAdapter#updateSiteIdProperty in class UpdateAdapter

ID of update site

$ UpdateAdapter#updatecolsProperty in class UpdateAdapter

Columns in the extensions table to be updated

$ UpdateAdapter#updateSiteNameProperty in class UpdateAdapter

The name of the update site (used in logging)

UpdaterClass in namespace Joomla\CMS\Updater

Updater Class

UriClass in namespace Joomla\CMS\Uri

Uri Class

UserClass in namespace Joomla\CMS\User

User class. Handles all application interaction with a user

$ User#usernameProperty in class User

The login name

UserFactoryClass in namespace Joomla\CMS\User

Default factory for creating User objects

UserFactoryAwareInterfaceClass in namespace Joomla\CMS\User

Interface to be implemented by classes depending on a user factory.

UserFactoryAwareTraitClass in namespace Joomla\CMS\User

Defines the trait for a UserFactoryInterface Aware Class.

UserFactoryInterfaceClass in namespace Joomla\CMS\User

Interface defining a factory which can create User objects

UserHelperClass in namespace Joomla\CMS\User

Authorisation helper class, provides static methods to perform various tasks relevant to the Joomla user and authorisation classes

UtilityClass in namespace Joomla\CMS\Utility

JUtility is a utility functions class

UnknownAssetExceptionClass in namespace Joomla\CMS\WebAsset\Exception

Exception class defining an Unknown Asset

UnsatisfiedDependencyExceptionClass in namespace Joomla\CMS\WebAsset\Exception

Exception class defining an Unsatisfied Dependency

$ WebAssetItem#uriProperty in class WebAssetItem

The URI for the asset

WebAssetManager::useAsset() — Method in class WebAssetManager

Enable an asset item to be attached to a Document

WebAssetManager::usePresetItems() — Method in class WebAssetManager

Enable list of assets provided by Preset item.

WebAssetManager::useStyle() — Method in class WebAssetManager
WebAssetManager::useScript() — Method in class WebAssetManager
WebAssetManager::usePreset() — Method in class WebAssetManager
WebAssetManagerInterface::useAsset() — Method in class WebAssetManagerInterface

Enable an asset item to be attached to a Document

Workflow::updateAssociations() — Method in class Workflow

Update an existing association with a new state

V

$ Access#viewLevelsProperty in class Access

Array of view levels

ChainedHandler::validatePassword() — Method in class ChainedHandler

Validate a password

MD5Handler::validatePassword() — Method in class MD5Handler

Validate a password

PHPassHandler::validatePassword() — Method in class PHPassHandler

Validate a password

ViewControllerClass in namespace Joomla\CMS\Cache\Controller

Joomla! Cache view type object

$ Changelog#versionProperty in class Changelog

Update manifest <version> element

$ RouterView#viewsProperty in class RouterView

Views of the component

$ PreprocessRules#viewProperty in class PreprocessRules

View to prepare

ValidateContactEventClass in namespace Joomla\CMS\Event\Contact

Class for Contact events

ValidateClass in namespace Joomla\CMS\Event\MultiFactor

Concrete Event class for the onUserMultifactorValidate event

LegacyComponent::validateSection() — Method in class LegacyComponent

Returns a valid section for articles. If it is not valid then null is returned.

$ AtomParser#versionProperty in class AtomParser
$ RssParser#versionProperty in class RssParser
FieldsServiceInterface::validateSection() — Method in class FieldsServiceInterface

Returns a valid section for the given section. If it is not valid then null is returned.

$ SqlField#valueFieldProperty in class SqlField

The valueField.

Form::validate() — Method in class Form

Method to validate form data.

$ FormField#validationtextProperty in class FormField

The validation text of invalid value of the form field.

$ FormField#validateProperty in class FormField

The validation method for the form field. This value will determine which method is used to validate the value for a field.

$ FormField#valueProperty in class FormField

The value of the form field.

FormField::validate() — Method in class FormField

Method to validate a FormField object based on field data.

$ RouteHelper#viewProperty in class RouteHelper
$ Manifest#versionProperty in class Manifest

Version of the extension

FileLayout::validComponent() — Method in class FileLayout

Validate that the active component is valid

$ AdminController#view_listProperty in class AdminController

The URL view list variable.

$ BaseController#viewsProperty in class BaseController

Instance container containing the views.

$ FormController#view_itemProperty in class FormController

The URL view item variable.

$ FormController#view_listProperty in class FormController

The URL view list variable.

FormModel::validate() — Method in class FormModel

Method to validate the form data.

$ CategoryView#viewNameProperty in class CategoryView

The name of the view to link individual items to

ViewInterfaceClass in namespace Joomla\CMS\MVC\View

Joomla Platform CMS Interface

$ Pagination#viewallProperty in class Pagination
ArrayProxy::valid() — Method in class ArrayProxy

Implementation of Iterator interface

ObjectProxy::valid() — Method in class ObjectProxy

Implementation of Iterator interface

$ Router#varsProperty in class Router

An array of variables

ViewLevelClass in namespace Joomla\CMS\Table

ViewLevel table class.

CoreButtonsTrait::versions() — Method in class CoreButtonsTrait

Writes a version history

ToolbarHelper::versions() — Method in class ToolbarHelper

Writes a version history

$ Update#versionProperty in class Update

Update manifest <version> element

UserHelper::verifyPassword() — Method in class UserHelper

Formats a password using the current encryption. If the user ID is given and the hash does not fit the current hashing algorithm, it automatically updates the hash.

VersionClass in namespace Joomla\CMS

Version information class for the Joomla CMS.

VersionableControllerTraitClass in namespace Joomla\CMS\Versioning

Defines the trait for a Versionable Controller Class.

VersionableModelTraitClass in namespace Joomla\CMS\Versioning

Defines the trait for a Versionable Model Class.

VersionableTableInterfaceClass in namespace Joomla\CMS\Versioning

Interface for a versionable Table class

VersioningClass in namespace Joomla\CMS\Versioning

Handle the versioning of content items

$ WebAssetItem#versionProperty in class WebAssetItem

Asset version

W

JNamespacePsr4Map::writeNamespaceFile() — Method in class JNamespacePsr4Map

Write the Namespace mapping file

DaemonApplication::writeProcessIdFile() — Method in class DaemonApplication

Method to write the process id file out to disk.

WebApplicationClass in namespace Joomla\CMS\Application

Base class for a Joomla! Web application.

FtpClient::write() — Method in class FtpClient

Method to write a string to the FTP server

WritableContainerLoaderClass in namespace Joomla\CMS\Console\Loader

PSR-11 compatible writable command loader.

WritableLoaderInterfaceClass in namespace Joomla\CMS\Console\Loader

Interface defining a writable command loader.

$ Date#weekProperty in class Date

W - ISO-8601 week number of year, weeks starting on Monday.

$ Document#webAssetManagerProperty in class Document

Web Asset instance

$ FeedDocument#webmasterProperty in class FeedDocument

Webmaster email feed element

$ FeedImage#widthProperty in class FeedImage

Width image attribute

$ OpensearchImage#widthProperty in class OpensearchImage

The image's width

WebAssetRegistryAssetChangedClass in namespace Joomla\CMS\Event\WebAsset

Event class for WebAssetRegistry "asset changed" events

WorkflowFunctionalityUsedEventClass in namespace Joomla\CMS\Event\Workflow

Event class for Workflow Functionality Used events

WorkflowTransitionEventClass in namespace Joomla\CMS\Event\Workflow

Event class for Workflow Functionality Used events

$ FeedLink#widthProperty in class FeedLink

The width of the image.

File::write() — Method in class File

Write contents to a file

$ Stream#writeprefixProperty in class Stream

Prefix of the connection for writing

Stream::write() — Method in class Stream

File write

Stream::writeFile() — Method in class Stream

Writes a chunk of data to a file.

$ CalendarField#weeknumbersProperty in class CalendarField

The week numbers flag

$ EditorField#widthProperty in class EditorField

The width of the editor.

$ MediaField#widthProperty in class MediaField

Modal width.

$ MeterField#widthProperty in class MeterField

The width of the progress bar

$ TransitionField#workflowStageProperty in class TransitionField

The workflow stage to use.

WorkflowComponentSectionsFieldClass in namespace Joomla\CMS\Form\Field

Form Field class for the Joomla Framework.

WorkflowconditionFieldClass in namespace Joomla\CMS\Form\Field

Workflow States field.

WorkflowstageFieldClass in namespace Joomla\CMS\Form\Field

Workflow Stages field.

WorkflowStageClass in namespace Joomla\CMS\HTML\Helpers

Utility class working with workflow states select lists

Image::watermark() — Method in class Image

Watermark the image

W3cLoggerClass in namespace Joomla\CMS\Log\Logger

Joomla! W3C Logging class

WorkflowBehaviorTraitClass in namespace Joomla\CMS\MVC\Model

Trait which supports state behavior

$ WorkflowBehaviorTrait#workflowEnabledProperty in class WorkflowBehaviorTrait

Is workflow for this component enabled?

$ WorkflowBehaviorTrait#workflowProperty in class WorkflowBehaviorTrait

The workflow object

WorkflowBehaviorTrait::workflowPreprocessForm() — Method in class WorkflowBehaviorTrait

Method to allow derived classes to preprocess the form.

WorkflowBehaviorTrait::workflowBeforeStageChange() — Method in class WorkflowBehaviorTrait

Let plugins access stage change events

WorkflowBehaviorTrait::workflowBeforeSave() — Method in class WorkflowBehaviorTrait

Preparation of workflow data/plugins

WorkflowBehaviorTrait::workflowAfterSave() — Method in class WorkflowBehaviorTrait

Executing of relevant workflow methods

WorkflowBehaviorTrait::workflowCleanupBatchMove() — Method in class WorkflowBehaviorTrait

Batch change workflow stage or current.

WorkflowModelInterfaceClass in namespace Joomla\CMS\MVC\Model

Interface for a workflow model.

WorkflowModelInterface::workflowPreprocessForm() — Method in class WorkflowModelInterface

Method to allow derived classes to preprocess the form.

WorkflowModelInterface::workflowBeforeStageChange() — Method in class WorkflowModelInterface

Let plugins access stage change events

WorkflowModelInterface::workflowBeforeSave() — Method in class WorkflowModelInterface

Preparation of workflow data/plugins

WorkflowModelInterface::workflowAfterSave() — Method in class WorkflowModelInterface

Executing of relevant workflow methods

WorkflowModelInterface::workflowCleanupBatchMove() — Method in class WorkflowModelInterface

Batch change workflow stage or current.

WebAssetRegistryClass in namespace Joomla\CMS\Service\Provider

Service provider for the application's WebAsset dependency

DatabaseStorage::write() — Method in class DatabaseStorage
WebAssetExceptionInterfaceClass in namespace Joomla\CMS\WebAsset\Exception

Exception interface defining a WebAsset error

WebAssetAttachBehaviorInterfaceClass in namespace Joomla\CMS\WebAsset

Web Asset Behavior interface

WebAssetItemClass in namespace Joomla\CMS\WebAsset

Web Asset Item class

WebAssetItemInterfaceClass in namespace Joomla\CMS\WebAsset

Web Asset Item interface

WebAssetManagerClass in namespace Joomla\CMS\WebAsset

Web Asset Manager class

WebAssetManagerInterfaceClass in namespace Joomla\CMS\WebAsset

Web Asset Manager Interface

WebAssetRegistryClass in namespace Joomla\CMS\WebAsset

Web Asset Registry class

WebAssetRegistryInterfaceClass in namespace Joomla\CMS\WebAsset

Web Asset Registry interface

WorkflowClass in namespace Joomla\CMS\Workflow

Workflow Class.

WorkflowPluginTraitClass in namespace Joomla\CMS\Workflow

Trait for component workflow plugins.

WorkflowServiceInterfaceClass in namespace Joomla\CMS\Workflow

The workflow service.

WorkflowServiceTraitClass in namespace Joomla\CMS\Workflow

Trait for component workflow service.

X

XmlClass in namespace Joomla\CMS\Application\CLI\Output

Output handler for writing command line output to the stdout interface

$ Changelog#xmlParserProperty in class Changelog

Resource handle for the XML Parser

XmlDocumentClass in namespace Joomla\CMS\Document

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

XmlRendererClass in namespace Joomla\CMS\Error\Renderer

XML error page renderer

$ Form#xmlProperty in class Form

The form XML definition.

$ Debug#xdebugLinkFormatProperty in class Debug

xdebug.file_link_format from the php.ini.

Debug::xdebuglink() — Method in class Debug

Replaces the Joomla! root with "JROOT" to improve readability.

$ Update#xmlParserProperty in class Update

Resource handle for the XML Parser

$ UpdateAdapter#xmlParserProperty in class UpdateAdapter

Resource handle for the XML Parser

Y

$ Date#yearProperty in class Date

Y - A full numeric representation of a year, 4 digits.

Z

$ TimezoneField#zonesProperty in class TimezoneField

The list of available timezone groups to use.

_

CryptoExceptionHandler::__construct() — Method in class CryptoExceptionHandler
CryptoExceptionHandler::__destruct() — Method in class CryptoExceptionHandler
JLoader::_autoload() — Method in class JLoader

Autoload a class based on name.

Rule::__construct() — Method in class Rule
Constructor.
Rule::__toString() — Method in class Rule

Convert this object into a JSON encoded string.

Rules::__construct() — Method in class Rules
Constructor.
Rules::__toString() — Method in class Rules

Magic method to convert the object to JSON string representation.

$ Adapter#_adaptersProperty in class Adapter

Associative array of adapters

$ Adapter#_adapterfolderProperty in class Adapter

Adapter Folder

$ Adapter#_classprefixProperty in class Adapter

Adapter Class Prefix

$ Adapter#_basepathProperty in class Adapter

Base Path for the adapter instance

$ Adapter#_dbProperty in class Adapter

Database Connector Object

Adapter::__construct() — Method in class Adapter
Constructor
AdapterInstance::__construct() — Method in class AdapterInstance
Constructor
AdministratorApplication::__construct() — Method in class AdministratorApplication

Class constructor.

ApiApplication::__construct() — Method in class ApiApplication

Class constructor.

$ ApplicationHelper#_clientsProperty in class ApplicationHelper

Client information array

BaseApplication::__construct() — Method in class BaseApplication

Class constructor.

CliOutput::__construct() — Method in class CliOutput
Constructor
ColorStyle::__construct() — Method in class ColorStyle
Constructor
ColorStyle::__toString() — Method in class ColorStyle

Convert to a string.

ColorProcessor::__construct() — Method in class ColorProcessor

Class constructor

CMSApplication::__construct() — Method in class CMSApplication

Class constructor.

CliApplication::__construct() — Method in class CliApplication

Class constructor.

CliApplication::__get() — Method in class CliApplication

Magic method to access properties of the application.

ConsoleApplication::__construct() — Method in class ConsoleApplication

Class constructor.

ConsoleApplication::__get() — Method in class ConsoleApplication

Magic method to access properties of the application.

DaemonApplication::__construct() — Method in class DaemonApplication

Class constructor.

SiteApplication::__construct() — Method in class SiteApplication

Class constructor.

WebApplication::__construct() — Method in class WebApplication

Class constructor.

Authentication::__construct() — Method in class Authentication
Constructor
ClassLoader::__construct() — Method in class ClassLoader
Constructor
ActionButton::__construct() — Method in class ActionButton

ActionButton constructor.

ActionButton::__toString() — Method in class ActionButton

Render to string.

TransitionButton::__construct() — Method in class TransitionButton

ActionButton constructor.

$ Cache#_handlerProperty in class Cache

Storage handler

$ Cache#_optionsProperty in class Cache

Cache options

Cache::__construct() — Method in class Cache
Constructor
Cache::_getStorage() — Method in class Cache

Get the cache storage handler

CacheController::__construct() — Method in class CacheController
Constructor
CacheController::__call() — Method in class CacheController

Magic method to proxy CacheController method calls to Cache

$ CacheStorage#_nowProperty in class CacheStorage

Time that the cache storage handler was instantiated

$ CacheStorage#_lifetimeProperty in class CacheStorage

Cache lifetime

$ CacheStorage#_lockingProperty in class CacheStorage

Flag if locking is enabled

$ CacheStorage#_languageProperty in class CacheStorage

Language code

$ CacheStorage#_applicationProperty in class CacheStorage

Application name

$ CacheStorage#_hashProperty in class CacheStorage

Object hash

$ CacheStorage#_thresholdProperty in class CacheStorage

The threshold

CacheStorage::__construct() — Method in class CacheStorage
Constructor
CacheStorage::_getCacheId() — Method in class CacheStorage

Get a cache ID string from an ID/group pair

CallbackController::_makeId() — Method in class CallbackController

Generate a callback cache ID

$ OutputController#_idProperty in class OutputController

Cache data ID

$ OutputController#_groupProperty in class OutputController

Cache data group

$ PageController#_idProperty in class PageController

ID property for the cache page object.

$ PageController#_groupProperty in class PageController

Cache group

$ PageController#_locktestProperty in class PageController

Cache lock test

PageController::_makeId() — Method in class PageController

Generate a page cache id

PageController::_noChange() — Method in class PageController

There is no change in page data so send an unmodified header and die gracefully

PageController::_setEtag() — Method in class PageController

Set the ETag header in the response

ViewController::_makeId() — Method in class ViewController

Generate a view cache ID.

CacheStorageHelper::__construct() — Method in class CacheStorageHelper
Constructor
$ FileStorage#_rootProperty in class FileStorage

Root path

$ FileStorage#_locked_filesProperty in class FileStorage

Locked resources

FileStorage::__construct() — Method in class FileStorage
Constructor
FileStorage::_checkExpire() — Method in class FileStorage

Check if a cache object has expired

FileStorage::_getFilePath() — Method in class FileStorage

Get a cache file path from an ID/group pair

FileStorage::_deleteFolder() — Method in class FileStorage

Quickly delete a folder of files

FileStorage::_cleanPath() — Method in class FileStorage

Function to strip additional / or \ in a path name

FileStorage::_filesInFolder() — Method in class FileStorage

Utility function to quickly read the files in a folder.

FileStorage::_folders() — Method in class FileStorage

Utility function to read the folders in a folder.

$ MemcachedStorage#_dbProperty in class MemcachedStorage

Memcached connection object

$ MemcachedStorage#_compressProperty in class MemcachedStorage

Payload compression level

MemcachedStorage::__construct() — Method in class MemcachedStorage
Constructor
MemcachedStorage::_getCacheId() — Method in class MemcachedStorage

Get a cache_id string from an id/group pair

$ RedisStorage#_redisProperty in class RedisStorage

Redis connection object

$ RedisStorage#_persistentProperty in class RedisStorage

Persistent session flag

RedisStorage::__construct() — Method in class RedisStorage
Constructor
Captcha::__construct() — Method in class Captcha

Class constructor.

HttpBridgePostRequestMethod::__construct() — Method in class HttpBridgePostRequestMethod

Class constructor.

$ Categories#_nodesProperty in class Categories

Array of category nodes

$ Categories#_checkedCategoriesProperty in class Categories

Array of checked categories -- used to save values when _nodes are null

$ Categories#_extensionProperty in class Categories

Name of the extension the categories belong to

$ Categories#_tableProperty in class Categories

Name of the linked content table to get category content count

$ Categories#_fieldProperty in class Categories

Name of the category field

$ Categories#_keyProperty in class Categories

Name of the key field

$ Categories#_statefieldProperty in class Categories

Name of the items state field

$ Categories#_optionsProperty in class Categories

Array of options

Categories::__construct() — Method in class Categories

Class constructor

Categories::_load() — Method in class Categories

Load method

CategoryFactory::__construct() — Method in class CategoryFactory

The namespace must be like: Joomla\Component\Content

$ CategoryNode#_pathProperty in class CategoryNode

Path from root to this category

$ CategoryNode#_allChildrenloadedProperty in class CategoryNode

Flag if all children have been loaded

$ CategoryNode#_constructorProperty in class CategoryNode

Constructor of this tree

CategoryNode::__construct() — Method in class CategoryNode

Class constructor

CategoryNode::__serialize() — Method in class CategoryNode

Serialize the node.

CategoryNode::__unserialize() — Method in class CategoryNode

Unserialize the node.

$ FtpClient#_responseCodeProperty in class FtpClient

The response code

$ FtpClient#_responseMsgProperty in class FtpClient

The response message

$ FtpClient#_connProperty in class FtpClient
$ FtpClient#_dataconnProperty in class FtpClient
$ FtpClient#_pasvProperty in class FtpClient
$ FtpClient#_responseProperty in class FtpClient
$ FtpClient#_timeoutProperty in class FtpClient
$ FtpClient#_typeProperty in class FtpClient
$ FtpClient#_autoAsciiProperty in class FtpClient
$ FtpClient#_lineEndingsProperty in class FtpClient

Array to hold native line ending characters

FtpClient::__construct() — Method in class FtpClient

FtpClient object constructor

FtpClient::__destruct() — Method in class FtpClient

FtpClient object destructor

FtpClient::_putCmd() — Method in class FtpClient

Send command to the FTP server and validate an expected response code

FtpClient::_verifyResponse() — Method in class FtpClient

Verify the response code from the server and log response if flag is set

FtpClient::_passive() — Method in class FtpClient

Set server to passive mode and open a data port connection

FtpClient::_findMode() — Method in class FtpClient

Method to find out the correct transfer mode for a specific file

FtpClient::_mode() — Method in class FtpClient

Set transfer mode

ComponentRecord::__construct() — Method in class ComponentRecord

Class constructor

ComponentRecord::__get() — Method in class ComponentRecord

Method to get certain otherwise inaccessible properties from the form field object.

ComponentRecord::__set() — Method in class ComponentRecord

Method to set certain otherwise inaccessible properties of the form field object.

RouterBase::__construct() — Method in class RouterBase

Class constructor.

RouterFactory::__construct() — Method in class RouterFactory

The namespace must be like: Joomla\Component\Content

RouterLegacy::__construct() — Method in class RouterLegacy
Constructor
RouterViewConfiguration::__construct() — Method in class RouterViewConfiguration

Constructor for the View-configuration class

MenuRules::__construct() — Method in class MenuRules

Class constructor.

NomenuRules::__construct() — Method in class NomenuRules

Class constructor.

PreprocessRules::__construct() — Method in class PreprocessRules

Class constructor.

StandardRules::__construct() — Method in class StandardRules

Class constructor.

AddUserCommand::__construct() — Method in class AddUserCommand

Command constructor.

AddUserToGroupCommand::__construct() — Method in class AddUserToGroupCommand

Command constructor.

CheckJoomlaUpdatesCommand::__construct() — Method in class CheckJoomlaUpdatesCommand

Command constructor (overridden to include the alias)

CoreUpdateChannelCommand::__construct() — Method in class CoreUpdateChannelCommand

CoreUpdateChannelCommand constructor.

DeleteUserCommand::__construct() — Method in class DeleteUserCommand

Command constructor.

ExtensionDiscoverInstallCommand::__construct() — Method in class ExtensionDiscoverInstallCommand

Instantiate the command.

ExtensionRemoveCommand::__construct() — Method in class ExtensionRemoveCommand

Command constructor.

ExtensionsListCommand::__construct() — Method in class ExtensionsListCommand

Instantiate the command.

FinderIndexCommand::__construct() — Method in class FinderIndexCommand

Instantiate the command.

ListUserCommand::__construct() — Method in class ListUserCommand

Command constructor.

WritableContainerLoader::__construct() — Method in class WritableContainerLoader
Constructor.
RemoveUserFromGroupCommand::__construct() — Method in class RemoveUserFromGroupCommand

Command constructor.

SessionMetadataGcCommand::__construct() — Method in class SessionMetadataGcCommand

Instantiate the command.

UpdateCoreCommand::__construct() — Method in class UpdateCoreCommand

UpdateCoreCommand constructor.

Date::__construct() — Method in class Date
Constructor.
Date::__get() — Method in class Date

Magic method to access properties of the date given by class to the format method.

Date::__toString() — Method in class Date

Magic method to render the date object in the format specified in the public static member Date::$format.

AbstractModuleDispatcher::__construct() — Method in class AbstractModuleDispatcher

Constructor for Dispatcher

ComponentDispatcher::__construct() — Method in class ComponentDispatcher

Constructor for ComponentDispatcher

ComponentDispatcherFactory::__construct() — Method in class ComponentDispatcherFactory

ComponentDispatcherFactory constructor.

Dispatcher::__construct() — Method in class Dispatcher

Constructor for Dispatcher

LegacyComponentDispatcher::__construct() — Method in class LegacyComponentDispatcher

Constructor for Dispatcher

ModuleDispatcherFactory::__construct() — Method in class ModuleDispatcherFactory

ModuleDispatcherFactory constructor.

$ Document#_generatorProperty in class Document

Document generator

$ Document#_mdateProperty in class Document

Document modified date

$ Document#_tabProperty in class Document

Tab string

$ Document#_lineEndProperty in class Document

Contains the line end string

$ Document#_charsetProperty in class Document

Contains the character encoding string

$ Document#_mimeProperty in class Document

Document mime type

$ Document#_namespaceProperty in class Document

Document namespace

$ Document#_profileProperty in class Document

Document profile

$ Document#_scriptsProperty in class Document

Array of linked scripts

$ Document#_scriptProperty in class Document

Array of scripts placed in the header

$ Document#_styleSheetsProperty in class Document

Array of linked style sheets

$ Document#_styleProperty in class Document

Array of included style declarations

$ Document#_metaTagsProperty in class Document

Array of meta tags

$ Document#_engineProperty in class Document

The rendering engine

$ Document#_typeProperty in class Document

The document type

$ Document#_bufferProperty in class Document

Array of buffered output

Document::__construct() — Method in class Document

Class constructor.

Document::_getLineEnd() — Method in class Document

Returns the lineEnd

Document::_getTab() — Method in class Document

Returns a string containing the unit for indenting HTML

$ DocumentRenderer#_docProperty in class DocumentRenderer

Reference to the Document object that instantiated the renderer

$ DocumentRenderer#_mimeProperty in class DocumentRenderer

Renderer mime type

DocumentRenderer::__construct() — Method in class DocumentRenderer

Class constructor

DocumentRenderer::_relToAbs() — Method in class DocumentRenderer

Convert links in a text from relative to absolute

$ ErrorDocument#_errorProperty in class ErrorDocument

Error Object

ErrorDocument::__construct() — Method in class ErrorDocument

Class constructor

FeedDocument::__construct() — Method in class FeedDocument

Class constructor

$ HtmlDocument#_linksProperty in class HtmlDocument

Array of Header <link> tags

$ HtmlDocument#_customProperty in class HtmlDocument

Array of custom tags

$ HtmlDocument#_fileProperty in class HtmlDocument

File name

$ HtmlDocument#_templateProperty in class HtmlDocument

String holding parsed template

$ HtmlDocument#_template_tagsProperty in class HtmlDocument

Array of parsed template JDoc tags

$ HtmlDocument#_cachingProperty in class HtmlDocument

Integer with caching setting

HtmlDocument::__construct() — Method in class HtmlDocument

Class constructor

HtmlDocument::_loadTemplate() — Method in class HtmlDocument

Load a template file

HtmlDocument::_fetchTemplate() — Method in class HtmlDocument

Fetch the template, and initialise the params

HtmlDocument::_parseTemplate() — Method in class HtmlDocument

Parse a document template

HtmlDocument::_renderTemplate() — Method in class HtmlDocument

Render pre-parsed template

ImageDocument::__construct() — Method in class ImageDocument

Class constructor

$ JsonDocument#_nameProperty in class JsonDocument

Document name

JsonDocument::__construct() — Method in class JsonDocument

Class constructor

JsonapiDocument::__construct() — Method in class JsonapiDocument

Class constructor

JsonapiDocument::__toString() — Method in class JsonapiDocument

Map to string.

OpensearchDocument::__construct() — Method in class OpensearchDocument

Class constructor

PreloadManager::__construct() — Method in class PreloadManager

PreloadManager constructor

RawDocument::__construct() — Method in class RawDocument

Class constructor

$ AtomRenderer#_mimeProperty in class AtomRenderer

Document mime type

$ AtomRenderer#_docProperty in class AtomRenderer

Reference to the Document object that instantiated the renderer

$ RssRenderer#_mimeProperty in class RssRenderer

Renderer mime type

$ RssRenderer#_docProperty in class RssRenderer

Reference to the Document object that instantiated the renderer

XmlDocument::__construct() — Method in class XmlDocument

Class constructor

Button::__construct() — Method in class Button

Class constructor;

Button::__get() — Method in class Button

Magic method to access a property.

Button::__set() — Method in class Button

Magic method to access property.

$ Editor#_editorProperty in class Editor

Editor Plugin object

$ Editor#_nameProperty in class Editor

Editor Plugin name

Editor::__construct() — Method in class Editor
Constructor
Editor::_loadEditor() — Method in class Editor

Load the editor

OpenSSL::__construct() — Method in class OpenSSL

Constructor for this class

Aes::__construct() — Method in class Aes

Initialise the AES encryption object.

Totp::__construct() — Method in class Totp

Initialises an RFC6238-compatible TOTP generator. Please note that this class does not implement the constraint in the last paragraph of §5.2 of RFC6238. It's up to you to ensure that the same user/device does not retry validation within the same Time Step.

Browser::__construct() — Method in class Browser

Create a browser instance (constructor).

Browser::_setPlatform() — Method in class Browser

Match the platform of the browser.

AbstractEvent::__construct() — Method in class AbstractEvent

Constructor. Overridden to go through the argument setters.

AbstractImmutableEvent::__construct() — Method in class AbstractImmutableEvent
Constructor.
ApplicationConfigurationEvent::__construct() — Method in class ApplicationConfigurationEvent
Constructor.
ApplicationDocumentEvent::__construct() — Method in class ApplicationDocumentEvent
Constructor.
ApplicationEvent::__construct() — Method in class ApplicationEvent
Constructor.
BeforeApiRouteEvent::__construct() — Method in class BeforeApiRouteEvent
Constructor.
DaemonReceiveSignalEvent::__construct() — Method in class DaemonReceiveSignalEvent
Constructor.
AfterPurgeEvent::__construct() — Method in class AfterPurgeEvent
Constructor.
CaptchaSetupEvent::__construct() — Method in class CaptchaSetupEvent
Constructor.
AfterCheckinEvent::__construct() — Method in class AfterCheckinEvent
Constructor.
SubmitContactEvent::__construct() — Method in class SubmitContactEvent
Constructor.
ValidateContactEvent::__construct() — Method in class ValidateContactEvent
Constructor.
ContentEvent::__construct() — Method in class ContentEvent
Constructor.
AbstractPrepareFieldEvent::__construct() — Method in class AbstractPrepareFieldEvent
Constructor.
AfterPrepareFieldEvent::__construct() — Method in class AfterPrepareFieldEvent
Constructor.
CustomFieldsEvent::__construct() — Method in class CustomFieldsEvent
Constructor.
PrepareDomEvent::__construct() — Method in class PrepareDomEvent
Constructor.
EditorButtonsSetupEvent::__construct() — Method in class EditorButtonsSetupEvent
Constructor.
EditorSetupEvent::__construct() — Method in class EditorSetupEvent
Constructor.
AbstractExtensionEvent::__construct() — Method in class AbstractExtensionEvent
Constructor.
AbstractJoomlaUpdateEvent::__construct() — Method in class AbstractJoomlaUpdateEvent
Constructor.
AfterInstallEvent::__construct() — Method in class AfterInstallEvent
Constructor.
AfterUninstallEvent::__construct() — Method in class AfterUninstallEvent
Constructor.
AfterUpdateEvent::__construct() — Method in class AfterUpdateEvent
Constructor.
BeforeInstallEvent::__construct() — Method in class BeforeInstallEvent
Constructor.
BeforeUninstallEvent::__construct() — Method in class BeforeUninstallEvent
Constructor.
BeforeUpdateEvent::__construct() — Method in class BeforeUpdateEvent
Constructor.
AbstractFinderEvent::__construct() — Method in class AbstractFinderEvent
Constructor.
AfterInstallerEvent::__construct() — Method in class AfterInstallerEvent
Constructor.
BeforePackageDownloadEvent::__construct() — Method in class BeforePackageDownloadEvent
Constructor.
InstallerEvent::__construct() — Method in class InstallerEvent
Constructor.
MailTemplateEvent::__construct() — Method in class MailTemplateEvent
Constructor.
AfterGetMenuTypeOptionsEvent::__construct() — Method in class AfterGetMenuTypeOptionsEvent
Constructor.
BeforeRenderMenuItemsViewEvent::__construct() — Method in class BeforeRenderMenuItemsViewEvent
Constructor.
PreprocessMenuItemsEvent::__construct() — Method in class PreprocessMenuItemsEvent
Constructor.
AfterCleanCacheEvent::__construct() — Method in class AfterCleanCacheEvent
Constructor.
BeforeBatchEvent::__construct() — Method in class BeforeBatchEvent
Constructor.
BeforeValidateDataEvent::__construct() — Method in class BeforeValidateDataEvent
Constructor.
FormEvent::__construct() — Method in class FormEvent
Constructor.
ModelEvent::__construct() — Method in class ModelEvent
Constructor.
PrepareDataEvent::__construct() — Method in class PrepareDataEvent
Constructor.
AfterRenderModulesEvent::__construct() — Method in class AfterRenderModulesEvent
Constructor.
ModuleEvent::__construct() — Method in class ModuleEvent
Constructor.
ModuleListEvent::__construct() — Method in class ModuleListEvent
Constructor.
RenderModuleEvent::__construct() — Method in class RenderModuleEvent
Constructor.
BeforeDisplayMethods::__construct() — Method in class BeforeDisplayMethods

Public constructor

Callback::__construct() — Method in class Callback

Public constructor

Captive::__construct() — Method in class Captive

Public constructor

GetMethod::__construct() — Method in class GetMethod

Public constructor

GetSetup::__construct() — Method in class GetSetup

Public constructor

NotifyActionLog::__construct() — Method in class NotifyActionLog

Public constructor

SaveSetup::__construct() — Method in class SaveSetup

Public constructor

Validate::__construct() — Method in class Validate

Public constructor

AjaxEvent::__construct() — Method in class AjaxEvent
Constructor.
BeforeCompileHeadEvent::__construct() — Method in class BeforeCompileHeadEvent
Constructor.
PrepareDataEvent::__construct() — Method in class PrepareDataEvent
Constructor.
PrepareFormEvent::__construct() — Method in class PrepareFormEvent
Constructor.
PrepareSaveEvent::__construct() — Method in class PrepareSaveEvent
Constructor.
GetStatsDataEvent::__construct() — Method in class GetStatsDataEvent
Constructor.
AjaxInitCreate::__construct() — Method in class AjaxInitCreate
Constructor
CanRemoveDataEvent::__construct() — Method in class CanRemoveDataEvent
Constructor.
CheckPrivacyPolicyPublishedEvent::__construct() — Method in class CheckPrivacyPolicyPublishedEvent
Constructor.
ExportRequestEvent::__construct() — Method in class ExportRequestEvent
Constructor.
PrivacyEvent::__construct() — Method in class PrivacyEvent
Constructor.
RemoveDataEvent::__construct() — Method in class RemoveDataEvent
Constructor.
GetIconEvent::__construct() — Method in class GetIconEvent
Constructor.
SampleDataEvent::__construct() — Method in class SampleDataEvent
Constructor.
AbstractEvent::__construct() — Method in class AbstractEvent
AfterDeleteEvent::__construct() — Method in class AfterDeleteEvent
Constructor.
AfterLoadEvent::__construct() — Method in class AfterLoadEvent
Constructor.
AfterMoveEvent::__construct() — Method in class AfterMoveEvent
Constructor.
AfterReorderEvent::__construct() — Method in class AfterReorderEvent
Constructor.
AfterStoreEvent::__construct() — Method in class AfterStoreEvent
Constructor.
BeforeBindEvent::__construct() — Method in class BeforeBindEvent
Constructor.
BeforeCheckinEvent::__construct() — Method in class BeforeCheckinEvent
Constructor.
BeforeCheckoutEvent::__construct() — Method in class BeforeCheckoutEvent
Constructor.
BeforeDeleteEvent::__construct() — Method in class BeforeDeleteEvent
Constructor.
BeforeLoadEvent::__construct() — Method in class BeforeLoadEvent
Constructor.
BeforeMoveEvent::__construct() — Method in class BeforeMoveEvent
Constructor.
BeforePublishEvent::__construct() — Method in class BeforePublishEvent
Constructor.
BeforeReorderEvent::__construct() — Method in class BeforeReorderEvent
Constructor.
BeforeStoreEvent::__construct() — Method in class BeforeStoreEvent
Constructor.
SetNewTagsEvent::__construct() — Method in class SetNewTagsEvent
Constructor.
AbstractLoginEvent::__construct() — Method in class AbstractLoginEvent
Constructor.
AbstractLogoutEvent::__construct() — Method in class AbstractLogoutEvent
Constructor.
AbstractSaveEvent::__construct() — Method in class AbstractSaveEvent
Constructor.
AfterDeleteEvent::__construct() — Method in class AfterDeleteEvent
Constructor.
AfterSaveEvent::__construct() — Method in class AfterSaveEvent
Constructor.
AuthenticationEvent::__construct() — Method in class AuthenticationEvent
Constructor.
UserEvent::__construct() — Method in class UserEvent
Constructor.
DisplayEvent::__construct() — Method in class DisplayEvent
Constructor.
AbstractEvent::__construct() — Method in class AbstractEvent
Constructor.
WebAssetRegistryAssetChanged::__construct() — Method in class WebAssetRegistryAssetChanged
Constructor.
AbstractEvent::__construct() — Method in class AbstractEvent
Constructor.
WorkflowFunctionalityUsedEvent::__construct() — Method in class WorkflowFunctionalityUsedEvent
Constructor.
WorkflowTransitionEvent::__construct() — Method in class WorkflowTransitionEvent
Constructor.
Component::__construct() — Method in class Component

Component constructor.

LegacyComponent::__construct() — Method in class LegacyComponent

LegacyComponentContainer constructor.

Module::__construct() — Method in class Module

Module constructor.

CategoryFactory::__construct() — Method in class CategoryFactory

The namespace must be like: Joomla\Component\Content

ComponentDispatcherFactory::__construct() — Method in class ComponentDispatcherFactory

ComponentDispatcherFactory constructor.

HelperFactory::__construct() — Method in class HelperFactory

HelperFactory constructor.

MVCFactory::__construct() — Method in class MVCFactory

MVCFactory constructor.

ModuleDispatcherFactory::__construct() — Method in class ModuleDispatcherFactory

ComponentDispatcherFactory constructor.

RouterFactory::__construct() — Method in class RouterFactory

DispatcherFactory constructor.

Feed::__get() — Method in class Feed

Magic method to return values for feed properties.

Feed::__set() — Method in class Feed

Magic method to set values for feed properties.

FeedEntry::__get() — Method in class FeedEntry

Magic method to return values for feed entry properties.

FeedEntry::__set() — Method in class FeedEntry

Magic method to set values for feed properties.

FeedLink::__construct() — Method in class FeedLink
Constructor.
FeedParser::__construct() — Method in class FeedParser
Constructor.
FeedPerson::__construct() — Method in class FeedPerson
Constructor.
Folder::_items() — Method in class Folder

Function to read the files/folders in a folder.

Patcher::__construct() — Method in class Patcher
Constructor
Stream::__construct() — Method in class Stream
Constructor
Stream::__destruct() — Method in class Stream
Destructor
Stream::_buildContext() — Method in class Stream

Stream contexts Builds the context from the array

Stream::_getFilename() — Method in class Stream

Determine the appropriate 'filename' of a file

StringController::_getArray() — Method in class StringController

Defines a variable as an array

InputFilter::__construct() — Method in class InputFilter

Constructor for inputFilter class. Only first parameter is required.

AccessiblemediaField::__get() — Method in class AccessiblemediaField

Method to get certain otherwise inaccessible properties from the form field object.

AccessiblemediaField::__set() — Method in class AccessiblemediaField

Method to set certain otherwise inaccessible properties of the form field object.

CalendarField::__get() — Method in class CalendarField

Method to get certain otherwise inaccessible properties from the form field object.

CalendarField::__set() — Method in class CalendarField

Method to set certain otherwise inaccessible properties of the form field object.

$ CaptchaField#_captchaProperty in class CaptchaField

The captcha base instance of our type.

CaptchaField::__get() — Method in class CaptchaField

Method to get certain otherwise inaccessible properties from the form field object.

CaptchaField::__set() — Method in class CaptchaField

Method to set certain otherwise inaccessible properties of the form field object.

CheckboxField::__get() — Method in class CheckboxField

Method to get certain otherwise inaccessible properties from the form field object.

CheckboxField::__set() — Method in class CheckboxField

Method to set certain otherwise inaccessible properties of the form field object.

CheckboxesField::__get() — Method in class CheckboxesField

Method to get certain otherwise inaccessible properties from the form field object.

CheckboxesField::__set() — Method in class CheckboxesField

Method to set certain otherwise inaccessible properties of the form field object.

ChromestyleField::__get() — Method in class ChromestyleField

Method to get certain otherwise inaccessible properties from the form field object.

ChromestyleField::__set() — Method in class ChromestyleField

Method to set certain otherwise inaccessible properties of the form field object.

ColorField::__get() — Method in class ColorField

Method to get certain otherwise inaccessible properties from the form field object.

ColorField::__set() — Method in class ColorField

Method to set certain otherwise inaccessible properties of the form field object.

EditorField::__get() — Method in class EditorField

Method to get certain otherwise inaccessible properties from the form field object.

EditorField::__set() — Method in class EditorField

Method to set certain otherwise inaccessible properties of the form field object.

FileField::__get() — Method in class FileField

Method to get certain otherwise inaccessible properties from the form field object.

FileField::__set() — Method in class FileField

Method to set certain otherwise inaccessible properties of the form field object.

FilelistField::__get() — Method in class FilelistField

Method to get certain otherwise inaccessible properties from the form field object.

FilelistField::__set() — Method in class FilelistField

Method to set certain otherwise inaccessible properties of the form field object.

FolderlistField::__get() — Method in class FolderlistField

Method to get certain otherwise inaccessible properties from the form field object.

FolderlistField::__set() — Method in class FolderlistField

Method to set certain otherwise inaccessible properties of the form field object.

LastvisitdaterangeField::__construct() — Method in class LastvisitdaterangeField

Method to instantiate the form field object.

ListField::__get() — Method in class ListField

Method to get certain otherwise inaccessible properties from the form field object.

MediaField::__get() — Method in class MediaField

Method to get certain otherwise inaccessible properties from the form field object.

MediaField::__set() — Method in class MediaField

Method to set certain otherwise inaccessible properties of the form field object.

MenuitemField::__get() — Method in class MenuitemField

Method to get certain otherwise inaccessible properties from the form field object.

MenuitemField::__set() — Method in class MenuitemField

Method to set certain otherwise inaccessible properties of the form field object.

MeterField::__get() — Method in class MeterField

Method to get certain otherwise inaccessible properties from the form field object.

MeterField::__set() — Method in class MeterField

Method to set certain otherwise inaccessible properties of the form field object.

ModalSelectField::__get() — Method in class ModalSelectField

Method to get certain otherwise inaccessible properties from the form field object.

ModalSelectField::__set() — Method in class ModalSelectField

Method to set certain otherwise inaccessible properties of the form field object.

ModuleorderField::__get() — Method in class ModuleorderField

Method to get certain otherwise inaccessible properties from the form field object.

ModuleorderField::__set() — Method in class ModuleorderField

Method to set certain otherwise inaccessible properties of the form field object.

ModulepositionField::__get() — Method in class ModulepositionField

Method to get certain otherwise inaccessible properties from the form field object.

ModulepositionField::__set() — Method in class ModulepositionField

Method to set certain otherwise inaccessible properties of the form field object.

NumberField::__get() — Method in class NumberField

Method to get certain otherwise inaccessible properties from the form field object.

NumberField::__set() — Method in class NumberField

Method to set certain otherwise inaccessible properties of the form field object.

OrderingField::__get() — Method in class OrderingField

Method to get certain otherwise inaccessible properties from the form field object.

OrderingField::__set() — Method in class OrderingField

Method to set certain otherwise inaccessible properties of the form field object.

PasswordField::__get() — Method in class PasswordField

Method to get certain otherwise inaccessible properties from the form field object.

PasswordField::__set() — Method in class PasswordField

Method to set certain otherwise inaccessible properties of the form field object.

PluginsField::__get() — Method in class PluginsField

Method to get certain otherwise inaccessible properties from the form field object.

PluginsField::__set() — Method in class PluginsField

Method to set certain otherwise inaccessible properties of the form field object.

RegistrationdaterangeField::__construct() — Method in class RegistrationdaterangeField

Method to instantiate the form field object.

RulesField::__get() — Method in class RulesField

Method to get certain otherwise inaccessible properties from the form field object.

RulesField::__set() — Method in class RulesField

Method to set certain otherwise inaccessible properties of the form field object.

SqlField::__get() — Method in class SqlField

Method to get certain otherwise inaccessible properties from the form field object.

SqlField::__set() — Method in class SqlField

Method to set certain otherwise inaccessible properties of the form field object.

SubformField::__get() — Method in class SubformField

Method to get certain otherwise inaccessible properties from the form field object.

SubformField::__set() — Method in class SubformField

Method to set certain otherwise inaccessible properties of the form field object.

TagField::__construct() — Method in class TagField
Constructor
TemplatestyleField::__get() — Method in class TemplatestyleField

Method to get certain otherwise inaccessible properties from the form field object.

TemplatestyleField::__set() — Method in class TemplatestyleField

Method to set certain otherwise inaccessible properties of the form field object.

TextField::__get() — Method in class TextField

Method to get certain otherwise inaccessible properties from the form field object.

TextField::__set() — Method in class TextField

Method to set certain otherwise inaccessible properties of the form field object.

TextareaField::__get() — Method in class TextareaField

Method to get certain otherwise inaccessible properties from the form field object.

TextareaField::__set() — Method in class TextareaField

Method to set certain otherwise inaccessible properties of the form field object.

TimeField::__set() — Method in class TimeField

Method to set certain otherwise inaccessible properties of the form field object.

TimeField::__get() — Method in class TimeField

Method to get certain otherwise inaccessible properties from the form field object.

TimezoneField::__get() — Method in class TimezoneField

Method to get certain otherwise inaccessible properties from the form field object.

TimezoneField::__set() — Method in class TimezoneField

Method to set certain otherwise inaccessible properties of the form field object.

UseractiveField::__construct() — Method in class UseractiveField

Method to instantiate the form field object.

Form::__construct() — Method in class Form

Method to instantiate the form object.

FormField::__construct() — Method in class FormField

Method to instantiate the form field object.

FormField::__get() — Method in class FormField

Method to get certain otherwise inaccessible properties from the form field object.

FormField::__set() — Method in class FormField

Method to set certain otherwise inaccessible properties of the form field object.

HTMLHelper::_() — Method in class HTMLHelper

Class loader method

Grid::_checkedOut() — Method in class Grid

Method to create a checked out icon with optional overlib in a grid.

HelperFactory::__construct() — Method in class HelperFactory

HelperFactory constructor.

UserGroupsHelper::__construct() — Method in class UserGroupsHelper
Constructor
Http::__construct() — Method in class Http
Constructor.
Image::__construct() — Method in class Image

Class constructor.

Image::__destruct() — Method in class Image

Method to call the destroy() method one last time to free any memory when the object is unset

ImageFilter::__construct() — Method in class ImageFilter

Class constructor.

Cli::__construct() — Method in class Cli
Constructor.
Cookie::__construct() — Method in class Cookie
Constructor.
Files::__construct() — Method in class Files

The class constructor.

Input::__construct() — Method in class Input
Constructor.
Input::__get() — Method in class Input

Magic method to get an input object

Json::__construct() — Method in class Json
Constructor.
ComponentAdapter::_buildAdminMenus() — Method in class ComponentAdapter

Method to build menu database entries for a component

ComponentAdapter::_removeAdminMenus() — Method in class ComponentAdapter

Method to remove admin menu references to a component

ComponentAdapter::_updateSiteMenus() — Method in class ComponentAdapter

Method to update menu database entries for a component in case the component has been uninstalled before.

ComponentAdapter::_updateMenus() — Method in class ComponentAdapter

Method to update menu database entries for a component in case if the component has been uninstalled before.

ComponentAdapter::_rollback_menu() — Method in class ComponentAdapter

Custom rollback method

  • Roll back the component menu item
ComponentAdapter::_createAdminMenuItem() — Method in class ComponentAdapter

Creates the menu item in the database. If the item already exists it tries to remove it and create it afresh.

LanguageAdapter::_install() — Method in class LanguageAdapter

Install function that is designed to handle individual clients

ModuleAdapter::_rollback_menu() — Method in class ModuleAdapter

Custom rollback method

  • Roll back the menu item
ModuleAdapter::_rollback_module() — Method in class ModuleAdapter

Custom rollback method

  • Roll back the module item
PackageAdapter::_getExtensionId() — Method in class PackageAdapter

Gets the extension id.

Installer::__construct() — Method in class Installer
Constructor
InstallerAdapter::__construct() — Method in class InstallerAdapter
Constructor
InstallerAdapter::__get() — Method in class InstallerAdapter

Proxy for db variable.

InstallerExtension::__construct() — Method in class InstallerExtension
Constructor
LegacyInstallerScript::__construct() — Method in class LegacyInstallerScript
LegacyInstallerScript::__set() — Method in class LegacyInstallerScript

Sets the variable to the internal script.

LegacyInstallerScript::__get() — Method in class LegacyInstallerScript

Returns the variable from the internal script.

LegacyInstallerScript::__call() — Method in class LegacyInstallerScript

Calls the function with the given name on the internal script with the given name and arguments.

$ Manifest#_errorsProperty in class Manifest

The error messages

Manifest::__construct() — Method in class Manifest
Constructor
Language::__construct() — Method in class Language

Constructor activating the default information of the language.

Language::_() — Method in class Language

Translate function, mimics the php gettext (alias _) function.

Text::_() — Method in class Text

Translates a string into the current language.

FileLayout::__construct() — Method in class FileLayout

Method to instantiate the file-based layout.

DelegatingPsrLogger::__construct() — Method in class DelegatingPsrLogger
Constructor.
Log::__construct() — Method in class Log
Constructor.
LogEntry::__construct() — Method in class LogEntry
Constructor
Logger::__construct() — Method in class Logger
Constructor.
CallbackLogger::__construct() — Method in class CallbackLogger
Constructor.
DatabaseLogger::__construct() — Method in class DatabaseLogger
Constructor.
EchoLogger::__construct() — Method in class EchoLogger
Constructor.
FormattedtextLogger::__construct() — Method in class FormattedtextLogger
Constructor.
FormattedtextLogger::__destruct() — Method in class FormattedtextLogger

If deferred, write all pending logs.

FormattedtextLogger::__wakeup() — Method in class FormattedtextLogger

Prevent object injection attacks by suppressing unserialization of instance with deferred rows

InMemoryLogger::__construct() — Method in class InMemoryLogger
Constructor.
SyslogLogger::__construct() — Method in class SyslogLogger
Constructor.
SyslogLogger::__destruct() — Method in class SyslogLogger
Destructor.
W3cLogger::__construct() — Method in class W3cLogger
Constructor.
AdminController::__construct() — Method in class AdminController
Constructor.
ApiController::__construct() — Method in class ApiController
Constructor.
BaseController::__construct() — Method in class BaseController
Constructor.
FormController::__construct() — Method in class FormController
Constructor.
MVCFactory::__construct() — Method in class MVCFactory

The namespace must be like: Joomla\Component\Content

AdminModel::__construct() — Method in class AdminModel
Constructor.
BaseDatabaseModel::__construct() — Method in class BaseDatabaseModel
Constructor
BaseDatabaseModel::_getList() — Method in class BaseDatabaseModel

Gets an array of objects from the results of database query.

BaseDatabaseModel::_getListCount() — Method in class BaseDatabaseModel

Returns a record count for the query.

BaseDatabaseModel::_createTable() — Method in class BaseDatabaseModel

Method to load and return a table object.

BaseDatabaseModel::__get() — Method in class BaseDatabaseModel

Proxy for _db variable.

BaseModel::__construct() — Method in class BaseModel
Constructor
$ DatabaseAwareTrait#_dbProperty in class DatabaseAwareTrait

The database driver.

$ FormBehaviorTrait#_formsProperty in class FormBehaviorTrait

Array of form objects.

FormModel::__construct() — Method in class FormModel
Constructor
$ ItemModel#_itemProperty in class ItemModel

An item.

$ ItemModel#_contextProperty in class ItemModel

Model context string.

LegacyModelLoaderTrait::_createFileName() — Method in class LegacyModelLoaderTrait

Create the filename for a resource

ListModel::__construct() — Method in class ListModel
Constructor
ListModel::_getListQuery() — Method in class ListModel

Method to cache the last query constructed.

State::__construct() — Method in class State
Constructor
State::__get() — Method in class State

Proxy for internal data access for the given name.

State::__set() — Method in class State

Proxy for internal data storage for the given name and value.

State::__isset() — Method in class State

Proxy for internal data check for a variable with the given key.

$ StateBehaviorTrait#__state_setProperty in class StateBehaviorTrait

Indicates if the internal state has been set

$ AbstractView#_nameProperty in class AbstractView

The name of the view

$ AbstractView#_modelsProperty in class AbstractView

Registered models

$ AbstractView#_defaultModelProperty in class AbstractView

The default model

AbstractView::__construct() — Method in class AbstractView
Constructor
CanDo::__construct() — Method in class CanDo
Constructor
CanDo::__get() — Method in class CanDo

Proxy for internal data access for the given name.

CanDo::__set() — Method in class CanDo

Proxy for internal data storage for the given name and value.

CanDo::__isset() — Method in class CanDo

Proxy for internal data check for a variable with the given key.

OnGetApiFields::__construct() — Method in class OnGetApiFields
Constructor.
FormView::__construct() — Method in class FormView
Constructor
$ HtmlView#_basePathProperty in class HtmlView

The base path of the view

$ HtmlView#_layoutProperty in class HtmlView

Layout name

$ HtmlView#_layoutExtProperty in class HtmlView

Layout extension

$ HtmlView#_layoutTemplateProperty in class HtmlView

Layout template

$ HtmlView#_pathProperty in class HtmlView

The set of search directories for resources (templates)

$ HtmlView#_templateProperty in class HtmlView

The name of the default template source file.

$ HtmlView#_outputProperty in class HtmlView

The output of the template script.

$ HtmlView#_charsetProperty in class HtmlView

Charset to use in escaping mechanisms; defaults to urf8 (UTF-8)

HtmlView::__construct() — Method in class HtmlView
Constructor
HtmlView::_setPath() — Method in class HtmlView

Sets an entire array of search paths for templates or resources.

HtmlView::_addPath() — Method in class HtmlView

Adds to the search path for templates and resources.

HtmlView::_createFileName() — Method in class HtmlView

Create the filename for a resource

JsonApiView::__construct() — Method in class JsonApiView
Constructor.
$ JsonView#_basePathProperty in class JsonView

The base path of the view

$ JsonView#_charsetProperty in class JsonView

Charset to use in escaping mechanisms; defaults to urf8 (UTF-8)

$ JsonView#_outputProperty in class JsonView

The output of the view.

JsonView::__construct() — Method in class JsonView
Constructor
ListView::__construct() — Method in class ListView
Constructor
MailDisabledException::__construct() — Method in class MailDisabledException
Constructor.
Mail::__construct() — Method in class Mail
Constructor
MailTemplate::__construct() — Method in class MailTemplate

Constructor for the mail templating class

MailerFactory::__construct() — Method in class MailerFactory

The MailerFactory constructor.

AbstractMenu::__construct() — Method in class AbstractMenu

Class constructor

AbstractMenu::__get() — Method in class AbstractMenu

Magic getter for the user object. Returns the injected one if any, or the current one if none.

MenuItem::__construct() — Method in class MenuItem

Class constructor

SiteMenu::__construct() — Method in class SiteMenu

Class constructor

Microdata::__construct() — Method in class Microdata

Initialize the class and setup the default $Type

CMSObject::__construct() — Method in class CMSObject

Class constructor, overridden in descendant classes.

CMSObject::__toString() — Method in class CMSObject

Magic method to convert the object to a string gracefully.

$ LegacyErrorHandlingTrait#_errorsProperty in class LegacyErrorHandlingTrait

An array of error messages or Exception objects.

Pagination::__construct() — Method in class Pagination
Constructor.
Pagination::_list_footer() — Method in class Pagination

Create the HTML for a list footer

Pagination::_list_render() — Method in class Pagination

Create the html for a list footer

Pagination::_item_active() — Method in class Pagination

Method to create an active pagination link to the item

Pagination::_item_inactive() — Method in class Pagination

Method to create an inactive pagination string

Pagination::_buildDataObject() — Method in class Pagination

Create and return the pagination data object.

PaginationObject::__construct() — Method in class PaginationObject

Class constructor.

SitePathway::__construct() — Method in class SitePathway

Class constructor.

$ CMSPlugin#_nameProperty in class CMSPlugin

The name of the plugin

$ CMSPlugin#_typeProperty in class CMSPlugin

The plugin type

CMSPlugin::__construct() — Method in class CMSPlugin
Constructor
Profiler::__construct() — Method in class Profiler
Constructor
ArrayProxy::__construct() — Method in class ArrayProxy

Class constructor

ObjectProxy::__construct() — Method in class ObjectProxy

Class constructor

ObjectProxy::__get() — Method in class ObjectProxy

Implementing reading from object

ObjectProxy::__set() — Method in class ObjectProxy

Implementing writing to object

ObjectReadOnlyProxy::__get() — Method in class ObjectReadOnlyProxy

Implementing reading from object

ObjectReadOnlyProxy::__set() — Method in class ObjectReadOnlyProxy

Implementing writing to object

JsonResponse::__construct() — Method in class JsonResponse
Constructor
JsonResponse::__toString() — Method in class JsonResponse

Magic toString method for sending the response in JSON format

ApiRouter::__construct() — Method in class ApiRouter
Constructor.
RouteNotFoundException::__construct() — Method in class RouteNotFoundException
Constructor
Route::_() — Method in class Route

Translates an internal Joomla URL to a humanly readable URL. This method builds links for the current active client.

SiteRouter::__construct() — Method in class SiteRouter

Class constructor

ChangeItem::__construct() — Method in class ChangeItem

Constructor: builds check query and message from $updateQuery

ChangeSet::__construct() — Method in class ChangeSet

Constructor: builds array of $changeItems by processing the .sql files in a folder.

OnGetApiAttributes::__construct() — Method in class OnGetApiAttributes
Constructor.
OnGetApiRelation::__construct() — Method in class OnGetApiRelation
Constructor.
JoomlaSerializer::__construct() — Method in class JoomlaSerializer
Constructor.
MetadataManagerListener::__construct() — Method in class MetadataManagerListener
Constructor.
MetadataManager::__construct() — Method in class MetadataManager

MetadataManager constructor.

Session::__construct() — Method in class Session
Constructor
SessionManager::__construct() — Method in class SessionManager

SessionManager constructor.

JoomlaStorage::__construct() — Method in class JoomlaStorage
Constructor
StringableInterface::__toString() — Method in class StringableInterface

To String magick.

DatabaseStorage::__construct() — Method in class DatabaseStorage

Initialize the DatabaseStorage class

HttpLoader::__construct() — Method in class HttpLoader
TufFetcher::__construct() — Method in class TufFetcher

Validating updates with TUF

Asset::__construct() — Method in class Asset
Constructor
$ Category#_supportNullValueProperty in class Category

Indicates that columns fully support the NULL value in the database

Category::__construct() — Method in class Category
Constructor
Category::_getAssetName() — Method in class Category

Method to compute the default name of the asset.

Category::_getAssetTitle() — Method in class Category

Method to return the title to use for the asset table.

Category::_getAssetParentId() — Method in class Category

Get the parent asset id for the record

$ Content#_supportNullValueProperty in class Content

Indicates that columns fully support the NULL value in the database

Content::__construct() — Method in class Content
Constructor
Content::_getAssetName() — Method in class Content

Method to compute the default name of the asset.

Content::_getAssetTitle() — Method in class Content

Method to return the title to use for the asset table.

Content::_getAssetParentId() — Method in class Content

Method to get the parent asset id for the record

ContentHistory::__construct() — Method in class ContentHistory
Constructor
ContentType::__construct() — Method in class ContentType
Constructor
$ CoreContent#_supportNullValueProperty in class CoreContent

Indicates that columns fully support the NULL value in the database

$ CoreContent#_jsonEncodeProperty in class CoreContent

An array of key names to be json encoded in the bind method

CoreContent::__construct() — Method in class CoreContent
Constructor
$ Extension#_supportNullValueProperty in class Extension

Indicates that columns fully support the NULL value in the database

$ Extension#_jsonEncodeProperty in class Extension

Ensure the params are json encoded in the bind method

Extension::__construct() — Method in class Extension
Constructor
Language::__construct() — Method in class Language
Constructor
Language::_getAssetName() — Method in class Language

Method to compute the default name of the asset.

Language::_getAssetTitle() — Method in class Language

Method to return the title to use for the asset table.

Language::_getAssetParentId() — Method in class Language

Method to get the parent asset under which to register this one.

$ Menu#_supportNullValueProperty in class Menu

Indicates that columns fully support the NULL value in the database

Menu::__construct() — Method in class Menu
Constructor
MenuType::__construct() — Method in class MenuType
Constructor
MenuType::_getAssetName() — Method in class MenuType

Method to compute the default name of the asset.

MenuType::_getAssetTitle() — Method in class MenuType

Method to return the title to use for the asset table.

MenuType::_getAssetParentId() — Method in class MenuType

Method to get the parent asset under which to register this one.

$ Module#_supportNullValueProperty in class Module

Indicates that columns fully support the NULL value in the database

Module::__construct() — Method in class Module
Constructor.
Module::_getAssetName() — Method in class Module

Method to compute the default name of the asset.

Module::_getAssetTitle() — Method in class Module

Method to return the title to use for the asset table.

Module::_getAssetParentId() — Method in class Module

Method to get the parent asset id for the record

$ Nested#_locationProperty in class Nested

Object property to hold the location type to use when storing the row.

$ Nested#_location_idProperty in class Nested

Object property to hold the primary key of the location reference node to use when storing the row.

$ Nested#_cacheProperty in class Nested

An array to cache values in recursive processes.

$ Nested#_debugProperty in class Nested

Debug level

Nested::_getNode() — Method in class Nested

Method to get nested set properties for a node in the tree.

Nested::_getTreeRepositionData() — Method in class Nested

Method to get various data necessary to make room in the tree at a location for a node and its children. The returned data object includes conditions for SQL WHERE clauses for updating left and right id values to make room for the node as well as the new left and right ids for the node.

Nested::_logtable() — Method in class Nested

Method to create a log table in the buffer optionally showing the query and/or data.

Nested::_runQuery() — Method in class Nested

Runs a query and unlocks the database on an error.

$ Table#_tblProperty in class Table

Name of the database table to model.

$ Table#_tbl_keyProperty in class Table

Name of the primary key field in the table.

$ Table#_tbl_keysProperty in class Table

Name of the primary key fields in the table.

$ Table#_dbProperty in class Table

DatabaseDriver object.

$ Table#_trackAssetsProperty in class Table

Should rows be tracked as ACL assets?

$ Table#_rulesProperty in class Table

The rules associated with this record.

$ Table#_lockedProperty in class Table

Indicator that the tables have been locked.

$ Table#_autoincrementProperty in class Table

Indicates that the primary keys autoincrement.

$ Table#_columnAliasProperty in class Table

Array with alias for "special" columns such as ordering, hits etc etc

$ Table#_jsonEncodeProperty in class Table

An array of key names to be json encoded in the bind function

$ Table#_supportNullValueProperty in class Table

Indicates that columns fully support the NULL value in the database

Table::__construct() — Method in class Table

Object constructor to set table and key fields. In most cases this will be overridden by child classes to explicitly set the table and key fields for a particular database table.

Table::_getAssetName() — Method in class Table

Method to compute the default name of the asset.

Table::_getAssetTitle() — Method in class Table

Method to return the title to use for the asset table.

Table::_getAssetParentId() — Method in class Table

Method to get the parent asset under which to register this one.

Table::_lock() — Method in class Table

Method to lock the database table for writing.

Table::_unlock() — Method in class Table

Method to unlock the database table for writing.

Tuf::__construct() — Method in class Tuf
Constructor
Ucm::__construct() — Method in class Ucm
Constructor
$ Update#_jsonEncodeProperty in class Update

Ensure the params are json encoded in the bind method

Update::__construct() — Method in class Update
Constructor
UpdateSite::__construct() — Method in class UpdateSite
Constructor
$ User#_supportNullValueProperty in class User

Indicates that columns fully support the NULL value in the database

User::__construct() — Method in class User
Constructor
Usergroup::__construct() — Method in class Usergroup
Constructor
ViewLevel::__construct() — Method in class ViewLevel
Constructor
ConfirmButton::_getCommand() — Method in class ConfirmButton

Get the JavaScript command for the button

HelpButton::_getCommand() — Method in class HelpButton

Get the JavaScript command for the button

StandardButton::_getCommand() — Method in class StandardButton

Get the JavaScript command for the button

$ Toolbar#_nameProperty in class Toolbar

Toolbar name

$ Toolbar#_barProperty in class Toolbar

Toolbar array

$ Toolbar#_buttonPathProperty in class Toolbar

Directories, where button types can be stored.

Toolbar::__construct() — Method in class Toolbar
Constructor
Toolbar::__call() — Method in class Toolbar

Magic method proxy.

ToolbarButton::__construct() — Method in class ToolbarButton

Init this class.

ToolbarButton::__call() — Method in class ToolbarButton

Magiix method to adapt option accessors.

$ ImmutableNodeTrait#_parentProperty in class ImmutableNodeTrait

Parent node object

$ ImmutableNodeTrait#_childrenProperty in class ImmutableNodeTrait

Array of Children

$ ImmutableNodeTrait#_leftSiblingProperty in class ImmutableNodeTrait

Node left of this one

$ ImmutableNodeTrait#_rightSiblingProperty in class ImmutableNodeTrait

Node right of this one

UCMBase::__construct() — Method in class UCMBase

Instantiate the UCMBase.

UCMContent::__construct() — Method in class UCMContent

Instantiate UCMContent.

UCMType::__construct() — Method in class UCMType

Class constructor

UCMType::__get() — Method in class UCMType

Magic method to get the name of the field mapped to an ucm field (core_something).

CollectionAdapter::_getStackLocation() — Method in class CollectionAdapter

Gets the reference to the current direct parent

CollectionAdapter::_getParent() — Method in class CollectionAdapter

Get the parent tag

CollectionAdapter::_startElement() — Method in class CollectionAdapter

Opening an XML element

CollectionAdapter::_endElement() — Method in class CollectionAdapter

Closing an XML element Note: This is a protected function though has to be exposed externally as a callback

ExtensionAdapter::_startElement() — Method in class ExtensionAdapter

Start element parser callback.

ExtensionAdapter::_endElement() — Method in class ExtensionAdapter

Character Parser Function

ExtensionAdapter::_characterData() — Method in class ExtensionAdapter

Character Parser Function

ConstraintChecker::__construct() — Method in class ConstraintChecker

Constructor, used to populate the failed

Update::_getStackLocation() — Method in class Update

Gets the reference to the current direct parent

Update::_getLastTag() — Method in class Update

Get the last position in stack count

Update::_startElement() — Method in class Update

XML Start Element callback

Update::_endElement() — Method in class Update

Callback for closing the element

Update::_characterData() — Method in class Update

Character Parser Function

$ UpdateAdapter#_urlProperty in class UpdateAdapter

The update site URL from which we will get the update information

UpdateAdapter::_getStackLocation() — Method in class UpdateAdapter

Gets the reference to the current direct parent

UpdateAdapter::_getLastTag() — Method in class UpdateAdapter

Gets the reference to the last tag

Updater::__construct() — Method in class Updater
Constructor
$ User#_paramsProperty in class User

User parameters

$ User#_authGroupsProperty in class User

Authorised access groups

$ User#_authLevelsProperty in class User

Authorised access levels

$ User#_authActionsProperty in class User

Authorised access actions

$ User#_errorMsgProperty in class User

Error message

User::__construct() — Method in class User

Constructor activating the default information of the language

User::__sleep() — Method in class User

Method to allow serialize the object with minimal properties.

User::__wakeup() — Method in class User

Method to recover the full object on unserialize.

UserFactory::__construct() — Method in class UserFactory

UserFactory constructor.

LangActiveAssetItem::__construct() — Method in class LangActiveAssetItem

Class constructor

WebAssetItem::__construct() — Method in class WebAssetItem

Class constructor

WebAssetManager::__construct() — Method in class WebAssetManager

Class constructor

WebAssetManager::__call() — Method in class WebAssetManager

Adds support for magic method calls

WebAssetRegistry::__construct() — Method in class WebAssetRegistry

Registry constructor

Server::__construct() — Method in class Server
Constructor
Workflow::__construct() — Method in class Workflow

Class constructor

PasswordHash::__construct() — Method in class PasswordHash
__TwigTemplate_0bf62896b95c7e97cd0f4eae5f5f6195Class in namespace [Global Namespace]
__TwigTemplate_0bf62896b95c7e97cd0f4eae5f5f6195::__construct() — Method in class __TwigTemplate_0bf62896b95c7e97cd0f4eae5f5f6195
__TwigTemplate_3994fb5d5d826575e5e068ab43919da3Class in namespace [Global Namespace]
__TwigTemplate_3994fb5d5d826575e5e068ab43919da3::__construct() — Method in class __TwigTemplate_3994fb5d5d826575e5e068ab43919da3
__TwigTemplate_4bcccb9f0894179cb357804bda58e4b3Class in namespace [Global Namespace]
__TwigTemplate_4bcccb9f0894179cb357804bda58e4b3::__construct() — Method in class __TwigTemplate_4bcccb9f0894179cb357804bda58e4b3
__TwigTemplate_5043402560718bb1c61e09b845b77e36Class in namespace [Global Namespace]
__TwigTemplate_5043402560718bb1c61e09b845b77e36::__construct() — Method in class __TwigTemplate_5043402560718bb1c61e09b845b77e36
__TwigTemplate_79fb764e9da8ea996f0ce34ace2da336Class in namespace [Global Namespace]
__TwigTemplate_79fb764e9da8ea996f0ce34ace2da336::__construct() — Method in class __TwigTemplate_79fb764e9da8ea996f0ce34ace2da336
__TwigTemplate_85e091843a2d5eb6b1597c2f89e0752cClass in namespace [Global Namespace]
__TwigTemplate_85e091843a2d5eb6b1597c2f89e0752c::__construct() — Method in class __TwigTemplate_85e091843a2d5eb6b1597c2f89e0752c
__TwigTemplate_896e1a17f0353adb41deb8b45210ae94Class in namespace [Global Namespace]
__TwigTemplate_896e1a17f0353adb41deb8b45210ae94::__construct() — Method in class __TwigTemplate_896e1a17f0353adb41deb8b45210ae94
__TwigTemplate_93a051471fb2bd8bc386b2041ff7ba2bClass in namespace [Global Namespace]
__TwigTemplate_93a051471fb2bd8bc386b2041ff7ba2b::__construct() — Method in class __TwigTemplate_93a051471fb2bd8bc386b2041ff7ba2b
__TwigTemplate_959903b26cb0d471d240abcbd9524242Class in namespace [Global Namespace]
__TwigTemplate_959903b26cb0d471d240abcbd9524242::__construct() — Method in class __TwigTemplate_959903b26cb0d471d240abcbd9524242
__TwigTemplate_a53d5b9a592c30f5292fdf2cf5daaf44Class in namespace [Global Namespace]
__TwigTemplate_a53d5b9a592c30f5292fdf2cf5daaf44::__construct() — Method in class __TwigTemplate_a53d5b9a592c30f5292fdf2cf5daaf44
__TwigTemplate_acdad90fc61f5e474deb98262a7dc3ebClass in namespace [Global Namespace]
__TwigTemplate_acdad90fc61f5e474deb98262a7dc3eb::__construct() — Method in class __TwigTemplate_acdad90fc61f5e474deb98262a7dc3eb
__TwigTemplate_adbbf7f4f8572fd945270d87a68752a6Class in namespace [Global Namespace]
__TwigTemplate_adbbf7f4f8572fd945270d87a68752a6::__construct() — Method in class __TwigTemplate_adbbf7f4f8572fd945270d87a68752a6
__TwigTemplate_bc6db32d62004a1677f9a4af03635305Class in namespace [Global Namespace]
__TwigTemplate_bc6db32d62004a1677f9a4af03635305::__construct() — Method in class __TwigTemplate_bc6db32d62004a1677f9a4af03635305
__TwigTemplate_ebd3ded38a1374cfcb2671eaa14a1d29Class in namespace [Global Namespace]
__TwigTemplate_ebd3ded38a1374cfcb2671eaa14a1d29::__construct() — Method in class __TwigTemplate_ebd3ded38a1374cfcb2671eaa14a1d29
__TwigTemplate_f39bca71236ed63ca7b7b0f776c66525Class in namespace [Global Namespace]
__TwigTemplate_f39bca71236ed63ca7b7b0f776c66525::__construct() — Method in class __TwigTemplate_f39bca71236ed63ca7b7b0f776c66525