Documentation

SigmaPageTree extends PageTree
in package

AbstractYes

SigmaPageTree

Tags
copyright

CLOUDREXX CMS - CLOUDREXX AG

author

CLOUDREXX Development Team info@cloudrexx.com

subpackage

core_pagetree

Table of Contents

Properties

$bytes  : mixed
$considerLogin  : mixed
$considerSeoEnabledOnly  : bool
Consider seo enabled pages alone
$currentPage  : mixed
$currentPageOnRootNode  : mixed
$currentPagePath  : mixed
$depth  : mixed
$em  : mixed
$lang  : mixed
$license  : mixed
$nodeRepo  : mixed
$pageIdsAtCurrentPath  : mixed
$pageRepo  : mixed
$rootNode  : mixed
$skipInactive  : mixed
$skipInvisible  : mixed
$startLevel  : mixed
$startPath  : mixed
$template  : Sigma
$virtualLanguageDirectory  : mixed
$virtualPagesAdded  : mixed

Methods

__construct()  : mixed
isPagePathActive()  : bool
Tells wheter $pathToPage is in the active branch
postRenderLevel()  : mixed
preRenderLevel()  : mixed
render()  : string
returns the string representation of the tree.
setTemplate()  : mixed
setVirtualLanguageDirectory()  : mixed
getFirstLevel()  : mixed
getFullNavigation()  : bool
getLastLevel()  : mixed
getMetaImageOfPage()  : string
Get the path of the set meta image of $page. If $page does not have a meta image set, then the path to the default meta image set by the basic configuration is returned instead.
init()  : mixed
Called on construction. Override if you do not want to override the ctor.
postRender()  : mixed
postRenderElement()  : mixed
preRender()  : mixed
preRenderElement()  : mixed
realPreRender()  : mixed
renderElement()  : string
Override this to do your representation of the tree.
renderFooter()  : mixed
renderHeader()  : mixed

Properties

$considerSeoEnabledOnly

Consider seo enabled pages alone

protected bool $considerSeoEnabledOnly

$currentPageOnRootNode

protected mixed $currentPageOnRootNode = false

$pageIdsAtCurrentPath

protected mixed $pageIdsAtCurrentPath = array()

$virtualLanguageDirectory

protected mixed $virtualLanguageDirectory

$virtualPagesAdded

protected static mixed $virtualPagesAdded = false

Methods

__construct()

public __construct(mixed $entityManager, License $license[, int $maxDepth = 0 ][, Node $rootNode = null ][, int $lang = null ][, Page $currentPage = null ][, bool $skipInvisible = true ][, bool $considerLogin = true ][, mixed $skipInactive = true ][, bool $considerSeoEnabledOnly = false ]) : mixed
Parameters
$entityManager : mixed

the doctrine em

$license : License

License used to check if a module is allowed in frontend

$maxDepth : int = 0

maximum depth to fetch, 0 means everything

$rootNode : Node = null

node to use as root

$lang : int = null

the language

$currentPage : Page = null

if set, renderElement() will receive a correctly set $current flag.

$skipInvisible : bool = true

value to skip invisible pages

$considerLogin : bool = true

value to consider whether the user is logged in or not

$skipInactive : mixed = true
$considerSeoEnabledOnly : bool = false

Consider seo enabled pages alone

isPagePathActive()

Tells wheter $pathToPage is in the active branch

public isPagePathActive(string $pathToPage) : bool
Parameters
$pathToPage : string
Return values
bool —

True if active, false otherwise

postRenderLevel()

public abstract postRenderLevel(mixed $level, mixed $lang, mixed $parentNode) : mixed
Parameters
$level : mixed
$lang : mixed
$parentNode : mixed

preRenderLevel()

public abstract preRenderLevel(mixed $level, mixed $lang, mixed $parentNode) : mixed
Parameters
$level : mixed
$lang : mixed
$parentNode : mixed

render()

returns the string representation of the tree.

public render() : string
Return values
string

setTemplate()

public setTemplate(mixed $template) : mixed
Parameters
$template : mixed

the PEAR Sigma template.

setVirtualLanguageDirectory()

public setVirtualLanguageDirectory(mixed $dir) : mixed
Parameters
$dir : mixed

getFullNavigation()

protected getFullNavigation(int $level) : bool
Parameters
$level : int
Return values
bool

getMetaImageOfPage()

Get the path of the set meta image of $page. If $page does not have a meta image set, then the path to the default meta image set by the basic configuration is returned instead.

protected getMetaImageOfPage(Page $page) : string
Parameters
$page : Page
Return values
string —

Path to meta image

init()

Called on construction. Override if you do not want to override the ctor.

protected abstract init() : mixed

postRender()

protected abstract postRender(mixed $lang) : mixed
Parameters
$lang : mixed

postRenderElement()

protected abstract postRenderElement(mixed $level, mixed $hasChilds, mixed $lang, mixed $page) : mixed
Parameters
$level : mixed
$hasChilds : mixed
$lang : mixed
$page : mixed

preRenderElement()

protected abstract preRenderElement(mixed $level, mixed $hasChilds, mixed $lang, mixed $page) : mixed
Parameters
$level : mixed
$hasChilds : mixed
$lang : mixed
$page : mixed

realPreRender()

protected abstract realPreRender(mixed $lang) : mixed
Parameters
$lang : mixed

renderElement()

Override this to do your representation of the tree.

protected abstract renderElement(string $title, int $level, bool $hasChilds, int $lang, string $path, bool $current, mixed $page) : string
Parameters
$title : string
$level : int

0-based level of the element

$hasChilds : bool

are there children of this element? if yes, they will be processed in the subsequent calls.

$lang : int

language id

$path : string

path to this element, e.g. '/CatA/CatB'

$current : bool

if a $currentPage has been specified, this will be set to true if either a parent element of the current element or the current element itself is rendered.

$page : mixed
Return values
string —

your string representation of the element.

renderFooter()

protected abstract renderFooter(mixed $lang) : mixed
Parameters
$lang : mixed

renderHeader()

protected abstract renderHeader(mixed $lang) : mixed
Parameters
$lang : mixed 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results