### Instantiate Finder Events

Source: https://api.joomla.org/cms-6/namespaces/joomla.html

Examples for creating instances of Finder-related event classes.

```php
new PrepareContentEvent('onEventName', ['subject' => $item]);
```

```php
new ResultEvent('onEventName', ['subject' => $item, 'query' => $query]);
```

```php
new StartIndexEvent('onEventName', []);
```

--------------------------------

### Instantiate Module Events

Source: https://api.joomla.org/cms-6/namespaces/joomla.html

Examples for creating instances of various Module-related event classes.

```php
new AfterCleanModuleListEvent('onEventName', ['subject' => $modules]);
```

```php
new AfterModuleListEvent('onEventName', ['subject' => $modules]);
```

```php
new AfterRenderModuleEvent('onEventName', ['subject' => $module, 'attributes' => $attrs]);
```

```php
new AfterRenderModulesEvent('onEventName', ['subject' => $content, 'attributes' => $attrs]);
```

```php
new BeforeRenderModuleEvent('onEventName', ['subject' => $module, 'attributes' => $attrs]);
```

```php
new AfterModuleListEvent('onEventName', ['subject' => $modules]);
```

--------------------------------

### Instantiate Privacy Events

Source: https://api.joomla.org/cms-6/namespaces/joomla.html

Examples of instantiating various privacy-related event classes.

```php
new CanRemoveDataEvent('onEventName', ['subject' => $requestTable, 'user' => $user]);
```

```php
new CheckPrivacyPolicyPublishedEvent('onEventName', ['subject' => $policyInfo]);
```

```php
new CollectCapabilitiesEvent('onEventName');
```

```php
new ExportRequestEvent('onEventName', ['subject' => $requestTable, 'user' => $user]);
```

```php
new RemoveDataEvent('onEventName', ['subject' => $requestTable, 'user' => $user]);
```

--------------------------------

### Instantiate Model Events

Source: https://api.joomla.org/cms-6/namespaces/joomla.html

Examples for creating instances of various Model-related event classes.

```php
new AfterCategoryChangeStateEvent('onEventName', ['context' => $extension, 'subject' => $primaryKeys, 'value' => $newState]);
```

```php
new AfterChangeStateEvent('onEventName', ['context' => 'com_example.example', 'subject' => $primaryKeys, 'value' => $newState]);
```

```php
new AfterDeleteEvent('onEventName', ['context' => 'com_example.example', 'subject' => $itemObjectToDelete]);
```

```php
new AfterSaveEvent('onEventName', ['context' => 'com_example.example', 'subject' => $itemObjectToSave, 'isNew' => $isNew, 'data' => $submittedData]);
```

```php
new BeforeChangeStateEvent('onEventName', ['context' => 'com_example.example', 'subject' => $primaryKeys, 'value' => $newState]);
```

```php
new BeforeDeleteEvent('onEventName', ['context' => 'com_example.example', 'subject' => $itemObjectToDelete]);
```

```php
new BeforeSaveEvent('onEventName', ['context' => 'com_example.example', 'subject' => $itemObjectToSave, 'isNew' => $isNew, 'data' => $submittedData]);
```

```php
new BeforeValidateDataEvent('onEventName', ['subject' => $form, 'data' => $data]);
```

```php
new NormaliseRequestDataEvent('onEventName', ['context' => 'com_example.example', 'data' => $data, 'subject' => $form]);
```

```php
new PrepareDataEvent('onEventName', ['context' => 'com_example.example', 'subject' => $data]);
```

```php
new PrepareFormEvent('onEventName', ['subject' => $form, 'data' => $data]);
```

--------------------------------

### Instantiate Stats Plugin Event

Source: https://api.joomla.org/cms-6/namespaces/joomla.html

Example of instantiating the GetStatsDataEvent for the Stats plugin.

```php
new GetStatsDataEvent('onEventName', ['context' => 'com_example.example']);
```

--------------------------------

### Instantiate MailTemplate Event

Source: https://api.joomla.org/cms-6/namespaces/joomla.html

Example for creating an instance of the BeforeRenderingMailTemplateEvent.

```php
new BeforeRenderingMailTemplateEvent('onEventName', ['templateId' => 'com_example.template', 'subject' => $mailTemplateInstance]);
```

--------------------------------

### User Login Event Example

Source: https://api.joomla.org/cms-6/namespaces/joomla.html

Instantiate an AfterLoginEvent for user login events. Requires event name and an array of subject and options.

```php
new AfterLoginEvent('onEventName', ['subject' => $authenticationResponseArray, 'options' => $options]);
```

--------------------------------

### Instantiate Schema Events

Source: https://api.joomla.org/cms-6/namespaces/joomla.html

Examples of instantiating various schema-related event classes for Joomla plugins.

```php
new BeforeCompileHeadEvent('onSchemaBeforeCompileHead', ['subject' => $schema, 'context' => 'com_example.example']);
```

```php
new PrepareDataEvent('onSchemaPrepareData', ['subject' => $data, 'context' => 'com_example.example']);
```

```php
new PrepareFormEvent('onSchemaPrepareForm', ['subject' => $form]);
```

```php
new PrepareFormEvent('onSchemaPrepareForm', ['subject' => $subject, 'context' => $context, 'item' => $table, 'isNew' => $isNew, 'schema' => $schema]);
```

--------------------------------

### User Logout Event Example

Source: https://api.joomla.org/cms-6/namespaces/joomla.html

Instantiate an AfterLogoutEvent for user logout events. Requires event name and an array of subject and options.

```php
new AfterLogoutEvent('onEventName', ['subject' => $parameters, 'options' => $options]);
```

--------------------------------

### Extension Management Commands

Source: https://api.joomla.org/cms-6/namespaces/joomla.html

Commands for discovering, installing, listing, and removing Joomla extensions.

```APIDOC
## Extension Management Commands

### Description
These commands allow for the management of extensions within the Joomla CMS, including discovery, installation, and removal.

### Commands
- **ExtensionDiscoverCommand**: Discover extensions.
- **ExtensionDiscoverInstallCommand**: Discover and install extensions.
- **ExtensionDiscoverListCommand**: List discovered extensions.
- **ExtensionInstallCommand**: Install extensions.
- **ExtensionRemoveCommand**: Remove extensions.
- **ExtensionsListCommand**: List installed extensions.
```

--------------------------------

### Editor Events

Source: https://api.joomla.org/cms-6/namespaces/joomla.html

Classes related to editor setup events.

```APIDOC
## Editor Events

### Description
Events related to editor setup.

### Classes
- **EditorButtonsSetupEvent**: Editor setup event.
- **EditorSetupEvent**: Editor setup event.
```

--------------------------------

### User Reset Complete Event Example

Source: https://api.joomla.org/cms-6/namespaces/joomla.html

Instantiate an AfterResetCompleteEvent for user reset completion events. Requires event name and an array containing the user subject.

```php
new AfterResetCompleteEvent('onEventName', ['subject' => $user]);
```

--------------------------------

### User Delete Event Example

Source: https://api.joomla.org/cms-6/namespaces/joomla.html

Instantiate an AfterDeleteEvent for user deletion events. Requires event name and an array of subject, deletingResult, and errorMessage.

```php
new AfterDeleteEvent('onEventName', ['subject' => $userArray, 'deletingResult' => $result, 'errorMessage' => $errorStr]);
```

--------------------------------

### Captcha Events

Source: https://api.joomla.org/cms-6/namespaces/joomla.html

Classes related to Captcha setup events.

```APIDOC
## Captcha Events

### Description
Events related to Captcha setup.

### Classes
- **CaptchaSetupEvent**: Captcha setup event.
```

--------------------------------

### User Remind Event Example

Source: https://api.joomla.org/cms-6/namespaces/joomla.html

Instantiate an AfterRemindEvent for user remind events. Requires event name and an array containing the user subject.

```php
new AfterRemindEvent('onEventName', ['subject' => $user]);
```

--------------------------------

### AfterLoginEvent Class

Source: https://api.joomla.org/cms-6/namespaces/joomla.html

Class for User event. Example: new AfterLoginEvent('onEventName', ['subject' => $authenticationResponseArray, 'options' => $options]);

```APIDOC
## AfterLoginEvent

### Description
Class for User event.
Example: new AfterLoginEvent('onEventName', ['subject' => $authenticationResponseArray, 'options' => $options]);

### Type
Class
```

--------------------------------

### AfterResetCompleteEvent Class

Source: https://api.joomla.org/cms-6/namespaces/joomla.html

Class for User reset event. Example: new AfterResetCompleteEvent('onEventName', ['subject' => $user]);

```APIDOC
## AfterResetCompleteEvent

### Description
Class for User reset event.
Example: new AfterResetCompleteEvent('onEventName', ['subject' => $user]);

### Type
Class
```

--------------------------------

### AfterLogoutEvent Class

Source: https://api.joomla.org/cms-6/namespaces/joomla.html

Class for User event. Example: new AfterLogoutEvent('onEventName', ['subject' => $parameters, 'options' => $options]);

```APIDOC
## AfterLogoutEvent

### Description
Class for User event.
Example: new AfterLogoutEvent('onEventName', ['subject' => $parameters, 'options' => $options]);

### Type
Class
```

--------------------------------

### AfterRemindEvent Class

Source: https://api.joomla.org/cms-6/namespaces/joomla.html

Class for User event. Example: new AfterRemindEvent('onEventName', ['subject' => $user]);

```APIDOC
## AfterRemindEvent

### Description
Class for User event.
Example: new AfterRemindEvent('onEventName', ['subject' => $user]);

### Type
Class
```

--------------------------------

### AfterDeleteEvent Class (User)

Source: https://api.joomla.org/cms-6/namespaces/joomla.html

Class for User delete event. Example: new AfterDeleteEvent('onEventName', ['subject' => $userArray, 'deletingResult' => $result, 'errorMessage' => $errorStr]);

```APIDOC
## AfterDeleteEvent

### Description
Class for User delete event.
Example: new AfterDeleteEvent('onEventName', ['subject' => $userArray, 'deletingResult' => $result, 'errorMessage' => $errorStr]);

### Type
Class
```

--------------------------------

### Instantiate ContentPrepareEvent

Source: https://api.joomla.org/cms-6/namespaces/joomla.html

Use this event to prepare content. It requires context, subject, parameters, and the page number.

```php
new ContentPrepareEvent('onEventName', ['context' => 'com_example.example', 'subject' => $contentObject, 'params' => $params, 'page' => $pageNum]);
```

--------------------------------

### Instantiate Login Event

Source: https://api.joomla.org/cms-6/namespaces/joomla.html

Creates an instance of the LoginEvent for user login.

```php
new LoginEvent('onEventName', ['subject' => $authenticationResponseArray, 'options' => $options]);
```

--------------------------------

### Instantiate BuildIndexEvent for Finder

Source: https://api.joomla.org/cms-6/namespaces/joomla.html

Use this event to build the index. It takes an event name and an empty array for parameters.

```php
new BuildIndexEvent('onEventName', []);
```

--------------------------------

### Console Commands

Source: https://api.joomla.org/cms-6/namespaces/joomla.html

Overview of available system console commands for managing users, cache, and updates.

```APIDOC
## Console Commands

### Description
Joomla provides various console commands for administrative tasks such as user management, cache clearing, and update checking.

### Available Commands
- **AddUserCommand**: Adds a new user to the system.
- **AddUserToGroupCommand**: Assigns a user to a specific group.
- **ChangeUserPasswordCommand**: Updates a user's password.
- **DeleteUserCommand**: Removes a user from the system.
- **CleanCacheCommand**: Clears the system cache.
- **CheckJoomlaUpdatesCommand / CheckUpdatesCommand**: Checks for pending extension updates.
- **AutomatedUpdatesRegisterCommand / AutomatedUpdatesUnregisterCommand / CoreUpdateChannelCommand**: Manages Joomla update channels.
```

--------------------------------

### Instantiate Login Buttons Event

Source: https://api.joomla.org/cms-6/namespaces/joomla.html

Creates an instance of the LoginButtonsEvent for login button rendering.

```php
new LoginButtonsEvent('onEventName', ['subject' => $formId]);
```

--------------------------------

### Instantiate BeforeIndexEvent for Finder

Source: https://api.joomla.org/cms-6/namespaces/joomla.html

Use this event before indexing items. It takes an event name and an empty array for parameters.

```php
new BeforeIndexEvent('onEventName', []);
```

--------------------------------

### Instantiate Before Reset Complete Event

Source: https://api.joomla.org/cms-6/namespaces/joomla.html

Creates an instance of the BeforeResetCompleteEvent for user reset completion.

```php
new BeforeResetCompleteEvent('onEventName', ['subject' => $user]);
```

--------------------------------

### Instantiate Authorisation Event

Source: https://api.joomla.org/cms-6/namespaces/joomla.html

Creates an instance of the AuthorisationEvent for user authorization.

```php
new AuthorisationEvent('onEventName', ['subject' => $authenticationResponse, 'options' => $options]);
```

--------------------------------

### Instantiate BeforeDisplayEvent for Content

Source: https://api.joomla.org/cms-6/namespaces/joomla.html

Use this event before content is displayed. It requires context, subject, parameters, and the page number.

```php
new BeforeDisplayEvent('onEventName', ['context' => 'com_example.example', 'subject' => $contentObject, 'params' => $params, 'page' => $pageNum]);
```

--------------------------------

### BeforeStoreEvent Class

Source: https://api.joomla.org/cms-6/namespaces/joomla.html

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

```APIDOC
## BeforeStoreEvent

### Description
Event class for \Joomla\CMS\Table\Table onBeforeStore event.

### Type
Class
```

--------------------------------

### Instantiate Authentication Event

Source: https://api.joomla.org/cms-6/namespaces/joomla.html

Creates an instance of the AuthenticationEvent for user authentication.

```php
new AuthenticationEvent('onEventName', ['credentials' => $credentials, 'options' => $options, 'subject' => $authenticationResponse]);
```

--------------------------------

### Instantiate GarbageCollectionEvent for Finder

Source: https://api.joomla.org/cms-6/namespaces/joomla.html

Use this event for garbage collection in the finder. It takes an event name and an empty array for parameters.

```php
new GarbageCollectionEvent('onEventName', []);
```

--------------------------------

### BeforeBindEvent Class

Source: https://api.joomla.org/cms-6/namespaces/joomla.html

Event class for Table onBeforeBind event.

```APIDOC
## BeforeBindEvent

### Description
Event class for Table onBeforeBind event.

### Type
Class
```

--------------------------------

### Instantiate Before Delete Event

Source: https://api.joomla.org/cms-6/namespaces/joomla.html

Creates an instance of the BeforeDeleteEvent for user deletion.

```php
new BeforeDeleteEvent('onEventName', ['subject' => $userArray]);
```

--------------------------------

### Application Configuration Events

Source: https://api.joomla.org/cms-6/namespaces/joomla.html

Classes for Application Configuration events.

```APIDOC
## Application Configuration Events

### Description
Classes for Application Configuration events.

### Classes
- **AfterSaveConfigurationEvent**: Class for Application Configuration events.
- **BeforeSaveConfigurationEvent**: Class for Application Configuration events.
```

--------------------------------

### Instantiate Before Reset Request Event

Source: https://api.joomla.org/cms-6/namespaces/joomla.html

Creates an instance of the BeforeResetRequestEvent for user reset requests.

```php
new BeforeResetRequestEvent('onEventName', ['subject' => $user]);
```

--------------------------------

### Instantiate Logout Event

Source: https://api.joomla.org/cms-6/namespaces/joomla.html

Creates an instance of the LogoutEvent for user logout.

```php
new LogoutEvent('onEventName', ['subject' => $parameters, 'options' => $options]);
```

--------------------------------

### System Maintenance Commands

Source: https://api.joomla.org/cms-6/namespaces/joomla.html

Commands for database maintenance, configuration management, and system state.

```APIDOC
## System Maintenance Commands

### Description
Commands for maintaining the database, managing configuration, and controlling site state.

### Commands
- **MaintenanceDatabaseCommand**: Maintain database structure.
- **GetConfigurationCommand**: Display configuration options.
- **SetConfigurationCommand**: Set configuration options.
- **SiteDownCommand**: Set site to offline mode.
- **SiteUpCommand**: Set site to online mode.
```

--------------------------------

### BeforeCheckoutEvent Class

Source: https://api.joomla.org/cms-6/namespaces/joomla.html

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

```APIDOC
## BeforeCheckoutEvent

### Description
Event class for \Joomla\CMS\Table\Table onBeforeCheckout event.

### Type
Class
```

--------------------------------

### BeforeHitEvent Class

Source: https://api.joomla.org/cms-6/namespaces/joomla.html

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

```APIDOC
## BeforeHitEvent

### Description
Event class for \Joomla\CMS\Table\Table onBeforeHit event.

### Type
Class
```

--------------------------------

### Instantiate AfterDisplayEvent for Content

Source: https://api.joomla.org/cms-6/namespaces/joomla.html

Use this event when content has been displayed. It requires context, subject, parameters, and the page number.

```php
new AfterDisplayEvent('onEventName', ['context' => 'com_example.example', 'subject' => $contentObject, 'params' => $params, 'page' => $pageNum]);
```

--------------------------------

### AbstractLoginEvent Class

Source: https://api.joomla.org/cms-6/namespaces/joomla.html

Base class for User login event.

```APIDOC
## AbstractLoginEvent

### Description
Base class for User login event.

### Type
Class
```

--------------------------------

### hash_pbkdf2 Shim Function

Source: https://api.joomla.org/cms-6/namespaces/joomla.html

Provides a fallback implementation for the hash_pbkdf2 function if it is not available in the environment. It requires specifying the algorithm, password, salt, iteration count, output length, and whether to return raw output.

```php
function hash_pbkdf2(string $algo, string $password, string $salt, int $count, int $length = 0, bool $rawOutput = false): string
```

--------------------------------

### Instantiate Login Failure Event

Source: https://api.joomla.org/cms-6/namespaces/joomla.html

Creates an instance of the LoginFailureEvent for failed login attempts.

```php
new LoginFailureEvent('onEventName', ['subject' => $authenticationResponseArray, 'options' => $options]);
```

--------------------------------

### GetOverviewEvent Class

Source: https://api.joomla.org/cms-6/namespaces/joomla.html

Class for Sample data events.

```APIDOC
## GetOverviewEvent

### Description
Class for Sample data events.

### Type
Class
```

--------------------------------

### Instantiate Authorisation Failure Event

Source: https://api.joomla.org/cms-6/namespaces/joomla.html

Creates an instance of the AuthorisationFailureEvent for failed authorization attempts.

```php
new AuthorisationFailureEvent('onEventName', ['subject' => $authenticationResponseArray, 'options' => $options]);
```

--------------------------------

### Instantiate Before Save Event

Source: https://api.joomla.org/cms-6/namespaces/joomla.html

Creates an instance of the BeforeSaveEvent for user save operations.

```php
new BeforeSaveEvent('onEventName', ['subject' => $oldUserArray, 'isNew' => $isNew, 'data' => $data]);
```

--------------------------------

### Instantiate User Reset Event

Source: https://api.joomla.org/cms-6/namespaces/joomla.html

Creates an instance of the AfterResetRequestEvent for user reset operations.

```php
new AfterResetRequestEvent('onEventName', ['subject' => $user]);
```

--------------------------------

### User Management Commands

Source: https://api.joomla.org/cms-6/namespaces/joomla.html

Commands for listing users and managing user group memberships.

```APIDOC
## User Management Commands

### Description
Commands to manage user accounts and their group associations.

### Commands
- **ListUserCommand**: List existing users.
- **RemoveUserFromGroupCommand**: Remove a user from a specific group.
```

--------------------------------

### BeforeLoadEvent Class

Source: https://api.joomla.org/cms-6/namespaces/joomla.html

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

```APIDOC
## BeforeLoadEvent

### Description
Event class for \Joomla\CMS\Table\Table onBeforeLoad event.

### Type
Class
```

--------------------------------

### AfterStoreEvent Class

Source: https://api.joomla.org/cms-6/namespaces/joomla.html

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

```APIDOC
## AfterStoreEvent

### Description
Event class for \Joomla\CMS\Table\Table onAfterStore event.

### Type
Class
```

--------------------------------

### Instantiate User Save Event

Source: https://api.joomla.org/cms-6/namespaces/joomla.html

Creates an instance of the AfterSaveEvent for user save operations.

```php
new AfterSaveEvent('onEventName', ['subject' => $userArray, 'isNew' => $isNew, 'savingResult' => $result, 'errorMessage' => $errorStr]);
```

--------------------------------

### AbstractResetEvent Class (User)

Source: https://api.joomla.org/cms-6/namespaces/joomla.html

Class for User reset event.

```APIDOC
## AbstractResetEvent

### Description
Class for User reset event.

### Type
Class
```

--------------------------------

### Instantiate User Group Before Delete Event

Source: https://api.joomla.org/cms-6/namespaces/joomla.html

Creates an instance of the UserGroupBeforeDeleteEvent for model deletion.

```php
new UserGroupBeforeDeleteEvent('onEventName', ['context' => 'com_example.example', 'subject' => $itemObjectToDelete]);
```

--------------------------------

### Instantiate Logout Failure Event

Source: https://api.joomla.org/cms-6/namespaces/joomla.html

Creates an instance of the LogoutFailureEvent for failed logout attempts.

```php
new LogoutFailureEvent('onEventName', ['subject' => $parameters, 'options' => $options]);
```

--------------------------------

### Instantiate User Group After Delete Event

Source: https://api.joomla.org/cms-6/namespaces/joomla.html

Creates an instance of the UserGroupAfterDeleteEvent for model deletion.

```php
new UserGroupAfterDeleteEvent('onEventName', ['context' => 'com_example.example', 'subject' => $itemObjectToDelete]);
```

--------------------------------

### BeforeCheckinEvent Class

Source: https://api.joomla.org/cms-6/namespaces/joomla.html

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

```APIDOC
## BeforeCheckinEvent

### Description
Event class for \Joomla\CMS\Table\Table onBeforeCheckin event.

### Type
Class
```

--------------------------------

### BeforeResetEvent Class

Source: https://api.joomla.org/cms-6/namespaces/joomla.html

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

```APIDOC
## BeforeResetEvent

### Description
Event class for \Joomla\CMS\Table\Table onBeforeReset event.

### Type
Class
```

--------------------------------

### Function hash_pbkdf2

Source: https://api.joomla.org/cms-6/namespaces/joomla.html

Provides a shim for the hash_pbkdf2 function to generate secure password hashes using PBKDF2.

```APIDOC
## hash_pbkdf2

### Description
Provides a shim for the missing hash_pbkdf2 function to perform password hashing.

### Parameters
- **algo** (string) - Required - Algorithm to use
- **password** (string) - Required - Plaintext password
- **salt** (string) - Required - Salt for the hash
- **count** (int) - Required - Number of iterations
- **length** (int) - Required - Length of the output
- **rawOutput** (bool) - Required - Whether to return raw output

### Response
- **string** - Hashed string
```

--------------------------------

### Instantiate BeforeSaveEvent for Model

Source: https://api.joomla.org/cms-6/namespaces/joomla.html

Use this event before an item is saved. It requires context, the item object to be saved, and a flag indicating if it's a new item.

```php
new BeforeSaveEvent('onEventName', ['context' => 'com_example.example', 'subject' => $itemObjectToSave, 'isNew' => $isNew);
```

--------------------------------

### AfterBindEvent Class

Source: https://api.joomla.org/cms-6/namespaces/joomla.html

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

```APIDOC
## AfterBindEvent

### Description
Event class for \Joomla\CMS\Table\Table onAfterBind event.

### Type
Class
```

--------------------------------

### AfterCheckoutEvent Class

Source: https://api.joomla.org/cms-6/namespaces/joomla.html

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

```APIDOC
## AfterCheckoutEvent

### Description
Event class for \Joomla\CMS\Table\Table onAfterCheckout event.

### Type
Class
```

--------------------------------

### Instantiate AfterTitleEvent for Content

Source: https://api.joomla.org/cms-6/namespaces/joomla.html

Use this event after the content title has been processed. It requires context, subject, parameters, and the page number.

```php
new AfterTitleEvent('onEventName', ['context' => 'com_example.example', 'subject' => $contentObject, 'params' => $params, 'page' => $pageNum]);
```

--------------------------------

### Application Events

Source: https://api.joomla.org/cms-6/namespaces/joomla.html

Classes related to application-level events.

```APIDOC
## Application Events

### Description
Classes for various application events.

### Classes
- **AfterRenderEvent**: Class for AfterRender event.
- **AfterRespondEvent**: Class for AfterRespond event.
- **AfterRouteEvent**: Class for AfterRoute event.
- **ApplicationConfigurationEvent**: Class for Application Configuration events.
- **ApplicationDocumentEvent**: Class for Application's Document events.
- **ApplicationEvent**: Class for Application events.
- **BeforeApiRouteEvent**: Class for BeforeApiRoute event.
- **BeforeCompileHeadEvent**: Class for BeforeCompileHead event.
- **BeforeExecuteEvent**: Class for BeforeExecute event.
- **BeforeRenderEvent**: Class for BeforeRender event.
- **BeforeRespondEvent**: Class for BeforeRespond event.
- **DaemonForkEvent**: Class for Fork event for DaemonApplication.
- **DaemonReceiveSignalEvent**: Class for ReceiveSignal event for DaemonApplication.
```

--------------------------------

### BeforeReorderEvent Class

Source: https://api.joomla.org/cms-6/namespaces/joomla.html

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

```APIDOC
## BeforeReorderEvent

### Description
Event class for \Joomla\CMS\Table\Table onBeforeReorder event.

### Type
Class
```

--------------------------------

### User Event Classes

Source: https://api.joomla.org/cms-6/namespaces/joomla.html

A collection of event classes used for handling user lifecycle operations such as saving, deleting, resetting, and authentication.

```APIDOC
## User Event Classes

### Description
These classes represent various events triggered during user management processes in Joomla.

### Usage Examples
- **AfterSaveEvent**: `new AfterSaveEvent('onEventName', ['subject' => $userArray, 'isNew' => $isNew, 'savingResult' => $result, 'errorMessage' => $errorStr]);`
- **AuthenticationEvent**: `new AuthenticationEvent('onEventName', ['credentials' => $credentials, 'options' => $options, 'subject' => $authenticationResponse]);`
- **BeforeDeleteEvent**: `new BeforeDeleteEvent('onEventName', ['subject' => $userArray]);`
- **LoginEvent**: `new LoginEvent('onEventName', ['subject' => $authenticationResponseArray, 'options' => $options]);`
```

--------------------------------

### BeforeMoveEvent Class

Source: https://api.joomla.org/cms-6/namespaces/joomla.html

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

```APIDOC
## BeforeMoveEvent

### Description
Event class for \Joomla\CMS\Table\Table onBeforeMove event.

### Type
Class
```

--------------------------------

### AfterResetEvent Class

Source: https://api.joomla.org/cms-6/namespaces/joomla.html

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

```APIDOC
## AfterResetEvent

### Description
Event class for \Joomla\CMS\Table\Table onAfterReset event.

### Type
Class
```

--------------------------------

### Instantiate AfterDeleteEvent for Model

Source: https://api.joomla.org/cms-6/namespaces/joomla.html

Use this event after an item has been deleted. It requires context and the item object that was deleted.

```php
new AfterDeleteEvent('onEventName', ['context' => 'com_example.example', 'subject' => $itemObjectToDelete]);
```

--------------------------------

### BeforePublishEvent Class

Source: https://api.joomla.org/cms-6/namespaces/joomla.html

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

```APIDOC
## BeforePublishEvent

### Description
Event class for \Joomla\CMS\Table\Table onBeforePublish event.

### Type
Class
```

--------------------------------

### AfterHitEvent Class

Source: https://api.joomla.org/cms-6/namespaces/joomla.html

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

```APIDOC
## AfterHitEvent

### Description
Event class for \Joomla\CMS\Table\Table onAfterHit event.

### Type
Class
```

--------------------------------

### Instantiate AfterCategoryChangeStateEvent for Model

Source: https://api.joomla.org/cms-6/namespaces/joomla.html

Use this event after a category's state has changed. It requires the extension context, primary keys of the affected items, and the new state value.

```php
new AfterCategoryChangeStateEvent('onEventName', ['context' => $extension, 'subject' => $primaryKeys, 'value' => $newState]);
```

--------------------------------

### Schema Event Classes

Source: https://api.joomla.org/cms-6/namespaces/joomla.html

Classes used for handling schema-related events such as compiling head data, preparing form data, and preparing save operations.

```APIDOC
## BeforeCompileHeadEvent

### Description
Class for SchemaBeforeCompileHeadEvent event.

### Request Example
new BeforeCompileHeadEvent('onSchemaBeforeCompileHead', ['subject' => $schema, 'context' => 'com_example.example']);

## PrepareDataEvent

### Description
Class for SchemaPrepareDataEvent event.

### Request Example
new PrepareDataEvent('onSchemaPrepareData', ['subject' => $data, 'context' => 'com_example.example']);

## PrepareFormEvent

### Description
Class for SchemaPrepareFormEvent event.

### Request Example
new PrepareFormEvent('onSchemaPrepareForm', ['subject' => $form]);

## PrepareSaveEvent

### Description
Class for SchemaPrepareSaveEvent event.

### Request Example
new PrepareFormEvent('onSchemaPrepareForm', ['subject' => $subject, 'context' => $context, 'item' => $table, 'isNew' => $isNew, 'schema' => $schema]);
```

--------------------------------

### Finder Events

Source: https://api.joomla.org/cms-6/namespaces/joomla.html

Classes related to finder events and indexing.

```APIDOC
## Finder Events

### Description
Classes for finder-related events, including indexing and garbage collection.

### Interfaces
- **FinderEventInterface**: Interface class for finder events.

### Classes
- **AbstractFinderEvent**: Class for Finder events.
- **BeforeIndexEvent**: Class for Finder events. Example: new BeforeIndexEvent('onEventName', []);
- **BuildIndexEvent**: Class for Finder events. Example: new BuildIndexEvent('onEventName', []);
- **GarbageCollectionEvent**: Class for Finder events. Example: new GarbageCollectionEvent('onEventName', []);
```

--------------------------------

### ObjectCreateEvent Class

Source: https://api.joomla.org/cms-6/namespaces/joomla.html

Event class for \Joomla\CMS\Table\Table onObjectCreate event.

```APIDOC
## ObjectCreateEvent

### Description
Event class for \Joomla\CMS\Table\Table onObjectCreate event.

### Type
Class
```

--------------------------------

### AbstractSaveEvent Class

Source: https://api.joomla.org/cms-6/namespaces/joomla.html

Base class for User save event.

```APIDOC
## AbstractSaveEvent

### Description
Base class for User save event.

### Type
Class
```

--------------------------------

### Instantiate AfterChangeStateEvent for Model

Source: https://api.joomla.org/cms-6/namespaces/joomla.html

Use this event after an item's state has changed. It requires context, primary keys of the affected items, and the new state value.

```php
new AfterChangeStateEvent('onEventName', ['context' => 'com_example.example', 'subject' => $primaryKeys, 'value' => $newState]);
```

--------------------------------

### AbstractLogoutEvent Class

Source: https://api.joomla.org/cms-6/namespaces/joomla.html

Base class for User logout event.

```APIDOC
## AbstractLogoutEvent

### Description
Base class for User logout event.

### Type
Class
```

--------------------------------

### Checkin Events

Source: https://api.joomla.org/cms-6/namespaces/joomla.html

Classes related to checkin events.

```APIDOC
## Checkin Events

### Description
Classes for checkin events.

### Classes
- **AfterCheckinEvent**: Class for Checkin events.
```

--------------------------------

### Service Factory Classes

Source: https://api.joomla.org/cms-6/namespaces/joomla.html

Classes responsible for providing services related to components, modules, and MVC patterns.

```APIDOC
## Service Factory Classes

### Description
These classes act as service providers for core Joomla functionality, including factory patterns for dispatchers, helpers, and routers.

### Classes
- **CategoryFactory**: Service provider for categories.
- **ComponentDispatcherFactory**: Service provider for component dispatchers.
- **HelperFactory**: Service provider for helper classes.
- **MVCFactory**: Service provider for MVC components.
```

--------------------------------

### AbstractEvent Class

Source: https://api.joomla.org/cms-6/namespaces/joomla.html

Event class for the Table's events.

```APIDOC
## AbstractEvent

### Description
Event class for the Table's events.

### Type
Class
```

--------------------------------

### Instantiate AfterSaveEvent for Model

Source: https://api.joomla.org/cms-6/namespaces/joomla.html

Use this event after an item has been saved. It requires context, the item object that was saved, and a flag indicating if it's a new item.

```php
new AfterSaveEvent('onEventName', ['context' => 'com_example.example', 'subject' => $itemObjectToSave, 'isNew' => $isNew]);
```

--------------------------------

### SampleDataEvent Class

Source: https://api.joomla.org/cms-6/namespaces/joomla.html

Base class for Sample data events.

```APIDOC
## SampleDataEvent

### Description
Base class for Sample data events.

### Type
Class
```

--------------------------------

### BeforeDeleteEvent Class (Table)

Source: https://api.joomla.org/cms-6/namespaces/joomla.html

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

```APIDOC
## BeforeDeleteEvent

### Description
Event class for \Joomla\CMS\Table\Table onBeforeDelete event.

### Type
Class
```

--------------------------------

### AbstractDeleteEvent Class (User)

Source: https://api.joomla.org/cms-6/namespaces/joomla.html

Base class for User delete event.

```APIDOC
## AbstractDeleteEvent

### Description
Base class for User delete event.

### Type
Class
```

--------------------------------

### AfterLoadEvent Class

Source: https://api.joomla.org/cms-6/namespaces/joomla.html

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

```APIDOC
## AfterLoadEvent

### Description
Event class for \Joomla\CMS\Table\Table onAfterLoad event.

### Type
Class
```

--------------------------------

### Content Events

Source: https://api.joomla.org/cms-6/namespaces/joomla.html

Classes related to content events.

```APIDOC
## Content Events

### Description
Classes for content-related events.

### Classes
- **AfterDisplayEvent**: Class for Content event. Example: new AfterDisplayEvent('onEventName', ['context' => 'com_example.example', 'subject' => $contentObject, 'params' => $params, 'page' => $pageNum]);
- **AfterTitleEvent**: Class for Content event. Example: new AfterTitleEvent('onEventName', ['context' => 'com_example.example', 'subject' => $contentObject, 'params' => $params, 'page' => $pageNum]);
- **BeforeDisplayEvent**: Class for Content event. Example: new BeforeDisplayEvent('onEventName', ['context' => 'com_example.example', 'subject' => $contentObject, 'params' => $params, 'page' => $pageNum]);
- **ContentEvent**: Base class for Content events.
- **ContentPrepareEvent**: Class for Content event. Example: new ContentPrepareEvent('onEventName', ['context' => 'com_example.example', 'subject' => $contentObject, 'params' => $params, 'page' => $pageNum]);
```

--------------------------------

### AfterReorderEvent Class

Source: https://api.joomla.org/cms-6/namespaces/joomla.html

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

```APIDOC
## AfterReorderEvent

### Description
Event class for \Joomla\CMS\Table\Table onAfterReorder event.

### Type
Class
```

--------------------------------

### Cache Events

Source: https://api.joomla.org/cms-6/namespaces/joomla.html

Classes related to cache events.

```APIDOC
## Cache Events

### Description
Classes for cache-related events.

### Classes
- **AfterPurgeEvent**: Class for Cache events.
```

--------------------------------

### AfterCheckinEvent Class

Source: https://api.joomla.org/cms-6/namespaces/joomla.html

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

```APIDOC
## AfterCheckinEvent

### Description
Event class for \Joomla\CMS\Table\Table onAfterCheckin event.

### Type
Class
```

--------------------------------

### Extension Events

Source: https://api.joomla.org/cms-6/namespaces/joomla.html

Classes related to extension and Joomla update events.

```APIDOC
## Extension and Joomla Update Events

### Description
Base classes and specific event classes for extension and Joomla update processes.

### Classes
- **AbstractExtensionEvent**: Base class for Extension events.
- **AbstractJoomlaUpdateEvent**: Base class for Joomla Update events.
- **AfterInstallEvent**: Class for Extension events.
- **AfterJoomlaUpdateEvent**: Class for Joomla Update events.
- **AfterUninstallEvent**: Class for Extension events.
- **AfterUpdateEvent**: Class for Extension events.
- **BeforeInstallEvent**: Class for Extension events.
- **BeforeJoomlaAutoupdateEvent**: Class for Joomla Auto Update events.
- **BeforeJoomlaUpdateEvent**: Class for Joomla Update events.
- **BeforeUninstallEvent**: Class for Extension events.
- **BeforeUpdateEvent**: Class for Extension events.
```

--------------------------------

### Contact Events

Source: https://api.joomla.org/cms-6/namespaces/joomla.html

Classes related to contact events.

```APIDOC
## Contact Events

### Description
Classes for contact-related events.

### Classes
- **SubmitContactEvent**: Class for Contact events.
- **ValidateContactEvent**: Class for Contact events.
```

--------------------------------

### AfterPublishEvent Class

Source: https://api.joomla.org/cms-6/namespaces/joomla.html

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

```APIDOC
## AfterPublishEvent

### Description
Event class for \Joomla\CMS\Table\Table onAfterPublish event.

### Type
Class
```

--------------------------------

### AfterMoveEvent Class

Source: https://api.joomla.org/cms-6/namespaces/joomla.html

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

```APIDOC
## AfterMoveEvent

### Description
Event class for \Joomla\CMS\Table\Table onAfterMove event.

### Type
Class
```

--------------------------------

### CheckEvent Class

Source: https://api.joomla.org/cms-6/namespaces/joomla.html

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

```APIDOC
## CheckEvent

### Description
Event class for \Joomla\CMS\Table\Table onCheck event.

### Type
Class
```

--------------------------------

### Privacy Event Classes

Source: https://api.joomla.org/cms-6/namespaces/joomla.html

Classes used for handling privacy-related events, including data removal requests, capability collection, and policy publication checks.

```APIDOC
## CanRemoveDataEvent

### Description
Class for Privacy events to check if data can be removed.

### Request Example
new CanRemoveDataEvent('onEventName', ['subject' => $requestTable, 'user' => $user]);

## CheckPrivacyPolicyPublishedEvent

### Description
Class for Privacy events to check if a privacy policy is published.

### Request Example
new CheckPrivacyPolicyPublishedEvent('onEventName', ['subject' => $policyInfo]);

## CollectCapabilitiesEvent

### Description
Class for Privacy events to collect system capabilities.

### Request Example
new CollectCapabilitiesEvent('onEventName');

## ExportRequestEvent

### Description
Class for Privacy events to handle data export requests.

### Request Example
new ExportRequestEvent('onEventName', ['subject' => $requestTable, 'user' => $user]);

## RemoveDataEvent

### Description
Class for Privacy events to handle data removal.

### Request Example
new RemoveDataEvent('onEventName', ['subject' => $requestTable, 'user' => $user]);
```

--------------------------------

### AfterDeleteEvent Class (Table)

Source: https://api.joomla.org/cms-6/namespaces/joomla.html

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

```APIDOC
## AfterDeleteEvent

### Description
Event class for \Joomla\CMS\Table\Table onAfterDelete event.

### Type
Class
```

--------------------------------

### Model Events

Source: https://api.joomla.org/cms-6/namespaces/joomla.html

Classes related to model events, such as state changes, saving, and deletion.

```APIDOC
## Model Events

### Description
Classes for model-related events, including state changes, saving, and deletion.

### Classes
- **AfterCategoryChangeStateEvent**: Class for Model event. Example: new AfterCategoryChangeStateEvent('onEventName', ['context' => $extension, 'subject' => $primaryKeys, 'value' => $newState]);
- **AfterChangeStateEvent**: Class for Model event. Example: new AfterChangeStateEvent('onEventName', ['context' => 'com_example.example', 'subject' => $primaryKeys, 'value' => $newState]);
- **AfterDeleteEvent**: Class for Model event. Example: new AfterDeleteEvent('onEventName', ['context' => 'com_example.example', 'subject' => $itemObjectToDelete]);
- **AfterSaveEvent**: Class for Model event. Example: new AfterSaveEvent('onEventName', ['context' => 'com_example.example', 'subject' => $itemObjectToSave, 'isNew' => $isNew]);
- **BeforeSaveEvent**: Class for Model event. Example: new BeforeSaveEvent('onEventName', ['context' => 'com_example.example', 'subject' => $itemObjectToSave, 'isNew' => $isNew);

```

--------------------------------

### SetNewTagsEvent Class

Source: https://api.joomla.org/cms-6/namespaces/joomla.html

Event class for \Joomla\CMS\Table\Table onSetNewTags event.

```APIDOC
## SetNewTagsEvent

### Description
Event class for \Joomla\CMS\Table\Table onSetNewTags event.

### Type
Class
```

--------------------------------

### Custom Fields Events

Source: https://api.joomla.org/cms-6/namespaces/joomla.html

Classes related to custom fields events.

```APIDOC
## Custom Fields Events

### Description
Classes for custom fields-related events.

### Classes
- **AbstractPrepareFieldEvent**: Class for CustomFields events.
- **AfterPrepareFieldEvent**: Class for CustomFields events.
- **BeforePrepareFieldEvent**: Class for CustomFields events.
- **CustomFieldsEvent**: Class for CustomFields events.
- **GetTypesEvent**: Class for CustomFields events.
- **PrepareDomEvent**: Class for CustomFields events.
- **PrepareFieldEvent**: Class for CustomFields events.
```

--------------------------------

### Joomla Form Field Classes

Source: https://api.joomla.org/cms-6/namespaces/joomla.html

A collection of Form Field classes used to render various input types in Joomla forms.

```APIDOC
## Form Field Classes

### Description
Joomla provides a wide range of Form Field classes to handle user input, selection, and display logic.

### Available Fields
- **IntegerField**: Select list of integers with step values.
- **LanguageField**: List of installed application languages.
- **ListField**: Generic list of options.
- **MediaField**: Modal media selector with upload.
- **MenuField**: Select list of menus.
- **NumberField**: Text box with up-down handles.
- **PasswordField**: Text field for passwords.
- **RadioField**: Radio button inputs.
- **TextField**: One line text field.
- **TextareaField**: Multi-line text area.
- **UserField**: Modal user selection.
```

--------------------------------

### Joomla Form Filter Classes

Source: https://api.joomla.org/cms-6/namespaces/joomla.html

Classes used for filtering and sanitizing input data within the Joomla framework.

```APIDOC
## Form Filter Classes

### Description
Filter classes are used to sanitize or transform input data before processing.

### Available Filters
- **IntarrayFilter**: Filter for integer arrays.
- **RawFilter**: Filter for raw values.
- **SafehtmlFilter**: Filter for safe HTML content.
- **TelFilter**: Filter for phone numbers.
- **UrlFilter**: Filter for URLs.
```

--------------------------------

### ResultAwareInterface

Source: https://api.joomla.org/cms-6/namespaces/joomla.html

Defines an Event which has an append-only array argument named 'result'. This interface is partially implemented by the ResultAware trait and type checking is handled by ResultType*Aware traits.

```APIDOC
## ResultAwareInterface

### Description
Defines an Event which has an append-only array argument named 'result'. This is used for Events whose handlers are expected to return something when called, similar to how many plugin events worked in earlier versions of Joomla. This interface is partially implemented by the ResultAware trait. The typeCheckResult method is implemented by the various ResultType*Aware traits. Your event needs to use both the ResultAware trait and one of the ResultType*Aware traits. For example, if your event returns boolean results you need to use the ResultAware and ResultTypeBooleanAware traits in your event.

### Type
Interface
```

--------------------------------

### ResultTypeObjectAware Trait

Source: https://api.joomla.org/cms-6/namespaces/joomla.html

This Trait partially implements the ResultAwareInterface for type checking. Events using this Trait expect event handlers to set results of an object type. If no acceptable result classes are set, any PHP object will satisfy this type check.

```APIDOC
## ResultTypeObjectAware

### Description
This Trait partially implements the ResultAwareInterface for type checking. Events using this Trait (and the ResultAware trait) will expect event handlers to set results of an object type. If you do not set a list of acceptable result classes any PHP object will satisfy this type check.

### Type
Trait
```

--------------------------------

### ResultTypeStringAware Trait

Source: https://api.joomla.org/cms-6/namespaces/joomla.html

This Trait partially implements the ResultAwareInterface for type checking. Events using this Trait expect event handlers to set results of a String type.

```APIDOC
## ResultTypeStringAware

### Description
This Trait partially implements the ResultAwareInterface for type checking. Events using this Trait (and the ResultAware trait) will expect event handlers to set results of a String type.

### Type
Trait
```

--------------------------------

### Joomla Form Rule Classes

Source: https://api.joomla.org/cms-6/namespaces/joomla.html

Validation rule classes used to enforce data integrity in Joomla forms.

```APIDOC
## Form Rule Classes

### Description
Rule classes provide validation logic for form fields.

### Available Rules
- **BooleanRule**: Validation for boolean values.
- **CalendarRule**: Validation for calendar/date inputs.
- **CaptchaRule**: Validation for CAPTCHA inputs.
- **ColorRule**: Validation for color inputs.
```

--------------------------------

### ResultTypeNumericAware Trait

Source: https://api.joomla.org/cms-6/namespaces/joomla.html

This Trait partially implements the ResultAwareInterface for type checking. Events using this Trait expect event handlers to set results of a Numeric type.

```APIDOC
## ResultTypeNumericAware

### Description
This Trait partially implements the ResultAwareInterface for type checking. Events using this Trait (and the ResultAware trait) will expect event handlers to set results of a Numeric type.

### Type
Trait
```

=== COMPLETE CONTENT === This response contains all available snippets from this library. No additional content exists. Do not make further requests.