Class CMS_module_cms_aliases

represent the cms_alias module.

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

Located in /automne/classes/modules/cms_aliases.php (line 24)

CMS_grandFather
   |
   --CMS_module
      |
      --CMS_moduleValidation
         |
         --CMS_module_cms_aliases

static getAll (line 236)

Get all the sub-aliases of a given alias

• access: public

static array getAll (CMS_resource_cms_aliases $parent, [boolean $returnObject = false])

• CMS_resource_cms_aliases $parent: The parent of the sub-aliases to get or 0 to get first level or false to get all aliases recursively
• boolean $returnObject: function return array of id (default) or array of CMS_resource_cms_aliases

static getAllByPage (line 281)

Get all the sub-aliases of a given alias which contain the given page in tree

• access: public

static array getAllByPage (CMS_resource_cms_aliases $parent,  $pageId, [boolean $returnObject = false])

• CMS_resource_cms_aliases $parent: The parent of the sub-aliases to get or 0 to get first level or false to get all aliases recursively
• boolean $returnObject: function return array of id (default) or array of CMS_resource_cms_aliases
• $pageId

static getByID (line 385)

Gets alias by its internal ID

• return: or false if not founded
• access: public

static CMS_resource_cms_aliases getByID (integer $id, [ $reset = false])

• integer $id: The DB ID of the alias to get
• $reset

static getByName (line 350)

Get all the aliases for a given name

• access: public

static array getByName (string $name, [boolean $returnObject = true])

• string $name: The name to get aliases of
• boolean $returnObject: function return array of id or array of CMS_resource_cms_aliases (default)

static redirect (line 408)

Create the redirection of an alias

• return: true on success, false on failure
• access: public

static boolean redirect ()

getObjectsInfos (line 73)

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

getPageFromURL (line 177)

Return a valid page for a given URL

• return: if page founded, false otherwise
• access: public

CMS_page getPageFromURL (string $pageUrl, [boolean $useDomain = true])

• string $pageUrl: the page URL
• boolean $useDomain: : use queried domain to found root page associated (default : true)

getPageTabsProperties (line 122)

Return a list of objects infos to be displayed in page properties tabs according to user privileges

• return: : HTML scripts infos
• access: public

string getPageTabsProperties ( $page,  $user)

• $page
• $user

getPageURL (line 148)

Return alias page URL if exists for a given page

• return: : the alias page url or false if none founded
• access: public

string getPageURL (mixed $page, [constant $relativeTo = PATH_RELATIVETO_WEBROOT])

• mixed $page: the page or page Id to get URL of
• constant $relativeTo: Return the alias path relative from webroot (default) or from filesystem (PATH_RELATIVETO_FILESYSTEM)

getResourceByID (line 61)

Gets resource by its internal ID (not the resource table DB ID) This function need to stay here because sometimes it is directly queried

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

load (line 99)

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_ALIAS_ALIASES = 1 (line 26)

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