This documentation applies to Ka Extensions for OpenCart 4.x only. It is not compatible with OpenCart 3.
System
Table of Contents
Classes
- Arrays
- Helpful functions for managing arrays.
- Controller
- Replaces the standard OpenCart Controller class with extended functionality. Recommended as a base
class for all controllers of Ka extensions.
- ControllerForm
- A base controller class for a basic form page. It builds the field list, url parameters
and breadcrumbs, validates submitted values and passes pagination data to the template.
- ControllerInstaller
- This class contains essential parts of the module installation. It reads the extension manifest
(install.json), checks compatibility with the Ka Extensions library and the database, creates
tables and grants permissions to the extension pages. Module settings pages inherit from it
through ControllerSettings.
- ControllerSettings
- A base class for a module settings page. It incapsulates all required fields and methods:
shows the settings form, validates and saves settings, sets default values on installation and
deletes settings on uninstallation.
- Curl
- Simplifies http requests. Optional.
- Db
- A wrapper around the OpenCart database object with helper methods for building and running
insert, update and select queries.
- FileUtf8
- Reads and writes files in different charsets through UTF-8 conversion filters. It handles BOM
and MacOS line endings.
- Format
- Formats and parses values (numbers, prices, dates, weights, lengths, sizes) with language based settings.
- KaGlobal
- Contains several global helper methods: registry access, area and version checks, extension and
file helpers.
- KaURLify
- Transliterates text to ASCII and converts it to URL-friendly strings (SEO keywords). Based on
https://github.com/jbroadway/urlify.
- Language
- Helps to get language data by ID or vice versa.
- Mail
- Simplifies email submission. Builds emails from templates and language files and sends them with
the store mail settings.
- Model
- Base model class for models of Ka extensions.
- Pagination
- Extended pagination class. It renders the standard pagination and the results text.
- QB
- Query Builder. Builds SQL SELECT queries from parts.
- Store
- Gives information about stores. Results are cached per store.
- Tables
- Gives access to table objects by their model path or class name. Objects are cached.
- UrlParams
- This is a service class for storing url parameters and building URLs.
Traits
- TraitController
- Adds some helpful functions and makes it possible to suppress output of a parent controller.
- TraitControllerForm
- Helpful functions for forms: field values, errors and validation.
- TraitModel
- Helpful functions for models.
- TraitSession
- Provides functions for controller/model to generate unique session variables within a class.