Class CMS_module_standard

Description

Class CMS_module_standard

represent the standard module.

Located in /automne/classes/modules/standard.php (line 33)

CMS_grandFather
   |
   --CMS_module
      |
      --CMS_module_standard
Class Constant Summary
Method Summary
 boolean destroy ()
 string getAdminFrontendPath (integer $relativeTo)
 CMS_auth getAuthAdapter (array $params)
 string getModuleCode (mixed $modulesCode, integer $treatmentMode, integer $visualizationMode,  &$treatedObject, array $treatmentParameters, object $treatedObject)
 CMS_resource getResourceByID (integer $resourceID)
 array getSearchResults (array $resultsIds,  $user)
 object The getTagRepresentation (CMS_XMLTag $tag, array(mixed) $args)
 array(CMS_resourceValidation) getValidationByID (integer $pageID,  &$user, [integer $getEditionType = false], CMS_user $user)
 array(CMS_resourceValidation) getValidations (CMS_user $user)
 array(CMS_resourceValidation) getValidationsByEditions ( &$user, integer $editions, CMS_user $user)
 array(CMS_resourceValidation) getValidationsInfo (CMS_user $user)
 array(CMS_resourceValidation) getValidationsInfoByEditions ( &$user, integer $editions, CMS_user $user)
 array getWantedTags (integer $treatmentMode, integer $visualizationMode)
 boolean processValidation (CMS_resourceValidation $resourceValidation, integer $result, [boolean $lastValidation = true])
 string scriptInfo (array $parameters)
 Boolean scriptTask (array $parameters)
 array search (string $keyword,  &$user, [booolean $public = false], [array &$score = array()], CMS_profile_user $user)
 string treatWantedTag ( &$tag, string $tagContent, integer $treatmentMode, integer $visualizationMode,  &$treatedObject, array $treatmentParameters, string $tag, object $treatedObject)
 boolean writeToPersistence ()
 void _changeDataLocation (CMS_page $resource, string $locationFrom, string $locationTo, [boolean $copyOnly = false])
Methods
destroy (line 1437)

Supposed to destroy the module. Not possible.

  • return: false
  • access: public
boolean destroy ()

Redefinition of:
CMS_module::destroy()
Remove the module from database
getAdminFrontendPath (line 120)

Gets the administration frontend path. No centralized admin for the standard module.

  • return: The administration frontend path
  • access: public
string getAdminFrontendPath (integer $relativeTo)
  • integer $relativeTo: Can be to webroot or filesystem. See constants.

Redefinition of:
CMS_module::getAdminFrontendPath()
Gets the administration frontend path.
getAuthAdapter (line 2383)

Get the module authentification adapter

  • return: : the module authentification adapter
  • access: public
CMS_auth getAuthAdapter (array $params)
  • array $params: : the authentification params
getModuleCode (line 1997)

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.
getModuleReplacements (line 2209)

Module replacements vars

  • return: of replacements values (pattern to replace => replacement)
  • access: public
array getModuleReplacements ()

Redefinition of:
CMS_module::getModuleReplacements()
Module replacements vars
getResourceByID (line 132)

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

  • return: The CMS_resource subclassed object
  • access: public
CMS_resource getResourceByID (integer $resourceID)
  • integer $resourceID: The DB ID of the resource in the module table(s)

Redefinition of:
CMS_module::getResourceByID()
Gets resource by its internal ID (not the resource table DB ID)
getRessourceNameMethod (line 144)

Gets module ressource name method (method to get the name of resource objects of the module)

  • return: : the method name to get objects label
  • access: public
string getRessourceNameMethod ()
getRessourceTypeLabelMethod (line 154)

Gets module ressource type method (method to get the type of resource objects of the module)

  • return: : the method type to get objects type label
  • access: public
string getRessourceTypeLabelMethod ()
getSearchResults (line 2293)

Get search results objects for module by Id

  • return: : results elements (cms_page)
  • access: public
array getSearchResults (array $resultsIds,  $user)
  • array $resultsIds: : the results score ids
  • $user
getTagRepresentation (line 166)

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_module::getTagRepresentation()
Gets a tag representation instance
getValidationByID (line 301)

Gets a validation for a given page

  • return: The resourceValidations objects, false if none found for the given user.
  • access: public
array(CMS_resourceValidation) getValidationByID (integer $pageID,  &$user, [integer $getEditionType = false], CMS_user $user)
  • integer $pageID: The page we want the validations for
  • CMS_user $user: The user we want the validations for
  • integer $getEditionType: The validation type we want. by default function return RESOURCE_EDITION_LOCATION then RESOURCE_EDITION_CONTENT then RESOURCE_EDITION_SIBLINGSORDER
  • &$user
getValidations (line 209)

Gets the module validations

  • return: The resourceValidations objects, false if none found
  • access: public
array(CMS_resourceValidation) getValidations (CMS_user $user)
  • CMS_user $user: The user we want the validations for

Redefinition of:
CMS_module::getValidations()
Gets the module validations
getValidationsByEditions (line 660)

Gets the module validations for the given editions and user

  • return: The resourceValidations objects, false if noen found
  • access: public
array(CMS_resourceValidation) getValidationsByEditions ( &$user, integer $editions, CMS_user $user)
  • CMS_user $user: The user we want the validations for
  • integer $editions: The editions we want the validations of
  • &$user
getValidationsInfo (line 254)

Gets the module validations info

  • return: The resourceValidations objects, false if none found
  • access: public
array(CMS_resourceValidation) getValidationsInfo (CMS_user $user)
  • CMS_user $user: The user we want the validations for
getValidationsInfoByEditions (line 497)

Gets the module validations Info for the given editions and user

  • return: The resourceValidations objects, false if noen found
  • access: public
array(CMS_resourceValidation) getValidationsInfoByEditions ( &$user, integer $editions, CMS_user $user)
  • CMS_user $user: The user we want the validations for
  • integer $editions: The editions we want the validations of
  • &$user
getWantedTags (line 1460)

Get the tags to be treated by this module for the specified treatment mode, visualization mode and object.

  • return: of tags to be treated.
  • access: public
array getWantedTags (integer $treatmentMode, integer $visualizationMode)
  • integer $treatmentMode: The current treatment mode (see constants on top of CMS_modulesTags class for accepted values).
  • integer $visualizationMode: The current visualization mode (see constants on top of cms_page class for accepted values).

Redefinition of:
CMS_module::getWantedTags()
Get the tags to be treated by this module for the specified treatment mode, visualization mode and object.
processDailyRoutine (line 1050)

Process the daily routine, which typically put out of userspace resources which have a past publication date

  • access: public
void processDailyRoutine ()

Redefinition of:
CMS_module::processDailyRoutine()
Process the daily routine, which typically put out of userspace resources which have a past publication date
processValidation (line 892)

Process the module validations : here, calls the parent function but before :

  • Pass all the editors to remindedEditors
  • computes all the pages that got to be regenerated.

  • return: true on success, false on failure to process
  • access: public
boolean processValidation (CMS_resourceValidation $resourceValidation, integer $result, [boolean $lastValidation = true])
  • CMS_resourceValidation $resourceValidation: The resource validation to process
  • integer $result: The result of the validation process. See VALIDATION_OPTION constants
  • boolean $lastValidation: Is this the last validation done in a load of multiple validations (or the only one) ? if true, launch the regeneration script.

Redefinition of:
CMS_module::processValidation()
Process the module validations. Note that the EMails sent to either the transferred validator or the editors were sent before.
scriptInfo (line 2257)

Module script info : get infos for a given script parameters

  • return: : HTML scripts infos
  • access: public
string scriptInfo (array $parameters)
  • array $parameters: the task parameters pageid : integer page id to regenerate fromscratch : boolean, regenerate from scratch

Redefinition of:
CMS_module::scriptInfo()
Module script info : get infos for a given script parameters
scriptTask (line 2237)

Module script task : regenerate a page

  • return: true/false
  • access: public
Boolean scriptTask (array $parameters)
  • array $parameters: the task parameters pageid : integer page id to regenerate fromscratch : boolean, regenerate from scratch

Redefinition of:
CMS_module::scriptTask()
Module script task : default function, return true
search (line 2279)

Search module objects by Id

  • return: : results elements Ids
  • access: public
array search (string $keyword,  &$user, [booolean $public = false], [array &$score = array()], CMS_profile_user $user)
  • string $keyword: : the search keywords
  • CMS_profile_user $user: : the user which make the search
  • booolean $public: : public search (default : false)
  • array &$score: : the results score returned by reference
  • &$user
treatWantedTag (line 1551)

Treat given content tag by this module for the specified treatment mode, visualization mode and object.

  • return: the tag content treated.
  • access: public
string treatWantedTag ( &$tag, string $tagContent, integer $treatmentMode, integer $visualizationMode,  &$treatedObject, array $treatmentParameters, string $tag, object $treatedObject)
  • string $tag: The CMS_XMLTag.
  • string $tagContent: previous tag content.
  • integer $treatmentMode: The current treatment mode (see constants on top of CMS_modulesTags class 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.
  • &$tag
  • &$treatedObject

Redefinition of:
CMS_module::treatWantedTag()
Treat given content tag by this module for the specified treatment mode, visualization mode and object.
writeToPersistence (line 1448)

This module can't be edited.

  • return: false
  • access: public
boolean writeToPersistence ()

Redefinition of:
CMS_module::writeToPersistence()
Writes the module into persistence (MySQL for now).
_changeDataLocation (line 1380)

Changes The page data (in the DB) from one location to another.

  • access: private
void _changeDataLocation (CMS_page $resource, string $locationFrom, string $locationTo, [boolean $copyOnly = false])
  • CMS_page $resource: The resource concerned by the data location change
  • string $locationFrom: The starting location among "edited", "edition", "public", "archived", "deleted"
  • string $locationTo: The ending location among "edited", "edition", "public", "archived", "deleted"
  • boolean $copyOnly: If true, data is not deleted from the original location

Redefinition of:
CMS_module::_changeDataLocation()
Changes The page data (in the DB) from one location to another.
_dailyRoutineClean (line 1322)

Process the daily routine clean part : remove useless files

  • access: private
void _dailyRoutineClean ()
_dailyRoutineOptimize (line 1301)

Process the daily routine optimisation part : optimize SQL tables

  • access: private
void _dailyRoutineOptimize ()
_dailyRoutinePublish (line 1100)

Process the daily routine publication part : publish page that needs to be

  • access: private
void _dailyRoutinePublish ()
_dailyRoutineReminders (line 1227)

Process the daily routine reminders part : send reminders to users

  • access: private
void _dailyRoutineReminders ()
_dailyRoutineUnpublish (line 1163)

Process the daily routine unpublication part : unpublish page that needs to be

  • access: private
void _dailyRoutineUnpublish ()

Inherited Methods

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()
Class Constants
MESSAGE_MOD_STANDARD_CODENAME = 1675 (line 57)
MESSAGE_MOD_STANDARD_EMAIL_REMINDER_BODY = 924 (line 52)
MESSAGE_MOD_STANDARD_EMAIL_REMINDER_BODY_MESSAGE = 925 (line 53)
MESSAGE_MOD_STANDARD_EMAIL_REMINDER_SUBJECT = 923 (line 51)
MESSAGE_MOD_STANDARD_ID = 863 (line 58)
MESSAGE_MOD_STANDARD_LINKTITLE = 133 (line 56)
MESSAGE_MOD_STANDARD_PAGE = 1328 (line 61)
MESSAGE_MOD_STANDARD_PLUGIN = 1403 (line 54)
MESSAGE_MOD_STANDARD_STATUS = 160 (line 60)
MESSAGE_MOD_STANDARD_TEMPLATE = 72 (line 59)
MESSAGE_MOD_STANDARD_URL_EDIT = 261 (line 50)
MESSAGE_MOD_STANDARD_URL_ONLINE = 49 (line 49)
MESSAGE_MOD_STANDARD_URL_PREVIZ = 48 (line 48)
MESSAGE_MOD_STANDARD_VALIDATION_EDITION = 44 (line 40)
MESSAGE_MOD_STANDARD_VALIDATION_EDITION_OFPAGE = 45 (line 41)
MESSAGE_MOD_STANDARD_VALIDATION_LOCATIONCHANGE = 42 (line 38)

Messages

MESSAGE_MOD_STANDARD_VALIDATION_LOCATIONCHANGE_OFPAGE = 43 (line 39)
MESSAGE_MOD_STANDARD_VALIDATION_MOVE = 592 (line 45)
MESSAGE_MOD_STANDARD_VALIDATION_MOVE_OFPAGE = 594 (line 46)
MESSAGE_MOD_STANDARD_VALIDATION_SIBLINGSORDER = 46 (line 42)
MESSAGE_MOD_STANDARD_VALIDATION_SIBLINGSORDER_OFPAGE = 47 (line 43)
MESSAGE_PAGE_BLOCK_GENERAL_VARS = 1706 (line 105)
MESSAGE_PAGE_BLOCK_GENERAL_VARS_EXPLANATION = 1705 (line 106)
MESSAGE_PAGE_BLOCK_TAGS = 1708 (line 107)
MESSAGE_PAGE_BLOCK_TAGS_EXPLANATION = 1219 (line 108)
MESSAGE_PAGE_ROW_EXPLANATION = 1219 (line 102)
MESSAGE_PAGE_TAGS_CHOOSE = 1707 (line 101)
MESSAGE_PAGE_TEMPLATE_EXPLANATION = 1222 (line 111)
MESSAGE_PAGE_WORKING_STANDARD_TAGS = 1710 (line 109)
MESSAGE_PAGE_WORKING_STANDARD_TAGS_EXPLANATION = 1709 (line 110)
MESSAGE_PAGE_WORKING_TAGS = 1704 (line 103)
MESSAGE_PAGE_WORKING_TAGS_EXPLANATION = 1703 (line 104)
MESSAGE_PARAM_ALLOW_IMAGES_IN_WYSIWYG = 615 (line 78)
MESSAGE_PARAM_ALLOW_IMAGES_IN_WYSIWYG_DESC = 633 (line 97)
MESSAGE_PARAM_ALLOW_SPECIFIC_PAGE_HTTPS = 1566 (line 80)
MESSAGE_PARAM_ALLOW_SPECIFIC_PAGE_HTTPS_DESC = 1567 (line 99)
MESSAGE_PARAM_APPLICATION_ENFORCES_ACCESS_CONTROL = 614 (line 77)
MESSAGE_PARAM_APPLICATION_ENFORCES_ACCESS_CONTROL_DESC = 632 (line 96)
MESSAGE_PARAM_APPLICATION_LABEL = 599 (line 63)
MESSAGE_PARAM_APPLICATION_LABEL_DESC = 617 (line 82)
MESSAGE_PARAM_APPLICATION_MAINTAINER_EMAIL = 600 (line 64)
MESSAGE_PARAM_APPLICATION_MAINTAINER_EMAIL_DESC = 618 (line 83)
MESSAGE_PARAM_APPLICATION_POSTMASTER_EMAIL = 601 (line 65)
MESSAGE_PARAM_APPLICATION_POSTMASTER_EMAIL_DESC = 619 (line 84)
MESSAGE_PARAM_ERROR404_EMAIL_ALERT = 613 (line 76)
MESSAGE_PARAM_ERROR404_EMAIL_ALERT_DESC = 631 (line 95)
MESSAGE_PARAM_LOG_SENDING_MAIL = 616 (line 79)
MESSAGE_PARAM_LOG_SENDING_MAIL_DESC = 634 (line 98)
MESSAGE_PARAM_NO_APPLICATION_MAIL = 609 (line 73)
MESSAGE_PARAM_NO_APPLICATION_MAIL_DESC = 627 (line 92)
MESSAGE_PARAM_NO_PAGES_EXTENDED_META_TAGS = 610 (line 74)
MESSAGE_PARAM_NO_PAGES_EXTENDED_META_TAGS_DESC = 628 (line 93)
MESSAGE_PARAM_OPEN_ZOOMIMAGE_IN_POPUP = 604 (line 68)
MESSAGE_PARAM_OPEN_ZOOMIMAGE_IN_POPUP_DESC = 622 (line 87)
MESSAGE_PARAM_PAGE_LINK_NAME_IN_TREE = 602 (line 66)
MESSAGE_PARAM_PAGE_LINK_NAME_IN_TREE_DESC = 620 (line 85)
MESSAGE_PARAM_POLYMOD_DEBUG = 607 (line 71)
MESSAGE_PARAM_POLYMOD_DEBUG_DESC = 625 (line 90)
MESSAGE_PARAM_STATS_DEBUG = 606 (line 70)
MESSAGE_PARAM_STATS_DEBUG_DESC = 624 (line 89)
MESSAGE_PARAM_SYSTEM_DEBUG = 605 (line 69)
MESSAGE_PARAM_SYSTEM_DEBUG_DESC = 623 (line 88)
MESSAGE_PARAM_USE_BACKGROUND_REGENERATOR = 612 (line 75)
MESSAGE_PARAM_USE_BACKGROUND_REGENERATOR_DESC = 630 (line 94)
MESSAGE_PARAM_USE_PRINT_PAGES = 603 (line 67)
MESSAGE_PARAM_USE_PRINT_PAGES_DESC = 621 (line 86)
MESSAGE_PARAM_VIEW_SQL = 608 (line 72)
MESSAGE_PARAM_VIEW_SQL_DESC = 626 (line 91)

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

Documentation generated on Wed, 15 Feb 2012 15:39:36 +0100 by phpDocumentor 1.4.3