Class CMS_object_usergroup

Description
Description | Methods (details) Constants (details)

Class CMS_object_usergroup

represent a usergroup object

Located in /automne/classes/modules/polymod/objects/object_usergroup.php (line 29) 

CMS_grandFather
   |
   --CMS_object_common
      |
      --CMS_object_usergroup
Class Constant Summary
Description | Constants (details) | Methods (details)
MESSAGE_CHOOSE_OBJECT = 1132
MESSAGE_EMPTY_OBJECTS_SET = 265
MESSAGE_OBJECT_USERGROUP_COUNT_DESCRIPTION = 259
MESSAGE_OBJECT_USERGROUP_DESCRIPTION = 265
MESSAGE_OBJECT_USERGROUP_EMAIL_DESCRIPTION = 274
MESSAGE_OBJECT_USERGROUP_FUNCTION_SELECTEDOPTIONS_DESCRIPTION = 271
MESSAGE_OBJECT_USERGROUP_IDS_DESCRIPTION = 387
MESSAGE_OBJECT_USERGROUP_ID_DESCRIPTION = 263
MESSAGE_OBJECT_USERGROUP_LABEL = 264
MESSAGE_OBJECT_USERGROUP_LABEL_DESCRIPTION = 272
MESSAGE_OBJECT_USERGROUP_PARAMETER_CREATION_USER = 377
MESSAGE_OBJECT_USERGROUP_PARAMETER_CREATION_USER_DESCRIPTION = 269
MESSAGE_OBJECT_USERGROUP_PARAMETER_CURRENT_USER = 268
MESSAGE_OBJECT_USERGROUP_PARAMETER_CURRENT_USER_DESCRIPTION = 269
MESSAGE_OBJECT_USERGROUP_PARAMETER_DISABLEGROUPS = 315
MESSAGE_OBJECT_USERGROUP_PARAMETER_DISABLEUSERS = 314
MESSAGE_OBJECT_USERGROUP_PARAMETER_GROUPS_LEFT_TITLE = 318
MESSAGE_OBJECT_USERGROUP_PARAMETER_GROUPS_RIGHT_TITLE = 319
MESSAGE_OBJECT_USERGROUP_PARAMETER_INCLUDE_EXCLUDE = 320
MESSAGE_OBJECT_USERGROUP_PARAMETER_INCLUDE_EXCLUDE_DESCRIPTION = 321
MESSAGE_OBJECT_USERGROUP_PARAMETER_MULTI = 266
MESSAGE_OBJECT_USERGROUP_PARAMETER_ROOT_CATEGORY = 267
MESSAGE_OBJECT_USERGROUP_PARAMETER_ROOT_CATEGORY_DESCRIPTION = 270
MESSAGE_OBJECT_USERGROUP_PARAMETER_USERS_LEFT_TITLE = 316
MESSAGE_OBJECT_USERGROUP_PARAMETER_USERS_RIGHT_TITLE = 317
MESSAGE_OBJECT_USERGROUP_VALUESEMAIL_DESCRIPTION = 273
MESSAGE_OBJECT_USERGROUP_VALUESID_DESCRIPTION = 261
MESSAGE_OBJECT_USERGROUP_VALUESLABEL_DESCRIPTION = 262
MESSAGE_OBJECT_USERGROUP_VALUES_DESCRIPTION = 260
Method Summary
Description | Constants (details) Methods (details)
static array(integer getListOfNamesForObject ([boolean $public = false], [ $searchConditions = array()], array $searchConditions,)
boolean checkMandatory (array $values, string $prefixName)
string getFieldOrderSQL (integer $fieldID, mixed $direction, string $operator, string $where, [boolean $public = false])
string getFieldSearchSQL (integer $fieldID, integer $value, string $operator, string $where, [boolean $public = false])
string getHTMLAdmin ( $fieldID,  $language, string $prefixName, integer $fieldID,, CMS_language $language,)
string getHTMLDescription ()
string getHTMLSubFieldsParametersDisableGroups ( $language,  $prefixName)
string getHTMLSubFieldsParametersDisableUsers ( $language,  $prefixName)
string getInput ( $fieldID, multidimentionnal $language,  $inputParams, array $values)
array getLabelsStructure ( &$language,  $objectName)
multidimentionnal getStructure ()
multidimentionnal getValue (string $name, [string $parameters = ''])
void __construct ([array $datas = array()], CMS_object_field &$field, [boolean $public = false])
string selectOptions (array $values, multidimentionnal $tags)
boolean setSubFieldsDefinition ($subFieldsDefinition $subFieldsDefinition)
boolean setValues (array $values, string $prefixName)
array, treatParams (array $post, string $prefix)
boolean writeToPersistence ()
Methods
Description | Constants (details) Methods (details)
static getListOfNamesForObject (line 815)

Return a list of all objects names of given type

  • return: objectID => string objectName)
  • access: public
static array(integer getListOfNamesForObject ([boolean $public = false], [ $searchConditions = array()], array $searchConditions,)
  • boolean $public: are the needed datas public ? /!\ Does not apply for this type of object
  • array $searchConditions,: search conditions to add. /!\ only keywords apply for this type of object
  • $searchConditions
checkMandatory (line 458)

check object Mandatories Values

  • return: true on success, false on failure
  • access: public
boolean checkMandatory (array $values, string $prefixName)
  • array $values: : the POST result values
  • string $prefixName: prefixname : the prefix used for post names
Redefinition of:
CMS_object_common::checkMandatory()
check object Mandatories Values
getFieldOrderSQL (line 1013)

Get field order SQL request (used by class CMS_object_search)

  • return: : the SQL request
  • access: public
string getFieldOrderSQL (integer $fieldID, mixed $direction, string $operator, string $where, [boolean $public = false])
  • integer $fieldID: : this field id in object (aka $this->_field->getID())
  • mixed $direction: : the direction to search (asc/desc)
  • string $operator: : additionnal search operator
  • string $where: : where clauses to add to SQL
  • boolean $public: : values are public or edited ? (default is edited)
Redefinition of:
CMS_object_common::getFieldOrderSQL()
Get field order SQL request (used by class CMS_object_search)
getFieldSearchSQL (line 788)

Get field search SQL request (used by class CMS_object_search)

  • return: : the SQL request
  • access: public
string getFieldSearchSQL (integer $fieldID, integer $value, string $operator, string $where, [boolean $public = false])
  • 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)
Redefinition of:
CMS_object_common::getFieldSearchSQL()
Get field search SQL request (used by class CMS_object_search)
getHTMLAdmin (line 220)

get HTML admin (used to enter object values in admin)

  • return: : the html admin
  • access: public
string getHTMLAdmin ( $fieldID,  $language, string $prefixName, integer $fieldID,, CMS_language $language,)
  • integer $fieldID,: the current field id (only for poly object compatibility)
  • CMS_language $language,: the current admin language
  • string $prefixName: prefixname : the prefix to use for post names
  • $fieldID
  • $language
Redefinition of:
CMS_object_common::getHTMLAdmin()
get HTML admin (used to enter object values in admin)
getHTMLDescription (line 568)

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

  • return: : object HTML description
  • access: public
string getHTMLDescription ()
Redefinition of:
CMS_object_common::getHTMLDescription()
get object HTML description for admin search detail. Usually, the label.
getHTMLSubFieldsParametersDisableGroups (line 955)

get HTML admin subfields parameters (used to enter object categories parameters values in admin)

  • return: : the html admin
  • access: public
string getHTMLSubFieldsParametersDisableGroups ( $language,  $prefixName)
  • $language
  • $prefixName
getHTMLSubFieldsParametersDisableUsers (line 902)

get HTML admin subfields parameters (used to enter object categories parameters values in admin)

  • return: : the html admin
  • access: public
string getHTMLSubFieldsParametersDisableUsers ( $language,  $prefixName)
  • $language
  • $prefixName
getInput (line 321)

Return the needed form field tag for current object field

  • return: : the form field HTML tag
  • access: public
string getInput ( $fieldID, multidimentionnal $language,  $inputParams, array $values)
  • 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
Redefinition of:
CMS_object_common::getInput()
Return the needed form field tag for current object field
getLabelsStructure (line 729)

get labels for object structure and functions

  • return: : the labels of object structure and functions
  • access: public
array getLabelsStructure ( &$language,  $objectName)
  • &$language
  • $objectName
Redefinition of:
CMS_object_common::getLabelsStructure()
get labels for object structure and functions
getStructure (line 612)

get object values structure available with getValue method

  • return: array : the object values structure
  • access: public
multidimentionnal getStructure ()
Redefinition of:
CMS_object_common::getStructure()
get object values structure available with getValue method
getValue (line 644)

get an object value

  • return: array : the object values structure
  • access: public
multidimentionnal getValue (string $name, [string $parameters = ''])
  • string $name: : the name of the value to get
  • string $parameters: (optional) : parameters for the value to get
Redefinition of:
CMS_object_common::getValue()
get an object value
Constructor __construct (line 172)

Constructor.

initialize object.

  • access: public
void __construct ([array $datas = array()], CMS_object_field &$field, [boolean $public = false])
  • array $datas: DB object values : array(integer "subFieldID" => mixed)
  • boolean $public: values are public or edited ? (default is edited)
  • CMS_object_field &$field: reference
Redefinition of:
CMS_object_common::__construct()
Constructor.
selectOptions (line 765)

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

  • return: : options tag list
  • access: public
string selectOptions (array $values, multidimentionnal $tags)
  • array $values: : parameters values array(parameterName => parameterValue) in : selected : the category id which is selected (optional)
  • multidimentionnal $tags: array $tags : xml2Array content of atm-function tag (nothing for this one)
setSubFieldsDefinition (line 534)

Set subfields definition for current object

  • return: true on success, false on failure
  • access: public
boolean setSubFieldsDefinition ($subFieldsDefinition $subFieldsDefinition)
  • $subFieldsDefinition $subFieldsDefinition: array(integer "subFieldID" => array("type" => string [integer|string|text|date], "objectID" => integer, "fieldID" => integer, "subFieldID" => integer))
Redefinition of:
CMS_object_common::setSubFieldsDefinition()
Set subfields definition for current object
setValues (line 477)

set object Values

  • return: true on success, false on failure
  • access: public
boolean setValues (array $values, string $prefixName)
  • array $values: : the POST result values
  • string $prefixName: prefixname : the prefix used for post names
Redefinition of:
CMS_object_common::setValues()
set object Values
treatParams (line 552)

treat all params then return array of values treated or false if error

  • return: the treated datas
  • access: public
array, treatParams (array $post, string $prefix)
  • array $post: the posted datas
  • string $prefix: the prefix for datas name
Redefinition of:
CMS_object_common::treatParams()
treat all params then return array of values treated or false if error
writeToPersistence (line 592)

Writes all subobjects into persistence (MySQL for now), along with base data.

  • return: true on success, false on failure
  • access: public
boolean writeToPersistence ()
Redefinition of:
CMS_object_common::writeToPersistence()
Writes all subobjects into persistence (MySQL for now), along with base data.

Inherited Methods

Inherited From CMS_object_common

CMS_object_common::__construct()
CMS_object_common::asArray()
CMS_object_common::checkMandatory()
CMS_object_common::getDescription()
CMS_object_common::getFieldDescription()
CMS_object_common::getFieldLabel()
CMS_object_common::getFieldOrderSQL()
CMS_object_common::getFieldSearchSQL()
CMS_object_common::getHTMLAdmin()
CMS_object_common::getHTMLDescription()
CMS_object_common::getHTMLSubFieldsParameters()
CMS_object_common::getInput()
CMS_object_common::getLabel()
CMS_object_common::getLabelsStructure()
CMS_object_common::getObjectLabel()
CMS_object_common::getParamsValues()
CMS_object_common::getParamValue()
CMS_object_common::getSoapValues()
CMS_object_common::getStructure()
CMS_object_common::getSubFieldParameters()
CMS_object_common::getSubFieldsDefinition()
CMS_object_common::getValue()
CMS_object_common::hasParameters()
CMS_object_common::serializeHTMLParameters()
CMS_object_common::setParamValue()
CMS_object_common::setSoapValues()
CMS_object_common::setSubFieldsDefinition()
CMS_object_common::setValues()
CMS_object_common::treatParams()
CMS_object_common::writeToPersistence()

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
Description | Constants (details) | Methods (details)
MESSAGE_CHOOSE_OBJECT = 1132 (line 35)
MESSAGE_EMPTY_OBJECTS_SET = 265 (line 34)

Standard Messages

MESSAGE_OBJECT_USERGROUP_COUNT_DESCRIPTION = 259 (line 40)

Polymod Messages

MESSAGE_OBJECT_USERGROUP_DESCRIPTION = 265 (line 50)
MESSAGE_OBJECT_USERGROUP_EMAIL_DESCRIPTION = 274 (line 47)
MESSAGE_OBJECT_USERGROUP_FUNCTION_SELECTEDOPTIONS_DESCRIPTION = 271 (line 48)
MESSAGE_OBJECT_USERGROUP_IDS_DESCRIPTION = 387 (line 66)
MESSAGE_OBJECT_USERGROUP_ID_DESCRIPTION = 263 (line 45)
MESSAGE_OBJECT_USERGROUP_LABEL = 264 (line 49)
MESSAGE_OBJECT_USERGROUP_LABEL_DESCRIPTION = 272 (line 46)
MESSAGE_OBJECT_USERGROUP_PARAMETER_CREATION_USER = 377 (line 64)
MESSAGE_OBJECT_USERGROUP_PARAMETER_CREATION_USER_DESCRIPTION = 269 (line 65)
MESSAGE_OBJECT_USERGROUP_PARAMETER_CURRENT_USER = 268 (line 54)
MESSAGE_OBJECT_USERGROUP_PARAMETER_CURRENT_USER_DESCRIPTION = 269 (line 55)
MESSAGE_OBJECT_USERGROUP_PARAMETER_DISABLEGROUPS = 315 (line 57)
MESSAGE_OBJECT_USERGROUP_PARAMETER_DISABLEUSERS = 314 (line 56)
MESSAGE_OBJECT_USERGROUP_PARAMETER_GROUPS_LEFT_TITLE = 318 (line 60)
MESSAGE_OBJECT_USERGROUP_PARAMETER_GROUPS_RIGHT_TITLE = 319 (line 61)
MESSAGE_OBJECT_USERGROUP_PARAMETER_INCLUDE_EXCLUDE = 320 (line 62)
MESSAGE_OBJECT_USERGROUP_PARAMETER_INCLUDE_EXCLUDE_DESCRIPTION = 321 (line 63)
MESSAGE_OBJECT_USERGROUP_PARAMETER_MULTI = 266 (line 51)
MESSAGE_OBJECT_USERGROUP_PARAMETER_ROOT_CATEGORY = 267 (line 52)
MESSAGE_OBJECT_USERGROUP_PARAMETER_ROOT_CATEGORY_DESCRIPTION = 270 (line 53)
MESSAGE_OBJECT_USERGROUP_PARAMETER_USERS_LEFT_TITLE = 316 (line 58)
MESSAGE_OBJECT_USERGROUP_PARAMETER_USERS_RIGHT_TITLE = 317 (line 59)
MESSAGE_OBJECT_USERGROUP_VALUESEMAIL_DESCRIPTION = 273 (line 44)
MESSAGE_OBJECT_USERGROUP_VALUESID_DESCRIPTION = 261 (line 42)
MESSAGE_OBJECT_USERGROUP_VALUESLABEL_DESCRIPTION = 262 (line 43)
MESSAGE_OBJECT_USERGROUP_VALUES_DESCRIPTION = 260 (line 41)

Inherited Constants

Inherited from CMS_object_common

CMS_object_common::MESSAGE_FIELD_NO
 CMS_object_common::MESSAGE_FIELD_YES
 CMS_object_common::MESSAGE_OBJECT_COMMON_FIELDID_DESCRIPTION
 CMS_object_common::MESSAGE_OBJECT_COMMON_FIELDNAME_DESCRIPTION
 CMS_object_common::MESSAGE_OBJECT_COMMON_FIELD_DESC_DESCRIPTION
 CMS_object_common::MESSAGE_OBJECT_COMMON_LABEL_DESCRIPTION
 CMS_object_common::MESSAGE_OBJECT_COMMON_REQUIRED_DESCRIPTION
 CMS_object_common::MESSAGE_OBJECT_COMMON_VALUE_DESCRIPTION
 CMS_object_common::MESSAGE_UNKNOWN_OBJECT_DESCRIPTION
 CMS_object_common::MESSAGE_UNKNOWN_OBJECT_LABEL

Inherited from CMS_grandFather

CMS_grandFather::ERROR_LOG
 CMS_grandFather::SYSTEM_LABEL

Documentation generated on Wed, 15 Feb 2012 15:35:03 +0100 by phpDocumentor 1.4.3