[PluginAPI] element index

Package indexes

• Core
• HTML
• Addressbook
• Cache
• Mail
• View
• Database

__construct

rcube_plugin::__construct() in rcube_plugin.php

Default constructor.

$api

rcube_plugin::$api in rcube_plugin.php

Instance of Plugin API

add_button

rcube_plugin::add_button() in rcube_plugin.php

Append a button to a certain container

add_content

rcube_plugin_api::add_content() in rcube_plugin_api.php

Save the given HTML content to be added to a template container

add_hook

rcube_plugin::add_hook() in rcube_plugin.php

Register a callback function for a specific (server-side) hook

add_texts

rcube_plugin::add_texts() in rcube_plugin.php

Load localized texts from the plugins dir

$config

rcube_plugin_api::$config in rcube_plugin_api.php

$dir

rcube_plugin_api::$dir in rcube_plugin_api.php

exec_action

rcube_plugin_api::exec_action() in rcube_plugin_api.php

This method handles requests like _task=mail&_action=plugin.foo It executes the callback function that was registered with the given action.

exec_hook

rcube_plugin_api::exec_hook() in rcube_plugin_api.php

Triggers a plugin hook.

gettext

rcube_plugin::gettext() in rcube_plugin.php

Wrapper for rcmail::gettext() adding the plugin ID as domain

get_instance

rcube_plugin_api::get_instance() in rcube_plugin_api.php

This implements the 'singleton' design pattern

$handlers

rcube_plugin_api::$handlers in rcube_plugin_api.php

$home

rcube_plugin::$home in rcube_plugin.php

$ID

rcube_plugin::$ID in rcube_plugin.php

Class name of the plugin instance

include_script

rcube_plugin_api::include_script() in rcube_plugin_api.php

Include a plugin script file in the current HTML page

include_script

rcube_plugin::include_script() in rcube_plugin.php

Make this javascipt file available on the client

include_stylesheet

rcube_plugin::include_stylesheet() in rcube_plugin.php

Make this stylesheet available on the client

include_stylesheet

rcube_plugin_api::include_stylesheet() in rcube_plugin_api.php

Include a plugin stylesheet in the current HTML page

init

rcube_plugin::init() in rcube_plugin.php

Initialization method, needs to be implemented by the plugin itself

init

rcube_plugin_api::init() in rcube_plugin_api.php

Load and init all enabled plugins

is_plugin_task

rcube_plugin_api::is_plugin_task() in rcube_plugin_api.php

Checks whether the given task is registered by a plugin

is_processing

rcube_plugin_api::is_processing() in rcube_plugin_api.php

Check if a plugin hook is currently processing.

loaded_plugins

rcube_plugin_api::loaded_plugins() in rcube_plugin_api.php

Returns list of loaded plugins names

load_config

rcube_plugin::load_config() in rcube_plugin.php

Load local config file from plugins directory.

load_plugin

rcube_plugin_api::load_plugin() in rcube_plugin_api.php

Load the specified plugin

local_skin_path

rcube_plugin::local_skin_path() in rcube_plugin.php

Provide path to the currently selected skin folder within the plugin directory with a fallback to the default skin folder.

$noajax

rcube_plugin::$noajax in rcube_plugin.php

Disables plugin in AJAX requests

$noframe

rcube_plugin::$noframe in rcube_plugin.php

Disables plugin in framed mode

$output

rcube_plugin_api::$output in rcube_plugin_api.php

rcube_plugin

rcube_plugin in rcube_plugin.php

Plugin interface class

rcube_plugin.php

rcube_plugin.php in rcube_plugin.php

rcube_plugin_api

rcube_plugin_api in rcube_plugin_api.php

The plugin loader and global API

rcube_plugin_api.php

rcube_plugin_api.php in rcube_plugin_api.php

register_action

rcube_plugin::register_action() in rcube_plugin.php

Register a handler for a specific client-request action

register_action

rcube_plugin_api::register_action() in rcube_plugin_api.php

Let a plugin register a handler for a specific request

register_handler

rcube_plugin_api::register_handler() in rcube_plugin_api.php

Register a handler function for template objects

register_handler

rcube_plugin::register_handler() in rcube_plugin.php

Register a handler function for a template object

register_hook

rcube_plugin_api::register_hook() in rcube_plugin_api.php

Allows a plugin object to register a callback for a certain hook

register_task

rcube_plugin_api::register_task() in rcube_plugin_api.php

Register this plugin to be responsible for a specific task

register_task

rcube_plugin::register_task() in rcube_plugin.php

Register this plugin to be responsible for a specific task

remove_hook

rcube_plugin::remove_hook() in rcube_plugin.php

Unregister a callback function for a specific (server-side) hook.

require_plugin

rcube_plugin::require_plugin() in rcube_plugin.php

Attempt to load the given plugin which is required for the current plugin

$task

rcube_plugin::$task in rcube_plugin.php

Regular expression defining task(s) to bind with

$url

rcube_plugin_api::$url in rcube_plugin_api.php

$urlbase

rcube_plugin::$urlbase in rcube_plugin.php

unregister_hook

rcube_plugin_api::unregister_hook() in rcube_plugin_api.php

Allow a plugin object to unregister a callback.

url

rcube_plugin::url() in rcube_plugin.php

Generate an absolute URL to the given resource within the current plugin directory