extends |
XoopsObjectHandler |
|---|
XOOPS group permission handler class.
This class is responsible for providing data access mechanisms to the data source of XOOPS group permission class objects. This class is an abstract class to be implemented by child group permission classes.
| Methods | ||||||||||
|---|---|---|---|---|---|---|---|---|---|---|
public
|
__construct(XoopsDatabase $db)
called from child classes only
called from child classes only Parameters
Overrides |
# | ||||||||
public
|
create(bool $isNew = true): XoopsGroupPerm
Create a new {@link XoopsGroupPerm}
Create a new {@link XoopsGroupPerm} Parameters
Overrides |
# | ||||||||
public
|
get(int $id): XoopsGroupPerm|false
Retrieve a group permission
Retrieve a group permission Parameters
Returns{@link XoopsGroupPerm}, false on fail Overrides |
# | ||||||||
public
|
insert(XoopsObject|XoopsGroupPerm $perm): bool
Store a {@link XoopsGroupPerm}
Store a {@link XoopsGroupPerm} Parameters
Returnstrue on success, otherwise false Overrides |
# | ||||||||
public
|
delete(XoopsObject|XoopsGroupPerm $perm): bool
Delete a {@link XoopsGroupPerm}
Delete a {@link XoopsGroupPerm} Parameters
Returnstrue on success, otherwise false Overrides |
# | ||||||||
public
|
getObjects(CriteriaElement|CriteriaCompo $criteria = null, bool $id_as_key = false): array
Retrieve multiple {@link XoopsGroupPerm}s
Retrieve multiple {@link XoopsGroupPerm}s Parameters
ReturnsArray of {@link XoopsGroupPerm}s |
# | ||||||||
public
|
getCount(CriteriaElement|CriteriaCompo $criteria = null): int
Count some {@link XoopsGroupPerm}s
Count some {@link XoopsGroupPerm}s Parameters
|
# | ||||||||
public
|
deleteAll(CriteriaElement|CriteriaCompo $criteria = null): bool
Delete all permissions by a certain criteria
Delete all permissions by a certain criteria Parameters
ReturnsTRUE on success |
# | ||||||||
public
|
deleteByGroup(int $gperm_groupid, int $gperm_modid = null): bool
Delete all module specific permissions assigned for a group
Delete all module specific permissions assigned for a group Parameters
ReturnsTRUE on success |
# | ||||||||
public
|
deleteByModule(int $gperm_modid, string $gperm_name = null, int $gperm_itemid = null): bool
Delete all module specific permissions
Delete all module specific permissions Parameters
ReturnsTRUE on success |
# | ||||||||
public
|
checkRight(string $gperm_name, int $gperm_itemid, $gperm_groupid, int $gperm_modid = 1, bool $trueifadmin = true): bool
Check permission
Check permission Parameters
ReturnsTRUE if permission is enabled |
# | ||||||||
public
|
addRight(string $gperm_name, int $gperm_itemid, int $gperm_groupid, int $gperm_modid = 1): bool
Add a permission
Add a permission Parameters
ReturnsTRUE if success |
# | ||||||||
public
|
getItemIds(string $gperm_name, $gperm_groupid, int $gperm_modid = 1): array
Get all item IDs that a group is assigned a specific permission
Get all item IDs that a group is assigned a specific permission Parameters
Returnsarray of item IDs |
# | ||||||||
public
|
getGroupIds(string $gperm_name, int $gperm_itemid, int $gperm_modid = 1): array
Get all group IDs assigned a specific permission for a particular item
Get all group IDs assigned a specific permission for a particular item Parameters
Returnsarray of group IDs |
# | ||||||||
| Methods inherited from XoopsObjectHandler |
|---|
XoopsObjectHandler(), |
| Properties | |||
|---|---|---|---|
public
|
string
|
$table
table name
table name |
# |
| Properties inherited from XoopsObjectHandler |
|---|
$db |