IP.Board  3.3.0
plugin_online_users Class Reference
Inheritance diagram for plugin_online_users:
pluginBlockInterface

Public Member Functions

 __construct (ipsRegistry $registry)
 executePlugin ($block)
 getTags ()
 returnPluginConfig ($session)
 returnPluginInfo ()
 validatePluginConfig ($data)

Protected Attributes

 $cache
 $caches
 $DB
 $lang
 $member
 $memberData
 $registry
 $request
 $settings

Constructor & Destructor Documentation

__construct ( ipsRegistry registry)

#@- Constructor

public

Parameters:
objectRegistry reference
Returns:
void

Member Function Documentation

executePlugin ( block)

Execute the plugin and return the HTML to show on the page. Can be called from ACP or front end, so the plugin needs to setup any appropriate lang files, skin files, etc.

public

Parameters:
arrayBlock data
Returns:
string Block HTML to display or cache

Implements pluginBlockInterface.

getTags ( )

Return the tag help for this block type

public

Returns:
array
returnPluginConfig ( session)

Get plugin configuration data. Returns form elements and data

public

Parameters:
arraySession data
Returns:
array Form data

Implements pluginBlockInterface.

Return the plugin meta data

public

Returns:
array Plugin data (name, description, hasConfig)

Implements pluginBlockInterface.

validatePluginConfig ( data)

Check the plugin config data

public

Parameters:
arraySubmitted plugin data to check (usually $this->request)
Returns:
array Array( (bool) Ok or not, (array) Plugin data to use )

Implements pluginBlockInterface.


The documentation for this class was generated from the following file:
 All Data Structures Functions Variables