Class cfBackendController

cfBackendController Class

The base class for manager controllers.

flController

cfBackendController

Direct known subclasses

cloudflareBackendController, commentsBackendController, formsBackendController

Package: clearFusionCMS
Copyright: Copyright (c) 2012 - 2016 clearFusionCMS. All rights reserved.
Located at system/app/cfBackendController.php

Methods summary

`public`	# `__construct( flRouter $router, flRequest $request, string $permission = null )` Construct the controller. Construct the controller. Parameters `$router` The router object. `$request` The request object. `$permission` A permission required to be able to access the controller or array of permissions. Overrides `flController::__construct`
`public mixed`	# `_getVar( string $name )` Function used by cfBackendControllerAction to get variables when initialising the action. Function used by cfBackendControllerAction to get variables when initialising the action. Parameters `$name` The name of the variable to get. Returns mixed The value of the variable.
`public`	# `breadcrumbSnippet( cfTemplateEngine $tpl, array $params )` Snippet to draw the bread crumb trail. Snippet to draw the bread crumb trail. Parameters `$tpl` The template engine. `$params` The parameters being passed to the snippet.
`public`	# `testPermission( string\|array $permission )` Test if the logged in user has access permission. If the user doesn't have permission then they are directed to the dashboard. Test if the logged in user has access permission. If the user doesn't have permission then they are directed to the dashboard. Parameters `$permission` A permission to test for or an array of permissions.
`public string`	# `assemble( string $module, string $action, array $data = array(), boolean $absolute = false, boolean $secure = null )` Assemble a manager URI. Assemble a manager URI. Parameters `$module` The module name. `$action` The action name. `$data` Array of data to include. `$absolute` true to create an absolute URI else false for relative. `$secure` true for https, false for http and null for as per request. Returns string The composed URI.
`public`	# `renderPage( string $title, string $content, string $content2 = null )` Render the page. Render the page. Parameters `$title` The page title. `$content` The main HTML content for the page. `$content2` The optional secondary HTML content for tha page.
`public string`	# `alertMessage( string $type, string $message )` Assign an alert message to a template variable. Assign an alert message to a template variable. Parameters `$type` The message type Error, Success or Info `$message` The message text. Returns string The HTML for the alert.
`public string`	# `renderBlock( string $title, string $content, string $desc = '', string $msg = '', string $pagination = '' )` Render a page block. Render a page block. Parameters `$title` The title for the block. `$content` The HTML content. `$desc` The description for the block. `$msg` The message for the content area. `$pagination` The pagination widget if any. Returns string The rendered HTML.
`public string`	# `renderBlockToolbar( flWidgetToolbar $toolbar, string $content, string $msg = '', string $pagination = '' )` Render a page block with a toolbar. Render a page block with a toolbar. Parameters `$toolbar` The toolbar `$content` The HTML content. `$msg` The message for the content area. `$pagination` The pagination widget if any. Returns string The rendered HTML.
`public string`	# `getEditorModule( )` Get the editor module. Get the editor module. Returns string The WYSIWYG editor module.
`public string`	# `getCodeEditorModule( )` Get the code editor module. Get the code editor module. Returns string The code editor module.
`public string`	# `lockObject( string $module, integer $id, boolean $global = false )` Lock the module object to the current user. Lock the module object to the current user. Parameters `$module` The module name. `$id` The ID of the object to lock. `$global` Lock the object across all sites. Returns string true if locked; else HTML for a block informing object in use.
`public`	# `lockobjectAction( )` Action to lock an existing object via AJAX Action to lock an existing object via AJAX
`public`	# `unlockObject( string $module, integer $id, boolean $global = false )` Unlock the module object from the current user. Unlock the module object from the current user. Parameters `$module` The module name. `$id` The ID of the object to unlock. `$global` Lock the object across all sites.
`public`	# `confirmLeavePage( )` Add a JavaScript confirmation when the user tries to leave a page. Add a JavaScript confirmation when the user tries to leave a page.
`public`	# `getnoticesAction( )` AJAX called/Server-sent Event function to get the list of notice messages. AJAX called/Server-sent Event function to get the list of notice messages.

Methods inherited from flController

dispatch(), getActionClass(), getRequest(), getResponse(), getRouter(), setResponse()

Properties summary

`protected flDb`	`$db` The database object. The database object.	#
`protected flTemplateEngine`	`$tpl` The template engine. The template engine.	#
`protected flUser`	`$user` The user object. The user object.	#
`protected flSession`	`$session` The session object. The session object.	# `null`
`protected flWidgetBreadcrumb`	`$breadcrumbTrail` The breadcrumb trail. The breadcrumb trail.	# `null`
`protected flCache`	`$cache` Cache object to use. Cache object to use.	#
`protected flSessionData`	`$managerSession` The manager session data. The manager session data.	#

Properties inherited from flController

$actionClass, $request, $response, $router

Packages

Classes

Interfaces

Exceptions

Class cfBackendController

Direct known subclasses

Methods summary

Parameters

Overrides

Parameters

Returns

Parameters

Parameters

Parameters

Returns

Parameters

Parameters

Returns

Parameters

Returns

Parameters

Returns

Returns

Returns

Parameters

Returns

Parameters

Methods inherited from flController

Properties summary

Properties inherited from flController