Commit dc95da1c authored by Taddeus Kroes's avatar Taddeus Kroes

Updated documentation.

parent 7394bf50
<?php <?php
/** /**
* pQuery plugin for executing common array functions. * pQuery plugin for easily executing practical functions on arrays, in a
* more object-oriented manner than natively supported by PHP.
* *
* @package pQuery * @package pQuery
*/ */
/** /**
* @todo Documentation * pQuery extension class for the 'array' plugin.
*/ */
class pQueryArray extends pQuery { class pQueryArray extends pQuery {
static $accepts = array('array'); static $accepts = array('array');
......
<?php <?php
/** /**
* pQuery plugin for parsing templates. * pQuery plugin for cache-control of a list of files.
* *
* @package pQuery * @package pQuery
*/ */
/** /**
* @todo Documentation * pQuery extension class for the 'cache' plugin.
* @property string $files *
* @property string $files The list of files in the cached object.
* @todo Method documentation
*/ */
class pQueryCache extends pQuery { class pQueryCache extends pQuery {
const CACHE_FOLDER = 'cache/'; const CACHE_FOLDER = 'cache/';
......
<?php <?php
/** /**
* pQuery plugin for parsing templates. * pQuery plugin for composing sets of CSS stylesheets.
* The plugin has built-in cache control and uses the CssParser class.
* *
* @package pQuery * @package pQuery
*/ */
...@@ -9,7 +10,7 @@ __p::require_plugins('cache'); ...@@ -9,7 +10,7 @@ __p::require_plugins('cache');
__p::load_utils('CssParser'); __p::load_utils('CssParser');
/** /**
* @todo Documentation * pQuery extension class for the 'css' plugin.
*/ */
class pQueryCss extends pQueryCache { class pQueryCss extends pQueryCache {
static $accepts = array('array' => 'add_extensions', 'string' => 'make_array'); static $accepts = array('array' => 'add_extensions', 'string' => 'make_array');
......
<?php <?php
/** /**
* pQuery plugin for parsing templates. * pQuery plugin for composing sets of JavaScript files.
* The plugin has built-in cache control and supports the JShrink minifier.
* *
* @package pQuery * @package pQuery
*/ */
...@@ -9,7 +10,7 @@ __p::require_plugins('cache'); ...@@ -9,7 +10,7 @@ __p::require_plugins('cache');
__p::load_utils('jshrink'); __p::load_utils('jshrink');
/** /**
* @todo Documentation * pQuery extension class for the 'js' plugin.
*/ */
class pQueryJs extends pQueryCache { class pQueryJs extends pQueryCache {
static $accepts = array('array' => 'add_extensions', 'string' => 'make_array'); static $accepts = array('array' => 'add_extensions', 'string' => 'make_array');
......
...@@ -6,7 +6,8 @@ ...@@ -6,7 +6,8 @@
*/ */
/** /**
* @todo Documentation * pQuery extension class for the 'sql' plugin.
*
* @property $query The query that is being evaluated. * @property $query The query that is being evaluated.
*/ */
class pQuerySql extends pQuery { class pQuerySql extends pQuery {
......
...@@ -8,7 +8,8 @@ ...@@ -8,7 +8,8 @@
__p::load_utils('block'); __p::load_utils('block');
/** /**
* @todo Documentation * pQuery extension class for the 'tpl' plugin.
*
* @property string $content The template's content. * @property string $content The template's content.
*/ */
class pQueryTemplate extends pQuery { class pQueryTemplate extends pQuery {
......
<?php <?php
/** /**
* pQuery plugin for parsing templates. * pQuery plugin for parsing URL's and calling corresponding handlers.
* *
* @package pQuery * @package pQuery
*/ */
/** /**
* @todo Documentation * pQuery extension class for the 'url' plugin.
* @property string $content The template's content. *
* @property string $url The current url, with slashes removed at begin and end.
*/ */
class pQueryUrl extends pQuery { class pQueryUrl extends pQuery {
static $accepts = array('string' => 'parse_url'); static $accepts = array('string' => 'parse_url');
...@@ -19,9 +20,12 @@ class pQueryUrl extends pQuery { ...@@ -19,9 +20,12 @@ class pQueryUrl extends pQuery {
static $variable_alias = 'url'; static $variable_alias = 'url';
/** /**
* The current set of handlers, pointed to by regular expression patterns.
* *
* The handler that is called for the current URL is the one corresponding
* to the first pattern in this list that matches the URL.
* *
* @var string * @var array
*/ */
static $handlers = array(); static $handlers = array();
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment