CmsApp View code

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

Note: This class was named CmsObject before version 1.10

package

CMS
license

GPL
since 0.5

Methods

__construct()

Constructor

get_instance()

Retrieve the single app instancce.

static 
get_installed_schema_version()

Retrieve the installed schema version.

get_content_type()

Retrieve the request content type (for frontend requests)

If no content type is explicity set, text/html is assumed.

set_content_type(string $mime_type = null)

Set the request content type to a valid mime type.

Arguments

string $mime_type

disable_template_processing() : void

Disable the processing of the page template.

This function controls whether the page template will be processed at all. It must be called early enough in the content generation process.

Ideally this method can be called from within a module action that is called from within the default content block when content_processing is set to 2 (the default) in the config.php

template_processing_allowed() : boolean

Get the flag indicating whether or not template processing is allowed.

Response

boolean 

get_content_object() : \ContentBase|null

Get the current content page.

Will return the current content object for frontend requests. For admin requests, this method returns null.

Response

\ContentBase|null 

get_content_id() : integer|null

Get the ID of the current content page

Response

integer|null 

GetAvailableModules() : array<mixed,string>

Get a list of all installed and available modules

This method will return an array of module names that are installed, loaded and ready for use. suotable for iteration with GetModuleInstance

Response

array<mixed,string> 

GetModuleInstance(string $module_name, string $version = '') : \CMSModule

Get a reference to an installed module instance.

This method will return a reference to the module object specified if it is installed, and available. Optionally, a version check can be performed to test if the version of the requeted module matches that specified.

Arguments

string $module_name

The module name.

string $version

(optional) version number for a check.

Response

\CMSModule

Reference to the module object, or null.

GetDb() : \ADOConnection

Get a handle to the ADODB database object. You can then use this to perform all kinds of database operations.

final

Response

\ADOConnection

a handle to the ADODB database object

GetDbPrefix() : string

Get the database prefix.

Response

string 

GetConfig() : \cms_config

Get a handle to the global CMS config.

final

This object contains global paths and settings that do not belong in the database.

Response

\cms_config

The configuration object.

GetModuleOperations() : \ModuleOperations

Get a handle to the CMS ModuleOperations object.

If it does not yet exist, this method will instantiate it.

Response

\ModuleOperations

handle to the ModuleOperations object

GetSimplePluginOperations() : \CMSMS\simple_plugin_operations

Get the simple plugin operations object.

Response

\CMSMS\simple_plugin_operations 

GetUserOperations() : \UserOperations

Get a handle to the CMS UserOperations singleton object.

If it does not yet exist, this method will instantiate it.

Response

\UserOperations

handle to the UserOperations object

GetContentOperations() : \ContentOperations

Get a handle to the CMS ContentOperations singleton object.

If it does not yet exist, this method will instantiate it.

Response

\ContentOperations

handle to the ContentOperations object

GetBookmarkOperations() : \BookmarkOperations

Get a handle to the CMS Admin BookmarkOperations singleton object.

If it does not yet exist, this method will instantiate it.

Response

\BookmarkOperations

handle to the BookmarkOperations object, useful only in the admin

GetGroupOperations() : \GroupOperations

Get a handle to the CMS GroupOperations object.

If it does not yet exist, this method will instantiate it.

Response

\GroupOperations

handle to the GroupOperations object

GetUserTagOperations() : \UserTagOperations

Get a handle to the CMS UserTagOperations object.

deprecated

If it does not yet exist, this method will instantiate it.

Response

\UserTagOperations

handle to the UserTagOperations object

GetSmarty() : mixed

Get a handle to the CMS Smarty object.

If it does not yet exist, this method will instantiate it.

Response

mixed

Smarty_CMS handle to the Smarty object. Null if called from the phar installer

GetHierarchyManager() : \HierarchyManager

Get a handle to the CMS HierarchyManager object.

If it does not yet exist, this method will instantiate it.

Response

\HierarchyManager

handle to the HierarchyManager object

get_cache_driver() : \cms_cache_driver

Get the cache driver object.

Response

\cms_cache_driver 

get_hook_manager()

Get the hook manager object

get_template_manager()

Get the template manager object (for DesignManager templates)

get_cookie_manager()

Get the cookie manager.

get_site_identifier() : string

Get a randmoized string to uniquely identify this site can be used as a salt for other hashes.

Response

string 

create_new_mailer(boolean $exceptions = true) : \cms_mailer

Create a new instance of the mailer

Arguments

boolean $exceptions

Whether or not the mailer should throw exceptions.

Response

\cms_mailer 

get_admin_theme() : \CmsAdminThemeBase

Get the admin theme object

Response

\CmsAdminThemeBase 

test_state(string $state) : boolean

Test if the current application state matches the requested value.

This method will throw an exception if invalid data is passed in.

Arguments

string $state

A valid state name (see the state list above). It is recommended that the class constants be used.

Response

boolean 

get_states() : array<mixed,\stringp>

Get a list of all current states.

Response

array<mixed,\stringp>

Array of state strings, or null.

is_cli() : boolean

A convenience method to test if the current request was executed via the CLI.

Response

boolean 

is_frontend_request() : boolean

A convenience method to test if the current request is a frontend request.

Response

boolean 

is_https_request() : boolean

A convenience method to test if the current request was over HTTPS.

Response

boolean

Constants

A constant indicating that the request is for a page in the CMSMS admin console

STATE_ADMIN_PAGE

A constant indicating that the request is taking place during the installation process

STATE_INSTALL

A constant indicating that the request is for a stylesheet

STATE_STYLESHEET

A constant indicating that we are currently parsing page templates

STATE_PARSE_TEMPLATE
Back to top