Update class docs

pico-3.0-alpha
Daniel Rudolf 10 years ago
parent dbd8fa8c2f
commit 1c2f6a1b23
  1. 8
      lib/Pico.php
  2. 4
      plugins/00-PicoDeprecated.php
  3. 4
      plugins/DummyPlugin.php

@ -101,7 +101,7 @@ class Pico
* Current configuration of this Pico instance * Current configuration of this Pico instance
* *
* @see Pico::getConfig() * @see Pico::getConfig()
* @var mixed[]|null * @var array|null
*/ */
protected $config; protected $config;
@ -197,7 +197,7 @@ class Pico
* Variables passed to the twig template * Variables passed to the twig template
* *
* @see Pico::getTwigVariables * @see Pico::getTwigVariables
* @var mixed[]|null * @var array|null
*/ */
protected $twigVariables; protected $twigVariables;
@ -516,7 +516,7 @@ class Pico
* *
* @see Pico::loadConfig() * @see Pico::loadConfig()
* @see Pico::getConfig() * @see Pico::getConfig()
* @param mixed[] $config array with config variables * @param array $config array with config variables
* @return void * @return void
* @throws LogicException thrown if Pico already started processing * @throws LogicException thrown if Pico already started processing
*/ */
@ -1173,7 +1173,7 @@ class Pico
* URLs and paths (namely `base_dir`, `base_url`, `theme_dir` and * URLs and paths (namely `base_dir`, `base_url`, `theme_dir` and
* `theme_url`) don't add a trailing slash for historic reasons. * `theme_url`) don't add a trailing slash for historic reasons.
* *
* @return mixed[] template variables * @return array template variables
*/ */
protected function getTwigVariables() protected function getTwigVariables()
{ {

@ -104,7 +104,7 @@ class PicoDeprecated extends AbstractPicoPlugin
* @see PicoDeprecated::loadRootDirConfig() * @see PicoDeprecated::loadRootDirConfig()
* @see PicoDeprecated::enablePlugins() * @see PicoDeprecated::enablePlugins()
* @see DummyPlugin::onConfigLoaded() * @see DummyPlugin::onConfigLoaded()
* @param mixed[] &$config array of config variables * @param array &$config array of config variables
* @return void * @return void
*/ */
public function onConfigLoaded(array &$config) public function onConfigLoaded(array &$config)
@ -159,7 +159,7 @@ class PicoDeprecated extends AbstractPicoPlugin
* *
* @see PicoDeprecated::onConfigLoaded() * @see PicoDeprecated::onConfigLoaded()
* @see Pico::loadConfig() * @see Pico::loadConfig()
* @param mixed[] &$realConfig array of config variables * @param array &$realConfig array of config variables
* @return void * @return void
*/ */
protected function loadRootDirConfig(array &$realConfig) protected function loadRootDirConfig(array &$realConfig)

@ -49,7 +49,7 @@ final class DummyPlugin extends AbstractPicoPlugin
* Triggered after Pico has read its configuration * Triggered after Pico has read its configuration
* *
* @see Pico::getConfig() * @see Pico::getConfig()
* @param mixed[] &$config array of config variables * @param array &$config array of config variables
* @return void * @return void
*/ */
public function onConfigLoaded(array &$config) public function onConfigLoaded(array &$config)
@ -292,7 +292,7 @@ final class DummyPlugin extends AbstractPicoPlugin
* @see Pico::getTwig() * @see Pico::getTwig()
* @see DummyPlugin::onPageRendered() * @see DummyPlugin::onPageRendered()
* @param Twig_Environment &$twig twig template engine * @param Twig_Environment &$twig twig template engine
* @param mixed[] &$twigVariables template variables * @param array &$twigVariables template variables
* @param string &$templateName file name of the template * @param string &$templateName file name of the template
* @return void * @return void
*/ */

Loading…
Cancel
Save