clearFusionCMS 3.0.0
  • Package
  • Class
  • Tree
  • Deprecated

Packages

  • clearFusionCMS
    • module
      • cloudflare
      • comments
      • content
      • forms
      • members
      • search
  • fusionLib
  • None

Classes

  • cfApiController
  • cfBackendAdduserAction
  • cfBackendApikeysAction
  • cfBackendBrowsectntAction
  • cfBackendBrowsefilesAction
  • cfBackendClearcacheAction
  • cfBackendClearipblocksAction
  • cfBackendContentpermsAction
  • cfBackendContenttypesAction
  • cfBackendController
  • cfBackendControllerAction
  • cfBackendDashboardAction
  • cfBackendDocumentsAction
  • cfBackendDraftsAction
  • cfBackendEdituserAction
  • cfBackendElementsAction
  • cfBackendFilemgrAction
  • cfBackendFingerprintAction
  • cfBackendForgotpwdAction
  • cfBackendImagepreviewAction
  • cfBackendListusersAction
  • cfBackendLoginAction
  • cfBackendLogoutAction
  • cfBackendModulesAction
  • cfBackendMyprofileAction
  • cfBackendPrivatefilemgrAction
  • cfBackendResetpwdAction
  • cfBackendRolesAction
  • cfBackendSelectsiteAction
  • cfBackendSet403Action
  • cfBackendSet404Action
  • cfBackendSeterrorAction
  • cfBackendSethomeAction
  • cfBackendSetthemeAction
  • cfBackendSettingsAction
  • cfBackendSitemgrAction
  • cfBackendSocialimgsAction
  • cfConfirm
  • cfContent
  • cfContentController
  • cfContentTree
  • cfCron
  • cfCronController
  • cfCustomFieldList
  • cfCustomFields
  • cfDashboardMgr
  • cfDrafts
  • cfInstallController
  • cfNoticesEvent
  • cfNoticesEventMsg
  • cfPseudoCron
  • cfSearchHelper
  • cfSiteManager
  • cfSocialImagesMgr
  • cfTaskRunner
  • cfTaskSnippets
  • cfTemplateEngine
  • cfUserMgr
  • cfUserProfile
  • cfValidatorPageSlug
  • cfValidatorUserEmail
  • cfValidatorUsername
  • clearFusionCMS
  • contentApiV1
  • contentDrafts
  • errorController

Interfaces

  • cfInstallInterface
  • cfInstallUpdInterface
  • cfModuleSettingsInterface
  • cfUserProfileInterface

Exceptions

  • cfException
  • clearFusionCMSException

Class cfBackendControllerAction

cfBackendControllerAction Class

Base class for manager controller action classes.

flControllerAction
Extended by cfBackendControllerAction

Direct known subclasses

cfBackendAdduserAction, cfBackendApikeysAction, cfBackendDraftsAction, cfBackendEdituserAction, cfBackendElementsAction, cfBackendFilemgrAction, cfBackendFingerprintAction, cfBackendForgotpwdAction, cfBackendImagepreviewAction, cfBackendListusersAction, cfBackendLoginAction, cfBackendLogoutAction, cfBackendBrowsectntAction, cfBackendModulesAction, cfBackendMyprofileAction, cfBackendPrivatefilemgrAction, cfBackendResetpwdAction, cfBackendRolesAction, cfBackendSelectsiteAction, cfBackendSet403Action, cfBackendSet404Action, cfBackendSeterrorAction, cfBackendSethomeAction, cfBackendBrowsefilesAction, cfBackendSetthemeAction, cfBackendSettingsAction, cfBackendSitemgrAction, cfBackendSocialimgsAction, cfBackendClearcacheAction, cfBackendClearipblocksAction, cfBackendContentpermsAction, cfBackendContenttypesAction, cfBackendDashboardAction, cfBackendDocumentsAction

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

Methods summary

public
# __construct( flController $controller )

Construct the object.

Construct the object.

Parameters

$controller
The parent controller object.

Overrides

flControllerAction::__construct
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
$message
The message text.

Returns

string
The HTML for the alert.
public string
# renderBlock( string $title, string $content, string $desc = '', string $msg = '', flWidgetPagination $pagination = null )

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 it any.

Returns

string
The rendered HTML.
public string
# renderBlockToolbar( flWidgetToolbar $toolbar, string $content, string $msg = '', flWidgetPagination $pagination = null )

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 it any.

Returns

string
The rendered HTML.
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
# 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 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.

Methods inherited from flControllerAction

process()

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.
#
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 flControllerAction

$controller, $request, $response, $router

clearFusionCMS 3.0.0 API documentation generated by ApiGen