Docs For Class CMS_resourceValidationInfo

Description

Class CMS_resourceValidationInfo

represent a resource validation. Contains a reference to the resource moduleID and the resource itself. It is passed from the kernel to the moduleIDs for workflow purposes

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

Located in /automne/classes/workflow/resourcevalidationinfo.php (line 28)

CMS_grandFather
   |
   --CMS_resourceValidationInfo

Method Summary

void __construct (string $moduleCodename, integer $editions, integer $resourceID)

aray(integer=>integer) getAllValidationOptions ()

integer getEditions ()

string getModuleCodename ()

integer getResourceID ()

integer getValidationTypeLabel ()

boolean setValidationTypeLabel (string $label)

Methods

Constructor __construct (line 82)

Constructor. Caution ! Only the mandatory properties are passed here, but many others are needed to provide a readable validation.

access: public

void __construct (string $moduleCodename, integer $editions, integer $resourceID)

string $moduleCodename: the codename of the module the resource belongs to
integer $editions: the editions concerned by the validation
integer $resourceID: the resourceID to be validated

getAllValidationOptions (line 153)

Get the array of VALIDATION_OPTIONs

return: The validation options constants indexed by message ID
access: public

aray(integer=>integer) getAllValidationOptions ()

getEditions (line 96)

Data access method : get the editions concerned by the validation

return: the sum of REOURCE_EDITION constants
access: public

integer getEditions ()

getModuleCodename (line 118)

Data access method : get the moduleCodename

return: the module codename
access: public

string getModuleCodename ()

getResourceID (line 107)

Data access method : get the id of the resource

return: the internal id of the resource (module-wide range)
access: public

integer getResourceID ()

getValidationTypeLabel (line 129)

Data access method : get the validation type label

return: the internal type of validation label (module-wide range)
access: public

integer getValidationTypeLabel ()

setValidationTypeLabel (line 141)

Data access method : set the validation type label

return: true on success to set it, false otherwise.
access: public

boolean setValidationTypeLabel (string $label)

string $label: the label of the internal type

Inherited Methods

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

Inherited Constants

Inherited from CMS_grandFather

CMS_grandFather::ERROR_LOG
CMS_grandFather::SYSTEM_LABEL