Docs For Class CMS_linxesCatalog

Description

Class CMS_linxesCatalog

Represents a collection of linxes

author: Antoine Pouch <antoine.pouch@ws-interactive.fr>

Located in /automne/classes/pageContent/linxescatalog.php (line 27)

CMS_grandFather
   |
   --CMS_linxesCatalog

Class Constant Summary

PAGE_LINK_FROM = 2

PAGE_LINK_TO = 1

Method Summary

static void deleteLinxes ( &$page, [boolean $includingWhenTarget = false], CMS_page $page)

static void getAllTypes ()

static array(integer) getLinkers (CMS_page $page)

static array(integer) getWatchers (CMS_page $page)

static array(integer) searchRelations (constant $type, $pageID, integer $page)

Methods

static deleteLinxes (line 53)

Delete all the linxes for a page Static function

access: public

static void deleteLinxes ( &$page, [boolean $includingWhenTarget = false], CMS_page $page)

CMS_page $page: the page to forget
boolean $includingWhenTarget: Set to true to really delete all the linxes, including the one where the page is a target only
&$page

static getAllTypes (line 39)

Get the array of available linx types Static function

access: public

static void getAllTypes ()

static getLinkers (line 135)

Get the DB IDs of pages who "link" this one Static function

return: The DB IDs of pages linking the one in argument
access: public

static array(integer) getLinkers (CMS_page $page)

CMS_page $page: the page linked

static getWatchers (line 103)

Get the DB IDs of pages who "watch" this one Static function

return: The DB IDs of pages watching the one in argument
access: public

static array(integer) getWatchers (CMS_page $page)

CMS_page $page: the page watched

static searchRelations (line 168)

Get links relations between a page and linked ones Static function

return: : pages IDs
access: public

static array(integer) searchRelations (constant $type, $pageID, integer $page)

constant $type: : the type of relation (self::PAGE_LINK_FROM or self::PAGE_LINK_TO)
integer $page: : the page to get relations of
$pageID

Inherited Methods

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

PAGE_LINK_FROM = 2 (line 30)

PAGE_LINK_TO = 1 (line 29)

Inherited Constants

Inherited from CMS_grandFather

CMS_grandFather::ERROR_LOG
CMS_grandFather::SYSTEM_LABEL