Supposed to destroy the module. Not possible.
boolean
destroy
()
Redefinition of:
- CMS_module::destroy()
- Remove the module from database
Gets the administration frontend path. No centralized admin for the standard module.
string
getAdminFrontendPath
(integer $relativeTo)
-
integer
$relativeTo: Can be to webroot or filesystem. See constants.
Redefinition of:
- CMS_module::getAdminFrontendPath()
- Gets the administration frontend path.
Get the module authentification adapter
-
array
$params: : the authentification params
Return the module code for the specified treatment mode, visualization mode and object.
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.
Gets resource by its internal ID (not the resource table DB ID)
-
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)
Gets module ressource name method (method to get the name of resource objects of the module)
string
getRessourceNameMethod
()
Gets module ressource type method (method to get the type of resource objects of the module)
string
getRessourceTypeLabelMethod
()
Get search results objects for module by Id
array
getSearchResults
(array $resultsIds, $user)
-
array
$resultsIds: : the results score ids
-
$user
Gets a tag representation instance
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
Gets a validation for a given page
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
Gets the module validations
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
Gets the module validations for the given editions and user
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
Gets the module validations info
array(CMS_resourceValidation)
getValidationsInfo
(CMS_user $user)
-
CMS_user
$user: The user we want the validations for
Gets the module validations Info for the given editions and user
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
Get the tags to be treated by this module for the specified treatment mode, visualization mode and object.
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.
Process the daily routine, which typically put out of userspace resources which have a past publication date
void
processDailyRoutine
()
Redefinition of:
- CMS_module::processDailyRoutine()
- Process the daily routine, which typically put out of userspace resources which have a past publication date
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.
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.
Module script info : get infos for a given script parameters
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
Module script task : regenerate a page
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 module objects by Id
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
Treat given content tag by this module for the specified treatment mode, visualization mode and object.
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.
This module can't be edited.
boolean
writeToPersistence
()
Redefinition of:
- CMS_module::writeToPersistence()
- Writes the module into persistence (MySQL for now).
Changes The page data (in the DB) from one location to another.
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.
Process the daily routine clean part : remove useless files
void
_dailyRoutineClean
()
Process the daily routine optimisation part : optimize SQL tables
void
_dailyRoutineOptimize
()
Process the daily routine publication part : publish page that needs to be
void
_dailyRoutinePublish
()
Process the daily routine reminders part : send reminders to users
void
_dailyRoutineReminders
()
Process the daily routine unpublication part : unpublish page that needs to be
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()