Docs For Class CMS_object

CMS_object_file

Description

Class CMS_object_file

represent a file object

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

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

CMS_grandFather
   |
   --CMS_object_common
      |
      --CMS_object_file

Class Constant Summary

MESSAGE_ALL_FILE = 530

MESSAGE_OBJECT_FILE_DESCRIPTION = 228

MESSAGE_OBJECT_FILE_FIELD_ACTUAL_FILE = 241

MESSAGE_OBJECT_FILE_FIELD_DELETE = 240

MESSAGE_OBJECT_FILE_FIELD_DESC = 208

MESSAGE_OBJECT_FILE_FIELD_EXTERNALSOURCEFILE = 233

MESSAGE_OBJECT_FILE_FIELD_EXTERNALSOURCEFILE_FTP = 237

MESSAGE_OBJECT_FILE_FIELD_LABEL = 37

MESSAGE_OBJECT_FILE_FIELD_MAX_FILESIZE = 236

MESSAGE_OBJECT_FILE_FIELD_SOURCEFILE = 232

MESSAGE_OBJECT_FILE_FIELD_THUMBNAIL = 206

MESSAGE_OBJECT_FILE_FILEEXTENTION_DESCRIPTION = 239

MESSAGE_OBJECT_FILE_FILEHTML_DESCRIPTION = 242

MESSAGE_OBJECT_FILE_FILEICON_DESCRIPTION = 238

MESSAGE_OBJECT_FILE_FILELABEL_DESCRIPTION = 243

MESSAGE_OBJECT_FILE_FILENAME_DESCRIPTION = 244

MESSAGE_OBJECT_FILE_FILEPATH_DESCRIPTION = 246

MESSAGE_OBJECT_FILE_FILESIZE_DESCRIPTION = 251

MESSAGE_OBJECT_FILE_FILETHUMBNAME_DESCRIPTION = 245

MESSAGE_OBJECT_FILE_FILE_DESCRIPTION = 574

MESSAGE_OBJECT_FILE_IMAGEHEIGHT_DESCRIPTION = 577

MESSAGE_OBJECT_FILE_IMAGEMAXHEIGHT_DESCRIPTION = 414

MESSAGE_OBJECT_FILE_IMAGEMAXWIDTH_DESCRIPTION = 229

MESSAGE_OBJECT_FILE_IMAGEWIDTH_DESCRIPTION = 576

MESSAGE_OBJECT_FILE_LABEL = 227

MESSAGE_OBJECT_FILE_PARAMETER_ALLOWED_TYPE = 374

MESSAGE_OBJECT_FILE_PARAMETER_ALLOWED_TYPE_DESC = 375

MESSAGE_OBJECT_FILE_PARAMETER_ALLOW_FTP = 249

MESSAGE_OBJECT_FILE_PARAMETER_ALLOW_FTP_DESC = 250

MESSAGE_OBJECT_FILE_PARAMETER_DISALLOWED_TYPE = 376

MESSAGE_OBJECT_FILE_PARAMETER_DISALLOWED_TYPE_DESC = 375

MESSAGE_OBJECT_FILE_PARAMETER_FTP_DIRECTORY = 234

MESSAGE_OBJECT_FILE_PARAMETER_FTP_DIRECTORY_DESC = 235

MESSAGE_OBJECT_FILE_PARAMETER_ICONS = 231

MESSAGE_OBJECT_FILE_PARAMETER_MAXWIDTH_DESC = 212

MESSAGE_OBJECT_FILE_PARAMETER_THUMBMAXHEIGHT = 414

MESSAGE_OBJECT_FILE_PARAMETER_THUMBMAXWIDTH = 229

MESSAGE_OBJECT_FILE_PARAMETER_USETHUMBNAIL = 230

MESSAGE_OBJECT_FILE_THUMBEXTENTION_DESCRIPTION = 578

MESSAGE_OBJECT_FILE_THUMBHEIGHT_DESCRIPTION = 248

MESSAGE_OBJECT_FILE_THUMBWIDTH_DESCRIPTION = 247

MESSAGE_OBJECT_FILE_THUMB_DESCRIPTION = 575

MESSAGE_OBJECT_IMAGE_FIELD_DESC_HEIGHT = 415

MESSAGE_OBJECT_IMAGE_FIELD_DESC_HEIGHT_AND_WIDTH = 416

MESSAGE_OBJECT_IMAGE_PARAMETER_MAXHEIGHT_DESC = 412

MESSAGE_OBJECT_IMAGE_PARAMETER_MAXWIDTH_DESC = 212

MESSAGE_SELECT_FILE = 534

MESSAGE_SELECT_PICTURE = 528

OBJECT_FILE_TYPE_EXTERNAL = 2

OBJECT_FILE_TYPE_INTERNAL = 1

Method Summary

boolean checkMandatory (array $values, string $prefixName, [boolean $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 getHTMLSubFieldsParametersfileIcons ( $language, $prefixName)

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

string getLabel ()

array getLabelsStructure ( &$language)

multidimentionnal getStructure ()

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

void needIDToSetValues ()

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

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

array, treatParams (array $post, string $prefix)

string _getFileExtension ()

void _getFileIcon ()

string _getThumbExtension ()

Methods

checkMandatory (line 287)

check object Mandatories Values

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

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

array $values: : the POST result values
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::checkMandatory(): check object Mandatories Values

getFieldOrderSQL (line 1493)

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

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

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.

getHTMLSubFieldsParametersfileIcons (line 234)

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

return: : the html admin
access: public

string getHTMLSubFieldsParametersfileIcons ( $language, $prefixName)

$language
$prefixName

getInput (line 523)

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

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

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

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

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

needIDToSetValues (line 670)

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

access: public

void needIDToSetValues ()

Constructor __construct (line 223)

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.

setValues (line 684)

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

treatParams (line 256)

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

_getFileExtension (line 623)

return the extension of the current document.

return: : the extension of the current document
access: public

string _getFileExtension ()

_getFileIcon (line 651)

return the fileicon path if any for the current document.

access: public

void _getFileIcon ()

_getThumbExtension (line 637)

return the extension of the current thumbnail.

return: : the extension of the current document
access: public

string _getThumbExtension ()

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_ALL_FILE = 530 (line 76)

MESSAGE_OBJECT_FILE_DESCRIPTION = 228 (line 30)

MESSAGE_OBJECT_FILE_FIELD_ACTUAL_FILE = 241 (line 44)

MESSAGE_OBJECT_FILE_FIELD_DELETE = 240 (line 43)

MESSAGE_OBJECT_FILE_FIELD_DESC = 208 (line 41)

MESSAGE_OBJECT_FILE_FIELD_EXTERNALSOURCEFILE = 233 (line 56)

MESSAGE_OBJECT_FILE_FIELD_EXTERNALSOURCEFILE_FTP = 237 (line 60)

MESSAGE_OBJECT_FILE_FIELD_LABEL = 37 (line 39)

MESSAGE_OBJECT_FILE_FIELD_MAX_FILESIZE = 236 (line 59)

MESSAGE_OBJECT_FILE_FIELD_SOURCEFILE = 232 (line 55)

MESSAGE_OBJECT_FILE_FIELD_THUMBNAIL = 206 (line 40)

MESSAGE_OBJECT_FILE_FILEEXTENTION_DESCRIPTION = 239 (line 62)

MESSAGE_OBJECT_FILE_FILEHTML_DESCRIPTION = 242 (line 45)

MESSAGE_OBJECT_FILE_FILEICON_DESCRIPTION = 238 (line 61)

MESSAGE_OBJECT_FILE_FILELABEL_DESCRIPTION = 243 (line 46)

MESSAGE_OBJECT_FILE_FILENAME_DESCRIPTION = 244 (line 47)

MESSAGE_OBJECT_FILE_FILEPATH_DESCRIPTION = 246 (line 49)

MESSAGE_OBJECT_FILE_FILESIZE_DESCRIPTION = 251 (line 52)

MESSAGE_OBJECT_FILE_FILETHUMBNAME_DESCRIPTION = 245 (line 48)

MESSAGE_OBJECT_FILE_FILE_DESCRIPTION = 574 (line 69)

MESSAGE_OBJECT_FILE_IMAGEHEIGHT_DESCRIPTION = 577 (line 72)

MESSAGE_OBJECT_FILE_IMAGEMAXHEIGHT_DESCRIPTION = 414 (line 36)

MESSAGE_OBJECT_FILE_IMAGEMAXWIDTH_DESCRIPTION = 229 (line 35)

MESSAGE_OBJECT_FILE_IMAGEWIDTH_DESCRIPTION = 576 (line 71)

MESSAGE_OBJECT_FILE_LABEL = 227 (line 29)

MESSAGE_OBJECT_FILE_PARAMETER_ALLOWED_TYPE = 374 (line 65)

MESSAGE_OBJECT_FILE_PARAMETER_ALLOWED_TYPE_DESC = 375 (line 66)

MESSAGE_OBJECT_FILE_PARAMETER_ALLOW_FTP = 249 (line 63)

MESSAGE_OBJECT_FILE_PARAMETER_ALLOW_FTP_DESC = 250 (line 64)

MESSAGE_OBJECT_FILE_PARAMETER_DISALLOWED_TYPE = 376 (line 67)

MESSAGE_OBJECT_FILE_PARAMETER_DISALLOWED_TYPE_DESC = 375 (line 68)

MESSAGE_OBJECT_FILE_PARAMETER_FTP_DIRECTORY = 234 (line 57)

MESSAGE_OBJECT_FILE_PARAMETER_FTP_DIRECTORY_DESC = 235 (line 58)

MESSAGE_OBJECT_FILE_PARAMETER_ICONS = 231 (line 54)

MESSAGE_OBJECT_FILE_PARAMETER_MAXWIDTH_DESC = 212 (line 42)

MESSAGE_OBJECT_FILE_PARAMETER_THUMBMAXHEIGHT = 414 (line 32)

MESSAGE_OBJECT_FILE_PARAMETER_THUMBMAXWIDTH = 229 (line 31)

MESSAGE_OBJECT_FILE_PARAMETER_USETHUMBNAIL = 230 (line 53)

MESSAGE_OBJECT_FILE_THUMBEXTENTION_DESCRIPTION = 578 (line 73)

MESSAGE_OBJECT_FILE_THUMBHEIGHT_DESCRIPTION = 248 (line 51)

MESSAGE_OBJECT_FILE_THUMBWIDTH_DESCRIPTION = 247 (line 50)

MESSAGE_OBJECT_FILE_THUMB_DESCRIPTION = 575 (line 70)

MESSAGE_OBJECT_IMAGE_FIELD_DESC_HEIGHT = 415 (line 37)

MESSAGE_OBJECT_IMAGE_FIELD_DESC_HEIGHT_AND_WIDTH = 416 (line 38)

MESSAGE_OBJECT_IMAGE_PARAMETER_MAXHEIGHT_DESC = 412 (line 34)

MESSAGE_OBJECT_IMAGE_PARAMETER_MAXWIDTH_DESC = 212 (line 33)

MESSAGE_SELECT_FILE = 534 (line 77)

MESSAGE_SELECT_PICTURE = 528 (line 78)

OBJECT_FILE_TYPE_EXTERNAL = 2 (line 84)

OBJECT_FILE_TYPE_INTERNAL = 1 (line 83)

File types constants

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