Docs For Class CMS_object_google

Description

Class CMS_object_coordinates

represent a simple integer object

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

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

CMS_grandFather
   |
   --CMS_object_common
      |
      --CMS_object_google_coordinates

Class Constant Summary

MESSAGE_OBJECT_COORDINATES_DESCRIPTION = 562

MESSAGE_OBJECT_COORDINATES_FIELD_ADDRESS = 567

MESSAGE_OBJECT_COORDINATES_FIELD_ENTER_ADDRESS = 573

MESSAGE_OBJECT_COORDINATES_FIELD_MAP_WINDOW = 572

MESSAGE_OBJECT_COORDINATES_FIELD_PUT_ON_MAP = 571

MESSAGE_OBJECT_COORDINATES_FIELD_UNKOWN_ADDRESS = 570

MESSAGE_OBJECT_COORDINATES_FIELD_UPDATE_FROM_ADDRESS = 569

MESSAGE_OBJECT_COORDINATES_LABEL = 561

MESSAGE_OBJECT_COORDINATES_LATITUDE_DESCRIPTION = 564

MESSAGE_OBJECT_COORDINATES_LONGITUDE_DESCRIPTION = 563

MESSAGE_OBJECT_COORDINATES_PARAMETER_FIELDS = 568

MESSAGE_OBJECT_COORDINATES_PARAMETER_FIELDS_DESC = 566

MESSAGE_OBJECT_COORDINATES_PARAMETER_USE_FIELDS = 567

MESSAGE_OBJECT_COORDINATES_PARAMETER_USE_FIELDS_DESC = 565

Method Summary

static array getCoordinates ( &$language, [string $address = ''], [string $sCcTld = false], object $language)

string getHTMLAdmin ( $fieldID, $language, string $prefixName, integer $fieldID,, CMS_language $language,)

string getInput ( $fieldID, multidimentionnal $language, $inputParams, array $values)

array getLabelsStructure ( &$language)

multidimentionnal getStructure ()

multidimentionnal getValue (string $name, [string $parameters = ''])

array importParams (array $params, CMS_language $cms_language, &$idsRelation, &$infos, array $idsRelation, string $infos)

void __construct ([array $datas = array()], CMS_object_field &$field, [boolean $public = false])

Methods

static getCoordinates (line 379)

return the lat and long of a point by is adress

return: of coordonate
access: protected

static array getCoordinates ( &$language, [string $address = ''], [string $sCcTld = false], object $language)

object $language: cms_language object
string $address
string $sCcTld: sCcTld country top level domain to wich restrain the geocoding
&$language

getHTMLAdmin (line 146)

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)

getInput (line 346)

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

get labels for object structure and functions

return: : the labels of object structure and functions
access: public

array getLabelsStructure ( &$language)

&$language

Redefinition of:

CMS_object_common::getLabelsStructure(): get labels for object structure and functions

getStructure (line 307)

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

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

importParams (line 441)

Treat fields parameters to import

return: : the treated parameters
access: public

array importParams (array $params, CMS_language $cms_language, &$idsRelation, &$infos, array $idsRelation, string $infos)

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

Constructor __construct (line 132)

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.

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

MESSAGE_OBJECT_COORDINATES_DESCRIPTION = 562 (line 35)

MESSAGE_OBJECT_COORDINATES_FIELD_ADDRESS = 567 (line 46)

MESSAGE_OBJECT_COORDINATES_FIELD_ENTER_ADDRESS = 573 (line 47)

MESSAGE_OBJECT_COORDINATES_FIELD_MAP_WINDOW = 572 (line 45)

MESSAGE_OBJECT_COORDINATES_FIELD_PUT_ON_MAP = 571 (line 44)

MESSAGE_OBJECT_COORDINATES_FIELD_UNKOWN_ADDRESS = 570 (line 43)

MESSAGE_OBJECT_COORDINATES_FIELD_UPDATE_FROM_ADDRESS = 569 (line 42)

MESSAGE_OBJECT_COORDINATES_LABEL = 561 (line 34)

Polymod Messages

MESSAGE_OBJECT_COORDINATES_LATITUDE_DESCRIPTION = 564 (line 37)

MESSAGE_OBJECT_COORDINATES_LONGITUDE_DESCRIPTION = 563 (line 36)

MESSAGE_OBJECT_COORDINATES_PARAMETER_FIELDS = 568 (line 38)

MESSAGE_OBJECT_COORDINATES_PARAMETER_FIELDS_DESC = 566 (line 39)

MESSAGE_OBJECT_COORDINATES_PARAMETER_USE_FIELDS = 567 (line 40)

MESSAGE_OBJECT_COORDINATES_PARAMETER_USE_FIELDS_DESC = 565 (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