Docs For Class CMS_object

CMS_object_image

Description

Class CMS_object_image

represent an image object

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

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

CMS_grandFather
   |
   --CMS_object_common
      |
      --CMS_object_image

Class Constant Summary

MESSAGE_OBJECT_IMAGE_DESCRIPTION = 201

MESSAGE_OBJECT_IMAGE_FIELD_ACTUAL_IMAGE = 214

MESSAGE_OBJECT_IMAGE_FIELD_DELETE = 213

MESSAGE_OBJECT_IMAGE_FIELD_DESC = 208

MESSAGE_OBJECT_IMAGE_FIELD_DESC_HEIGHT = 415

MESSAGE_OBJECT_IMAGE_FIELD_DESC_HEIGHT_AND_WIDTH = 416

MESSAGE_OBJECT_IMAGE_FIELD_LABEL = 581

MESSAGE_OBJECT_IMAGE_FIELD_MAX_FILESIZE = 236

MESSAGE_OBJECT_IMAGE_FIELD_THUMBNAIL = 206

MESSAGE_OBJECT_IMAGE_FIELD_USE_ORIGINAL_AS_ZOOM = 211

MESSAGE_OBJECT_IMAGE_FIELD_ZOOM = 207

MESSAGE_OBJECT_IMAGE_IMAGEHEIGHT_DESCRIPTION = 221

MESSAGE_OBJECT_IMAGE_IMAGEHTML_DESCRIPTION = 215

MESSAGE_OBJECT_IMAGE_IMAGELABEL_DESCRIPTION = 216

MESSAGE_OBJECT_IMAGE_IMAGEMAXHEIGHT_DESCRIPTION = 413

MESSAGE_OBJECT_IMAGE_IMAGEMAXWIDTH_DESCRIPTION = 253

MESSAGE_OBJECT_IMAGE_IMAGENAME_DESCRIPTION = 217

MESSAGE_OBJECT_IMAGE_IMAGEPATH_DESCRIPTION = 219

MESSAGE_OBJECT_IMAGE_IMAGESIZE_DESCRIPTION = 224

MESSAGE_OBJECT_IMAGE_IMAGEWIDTH_DESCRIPTION = 220

MESSAGE_OBJECT_IMAGE_IMAGEZOOMHEIGHT_DESCRIPTION = 223

MESSAGE_OBJECT_IMAGE_IMAGEZOOMNAME_DESCRIPTION = 218

MESSAGE_OBJECT_IMAGE_IMAGEZOOMSIZE_DESCRIPTION = 225

MESSAGE_OBJECT_IMAGE_IMAGEZOOMWIDTH_DESCRIPTION = 222

MESSAGE_OBJECT_IMAGE_IMAGEZOOM_DESCRIPTION = 580

MESSAGE_OBJECT_IMAGE_IMAGE_DESCRIPTION = 579

MESSAGE_OBJECT_IMAGE_LABEL = 200

MESSAGE_OBJECT_IMAGE_PARAMETER_LEGENDMANDATORY = 582

MESSAGE_OBJECT_IMAGE_PARAMETER_MAKEZOOM = 205

MESSAGE_OBJECT_IMAGE_PARAMETER_MAXHEIGHT = 423

MESSAGE_OBJECT_IMAGE_PARAMETER_MAXHEIGHT_DESC = 412

MESSAGE_OBJECT_IMAGE_PARAMETER_MAXWIDTH = 202

MESSAGE_OBJECT_IMAGE_PARAMETER_MAXWIDTHPREVIZ = 409

MESSAGE_OBJECT_IMAGE_PARAMETER_MAXWIDTH_DESC = 212

MESSAGE_OBJECT_IMAGE_PARAMETER_MAXZOOMHEIGHT = 551

MESSAGE_OBJECT_IMAGE_PARAMETER_MAXZOOMHEIGHT_DESC = 552

MESSAGE_OBJECT_IMAGE_PARAMETER_MAXZOOMWIDTH = 549

MESSAGE_OBJECT_IMAGE_PARAMETER_MAXZOOMWIDTH_DESC = 550

MESSAGE_OBJECT_IMAGE_PARAMETER_USEDISTINCTZOOM = 209

MESSAGE_SELECT_PICTURE = 528

OBJECT_IMAGE_POPUP_FILE = "imagezoom.php"

Method Summary

boolean checkMandatory (array $values, string $prefixName, [ $newFormat = false])

string getFieldOrderSQL (integer $fieldID, mixed $direction, string $operator, string $where, [boolean $public = false])

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

string getHTMLDescription ()

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

string getLabel ()

array getLabelsStructure ( &$language)

multidimentionnal getStructure ()

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

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

void needIDToSetValues ()

boolean setValues (array $values, string $prefixName, [boolean $newFormat = false], [integer $objectID = ''])

Methods

checkMandatory (line 232)

check object Mandatories Values

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

boolean checkMandatory (array $values, string $prefixName, [ $newFormat = false])

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

Redefinition of:

CMS_object_common::checkMandatory(): check object Mandatories Values

getFieldOrderSQL (line 1280)

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)

getHTMLAdmin (line 302)

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

get object HTML description for admin search detail.

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.

getInput (line 467)

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

getLabel (line 216)

get object label

return: : the label
access: public

string getLabel ()

Redefinition of:

CMS_object_common::getLabel(): get object label : by default, the first subField value (used to designate this object in lists)

getLabelsStructure (line 1247)

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

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

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

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.

needIDToSetValues (line 560)

blank method, only needed to inform the need of an object id when set object values (method setValues)

access: public

void needIDToSetValues ()

setValues (line 574)

set object Values

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

boolean setValues (array $values, string $prefixName, [boolean $newFormat = false], [integer $objectID = ''])

array $values: : the POST result values
integer $objectID: : the current object id. Must be set, but default is blank for compatibility with other objects
string $prefixName: prefixname : the prefix used for post names
boolean $newFormat: newFormat : new automne v4 format (default false for compatibility)

Redefinition of:

CMS_object_common::setValues(): set object Values

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_IMAGE_DESCRIPTION = 201 (line 31)

MESSAGE_OBJECT_IMAGE_FIELD_ACTUAL_IMAGE = 214 (line 53)

MESSAGE_OBJECT_IMAGE_FIELD_DELETE = 213 (line 52)

MESSAGE_OBJECT_IMAGE_FIELD_DESC = 208 (line 46)

MESSAGE_OBJECT_IMAGE_FIELD_DESC_HEIGHT = 415 (line 47)

MESSAGE_OBJECT_IMAGE_FIELD_DESC_HEIGHT_AND_WIDTH = 416 (line 48)

MESSAGE_OBJECT_IMAGE_FIELD_LABEL = 581 (line 43)

MESSAGE_OBJECT_IMAGE_FIELD_MAX_FILESIZE = 236 (line 65)

MESSAGE_OBJECT_IMAGE_FIELD_THUMBNAIL = 206 (line 44)

MESSAGE_OBJECT_IMAGE_FIELD_USE_ORIGINAL_AS_ZOOM = 211 (line 50)

MESSAGE_OBJECT_IMAGE_FIELD_ZOOM = 207 (line 45)

MESSAGE_OBJECT_IMAGE_IMAGEHEIGHT_DESCRIPTION = 221 (line 60)

MESSAGE_OBJECT_IMAGE_IMAGEHTML_DESCRIPTION = 215 (line 54)

MESSAGE_OBJECT_IMAGE_IMAGELABEL_DESCRIPTION = 216 (line 55)

MESSAGE_OBJECT_IMAGE_IMAGEMAXHEIGHT_DESCRIPTION = 413 (line 35)

MESSAGE_OBJECT_IMAGE_IMAGEMAXWIDTH_DESCRIPTION = 253 (line 34)

MESSAGE_OBJECT_IMAGE_IMAGENAME_DESCRIPTION = 217 (line 56)

MESSAGE_OBJECT_IMAGE_IMAGEPATH_DESCRIPTION = 219 (line 58)

MESSAGE_OBJECT_IMAGE_IMAGESIZE_DESCRIPTION = 224 (line 63)

MESSAGE_OBJECT_IMAGE_IMAGEWIDTH_DESCRIPTION = 220 (line 59)

MESSAGE_OBJECT_IMAGE_IMAGEZOOMHEIGHT_DESCRIPTION = 223 (line 62)

MESSAGE_OBJECT_IMAGE_IMAGEZOOMNAME_DESCRIPTION = 218 (line 57)

MESSAGE_OBJECT_IMAGE_IMAGEZOOMSIZE_DESCRIPTION = 225 (line 64)

MESSAGE_OBJECT_IMAGE_IMAGEZOOMWIDTH_DESCRIPTION = 222 (line 61)

MESSAGE_OBJECT_IMAGE_IMAGEZOOM_DESCRIPTION = 580 (line 67)

MESSAGE_OBJECT_IMAGE_IMAGE_DESCRIPTION = 579 (line 66)

MESSAGE_OBJECT_IMAGE_LABEL = 200 (line 30)

MESSAGE_OBJECT_IMAGE_PARAMETER_LEGENDMANDATORY = 582 (line 68)

MESSAGE_OBJECT_IMAGE_PARAMETER_MAKEZOOM = 205 (line 38)

MESSAGE_OBJECT_IMAGE_PARAMETER_MAXHEIGHT = 423 (line 36)

MESSAGE_OBJECT_IMAGE_PARAMETER_MAXHEIGHT_DESC = 412 (line 37)

MESSAGE_OBJECT_IMAGE_PARAMETER_MAXWIDTH = 202 (line 32)

MESSAGE_OBJECT_IMAGE_PARAMETER_MAXWIDTHPREVIZ = 409 (line 51)

MESSAGE_OBJECT_IMAGE_PARAMETER_MAXWIDTH_DESC = 212 (line 33)

MESSAGE_OBJECT_IMAGE_PARAMETER_MAXZOOMHEIGHT = 551 (line 41)

MESSAGE_OBJECT_IMAGE_PARAMETER_MAXZOOMHEIGHT_DESC = 552 (line 42)

MESSAGE_OBJECT_IMAGE_PARAMETER_MAXZOOMWIDTH = 549 (line 39)

MESSAGE_OBJECT_IMAGE_PARAMETER_MAXZOOMWIDTH_DESC = 550 (line 40)

MESSAGE_OBJECT_IMAGE_PARAMETER_USEDISTINCTZOOM = 209 (line 49)

MESSAGE_SELECT_PICTURE = 528 (line 71)

OBJECT_IMAGE_POPUP_FILE = "imagezoom.php" (line 76)

Name of the enlarged image pop-up file

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