1: <?php
2: /**
3: * @file
4: * @package legacy
5: * @version $Id$
6: **/
7:
8: if(!defined('XOOPS_ROOT_PATH'))
9: {
10: exit();
11: }
12:
13: /**
14: * Interface of group delegate
15: **/
16: interface Legacy_iGroupDelegate
17: {
18: /**
19: * getTitle Legacy_Group.{dirname}.GetTitle
20: * get the group title by group id.
21: *
22: * @param string &$title
23: * @param string $gDirname Group Module Dirname
24: * @param int $groupId
25: *
26: * @return void
27: */
28: public static function getTitle(/*** string ***/ &$title, /*** string ***/ $gDirname, /*** int ***/ $groupId);
29:
30: /**
31: * getTitleList Legacy_Group.{dirname}.GetTitleList
32: * get group titles.
33: *
34: * @param string[] &$titleList
35: * @param string $gDirname Group Module Dirname
36: *
37: * @return void
38: */
39: public static function getTitleList(/*** string[] ***/ &$titleList, /*** string ***/ $gDirname);
40:
41: /**
42: * hasPermission Legacy_Group.{dirname}.HasPermission
43: *
44: * @param bool &$check
45: * @param string $gDirname
46: * @param int $groupId
47: * @param string $dirname
48: * @param string $dataname
49: * @param string $action
50: *
51: * @return void
52: */
53: public static function hasPermission(/*** bool ***/ &$check, /*** string ***/ $gDirname, /*** int ***/ $groupId, /*** string ***/ $dirname, /*** string ***/ $dataname, /*** string ***/ $action);
54:
55: /**
56: * getGroupIdList Legacy_Group.{dirname}.GetMyGroupIdList
57: *
58: * @param int[] &$list
59: * @param string $gDirname Group Module Dirname
60: * @param Enum $rank Lenum_GroupRank
61: * @param int $limit
62: * @param int $start
63: *
64: * @return void
65: */
66: public static function getGroupIdList(/*** int[] ***/ &$list, /*** string ***/ $gDirname, /*** Enum ***/ $rank, /*** int ***/ $limit=null, /*** int ***/ $start=null);
67:
68: /**
69: * getGroupList Legacy_Group.{dirname}.GetMyGroupList
70: *
71: * @param Legacy_AbstractGroupObject[] &$list
72: * @param string $gDirname Group Module Dirname
73: * @param Enum $rank Lenum_GroupRank
74: * @param int $limit
75: * @param int $start
76: *
77: * @return void
78: */
79: public static function getGroupList(/*** mixed[] ***/ &$list, /*** string ***/ $gDirname, /*** Enum ***/ $rank, /*** int ***/ $limit=null, /*** int ***/ $start=null);
80:
81: /**
82: * getGroupIdListByAction Legacy_Group.{dirname}.GetGroupIdListByAction
83: *
84: * @param int[] &$list
85: * @param string $gDirname Group Module Dirname
86: * @param string $dirname
87: * @param string $dataname
88: * @param string $action
89: * @param int $limit
90: * @param int $start
91: *
92: * @return void
93: */
94: public static function getGroupIdListByAction(/*** int[] ***/ &$list, /*** string ***/ $gDirname, /*** string ***/ $dirname, /*** string ***/ $dataname, /*** string ***/ $action, /*** int ***/ $limit=null, /*** int ***/ $start=null);
95:
96: /**
97: * getGroupListByAction Legacy_Group.{dirname}.GetGroupListByAction
98: *
99: * @param Legacy_AbstractGroupObject[] &$list
100: * @param string $gDirname Group Module Dirname
101: * @param string $dirname
102: * @param string $dataname
103: * @param string $action
104: * @param int $limit
105: * @param int $start
106: *
107: * @return void
108: */
109: public static function getGroupListByAction(/*** mixed[] ***/ &$list, /*** string ***/ $gDirname, /*** string ***/ $dirname, /*** string ***/ $dataname, /*** string ***/ $action, /*** int ***/ $limit=null, /*** int ***/ $start=null);
110:
111: /**
112: * getMemberList Legacy_Group.{dirname}.GetMemberList
113: * get member list in the given group
114: *
115: * @param mixed $list
116: * $list['uid']
117: * $list['rank']
118: * @param string $gDirname Group Module Dirname
119: * @param int $groupId
120: * @param Enum $rank Lenum_GroupRank
121: *
122: * @return void
123: */
124: public static function getMemberList(/*** int[] ***/ &$list, /*** string ***/ $gDirname, /*** int ***/ $groupId, /*** Enum ***/ $rank);
125:
126: /**
127: * isMember Legacy_Group.{dirname}.IsMember
128: * check the user's belonging and rank in the given group
129: *
130: * @param string $gDirname Group Module Dirname
131: * @param bool &$check
132: * @param int $groupId
133: * @param int $uid
134: * @param Enum $rank Lenum_GroupRank
135: *
136: * @return void
137: */
138: public static function isMember(/*** bool ***/ &$check, /*** string ***/ $gDirname, /*** int ***/ $groupId, /*** int ***/ $uid, /*** Enum ***/ $rank=Lenum_GroupRank::REGULAR);
139: }
140:
141: ?>
142: