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 clearFusionCMS

clearFusionCMS Class

Static clearFusionCMS application class.

flApp
Extended by clearFusionCMS
Package: clearFusionCMS
Copyright: Copyright (c) 2012 - 2015 clearFusionCMS. All rights reserved.
Located at system/app/clearFusionCMS.php

Methods summary

public static clearFusionCMS|flApp
# getInstance( )

Get the instance of the application object.

Get the instance of the application object.

Returns

clearFusionCMS|flApp
The app instance.

Overrides

flApp::getInstance
public static
# disableCache( )

Disable any cache systems.

Disable any cache systems.

public static flUser
# getUser( )

Get the user object.

Get the user object.

Returns

flUser
The object describing the user.
public static flUser
# getAccessCtrl( )

Get the access control object.

Get the access control object.

Deprecated

Applications should use getUser

Returns

flUser
The object for testing permissions or false if the user is not authenticated.
public static flUserMgr
# getUserMgr( )

Get the user manager object.

Get the user manager object.

Returns

flUserMgr
The user manager object.
public static
# setSite( string $site, string $displayName, string $twitterAccount = '' )

Set the name of the active site.

Set the name of the active site.

Parameters

$site
The short name of the active site.
$displayName
The display name of the active site.
$twitterAccount
The twitter account attributed to the site.
public static string
# getSite( )

Get the name of the active site.

Get the name of the active site.

Returns

string
The short name of the active site.
public static string
# getSiteName( )

Get the display name of the active site.

Get the display name of the active site.

Returns

string
The display name of the active site.
public static string
# getSiteTwitter( )

Get the twitter account that the site is attibuted to.

Get the twitter account that the site is attibuted to.

Returns

string
The twitter account the site is attributed to.
public static string
# getTimezone( )

Get the timezone.

Get the timezone.

Returns

string
If a user is logged in then their timezone; else the system timezone.
public static string
# getSysTimezone( )

Get the timezone used for the system.

Get the timezone used for the system.

Returns

string
The system timezone.
public static flConfig
# getSiteConfig( string $namespace )

Get the site configuration object for a given namespace.

Get the site configuration object for a given namespace.

Parameters

$namespace
The namespace to get the config for.

Returns

flConfig
The configuration object.

Throws

clearFusionCMSException
public static flEmail
# getMailer( )

Get a mailer object to send system emails from with the sender and reply to addresses set from the site config.

Get a mailer object to send system emails from with the sender and reply to addresses set from the site config.

Returns

flEmail
The mailer object.
public static flVariables
# getTaskData( string $taskName )

Get the data object for a task.

Get the data object for a task.

Parameters

$taskName
The name name of the task to get the data for.

Returns

flVariables
The data.

Throws

clearFusionCMSException
public static
# notify( integer $level, string $message, string $mention = '' )

Send out a system notification event.

Send out a system notification event.

Parameters

$level
The level 1 through 5, 1 being the lowest.
$message
The text formatted message to send.
$mention
The list of users to mention.

Methods inherited from flApp

getCache(), getCodeBuffer(), getConfig(), getController(), getDb(), getEventManager(), getRequest(), getResponse(), getRouter(), getSession(), init(), isConsole(), run(), setController(), setInstance()

Properties summary

protected flUser $user

The user object.

The user object.

# null
protected flUserMgr $userMgr

The user manager object.

The user manager object.

# null
protected string $site

The short name of the active site.

The short name of the active site.

# null
protected string $siteName

The display name of the active site.

The display name of the active site.

# null
protected string $siteTwitter

The twitter account attributed to the site.

The twitter account attributed to the site.

# ''
protected string $timezone

The timezone.

The timezone.

# null
protected string $sysTZ

The system timezone.

The system timezone.

# null
protected array $configs

Cache of flConfig objects.

Cache of flConfig objects.

# array()
protected array $taskData

Cache of task data.

Cache of task data.

# array()

Properties inherited from flApp

$cache, $cfg, $codeBuffer, $controller, $db, $eventManager, $innerObjects, $instance, $request, $response, $router, $session

clearFusionCMS 3.0.0 API documentation generated by ApiGen