1: <?php
2: /*
3: You may not change or alter any portion of this comment or credits
4: of supporting developers from this source code or any supporting source code
5: which is considered copyrighted (c) material of the original comment or credit authors.
6:
7: This program is distributed in the hope that it will be useful,
8: but WITHOUT ANY WARRANTY; without even the implied warranty of
9: MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
10: */
11:
12: /**
13: * @copyright XOOPS Project (http://xoops.org)
14: * @license GNU GPL 2 or later (http://www.gnu.org/licenses/gpl-2.0.html)
15: * @author Laurent JEN (aka DuGris)
16: * @version $Id$
17: */
18:
19: interface SystemPluginInterface
20: {
21: /**
22: * Used to synchronize a user number of posts
23: * Please return the number of posts the user as made in your module
24: *
25: * @param int $uid The uid of the user
26: *
27: * @return int Number of posts
28: */
29: public function userPosts($uid);
30:
31: /**
32: * Used to populate the Waiting Block
33: *
34: * Expects an array containing:
35: * count : Number of waiting items, ex: 3
36: * name : Name for the waiting items, ex: Pending approval
37: * link : Link for the waiting items, ex: Xoops::getInstance()->url('modules/comments/admin/main.php');
38: *
39: * @return array
40: */
41: public function waiting();
42:
43: /**
44: * Used to populate backend
45: *
46: * @param int $limit : Number of item for backend
47: *
48: * Expects an array containing:
49: * title : Title for the backend items
50: * link : Link for the backend items
51: * content : content for the backend items
52: * date : Date of the backend items
53: *
54: * @return array
55: */
56: public function backend($limit);
57:
58: /**
59: * Used to populate the User Block
60: *
61: * Expects an array containing:
62: * name : Name for the Link
63: * link : Link relative to module
64: * image : Url of image to display, please use 16px*16px image
65: *
66: * @return array
67: */
68: public function userMenus();
69: }
70: