Docs For Class CMS_wysiwyg

Description

Class CMS_wysiwyg_toolbar

represent a wwysiwyg (fckeditor) toolbar with a set of elements

author: Sébastien Pauchet <sebastien.pauchet@ws-interactive.fr>

Located in /automne/classes/dialogs/toolbar.php (line 27)

CMS_grandFather
   |
   --CMS_wysiwyg_toolbar

Method Summary

static array getAll ( &$user, CMS_profile_user $user)

static array getAllElements ([CMS_profile_user $user = ''])

static array getByCode (string $code, &$user, CMS_profile_user $user)

void __construct ([integer $id = 0], &$user)

void destroy ()

string getCode ()

string getDefinition ()

array getElements ()

integer getID ()

string getLabel ()

CMS_profile_user getUser ()

boolean hasModulePlugins ()

boolean setCode (string $code)

boolean setElements (elements $elements)

boolean setLabel (string $label)

boolean writeToPersistence ()

array _getDefaultElements ()

array _getModulesElements ()

Methods

static getAll (line 432)

Gets all toolbars

return: the toolbars
access: public

static array getAll ( &$user, CMS_profile_user $user)

CMS_profile_user $user: the toolbar elements to set
&$user

static getAllElements (line 404)

Gets the toolbar elements

return: the toolbar elements
access: public

static array getAllElements ([CMS_profile_user $user = ''])

CMS_profile_user $user: the toolbar elements to set

static getByCode (line 462)

Get toolbar by code

return: the toolbars
access: public

static array getByCode (string $code, &$user, CMS_profile_user $user)

string $code: the toolbar code to get
CMS_profile_user $user: the toolbar elements to set
&$user

Constructor __construct (line 140)

Constructor.

initializes the toolbar if the id is given.

access: public

void __construct ([integer $id = 0], &$user)

integer $id: DB id
&$user

destroy (line 345)

Totally destroys the current toolbar

access: public

void destroy ()

getCode (line 250)

Gets the toolbar code

return: the toolbar code
access: public

string getCode ()

getDefinition (line 316)

Gets the FCKEditor toolbar definition

return: the toolbar code
access: public

string getDefinition ()

getElements (line 272)

Gets the toolbar elements

return: the toolbar elements
access: public

array getElements ()

getID (line 181)

Gets the DB ID of the instance.

return: the DB id
access: public

integer getID ()

getLabel (line 306)

Gets the toolbar label

return: the toolbar code
access: public

string getLabel ()

getUser (line 191)

Get user used for this toolbar

return: the user
access: public

CMS_profile_user getUser ()

hasModulePlugins (line 217)

Does the toolbar use special modules plugins ?

access: public

boolean hasModulePlugins ()

setCode (line 261)

Sets the toolbar code

return: true on success, false on failure.
access: public

boolean setCode (string $code)

string $code: the toolbar code to set

setElements (line 283)

Sets the toolbar elements

return: true on success, false on failure.
access: public

boolean setElements (elements $elements)

elements $elements: the toolbar elements to set

setLabel (line 295)

Sets the toolbar label

return: true on success, false on failure.
access: public

boolean setLabel (string $label)

string $label: the toolbar label to set

writeToPersistence (line 365)

Writes the toolbar into persistence (MySQL for now).

return: true on success, false on failure
access: public

boolean writeToPersistence ()

_getDefaultElements (line 236)

Get default toolbar elements

return: : modules elements
access: public

array _getDefaultElements ()

_getModulesElements (line 201)

Get toolbar elements specifics to modules for the curent user

return: : modules elements
access: public

array _getModulesElements ()

Inherited Methods

Inherited From CMS_grandFather

CMS_grandFather::autoload()
CMS_grandFather::hasError()
CMS_grandFather::log()
CMS_grandFather::PHPErrorHandler()
CMS_grandFather::raiseError()
CMS_grandFather::setDebug()
CMS_grandFather::setLog()
CMS_grandFather::_raiseError()
CMS_grandFather::__call()

Class Constants

Inherited Constants

Inherited from CMS_grandFather

CMS_grandFather::ERROR_LOG
CMS_grandFather::SYSTEM_LABEL