Package APIs
QUIQQER packages can extend platform behavior through PHP providers, administration controls, JavaScript controls, messages, locks, uploads, and setup wizards.
Use these APIs when a package needs to integrate with an existing system area instead of only adding templates, XML configuration, or event handlers.
API Areas
| Area | Use it for |
|---|---|
| Authentication | Login providers, primary authentication, secondary authentication, and authenticator settings. |
| Backend Search | Search providers for the administration desktop search. |
| Controls and Inputs | PHP controls, JavaScript controls, form inputs, upload handling, and data-qui initialization. |
| Messages, Locks, and Errors | User-facing messages, persistent user notifications, object locks, and error code conventions. |
| Setup Wizard | Guided package setup steps after installation or update. |
Registration Patterns
Package APIs are usually connected in one of three ways:
- Provider declarations in
package.xml. - XML configuration files such as
settings.xml,site.xml, oruser.xml. - PHP classes and JavaScript controls referenced by package assets.
Keep provider classes autoloadable through Composer and keep browser controls inside package assets under bin/.
See Package Development for the general provider model and package.xml for provider declaration syntax.