Class CMS_module_cms_forms

represent the PDF Forms module.

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

Located in /automne/classes/modules/cms_forms.php (line 38)

CMS_grandFather
   |
   --CMS_module
      |
      --CMS_moduleValidation
         |
         --CMS_module_cms_forms

getModuleCode (line 99)

Return the module code for the specified treatment mode, visualization mode and object.

• return: : the module code to add
• access: public

string getModuleCode (mixed $modulesCode, integer $treatmentMode, integer $visualizationMode,  &$treatedObject, array $treatmentParameters, object $treatedObject)

• mixed $modulesCode: the previous modules codes (usually string)
• integer $treatmentMode: The current treatment mode (see constants on top of this file for accepted values).
• integer $visualizationMode: The current visualization mode (see constants on top of cms_page class for accepted values).
• object $treatedObject: The reference object to treat.
• array $treatmentParameters: : optionnal parameters used for the treatment. Usually an array of objects.
• &$treatedObject

---

Redefinition of:

CMS_module::getModuleCode()

Return the module code for the specified treatment mode, visualization mode and object.

getObjectsInfos (line 191)

Return a list of objects infos to be displayed in module index according to user privileges

• return: : HTML scripts infos
• access: public

string getObjectsInfos ( $user)

• $user

getResourceByID (line 49)

Gets a form by its internal ID

• access: public

CMS_forms_formular getResourceByID (integer $ID)

• integer $ID: The DB ID

---

Redefinition of:

CMS_module::getResourceByID()

Gets resource by its internal ID (not the resource table DB ID)

getTagRepresentation (line 61)

Gets a tag representation instance

• return: module tag representation instance
• access: public

object The getTagRepresentation (CMS_XMLTag $tag, array(mixed) $args)

• CMS_XMLTag $tag: The xml tag from which to build the representation
• array(mixed) $args: The arguments needed to build

---

Redefinition of:

CMS_moduleValidation::getTagRepresentation()

Gets a tag representation instance

load (line 160)

Module autoload handler

• return: : the file to use for required classname
• access: public

string load (string $classname)

• string $classname: the classname required for loading

Inherited Methods

Inherited From CMS_moduleValidation

CMS_moduleValidation::CMS_moduleValidation()
CMS_moduleValidation::getModuleValidationLabel()
CMS_moduleValidation::getPrimaryResourceInfo()
CMS_moduleValidation::getTagRepresentation()
CMS_moduleValidation::getValidationByID()
CMS_moduleValidation::getValidations()
CMS_moduleValidation::getValidationsByEditions()
CMS_moduleValidation::getValidationsCount()
CMS_moduleValidation::getValidationsInfo()
CMS_moduleValidation::getValidationsInfoByEditions()
CMS_moduleValidation::processValidation()
CMS_moduleValidation::_changeDataLocation()

Inherited From CMS_module

CMS_module::CMS_module()
CMS_module::asArray()
CMS_module::createModuleFiles()
CMS_module::destroy()
CMS_module::fromArray()
CMS_module::getAdminFrontendPath()
CMS_module::getCodename()
CMS_module::getCSSFiles()
CMS_module::getDefaultLanguageCodename()
CMS_module::getID()
CMS_module::getJSFiles()
CMS_module::getLabel()
CMS_module::getLabelID()
CMS_module::getModuleCategories()
CMS_module::getModuleCode()
CMS_module::getModuleReplacements()
CMS_module::getParameters()
CMS_module::getResourceByID()
CMS_module::getTagRepresentation()
CMS_module::getValidations()
CMS_module::getWantedTags()
CMS_module::hasAdmin()
CMS_module::hasParameters()
CMS_module::isCategoryUsed()
CMS_module::isDestroyable()
CMS_module::isPolymod()
CMS_module::moduleUsage()
CMS_module::processDailyRoutine()
CMS_module::processValidation()
CMS_module::scriptInfo()
CMS_module::scriptTask()
CMS_module::setAdminFrontend()
CMS_module::setAndWriteParameters()
CMS_module::setCodename()
CMS_module::setLabel()
CMS_module::setPolymod()
CMS_module::treatWantedTag()
CMS_module::useCategories()
CMS_module::writeToPersistence()
CMS_module::_changeDataLocation()

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

MESSAGE_CMS_FORMS_FORMS = 1 (line 40)

Inherited Constants

Inherited from CMS_module

CMS_module::MESSAGE_PAGE_ADMIN_CATEGORIES
CMS_module::MESSAGE_PAGE_CATEGORIES
CMS_module::MESSAGE_PAGE_CATEGORIES_USED
CMS_module::MESSAGE_PAGE_CHOOSE
CMS_module::MESSAGE_PAGE_MANAGE_OBJECTS

Inherited from CMS_grandFather

CMS_grandFather::ERROR_LOG
CMS_grandFather::SYSTEM_LABEL