Class CMS_forms_action

Description

Class CMS_forms_action

Represents an action attributed to a formular. Content of formular can be send by email, stored into a file, and user redirectied to given URL, etc. In any case form values are always recorded in database.

Some predefined types are determined :

  • db (Only one expected)
  • formnok (Only one expected)
  • formok (Only one expected)
  • email (Many of them accepted)
  • emailfield (Many of them accepted)
  • auth (Only one expected)

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

CMS_grandFather
   |
   --CMS_resource
      |
      --CMS_superResource
         |
         --CMS_forms_action
Class Constant Summary
Method Summary
 static array(integer=>integer) getAllTypes ()
 void getAll ([ $formularID = false], [ $returnObject = false], [ $actionType = false])
 void __construct ([integer $id = 0])
Methods
static getAllTypes (line 206)

Gets the array of all the type of destinations for a formular

  • return: All the destination types indexed by their message DB ID
  • access: public
static array(integer=>integer) getAllTypes ()
getAll (line 174)

Returns an array of all CMS_forms_action associated to a given formular ID and ordered by type

void getAll ([ $formularID = false], [ $returnObject = false], [ $actionType = false])
  • $formularID
  • $returnObject
  • $actionType
Constructor __construct (line 164)

Constructor

  • access: public
void __construct ([integer $id = 0])
  • integer $id

Inherited Methods

Inherited From CMS_superResource

 CMS_superResource::CMS_superResource()
 CMS_superResource::destroy()
 CMS_superResource::getBoolean()
 CMS_superResource::getDefaultValue()
 CMS_superResource::getExternalLink()
 CMS_superResource::getFilePath()
 CMS_superResource::getID()
 CMS_superResource::getImagePath()
 CMS_superResource::getInteger()
 CMS_superResource::getInternalLinkPage()
 CMS_superResource::getLink()
 CMS_superResource::getLinkType()
 CMS_superResource::getList()
 CMS_superResource::getObject()
 CMS_superResource::getOrder()
 CMS_superResource::getOrderMax()
 CMS_superResource::getString()
 CMS_superResource::getTableData()
 CMS_superResource::getTheDate()
 CMS_superResource::getValue()
 CMS_superResource::moveDown()
 CMS_superResource::moveTo()
 CMS_superResource::moveUp()
 CMS_superResource::search()
 CMS_superResource::setBoolean()
 CMS_superResource::setDate()
 CMS_superResource::setExternalLink()
 CMS_superResource::setFile()
 CMS_superResource::setImage()
 CMS_superResource::setInteger()
 CMS_superResource::setInternalLink()
 CMS_superResource::setLink()
 CMS_superResource::setObject()
 CMS_superResource::setOrder()
 CMS_superResource::setString()
 CMS_superResource::setValue()
 CMS_superResource::writeToPersistence()
 CMS_superResource::_hasResource()
 CMS_superResource::_initObjects()

Inherited From CMS_resource

 CMS_resource::CMS_resource()
 CMS_resource::addEdition()
 CMS_resource::addValidationRefused()
 CMS_resource::cancelAllEditions()
 CMS_resource::destroy()
 CMS_resource::getAllDataLocations()
 CMS_resource::getAllLinkTypes()
 CMS_resource::getEditors()
 CMS_resource::getEditorsStack()
 CMS_resource::getID()
 CMS_resource::getLocation()
 CMS_resource::getLock()
 CMS_resource::getLockDate()
 CMS_resource::getProposedLocation()
 CMS_resource::getPublication()
 CMS_resource::getPublicationDateEnd()
 CMS_resource::getPublicationDateStart()
 CMS_resource::getStatus()
 CMS_resource::isProposedForOutsideUserspace()
 CMS_resource::lock()
 CMS_resource::removeProposedLocation()
 CMS_resource::resetEditorsStack()
 CMS_resource::setProposedLocation()
 CMS_resource::setPublicationDates()
 CMS_resource::unlock()
 CMS_resource::validateEdition()
 CMS_resource::validateProposedLocation()
 CMS_resource::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
ACTION_ALREADY_FOLD = 0 (line 43)

Form destination type : action if form is already folded

ACTION_AUTH = 5 (line 68)

Form destination type : Authenticate user

ACTION_DB = 2 (line 53)

Form destination type : File (Stores content of a form in database)

ACTION_EMAIL = 3 (line 58)

Form destination type : Email (Send form results to email(s))

ACTION_FIELDEMAIL = 4 (line 63)

Form destination type : Email (Send form results to email(s) in given field)

ACTION_FORMNOK = 1 (line 48)

Form destination type : action if form validation is not OK

ACTION_FORMOK = 99 (line 79)

Form destination type : action if form validation is OK

(high id because it must be the last action done)

ACTION_SPECIFIC_PHP = 6 (line 73)

Execute specific PHP code

MESSAGE_CMS_FORMS_ACTION_ALREADY_FOLD = 52 (line 81)
MESSAGE_CMS_FORMS_ACTION_AUTH = 75 (line 87)
MESSAGE_CMS_FORMS_ACTION_DB = 39 (line 82)
MESSAGE_CMS_FORMS_ACTION_EMAIL = 42 (line 85)
MESSAGE_CMS_FORMS_ACTION_FIELDEMAIL = 43 (line 86)
MESSAGE_CMS_FORMS_ACTION_FORMNOK = 40 (line 83)
MESSAGE_CMS_FORMS_ACTION_FORMOK = 41 (line 84)
MESSAGE_CMS_FORMS_ACTION_SPECIFIC_PHP = 94 (line 88)

Inherited Constants

Inherited from CMS_resource

CMS_resource::MESSAGE_RESOURCE_LINK_TYPE_EXTERNAL
CMS_resource::MESSAGE_RESOURCE_LINK_TYPE_FILE
CMS_resource::MESSAGE_RESOURCE_LINK_TYPE_INTERNAL
CMS_resource::MESSAGE_RESOURCE_LINK_TYPE_NONE

Inherited from CMS_grandFather

CMS_grandFather::ERROR_LOG
CMS_grandFather::SYSTEM_LABEL

Documentation generated on Wed, 15 Feb 2012 15:27:58 +0100 by phpDocumentor 1.4.3