Docs For Class CMS_forms_formularCategories

Description

Class CMS_forms_formularCategories

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

Located in /automne/classes/modules/cms_forms/formcategories.php (line 25)

CMS_grandFather
   |
   --CMS_forms_formularCategories

Method Summary

static array(interger getAllUsedCategoriesForField ([ $language = false], CMS_language $language,)

void __construct ( &$resource, CMS_forms_formular $resource)

boolean addCategory ( &$obj, CMS_moduleCategory $category)

boolean categoryExists ( &$obj, CMS_moduleCategory $category)

boolean delCategory ( &$obj, CMS_moduleCategory $category)

array(string) getAllCategoriesAsArray ([ $language = false], [ $restrictToUsedCat = false], CMS_language $cms_language,, boolean $restrictToUsedCat,)

string getAttribute (string $name)

array(CMS_categories_medias) getCategories ([boolean $public = false])

array(integer) getCategoriesIds ([ $public = false], boolean $public,)

void init ()

void setAttribute (string $name, $value $value)

boolean writeToPersistence ()

Methods

static getAllUsedCategoriesForField (line 336)

Returns all categories IDs who has used by forms

return: id => integer id) the object ids
access: public

static array(interger getAllUsedCategoriesForField ([ $language = false], CMS_language $language,)

CMS_language $language,: restrict to language (default : false)
$language

Constructor __construct (line 51)

Constructor

access: public

void __construct ( &$resource, CMS_forms_formular $resource)

CMS_forms_formular $resource
&$resource

addCategory (line 172)

Adds resource to this category

access: public

boolean addCategory ( &$obj, CMS_moduleCategory $category)

CMS_moduleCategory $category
&$obj

categoryExists (line 154)

Check if a category already is in current list

return: true if already exists in set
access: public

boolean categoryExists ( &$obj, CMS_moduleCategory $category)

CMS_moduleCategory $category
&$obj

delCategory (line 197)

Delete resource linked to this category

access: public

boolean delCategory ( &$obj, CMS_moduleCategory $category)

CMS_moduleCategory $category
&$obj

getAllCategoriesAsArray (line 288)

Returns each category ID and label in a module given user can see

return: the statements or false if profile hasn't any access to any categories
access: public

array(string) getAllCategoriesAsArray ([ $language = false], [ $restrictToUsedCat = false], CMS_language $cms_language,, boolean $restrictToUsedCat,)

CMS_language $cms_language,: the language of the labels
boolean $restrictToUsedCat,: restrict returned categories to used ones only (default false)
$language
$restrictToUsedCat

getAttribute (line 65)

Getter for any private attribute on this class

access: public

string getAttribute (string $name)

string $name

getCategories (line 94)

Gets all categories this resource belongs to

access: public

array(CMS_categories_medias) getCategories ([boolean $public = false])

boolean $public

getCategoriesIds (line 135)

Gets all categories IDs this resource belongs to

access: public

array(integer) getCategoriesIds ([ $public = false], boolean $public,)

boolean $public,: to get only public datas
$public

init (line 276)

Empty category array

access: public

void init ()

setAttribute (line 77)

Setter for any private attribute on this class

access: public

void setAttribute (string $name, $value $value)

string $name: name of attribute to set
$value $value: , the value to give

writeToPersistence (line 221)

Write to persistence and submit resource to validation process too.

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

boolean writeToPersistence ()

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