Docs For Class CMS

Description

Class CMS_linxDisplay

Manages a linx "display" tag representation

author: Antoine Pouch <antoine.pouch@ws-interactive.fr> &
author: Sébastien Pauchet <sebastien.pauchet@ws-interactive.fr>

Located in /automne/classes/pageContent/linxdisplay.php (line 29)

CMS_grandFather
   |
   --CMS_linxDisplay

Method Summary

void __construct ( $tag, string $tagContent)

string getOutput ( &$parsedPage, &$page, boolean $public, integer $rank, [boolean $noerror = false], [ $noselection = false], CMS_page $parsedPage, CMS_page $page)

string getRecursiveOutput ( &$parsedPage, [integer $level = 0], multidimentionnal $recursiveTree, &$pages, boolean $public, [array $lineage = array()], CMS_page $parsedPage, array $pages)

string getSubLevelOutput (string $html)

boolean hasCondition ()

boolean pagePassesConditions ( &$parsedPage, &$page, $public, integer $rank, CMS_page $page, boolean $publicTree)

string _addSlashAroundPHPContent ($html $html)

Methods

Constructor __construct (line 67)

Constructor.

initializes the linxDisplay.

access: public

void __construct ( $tag, string $tagContent)

string $tagContent: The tag content.
$tag

getOutput (line 117)

Get the HTML display for a page, if it passes the condition of course.

return: The html or false if page fails to pass the condition
access: public

string getOutput ( &$parsedPage, &$page, boolean $public, integer $rank, [boolean $noerror = false], [ $noselection = false], CMS_page $parsedPage, CMS_page $page)

CMS_page $parsedPage: The page in which the linx tag is
CMS_page $page: The page to get the display of
boolean $public: Is the page data to show the public or edited one ?
integer $rank: The rank of the page in the linx targets
boolean $noerror: : Hide all link error (default : false)
&$parsedPage
&$page
$noselection

getRecursiveOutput (line 226)

Get the recursive HTML display for a recursivelinks, if it passes the condition of course.

return: The html of the recursive link
access: public

string getRecursiveOutput ( &$parsedPage, [integer $level = 0], multidimentionnal $recursiveTree, &$pages, boolean $public, [array $lineage = array()], CMS_page $parsedPage, array $pages)

CMS_page $parsedPage: The page in which the linx tag is
integer $level: The current level of recursivity
array $pages: array of pages objects (indexed by id)
boolean $public: Is the page data to show the public or edited one ?
array $lineage: The lineage of the pages (used to see wich recursions need to be done in closed link display mode)
multidimentionnal $recursiveTree: array $recursiveTree The tree to display
&$parsedPage
&$pages

getSubLevelOutput (line 204)

Surround the HTML output by sublevel template if any.

return: The html sourrounded
access: public

string getSubLevelOutput (string $html)

string $html: The html to surround by sublevel html

hasCondition (line 408)

Does the display has a condition ?

return: true if yes, false if no
access: public

boolean hasCondition ()

pagePassesConditions (line 390)

Test to see if a page passes all conditions

return: true if the page passes conditions, false otherwise
access: public

boolean pagePassesConditions ( &$parsedPage, &$page, $public, integer $rank, CMS_page $page, boolean $publicTree)

CMS_page $page: The page to test
boolean $publicTree: Is the test conducted inside the public or edited tree ?
integer $rank: The rank of the page in the pre-condition targets
&$parsedPage
&$page
$public

_addSlashAroundPHPContent (line 356)

add slash arround all php content founded in string.

Static function

return: evalued content
access: private

string _addSlashAroundPHPContent ($html $html)

$html $html: string

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

Inherited Constants

Inherited from CMS_grandFather

CMS_grandFather::ERROR_LOG
CMS_grandFather::SYSTEM_LABEL