Docs For Class Pluggable

Description

Pluggable class Implements methods that allow descendant classes to register functions to plugin hooks

version: $Id$
copyright: 2008
abstract:

Located in /system/classes/pluggable.php (line 11)

Direct descendents

Class	Description
Plugin	Habari Plugin Class
Theme	Habari Theme Class

Variable Summary

mixed $info

mixed $plugin_id

Method Summary

Pluggable __construct ()

string get_db_schema ()

string get_file ()

string get_url ([bool $trail = false])

void load ()

boolean load_text_domain ( $domain)

string plugin_id ()

Variables

mixed $info (line 14)

access: public

mixed $plugin_id (line 15)

access: public

Methods

Constructor __construct (line 24)

Pluggable constructor.

This function creates some internal structures that are required for plugin processing Plugins should not define their own constructors, because they are instantiated to extract plugin info. Instead, include a sink for a "init" hook which is executed immediately after the plugin is loaded during normal execution.

access: public

Pluggable __construct ()

Redefined in descendants as:

Plugin::__construct() : Plugin constructor.
Theme::__construct() : Constructor for theme

get_db_schema (line 46)

Gets a database schema associated with this pluggable

return: The database schema
access: public

string get_db_schema ()

get_file (line 33)

Gets the filename that contains this pluggable class

return: The filename of the file that contains the pluggable class.
access: public

string get_file ()

get_url (line 59)

Get a fully-qualified URL directory that contains this pluggable class

return: URL
access: public

string get_url ([bool $trail = false])

bool $trail: whether to include a trailing slash. Default: No

load (line 90)

Called when a pluggable is loaded to register its actions and filters.

Registers all of this pluggables action_ and filter_ functions with the Plugins dispatcher Registers xmlrpc_ functions with the Plugins dispatcher, and turns '__' into '.' for the purposes of matching dotted XMLRPC requests.

access: public

void load ()

load_text_domain (line 77)

Load a translation domain/file for this pluggable

return: TRUE if data was successfully loaded, FALSE otherwise
access: public

boolean load_text_domain ( $domain)

$domain

plugin_id (line 68)

Returns a unique id for this pluggable

return: A plugin id
access: public

string plugin_id ()