ContentTypeOverviewNode
extends AbstractNode
in package
implements
RenderablePageInterface
Synthetic node representing the auto-generated overview/listing page for a content-type collection (e.g. a "News" index listing all news items).
One ContentTypeOverviewNode is created per configured collection in
guides.xml by RenderPagesListener
during the post-render phase, after all individual items have been sorted.
This node implements RenderablePageInterface so that it flows through the same DelegatingNodeRenderer pipeline as PageNode and ContentTypeItemNode.
Table of Contents
Interfaces
- RenderablePageInterface
- Common contract for nodes that are rendered as standalone HTML pages outside the main documentation tree.
Properties
- $classes : array<string|int, string>
- $options : array<string, scalar|array<string|int, scalar>|null>
- $value : TValue
- $outputPath : string
- $template : string
- $title : string
Methods
- __construct() : mixed
- getChildren() : array<string|int, Node>
- Body nodes that make up the visible page content.
- getClasses() : array<string|int, string>
- getClassesString() : string
- getFilePath() : string
- Source file path relative to its source directory, without extension.
- getHeaderNodes() : array<string|int, MetadataNode>
- Metadata nodes that should be rendered inside the HTML <head>.
- getItems() : array<string|int, ContentTypeItemNode>
- The sorted list of {@see ContentTypeItemNode}s to display in the overview.
- getOption() : mixed
- getOptions() : array<string, scalar|array<string|int, scalar>|null>
- getOutputPath() : string
- Output path relative to the output root, without extension.
- getPageTitle() : string|null
- Title string for the HTML <title> element. May be null when no title metadata is present in the source file.
- getTemplate() : string
- Twig template path used to render this overview page.
- getValue() : TValue
- hasOption() : bool
- setClasses() : void
- Normalizes class names following the rules of identifier-normalization
- setValue() : void
- withKeepExistingOptions() : static
- Adds $options as default options without overriding any options already set.
- withOptions() : static
Properties
$classes
protected
array<string|int, string>
$classes
= []
$options
protected
array<string, scalar|array<string|int, scalar>|null>
$options
= []
$value
protected
TValue
$value
$outputPath read-only
private
string
$outputPath
$template read-only
private
string
$template
$title read-only
private
string
$title
Methods
__construct()
public
__construct(string $outputPath, string $title, string $template[, array<string|int, ContentTypeItemNode> $items = [] ]) : mixed
Parameters
- $outputPath : string
-
Output path relative to the output root, without extension.
- $title : string
-
Human-readable title for the overview page.
- $template : string
-
Twig template path for this overview.
- $items : array<string|int, ContentTypeItemNode> = []
-
Sorted collection items (newest-first).
getChildren()
Body nodes that make up the visible page content.
public
getChildren() : array<string|int, Node>
Return values
array<string|int, Node>getClasses()
public
getClasses() : array<string|int, string>
Return values
array<string|int, string>getClassesString()
public
getClassesString() : string
Return values
stringgetFilePath()
Source file path relative to its source directory, without extension.
public
getFilePath() : string
Used to build a thin DocumentNode for RenderContext compatibility.
Return values
stringgetHeaderNodes()
Metadata nodes that should be rendered inside the HTML <head>.
public
getHeaderNodes() : array<string|int, MetadataNode>
Return values
array<string|int, MetadataNode>getItems()
The sorted list of {@see ContentTypeItemNode}s to display in the overview.
public
getItems() : array<string|int, ContentTypeItemNode>
Return values
array<string|int, ContentTypeItemNode>getOption()
public
getOption(string $name[, TType|null $default = null ]) : mixed
Parameters
- $name : string
- $default : TType|null = null
Tags
getOptions()
public
getOptions() : array<string, scalar|array<string|int, scalar>|null>
Return values
array<string, scalar|array<string|int, scalar>|null>getOutputPath()
Output path relative to the output root, without extension.
public
getOutputPath() : string
This is the path at which the rendered HTML file is written.
Return values
stringgetPageTitle()
Title string for the HTML <title> element. May be null when no title metadata is present in the source file.
public
getPageTitle() : string|null
Return values
string|nullgetTemplate()
Twig template path used to render this overview page.
public
getTemplate() : string
Return values
stringgetValue()
public
getValue() : TValue
Return values
TValuehasOption()
public
hasOption(string $name) : bool
Parameters
- $name : string
Return values
boolsetClasses()
Normalizes class names following the rules of identifier-normalization
public
setClasses(array<string|int, string> $classes) : void
Parameters
- $classes : array<string|int, string>
Tags
setValue()
public
setValue(TValue $value) : void
Parameters
- $value : TValue
withKeepExistingOptions()
Adds $options as default options without overriding any options already set.
public
withKeepExistingOptions(array<string, scalar|null> $options) : static
Parameters
- $options : array<string, scalar|null>
Return values
staticwithOptions()
public
withOptions(array<string, scalar|array<string|int, scalar>|null> $options) : static
Parameters
- $options : array<string, scalar|array<string|int, scalar>|null>