static getAllUsedCategoriesForField (line 733)

Returns all categories IDs who has used by this type of object (ie : this field)

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

• mixed $restrictToItemsIds: (boolean or array) $restrictToItemsIds, restrict results to given items ids. False to restrict to only used categories (default)

categoriesTree (line 1289)

Return sub tree of a given category

• return: : the sub tree of the given category
• access: public

• array $values: : parameters values array(parameterName => parameterValue) in : root : the category id to get subtree. If none set, use the defined root category for field maxlevel : the maximum number of level to get (optional) selected : the current selected category id (optional) usedcategories : display only used categories (optional, default : true)
• multidimentionnal $tags: array $tags : xml2Array content of atm-function tag <item>...{lvl}...{id}...{label}...{sublevel}...</item> <itemselected>...{lvl}...{id}...{label}...{sublevel}...</itemselected> <template>...{sublevel}...</template>

categoryLineage (line 1223)

Return a given category lineage

• return: : the category lineage
• access: public

• array $values: : parameters values array(parameterName => parameterValue) in : category : the category id to get lineage of
• multidimentionnal $tags: array $tags : xml2Array content of atm-function tag <ancestor> ... {id} ... {label} ... </ancestor> <self> ... {label} ...</self>

getAllCategoriesAsArray (line 649)

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

• CMS_language $cms_language,: the language of the labels
• boolean $restrictToUsedCat,: restrict returned categories to used ones only (default false)
• string $cms_module,: the module codename (optional)
• boolean $editableOnly,: return only user editable categories (default false : viewvable ones)
• mixed $clearanceLevel: - false : CLEARANCE_MODULE_VIEW
  • true : CLEARANCE_MODULE_EDIT
  • constant value : clearanceLevel value
• mixed $categoriesRoot,: root category ID to use (default : false : the field root category)
• boolean $strict,: return strict categories available for user for this field (without the parent tree). default false
• mixed $crossLanguage: (boolean or array) $usedByItemsIds, This parameters is used only if $restrictToUsedCat is used. False to restrict to only used categories (default)
• $language
• $restrictToUsedCat
• $module
• $categoriesRoot
• $strict
• $usedByItemsIds

getFieldSearchSQL (line 1523)

Get field search SQL request (used by class CMS_object_search)

• return: : the SQL request
• access: public

• integer $fieldID: : this field id in object (aka $this->_field->getID())
• integer $value: : the category value to search
• string $operator: : additionnal search operator
• string $where: : where clauses to add to SQL
• boolean $public: : values are public or edited ? (default is edited)

CMS_object_common::getFieldSearchSQL()

Get field search SQL request (used by class CMS_object_search)

getHTMLDescription (line 593)

get object HTML description for admin search detail. Usually, the label.

• return: : object HTML description
• access: public

CMS_object_common::getHTMLDescription()

get object HTML description for admin search detail. Usually, the label.

getInput (line 365)

Return the needed form field tag for current object field

• return: : the form field HTML tag
• access: public

• array $values: : parameters values array(parameterName => parameterValue) in : id : the form field id to set
• multidimentionnal $language: array $tags : xml2Array content of atm-function tag
• $fieldID
• $inputParams

CMS_object_common::getInput()

Return the needed form field tag for current object field

getStructure (line 887)

get object values structure available with getValue method

• return: array : the object values structure
• access: public

CMS_object_common::getStructure()

get object values structure available with getValue method

importParams (line 1814)

Treat fields parameters to import

• return: : the treated parameters
• access: public

• array $params: The import parameters. array( create => false|true : create missing objects (default : true) update => false|true : update existing objects (default : true) files => false|true : use files from PATH_TMP_FS (default : true) )
• CMS_language $cms_language: The CMS_langage to use
• array $idsRelation: : Reference : The relations between import datas ids and real imported ids
• string $infos: : Reference : The import infos returned
• &$idsRelation
• &$infos

selectOptions (line 1446)

For a given category, return options tag list (for a select tag) of all sub categories

• return: : options tag list
• access: public

• array $values: : parameters values array(parameterName => parameterValue) in : selected : the category id which is selected (optional) usedcategories : display only used categories (optional, default : true) usedbyitemsids : display only categories used by items list. Accept array of items ids or list of ids (comma separated). Used only if 'usedcategories' is active (optional, default : false) editableonly : display only editable categories (optional, default : false) root : the category id to use as root (optional) crosslanguage : returned categories do not filter by language and return all categories even if current language has no label (default : false)
• multidimentionnal $tags: array $tags : xml2Array content of atm-function tag (nothing for this one)

setValues (line 511)

set object Values

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

• array $values: : the POST result values
• string $prefixName: prefixname : the prefix used for post names

CMS_object_common::setValues()

set object Values

_createCategoriesTree (line 1382)

• $categories
• $itemPattern
• $templatePattern
• $selectedPattern
• $maxlevel
• $selectedID