NacoWiki PHP API

SiteGen
in package

Site generation

Class that actually implements SiteGen

Tags
phpcod

SiteGen

Table of Contents

Constants

VERSION  = '1.0'
var string

Properties

$exts  : mixed
var string[]

Methods

load()  : void
Loading entry point for this class
lst()  : bool|null
List files
mkassets()  : bool|null
Copy assets
path()  : path
Return this plugin's path
postRender()  : bool|null
Fix generated links
render()  : bool|null
Render a wiki page as HTML

Constants

VERSION

var string

public mixed VERSION = '1.0'

Properties

$exts

var string[]

public static mixed $exts = \NULL

Methods

load()

Loading entry point for this class

public static load(array<string|int, mixed> $cfg) : void

Adds commands implemented by this class

Parameters
$cfg : array<string|int, mixed>

lst()

List files

public static lst(NacoWikiApp $wiki, array<string|int, mixed> $argv) : bool|null

Makes a list of Wiki files

Parameters
$wiki : NacoWikiApp
$argv : array<string|int, mixed>
Tags
phpcod

commands##files

event

cli:files

Return values
bool|null

mkassets()

Copy assets

public static mkassets(NacoWikiApp $wiki, array<string|int, mixed> $argv) : bool|null

Makes a copy of static assets to the generated site

Parameters
$wiki : NacoWikiApp
$argv : array<string|int, mixed>
Tags
phpcod

commands##mkassets

event

cli:mkassets

Return values
bool|null

path()

Return this plugin's path

public static path([string $f = '' ]) : path
Parameters
$f : string = ''

optional item

Return values
path

to filesystem for $f

postRender()

Fix generated links

public static postRender(NanoWikiApp $wiki, array<string|int, mixed> &$ev) : bool|null
Parameters
$wiki : NanoWikiApp

running wiki instance

$ev : array<string|int, mixed>
Return values
bool|null

render()

Render a wiki page as HTML

public static render(NanoWikiApp $wiki, array<string|int, mixed> $argv) : bool|null
Parameters
$wiki : NanoWikiApp

running wiki instance

$argv : array<string|int, mixed>

Command line arguments

Tags
phpcod

commands##render

event

cli:render

Return values
bool|null

        
On this page

Search results