Classes, interfaces and traits

CmsRegularTask

An interface to define how tasks should work.

« More »

ContentBase

Base level content object.

This is the base level content class. It is an abstract object and cannot be instantiated directly. All content pages in the database are required to be drived from this class.
« More »

cms_content_tree

A tree class that allows backward compatibility (somewhat) to the old Tree class used in CMSMS versions prior to 1.9, and provides content retrieval abilities, with interface into the content cache.

« More »

CmsFormUtils

A static class providing functionality for building forms.

« More »

User

Generic user class. This can be used for any logged in user or user related function.

« More »

CmsNlsOperations

A singleton class to provide simple, generic mechanism for dealing with languages encodings, and locales. This class does not handle translation strings.

« More »

CmsNls

A class to provide data and methods for encapsulating a single language

« More »

Group

Generic group class. This can be used for any logged in group or group related function.

« More »

CmsAdminUtils

A set of static utilities for assisting with admin requests

« More »

cms_url

A class for interacting with a URL.

« More »

ContentOperations

Class for static methods related to content

« More »

ContentManager

A simple alias for the ContentOperations class

« More »

Events

Class for handling and dispatching system and user defined events.

« More »

CmsLanguageDetector

An abstract class that is used to determine a suitable language for display This may be used by CMSMS on frontend requests to detect a suitable language.

modules may supply a language detector to read from preferences etc.
« More »

cms_tree

A Simple PHP Tree class that allows storing associative data along with each node.

« More »

CmsRoute

Simple global convenience object to hold information for a single route.

« More »

cms_mailer

A class for sending email.

Prior to CMSMS 2.0 this class was implemented as a core module.
« More »

Content

Implenents the Content (page) content type.

This is the primary content type. This represents an HTML page generated by smarty.
« More »

GroupOperations

A singleton Class for doing group related functions.

Many of the Group object functions are just wrappers around these.
« More »

UserOperations

Class for doing user related functions. Maybe of the User object functions are just wrappers around these.

« More »

CmsAdminThemeBase

Base class for CMSMS Admin themes.

This is an abstract class that is used for building CMSMS Admin Themes. This is also a singleton object.
« More »

CmsAdminThemeNotification

A class representing a simple notification.

« More »

cms_siteprefs

A class for working with site preferences

« More »

CmsLangOperations

A singleton class to provide simple, generic mechanism for dealing with languages encodings, and locales. This class does not handle translation strings.

« More »

CMSModuleContentType

Class that module defined content types must extend.

This is the base level content class. It is an abstract object and cannot be instantiated directly. All content pages in the database are required to be drived from this class.
« More »

CmsAdminMenuItem

Base module class.

All modules should inherit and extend this class with their functionality.
« More »

cms_utils

A Simple Static class providing various convenience utilities.

« More »

cms_module_smarty_plugin_manager

A singleton class to manage static smarty plugins registered by modules.

« More »

cms_userprefs

A static class for preferences stored with admin user accounts

« More »

CmsLayoutTemplateCategory

A class representing a template category.

Templates can be optionally organized into categories, this class manages the category itself.
« More »

cms_cookies

A simple static class providing convenience utilities for working with cookies.

« More »

cms_http_request

HTTP Class

This is a wrapper HTTP class that uses either cURL or fsockopen to harvest resources from web. This can be used with scripts that need a way to communicate with various APIs who support REST. Modified by Robert Campbell (calguy1000@cmsmadesimple.org) Renamed the class to cms_http_request Fixed some bugs.
« More »

CmsApp

Simple singleton class that contains various functions and states representing the application.

Note: This class was named CmsObject before version 1.10
« More »

CmsContentTypePlaceholder

Simple global convenience object to hold CMS Content Type structure.

« More »

ErrorPage

Implement the ErrorPage content type

Error pages are not navigble, do not have their own URLS and typically do not appear in navigations. They are used for handling different types of errors.
« More »

UserTagOperations

UserTags class for admin

« More »

cms_admin_utils

A Simple static class providing various convenience utilities for admin requests.

« More »

cms_tree_operations

A utility class to provide functions to populate a tree

« More »

cms_config

A singleton class for interacting with the CMSMS config.php file.

This class usses the ArrayAccess interface to behave like a PHP array.
« More »

cms_cache_handler

This singleton class provides a convenient caching capbility.

By default this uses the cms_filecache_driver to cache data in the TMP_CACHE_LOCATION for one hour.
« More »

CmsPermission

Simple class for dealing with a permission.

« More »

CMSModule

Base module class.

All modules should inherit and extend this class with their functionality.
« More »

CmsCoreCapabilities

A class that identifies numerous standard core capabilities

« More »

BookmarkOperations

Class for doing bookmark related functions. Maybe of the Bookmark object functions are just wrappers around these.

« More »

CmsLockException

An exception indicating an error creating a lock

This exception can accept an integer 'code' for an exception or a language key. if the string passed in contains a space it is not translated.
« More »

CmsLockOwnerException

An exception indicating a uid mismatch wrt a lock (person operating on the lock is not the owner)

This exception can accept an integer 'code' for an exception or a language key. if the string passed in contains a space it is not translated.
« More »

CmsUnLockException

An exception indicating an error removing a lock

This exception can accept an integer 'code' for an exception or a language key. if the string passed in contains a space it is not translated.
« More »

CmsNoLockException

An exception indicating an error loading or finding a lock

This exception can accept an integer 'code' for an exception or a language key. if the string passed in contains a space it is not translated.
« More »

CmsLock

A simple class represeinting a lock on a logical object in CMSMS.

« More »

cms_route_manager

A class to manage all recognized routes in the system.

« More »

ModuleOperations

A singleton utility class to allow for working with modules.

« More »

Bookmark

Bookmark class for the CMSMS admin console.

« More »

CmsExtraDataException

A basic exception class that holds on to extended information.

« More »

CmsException

A base CMSMS Exception

This exception can accept an integer 'code' for an exception or a language key. if the string passed in contains a space it is not translated.
« More »

CmsLogicException

A base CMSMS Logic Exception

This exception can accept an integer 'code' for an exception or a language key. if the string passed in contains a space it is not translated.
« More »

CmsCommunicationException

A base CMSMS Communications Exception

This exception can accept an integer 'code' for an exception or a language key. if the string passed in contains a space it is not translated.
« More »

CmsPrivacyException

A base CMSMS Privacy Exception

This exception can accept an integer 'code' for an exception or a language key. if the string passed in contains a space it is not translated.
« More »

CmsSingletonException

A base CMSMS Singleton Exception

This exception can accept an integer 'code' for an exception or a language key. if the string passed in contains a space it is not translated.
« More »

CmsInvalidDataException

An exception indicating invalid data was supplied to a function or class.

This exception can accept an integer 'code' for an exception or a language key. if the string passed in contains a space it is not translated.
« More »

CmsDataNotFoundException

An exception indicating that the requested data could not be found.

This exception can accept an integer 'code' for an exception or a language key. if the string passed in contains a space it is not translated.
« More »

CmsError404Exception

A special exception indicating that a 404 error should be supplied.

This exception can accept an integer 'code' for an exception or a language key. if the string passed in contains a space it is not translated.
« More »

CmsContentException

A special exception indicating an error with a content object

This exception can accept an integer 'code' for an exception or a language key. if the string passed in contains a space it is not translated.
« More »

CmsEditContentException

A special exception indicating an error when editing content.

This exception can accept an integer 'code' for an exception or a language key. if the string passed in contains a space it is not translated.
« More »

CmsSQLErrorException

A special exception indicating an SQL Error.

This exception can accept an integer 'code' for an exception or a language key. if the string passed in contains a space it is not translated.
« More »

CmsXMLErrorException

A special exception indicating an XML Error.

This exception can accept an integer 'code' for an exception or a language key. if the string passed in contains a space it is not translated.
« More »

CmsFileSystemException

A special exception indicating a problem with a file, directory, or filesystem

This exception can accept an integer 'code' for an exception or a language key. if the string passed in contains a space it is not translated.
« More »

Classes, interfaces and traits

SectionHeader

Implements the CMS Made Simple Section Header content type

Section headers are logical ways to organize content. They usually appear in navigations, but are not navigable.
« More »

Separator

Implements the CMS Made Simple Separator content type

A separator is used simply for navigations to provide a visual separation between menu items. Typically as a horizontal or vertical bar.
« More »