Classes, interfaces and traits

FilePickerInterface

FilePickerInterface 

Define an interface for modules that provide filepicker functionality.

inherited

FilePickerProfile

FilePickerProfile 

A simple class that defines a profile of information used by the filepicker to indicate how it should behave and what functionality should be provided.

inherited

This is an immutable class.

The constructor and overrideWith methods of this class accept an associative array of parameters (see the properties below) to allow building or altering a profile object. Ths is the only time when properties of a profile can be adjusted.


$obj = new \CMSMS\FilePickerProfile( [ 'type'=>FileType::TYPE_IMAGE,
   'exclude_prefix'=>'foo' ] );
« More »

HookManager

HookManager 

A class to manage hooks, and to call hook handlers.

inherited

This class is capable of managing a flexible list of hooks, registering handlers for those hooks, and calling the handlers and/or related events.

« More »

FileType

FileType 

A simple abstract class that defines constants for numerous file types.

inherited abstract

FileTypeHelper

FileTypeHelper 

A class to provide utilities for manipulating files by their type.

inherited

Classes, interfaces and traits

HookHandler

HookHandler 

An internal class to represent a hook handler.

inherited

HookDefn

HookDefn 

An internal class to represent a hook.

inherited

Classes, interfaces and traits

Statement

Statement 

A class defining a prepared database statement.

inherited abstract

DataDictionary

DataDictionary 

A class defining methods to work directly with database tables.

inherited abstract

This file is based on the DataDictionary base class from the adodb_lite library which was in turn a fork of the adodb library at approximately 2004.

Credits and kudos to the authors of those packages.

« More »

compatibility

compatibility 

A class for providing some compatibility functionality with older module code

inherited final

Resultset

Resultset 

A class defining a resultset and how to interact with results from a database query.

inherited abstract

EmptyResultset

EmptyResultset 

A final class to describe a special (empty) recordset.

inherited final

ConnectionSpec

ConnectionSpec 

A class defining all of the details needed to connect to a database.

inherited

Some database drivers may not require all of the parameters.

« More »

ConnectionSpecException

ConnectionSpecException 

A special exception to indicate a problem with a ConnectionSpec

inherited

Connection

Connection 

A class defining a database connection, and mechanisms for working with a database.

inherited abstract

This library is largely compatible with adodb_lite with the pear,extended,transaction plugins with a few notable differences:

Differences:

  • GenID will not automatically create a sequence table.

    We encourage you to not use sequence tables and use auto-increment fields instead.

« More »

DatabaseException

DatabaseException 

A special type of exception related to database queries.

inherited

DatabaseConnectionException

DatabaseConnectionException 

A special exception indicating a problem connecting to the database.

inherited

Classes, interfaces and traits

CronJobTrait

CronJobTrait 

A Trait to define functionality for recurring cron jobs.

inherited

CronJobInterface

CronJobInterface 

A simple interface to define the functions and constants needed for a cron job.

inherited

JobManager

JobManager 

A singleton class defining a manager for asyncrhonous jobs.

inherited final

In reality, this is a simple proxy for methods in the CmsJobManager module.

« More »

RegularTask

RegularTask 

This class allows converting an old CmsRegularTask pseudocron task into an asynchronous background job.

inherited

CronJob

CronJob 

An abstract base class for a cronjob.

inherited abstract

A Cron job is different than a regular job in that it recurs at a specified frequency and can have an end/until date.

« More »

Job

Job 

A class defining an asynchronous job, and mechanisms for saving and retrieving that job.

inherited abstract

Classes, interfaces and traits

TemplateTypeAssistant

TemplateTypeAssistant 

An abstract class to define an assistant to the template type objects in the database.

inherited abstract

Classes, interfaces and traits

Alert

Alert 

An abstract class that defines Admin Alerts for CMSMS.

inherited abstract

Admin alerts have a name, priority, title, message, a timestamp and can optionally refer to a module. Methods are used to test if a module is for a specific user, and to format the message.

Alerts are stored as preferences in the database. If the name is the name of the class or something else that is not data or time dependant the only one instance of that alert can be stored in the database. This class usses the ArrayAccess interface to behave like a PHP array.

« More »

SimpleAlert

SimpleAlert 

The SimpleAlert class is a type of alert that allows the developer to create alerts with pre-defined titles, messages, icons, and permissions.

inherited

Admin alerts have a name, priority, title, message, a timestamp and can optionally refer to a module. Methods are used to test if a module is for a specific user, and to format the message.

Alerts are stored as preferences in the database. If the name is the name of the class or something else that is not data or time dependant the only one instance of that alert can be stored in the database. This class usses the ArrayAccess interface to behave like a PHP array.

« More »

TranslatableAlert

TranslatableAlert 

The TranslatableAlert object is an alert that supports translatable language keys.

inherited

This class will use the module that is associated with the alert to translate the key. If the module name is empty, or the special value 'core' then the global 'lang' function will be used to read translations from the admin lang file.

« More »