\Anax\ContentCPageContent

Pages based on file content.

Summary

Methods
Properties
Constants
configure()
setDI()
getContentForRoute()
mapRoute2Toc()
getTitleFromFirstLine()
getTableOfContent()
createTableOfContent()
No public properties found
No constants found
No protected methods found
$di
N/A
No private methods found
$config
$toc
N/A

Properties

$di

$di : 

Properties

Type

$config

$config : 

Properties

Type

$toc

$toc : 

Properties.

Type

Methods

configure()

configure(\Anax\array/string  $what) : $this

Read configuration from file or array'.

Parameters

\Anax\array/string $what

is an array with key/value config options or a file to be included which returns such an array.

Returns

$this —

for chaining.

setDI()

setDI(\Anax\DI\class  $di) : $this

Set the service container to use

Parameters

\Anax\DI\class $di

a service container

Returns

$this

getContentForRoute()

getContentForRoute() 

Map url to page if such mapping can be done.

Throws

\Anax\Content\NotFoundException

when mapping can not be done.

mapRoute2Toc()

mapRoute2Toc(string  $route, array  $toc) : string

Map the route to the correct entry in the toc.

Parameters

string $route

current route used to access page.

array $toc

the toc as array.

Returns

string —

as the title for the content.

getTitleFromFirstLine()

getTitleFromFirstLine(string  $file) : string

Extract title from content.

Parameters

string $file

filenam to load load content from.

Returns

string —

as the title for the content.

getTableOfContent()

getTableOfContent(string  $id) : array

Get table of content for all pages.

Parameters

string $id

to use to generate key for toc.

Returns

array —

as table of content.

createTableOfContent()

createTableOfContent() : array

Generate ToC from directory structure, containing url, title and filename of each page.

Returns

array —

as table of content.