Class: PluginsLib

Source Location: /wiki/plugins_lib.php

Class Overview

BitBase
   |
   --PluginsLib

Author(s):

Claudio Bustos

Version:

$Revision$

Variables

Methods

Inherited Constants

Class: BitBase

BitBase::CACHE_STATE_ADDED
BitBase::CACHE_STATE_DELETE
BitBase::CACHE_STATE_NONE
BitBase::CACHE_STATE_STORED

Inherited Variables

Class: BitBase

BitBase::$dType
BitBase::$mCacheTime
BitBase::$mDb
BitBase::$mErrors
BitBase::$mInfo
BitBase::$mLogs
BitBase::$mName
BitBase::$mPreventCache
BitBase::$mSuccess

Inherited Methods

Class: BitBase

BitBase::BitBase(): During initialisation, we assign a name which is used by the class.
BitBase::__construct()
BitBase::clearFromCache()
BitBase::expunge(): Delete content object and all related records
BitBase::load()
BitBase::__destruct()

Class Details

[line 30]

Tags:

author:	Claudio Bustos
version:	$Revision$

[ Top ]

Class Variables

$aInfoPresetNames = array(
"hits" => "Hits", "last_modified" => "Last mod", "user" => "Last author", "len" => "Size", "comment" => "Com", "creator" => "Creator", "version" => "Last ver", "flag" => "Status", "versions" => "Vers", "links" => "Links", "backlinks" => "Backlinks")

[line 49]

List of fields retrieved from BitBase::list_pages()

Keys are the name of the fields and values the names for tra();

Type:

array

[ Top ]

$expanded_params = array()

[line 38]

Array of params to be expanded as arrays. Explode the string with $separator

Type:

array

[ Top ]

$separator = "|"

[line 43]

Separator used to explote params listed on $expanded_params

Type:

string

[ Top ]

$_data =

[line 32]

Type:

mixed

[ Top ]

$_errors =

[line 31]

Type:

mixed

[ Top ]

$_params =

[line 33]

Type:

mixed

[ Top ]

Class Methods

method error [line 139]

void error(

$message)

Parameters:

$message

[ Top ]

method getDefaultArguments [line 124]

array getDefaultArguments(
)

Returns the default arguments for the plugin

Use keys as the arguments and values as ... the default values

[ Top ]

method getDescription [line 106]

string getDescription(
)

Returns a description of the Plugin Made for overload it.

[ Top ]

method getErrorDetail [line 142]

void getErrorDetail(
)

[ Top ]

method getName [line 98]

string getName(
)

Returns the name of the Plugin By default, erase the first 'WikiPlugin' Made for overload it.

[ Top ]

method getParams [line 62]

array getParams(
array
$params, [bool
$request = false], [bool
$defaults = false])

Process the params, in this order:

default values, asigned on PluginsLib::getDefaultArguments()
request values, sended by GET or POST method, if $request is put to true
explicit values, asigned on the Wiki

Tags:

return:

list of params

Parameters:

array	$params	sended to wikiplugin_name($data, $params)
bool	$request	if set to true, accept values from $_REQUEST
bool	$defaults	if set to true, assign default values from PluginsLib::getDefaultArguments()

[ Top ]

method getVersion [line 114]

string getVersion(
)

Returns the version of the version Made for overload it.

[ Top ]

method run [line 133]

void run(
string
$data, array
$params)

Run the plugin

For sake of God, overload it!

Parameters:

string	$data
array	$params

[ Top ]

method _error [line 145]

void _error(

$message)

Parameters:

$message

[ Top ]

Documentation generated on Wed, 29 Jul 2015 13:57:15 +0000 by phpDocumentor 1.5.0-lsces

Class: PluginsLib

Class Overview

Author(s):

Version:

Variables

Methods

Inherited Constants

Class: BitBase

Inherited Variables

Class: BitBase

Inherited Methods

Class: BitBase

Class Details

Tags:

Class Variables

$aInfoPresetNames = array( "hits" => "Hits", "last_modified" => "Last mod", "user" => "Last author", "len" => "Size", "comment" => "Com", "creator" => "Creator", "version" => "Last ver", "flag" => "Status", "versions" => "Vers", "links" => "Links", "backlinks" => "Backlinks")

$expanded_params = array()

$separator = "|"

$_data =

$_errors =

$_params =

Class Methods

method error [line 139]

Parameters:

method getDefaultArguments [line 124]

method getDescription [line 106]

method getErrorDetail [line 142]

method getName [line 98]

method getParams [line 62]

Tags:

Parameters:

method getVersion [line 114]

method run [line 133]

Parameters:

method _error [line 145]

Parameters:

$aInfoPresetNames = array(
"hits" => "Hits", "last_modified" => "Last mod", "user" => "Last author", "len" => "Size", "comment" => "Com", "creator" => "Creator", "version" => "Last ver", "flag" => "Status", "versions" => "Vers", "links" => "Links", "backlinks" => "Backlinks")