Class CMS_object_float

Description

Class CMS_object_float

represent a simple float object

Located in /automne/classes/modules/polymod/objects/object_float.php (line 27)

CMS_grandFather
   |
   --CMS_object_common
      |
      --CMS_object_string
         |
         --CMS_object_float
Class Constant Summary
Method Summary
 string getFieldOrderSQL (integer $fieldID, mixed $direction, string $operator, string $where, [boolean $public = false])
 string getFieldSearchSQL (integer $fieldID, mixed $value, string $operator, string $where, [boolean $public = false])
 string getHTMLAdmin ( $fieldID,  $language, string $prefixName, integer $fieldID,, CMS_language $language,)
 string getInput ( $fieldID, multidimentionnal $language,  $inputParams, array $values)
 array getLabelsStructure ( &$language,  $objectName)
 multidimentionnal getStructure ()
 multidimentionnal getValue (string $name, [string $parameters = ''])
 string selectOptions (array $values, multidimentionnal $tags)
 boolean setValues (array $values, string $prefixName)
Methods
getFieldOrderSQL (line 314)

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 268)

Get field search SQL request (used by class CMS_object_search)

  • return: : the SQL request
  • access: public
string getFieldSearchSQL (integer $fieldID, mixed $value, string $operator, string $where, [boolean $public = false])
  • integer $fieldID: : this field id in object (aka $this->_field->getID())
  • mixed $value: : the 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_string::getFieldSearchSQL()
Get field search SQL request (used by class CMS_object_search)
getHTMLAdmin (line 106)

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_string::getHTMLAdmin()
get HTML admin (used to enter object values in admin)
getInput (line 180)

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_string::getInput()
Return the needed form field tag for current object field
getLabelsStructure (line 225)

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_string::getLabelsStructure()
get labels for object structure and functions
getStructure (line 164)

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 244)

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_string::getValue()
get an object value
selectOptions (line 351)

Return options tag list (for a select tag) of all float values for this field

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

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_string::setValues()
set object Values

Inherited Methods

Inherited From CMS_object_string

 CMS_object_string::__construct()
 CMS_object_string::getFieldSearchSQL()
 CMS_object_string::getHTMLAdmin()
 CMS_object_string::getInput()
 CMS_object_string::getLabelsStructure()
 CMS_object_string::getValue()
 CMS_object_string::setValues()
 CMS_object_string::treatParams()

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
MESSAGE_OBJECT_FLOAT_DESCRIPTION = 397 (line 32)
MESSAGE_OBJECT_FLOAT_FUNCTION_SELECTEDOPTIONS_DESCRIPTION = 538 (line 41)
MESSAGE_OBJECT_FLOAT_LABEL = 396 (line 31)

Polymod Messages

MESSAGE_OBJECT_FLOAT_OPERATOR_OTHERS_DESCRIPTION = 394 (line 33)
MESSAGE_OBJECT_FLOAT_PARAMETER_CANBENEGATIVE = 395 (line 35)
MESSAGE_OBJECT_FLOAT_PARAMETER_MATCH_EXPRESSION = 372 (line 36)
MESSAGE_OBJECT_FLOAT_PARAMETER_MATCH_EXPRESSION_DESCRIPTION = 373 (line 37)
MESSAGE_OBJECT_FLOAT_PARAMETER_MAXLENGTH = 187 (line 34)
MESSAGE_OBJECT_FLOAT_PARAMETER_UNIT = 417 (line 38)
MESSAGE_OBJECT_FLOAT_PARAMETER_UNIT_DESC = 418 (line 39)
MESSAGE_OBJECT_FLOAT_PARAMETER_UNIT_DESCRIPTION = 419 (line 40)

Inherited Constants

Inherited from CMS_object_string

CMS_object_string::MESSAGE_OBJECT_STRING_DESCRIPTION
CMS_object_string::MESSAGE_OBJECT_STRING_LABEL
CMS_object_string::MESSAGE_OBJECT_STRING_OPERATOR_ARRAY_DESCRIPTION
CMS_object_string::MESSAGE_OBJECT_STRING_OPERATOR_COMPARAISON_DESCRIPTION
CMS_object_string::MESSAGE_OBJECT_STRING_OPERATOR_DESCRIPTION
CMS_object_string::MESSAGE_OBJECT_STRING_PARAMETER_ISEMAIL
CMS_object_string::MESSAGE_OBJECT_STRING_PARAMETER_MATCH_EXPRESSION
CMS_object_string::MESSAGE_OBJECT_STRING_PARAMETER_MATCH_EXPRESSION_DESCRIPTION
CMS_object_string::MESSAGE_OBJECT_STRING_PARAMETER_MAXLENGHT_DESC
CMS_object_string::MESSAGE_OBJECT_STRING_PARAMETER_MAXLENGTH
CMS_object_string::MESSAGE_OBJECT_TEXT_OPERATOR_ALL_DESCRIPTION
CMS_object_string::MESSAGE_OBJECT_TEXT_OPERATOR_ANY_DESCRIPTION
CMS_object_string::MESSAGE_OBJECT_TEXT_OPERATOR_BEGINSWITH_DESCRIPTION
CMS_object_string::MESSAGE_OBJECT_TEXT_OPERATOR_PHRASE_DESCRIPTION

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:34:04 +0100 by phpDocumentor 1.4.3