PHP Class Pico

__construct() public méthode

To carry out all the processing in Pico, call {@link Pico::run()}.

public __construct ( string $rootDir, string $configDir, string $pluginsDir, string $themesDir )
$rootDir	string	root directory of this Pico instance
$configDir	string	config directory of this Pico instance
$pluginsDir	string	plugins directory of this Pico instance
$themesDir	string	themes directory of this Pico instance

discoverCurrentPage() protected méthode

Walks through the list of known pages and discovers the requested page as well as the previous and next page relative to it

protected discoverCurrentPage ( ) : void
Résultat	void

discoverRequestFile() protected méthode

Uses the request URL to discover the content file to serve

protected discoverRequestFile ( ) : void
Résultat	void

evaluateRequestUrl() protected méthode

Pico 1.0 uses the QUERY_STRING routing method (e.g. /pico/?sub/page) to support SEO-like URLs out-of-the-box with any webserver. You can still setup URL rewriting (e.g. using mod_rewrite on Apache) to basically remove the ? from URLs, but your rewritten URLs must follow the new QUERY_STRING principles. URL rewriting requires some special configuration on your webserver, but this should be "basic work" for any webmaster... Pico 0.9 and older required Apache with mod_rewrite enabled, thus old plugins, templates and contents may require you to enable URL rewriting to work. If you're upgrading from Pico 0.9, you will probably have to update your rewriting rules. We recommend you to use the link filter in templates to create internal links, e.g. {{ "sub/page"|link }} is equivalent to {{ base_url }}/sub/page and {{ base_url }}?sub/page, depending on enabled URL rewriting. In content files you can use the %base_url% variable; e.g. %base_url%?sub/page will be replaced accordingly.

protected evaluateRequestUrl ( ) : void
Résultat	void

getAbsolutePath() public méthode

This method also guarantees a trailing slash.

public getAbsolutePath ( string $path ) : string
$path	string	relative or absolute path
Résultat	string	absolute path

getBaseUrl() public méthode

Security Notice: You MUST configure Pico's base URL explicitly when using the base URL in contexts that are potentially vulnerable to HTTP Host Header Injection attacks (e.g. when generating emails).

public getBaseUrl ( ) : string
Résultat	string	the base url

getConfig() public méthode

Returns either the value of the specified config variable or the config array

public getConfig ( string $configName = null ) : mixed
$configName	string	optional name of a config variable
Résultat	mixed	returns either the value of the named config variable, null if the config variable doesn't exist or the config array if no config name was supplied

getConfigDir() public méthode

Returns the config directory of this Pico instance

public getConfigDir ( ) : string
Résultat	string	config directory path

getCurrentPage() public méthode

Returns the data of the requested page

public getCurrentPage ( ) : array | null
Résultat	array | null	page data

getFileContent() public méthode

Returns the cached contents of the requested page

public getFileContent ( ) : string | null
Résultat	string | null	parsed contents

getFileMeta() public méthode

Returns the parsed meta data of the requested page

public getFileMeta ( ) : array | null
Résultat	array | null	parsed meta data

getFiles() protected méthode

Recursively walks through a directory and returns all containing files matching the specified file extension

protected getFiles ( string $directory, string $fileExtension = '', integer $order = self::SORT_ASC ) : array
$directory	string	start directory
$fileExtension	string	return files with the given file extension only (optional)
$order	integer	specify whether and how files should be sorted; use Pico::SORT_ASC for a alphabetical ascending order (this is the default behaviour), Pico::SORT_DESC for a descending order or Pico::SORT_NONE to leave the result unsorted
Résultat	array	list of found files

getMetaHeaders() public méthode

Heads up! Calling this method triggers the onMetaHeaders event. Keep this in mind to prevent a infinite loop!

public getMetaHeaders ( ) : string[]
Résultat	string[]	known meta headers; the array value specifies the YAML key to search for, the array key is later used to access the found value

getNextPage() public méthode

Returns the data of the next page relative to the page being served

public getNextPage ( ) : array | null
Résultat	array | null	page data

getPageUrl() public méthode

Returns the URL to a given page

public getPageUrl ( string $page, array | string $queryData = null ) : string
$page	string	identifier of the page to link to
$queryData	array | string	either an array containing properties to create a URL-encoded query string from, or a already encoded string
Résultat	string	URL

getPages() public méthode

Returns the list of known pages

public getPages ( ) : array[] | null
Résultat	array[] | null	the data of all pages

getParsedown() public méthode

Returns the Parsedown Extra markdown parser

public getParsedown ( ) : ParsedownExtra | null
Résultat	ParsedownExtra | null	Parsedown Extra markdown parser

getPlugin() public méthode

Plugins SHOULD implement {@link PicoPluginInterface}, but you MUST NOT rely on it. For more information see {@link PicoPluginInterface}.

public getPlugin ( string $pluginName ) : object
$pluginName	string	name of the plugin
Résultat	object	instance of the plugin

getPlugins() public méthode

Returns all loaded plugins

public getPlugins ( ) : object[] | null
Résultat	object[] | null

getPluginsDir() public méthode

Returns the plugins directory of this Pico instance

public getPluginsDir ( ) : string
Résultat	string	plugins directory path

getPreviousPage() public méthode

Returns the data of the previous page relative to the page being served

public getPreviousPage ( ) : array | null
Résultat	array | null	page data

getRawContent() public méthode

Returns the raw contents, either of the requested or the 404 file

public getRawContent ( ) : string | null
Résultat	string | null	raw contents

getRequestFile() public méthode

Returns the absolute path to the content file to serve

public getRequestFile ( ) : string | null
Résultat	string | null	file path

getRequestUrl() public méthode

Returns the URL where a user requested the page

public getRequestUrl ( ) : string | null
Résultat	string | null	request URL

getRootDir() public méthode

Returns the root directory of this Pico instance

public getRootDir ( ) : string
Résultat	string	root directory path

getThemesDir() public méthode

Returns the themes directory of this Pico instance

public getThemesDir ( ) : string
Résultat	string	themes directory path

getTwig() public méthode

Returns the twig template engine

public getTwig ( ) : Twig_Environment | null
Résultat	Twig_Environment | null	Twig template engine

getTwigVariables() protected méthode

URLs and paths (namely base_dir, base_url, theme_dir and theme_url) don't add a trailing slash for historic reasons.

protected getTwigVariables ( ) : array
Résultat	array	template variables

isUrlRewritingEnabled() public méthode

Returns true if URL rewriting is enabled

public isUrlRewritingEnabled ( ) : boolean
Résultat	boolean	true if URL rewriting is enabled, false otherwise

load404Content() public méthode

Returns the raw contents of the first found 404 file when traversing up from the directory the requested file is in

public load404Content ( string $file ) : string
$file	string	path to requested (but not existing) file
Résultat	string	raw contents of the 404 file

loadConfig() protected méthode

Loads the config.php from Pico::$configDir

protected loadConfig ( ) : void
Résultat	void

loadFileContent() public méthode

Returns the raw contents of a file

public loadFileContent ( string $file ) : string
$file	string	file path
Résultat	string	raw contents of the file

loadPlugins() protected méthode

Plugin files MAY be prefixed by a number (e.g. 00-PicoDeprecated.php) to indicate their processing order. Plugins without a prefix will be loaded last. If you want to use a prefix, you MUST consider the following directives: - 00 to 19: Reserved - 20 to 39: Low level code helper plugins - 40 to 59: Plugins manipulating routing or the pages array - 60 to 79: Plugins hooking into template or markdown parsing - 80 to 99: Plugins using the onPageRendered event

protected loadPlugins ( ) : void
Résultat	void

parseFileContent() public méthode

Parses the contents of a page using ParsedownExtra

public parseFileContent ( string $content ) : string
$content	string	raw contents of a page (Markdown)
Résultat	string	parsed contents (HTML)

parseFileMeta() public méthode

Meta data MUST start on the first line of the file, either opened and closed by --- or C-style block comments (deprecated). The headers are parsed by the YAML component of the Symfony project, keys are lowered. If you're a plugin developer, you MUST register new headers during the onMetaHeaders event first. The implicit availability of headers is for users and pure (!) theme developers ONLY.

public parseFileMeta ( string $rawContent, array $headers ) : array
$rawContent	string	the raw file contents
$headers	array	known meta headers
Résultat	array	parsed meta data

prepareFileContent() public méthode

Applies some static preparations to the raw contents of a page, e.g. removing the meta header and replacing %base_url%

public prepareFileContent ( string $rawContent, array $meta ) : string
$rawContent	string	raw contents of a page
$meta	array	meta data to use for %meta.*% replacement
Résultat	string	contents prepared for parsing

readPages() protected méthode

The page data will be an array containing the following values: | Array key | Type | Description | | -------------- | ------ | ---------------------------------------- | | id | string | relative path to the content file | | url | string | URL to the page | | title | string | title of the page (YAML header) | | description | string | description of the page (YAML header) | | author | string | author of the page (YAML header) | | time | string | timestamp derived from the Date header | | date | string | date of the page (YAML header) | | date_formatted | string | formatted date of the page | | raw_content | string | raw, not yet parsed contents of the page | | meta | string | parsed meta data of the page |

protected readPages ( ) : void
Résultat	void

registerParsedown() protected méthode

Registers the Parsedown Extra markdown parser

protected registerParsedown ( ) : void
Résultat	void

registerTwig() protected méthode

This method also registers Pico's core Twig filters link and content as well as Pico's {@link PicoTwigExtension} Twig extension.

protected registerTwig ( ) : void
Résultat	void

run() public méthode

Loads plugins, evaluates the config file, does URL routing, parses meta headers, processes Markdown, does Twig processing and returns the rendered contents.

public run ( ) : string
Résultat	string	rendered Pico contents

setConfig() public méthode

This method allows you to modify Pico's config without creating a {@path "config/config.php"} or changing some of its variables before Pico starts processing. You can call this method between {@link Pico::__construct()} and {@link Pico::run()} only. Options set with this method cannot be overwritten by {@path "config/config.php"}.

public setConfig ( array $config ) : void
$config	array	array with config variables
Résultat	void

sortPages() protected méthode

Sorts all pages known to Pico

protected sortPages ( ) : void
Résultat	void

triggerEvent() protected méthode

Deprecated events (as used by plugins not implementing {@link PicoPluginInterface}) are triggered by {@link PicoDeprecated}.

protected triggerEvent ( string $eventName, array $params = [] ) : void
$eventName	string	name of the event to trigger
$params	array	optional parameters to pass
Résultat	void