SystemPluginInterface Interface Reference

Inheritance diagram for SystemPluginInterface:

Public Member Functions
	backend ($limit)
	userMenus ()
	userPosts ($uid)
	waiting ()

Detailed Description

Copyright

The XOOPS Project http://sourceforge.net/projects/xoops/ GNU GPL 2 or later (http://www.gnu.org/licenses/gpl-2.0.html)

Author

Laurent JEN (aka DuGris)

Version

$Id$

Definition at line 19 of file interface.php.

Member Function Documentation

SystemPluginInterface::backend

(

$limit

)

Used to populate backend

Parameters

int

$limit

: Number of item for backend

Expects an array containing: title : Title for the backend items link : Link for the backend items content : content for the backend items date : Date of the backend items

Returns

array

Implemented in CommentsSystemPlugin, NotificationsSystemPlugin, and UserconfigsSystemPlugin.

SystemPluginInterface::userMenus

(

)

Used to populate the User Block

Expects an array containing: name : Name for the Link link : Link relative to module image : Url of image to display, please use 16px*16px image

Returns

array

Implemented in CommentsSystemPlugin, NotificationsSystemPlugin, and UserconfigsSystemPlugin.

SystemPluginInterface::userPosts

(

$uid

)

Used to synchronize a user number of posts Please return the number of posts the user as made in your module

Parameters

int

$uid

The uid of the user

Returns

int Number of posts

Implemented in CommentsSystemPlugin, NotificationsSystemPlugin, and UserconfigsSystemPlugin.

SystemPluginInterface::waiting

(

)

Used to populate the Waiting Block

Expects an array containing: count : Number of waiting items, ex: 3 name : Name for the waiting items, ex: Pending approval link : Link for the waiting items, ex: Xoops::getInstance()->url('modules/comments/admin/main.php');

Returns

array

Implemented in CommentsSystemPlugin, NotificationsSystemPlugin, and UserconfigsSystemPlugin.

---

The documentation for this interface was generated from the following file:

• C:/usr64/htdocs/modules/system/class/plugin/interface.php