PHP Class Jarves\Model\Node

Inheritance: extends Jarves\Model\Base\Node
Mostrar archivo Open project: jarves/jarves Class Usage Examples

Public Properties

Property Type Description
$meta Symfony\Component\HttpFoundation\ParameterBag

Protected Properties

Property Type Description
$collNestedGetLinks
$offspring Node[] | null Children. Mostly used for breadcrumb.
$parents Node[] | null Parents. Mostly used for breadcrumb.
$path string

Public Methods

Method Description
__construct ( )
addOffspring ( Node $node )
addParent ( Node $node )
createPage ( string $title, string $urn, string | null $theme = null, string | null $layout = null ) : Node
getCacheKey ( ) : string
getLinks ( boolean $pWithFolders = false ) : Propel\Runtime\Collection\ObjectCollection Same as getChildren but returns only visible pages and non-folder nodes
getOffspring ( ) : Node[]
getParents ( ) : Node[] Returns all parents. Mainly used for breadcrumb.
getPath ( string $pDelimiter = ' » ' ) : string Generates a path to the current page.
hasLinks ( ) : boolean Does the current node has (valid) sub links?
isRenderable ( ) : boolean Whether this node is from type page or tray.
setPath ( string $path )

Method Details

__construct() public method

public __construct ( )

addOffspring() public method

public addOffspring ( Node $node )
$node Node

addParent() public method

public addParent ( Node $node )
$node Node

createPage() public static method

public static createPage ( string $title, string $urn, string | null $theme = null, string | null $layout = null ) : Node
$title string
$urn string
$theme string | null
$layout string | null
return Node

getCacheKey() public method

public getCacheKey ( ) : string
return string

getOffspring() public method

public getOffspring ( ) : Node[]
return Node[]

getParents() public method

Returns all parents. Mainly used for breadcrumb.
public getParents ( ) : Node[]
return Node[]

getPath() public method

level 1 -> level 2 -> page where ' -> ' is a $pDelimiter
public getPath ( string $pDelimiter = ' » ' ) : string
$pDelimiter string
return string

isRenderable() public method

Whether this node is from type page or tray.
public isRenderable ( ) : boolean
return boolean

setPath() public method

public setPath ( string $path )
$path string

Property Details

$meta public_oe property

public ParameterBag,Symfony\Component\HttpFoundation $meta
return Symfony\Component\HttpFoundation\ParameterBag

$offspring protected_oe property

Children. Mostly used for breadcrumb.
protected Node[],Jarves\Model|null $offspring
return Node[] | null

$parents protected_oe property

Parents. Mostly used for breadcrumb.
protected Node[],Jarves\Model|null $parents
return Node[] | null

$path protected_oe property

protected string $path
return string