NavigationBlockPlugin Class Reference
[Plugins]

Class for navigation block plugin. More...

Inheritance diagram for NavigationBlockPlugin:

BlockPlugin Plugin List of all members.

Public Member Functions

 getContents (&$templateMgr)
 getDescription ()
 getDisplayName ()
 getInstallSitePluginSettingsFile ()
 getName ()
 getNewConferencePluginSettingsFile ()
 getSupportedContexts ()
 register ($category, $path)

Detailed Description

Class for navigation block plugin.

NavigationBlockPlugin.inc.php

Copyright (c) 2000-2012 John Willinsky Distributed under the GNU GPL v2. For full terms see the file docs/COPYING.

Definition at line 19 of file NavigationBlockPlugin.inc.php.


Member Function Documentation

NavigationBlockPlugin.getContents ( &$  templateMgr  ) 

Get the contents for this block.

Parameters:
$templateMgr object
Returns:
string

Reimplemented from BlockPlugin.

Definition at line 81 of file NavigationBlockPlugin.inc.php.

NavigationBlockPlugin.getDescription (  ) 

Get a description of the plugin.

Reimplemented from BlockPlugin.

Definition at line 72 of file NavigationBlockPlugin.inc.php.

NavigationBlockPlugin.getDisplayName (  ) 

Get the display name of this plugin.

Returns:
String

Reimplemented from BlockPlugin.

Definition at line 65 of file NavigationBlockPlugin.inc.php.

NavigationBlockPlugin.getInstallSitePluginSettingsFile (  ) 

Install default settings on system install.

Returns:
string

Definition at line 49 of file NavigationBlockPlugin.inc.php.

NavigationBlockPlugin.getName (  ) 

Get the name of this plugin. The name must be unique within its category.

Returns:
String name of plugin

Reimplemented from BlockPlugin.

Definition at line 41 of file NavigationBlockPlugin.inc.php.

NavigationBlockPlugin.getNewConferencePluginSettingsFile (  ) 

Install default settings on conference creation.

Returns:
string

Reimplemented from Plugin.

Definition at line 57 of file NavigationBlockPlugin.inc.php.

NavigationBlockPlugin.getSupportedContexts (  ) 

Get the supported contexts (e.g. BLOCK_CONTEXT_...) for this block.

Returns:
array

Reimplemented from BlockPlugin.

Definition at line 32 of file NavigationBlockPlugin.inc.php.

NavigationBlockPlugin.register ( category,
path 
)

Called as a plugin is registered to the registry. Subclasses over- riding this method should call the parent method first.

Parameters:
$category String Name of category plugin was registered to
$path String The path the plugin was found in
Returns:
boolean True iff plugin initialized successfully; if false, the plugin will not be registered.

Reimplemented from BlockPlugin.

Definition at line 20 of file NavigationBlockPlugin.inc.php.


The documentation for this class was generated from the following file:
Generated on 25 Jul 2013 for Open Conference Systems by  doxygen 1.4.7