1. class
  2. XELOS
  3. \
  4. Framework
  5. \
  6. XF
  7. \
  8. Lib
  9. \
  10. GroupSecurity

GroupSecurity

class GroupSecurity

Methods

__construct()

No description

add_follow_user(int $group_security_id, bool|int $user_id = false, string $status = Follows::STATUS_FOLLOW)

Add user as follower for this group

mixed
add_global_group($module_name, $instance_id, $group_id, $title, string $security_type = 'public')

No description

mixed
add_group_member(int $gid, int $user_id = false, array $role_ids = array(), bool $set_follow_status = true)

Add Member to security Group

void
clear_group_members(int $gid)

Update Memberlist of security Group

array
get_accessible_groups(bool|int $user_id = false) deprecated

Get Groups of this user which are accessible

array
get_accessible_groups_by_policycheck(string $policy_instance = 'system', string $policy_name = 'page_accessible', string $policy_value = null, int $user_id = null, string $group_instance_id = null)

Determine the group_security_ids for a specific resource in a grouped module

array
get_available_roles_for_global_group(int $gid)

retruns an array of all available role ids if detectable detectable means that the gid contains to a instance of the type group (other will come e.g. multitenant)

array
get_available_users_for_global_group(int $gid, $include_roles = false)

retruns an array of all available role ids if detectable detectable means that the gid contains to a instance of the type group (other will come e.g. multitenant)

int
get_global_group(string $instance_id, int $group_id, bool $usecache = true)

Get Global Group ID for your local ID (using your group module instance, e.g. groups or groupizer)

array
get_global_group_meta(int $group_id)

Get Metainformation Global Group ID for your global ID

int
get_instance_global_group(string $instance_id, int $group_id)

Get Global Group ID for your local ID (using your grouped instance, e.g. forum) Function will traverse parent contexts and return the first global group found

int
get_instance_local_group(string $instance_id, int $group_security_id)

Get LOCAL Group ID for your group_securiy_id (using your grouped instance, e.g. forum)

int
get_local_group(string $instance_id, int $group_security_id)

Get local Group ID for your global group_security_id (using your group module instance, e.g. groups or groupizer)

array
get_local_group_meta(string $instance_id, int $group_id)

Get Metainformation Global Group ID for your local ID (using your group module instance, e.g. groups or groupizer)

int[]|false
get_members_for_global_group(int $gid)

Returns an array of all available role ids if detectable detectable means that the gid contains to a instance of the type group (other will come e.g. multitenant)

init()

No description

remove_follow_user(int $group_security_id, int $user_id)

Remove user as follower for this group

remove_global_group(int $gid)

Remove security Group

remove_group_member(int $gid, int $user_id = false, $set_follow_status = true)

Remove Member from security Group

remove_groups(int $gid)

Remove security Group

remove_local_group(string $instance_id, int $group_id)

Remove security Group

int|mixed
update_global_group($gid, $module_name, $instance_id, $group_id, $title, string $security_type = 'public')

No description

mixed
update_group_member(int $gid, int $user_id = false, array $role_ids = array(), bool $set_follow_status = false)

Add Member to security Group

Details

at line 19
__construct()

No description

at line 395
add_follow_user(int $group_security_id, bool|int $user_id = false, string $status = Follows::STATUS_FOLLOW)

Add user as follower for this group

Parameters

int $group_security_id
bool|int $user_id
string $status ('follow','auto_follow','ignore')

at line 37
mixed add_global_group($module_name, $instance_id, $group_id, $title, string $security_type = 'public')

No description

Parameters

$module_name
$instance_id
$group_id
$title
string $security_type

Return Value

mixed

at line 353
mixed add_group_member(int $gid, int $user_id = false, array $role_ids = array(), bool $set_follow_status = true)

Add Member to security Group

Parameters

int $gid
int $user_id
array $role_ids
bool $set_follow_status

Set Follow Status?

Return Value

mixed

at line 521
void clear_group_members(int $gid)

Update Memberlist of security Group

Parameters

int $gid

Return Value

void

at line 539
array get_accessible_groups(bool|int $user_id = false) deprecated

deprecated Use ModuleGroupSecurityCollection->filterByAccessible() instead

Get Groups of this user which are accessible

Parameters

bool|int $user_id

Return Value

array

= [['id'=>$groupSecurityId,'group_id'=>$localGroupID,'instance_id'=>$instanceString,'module_name'=>$moduleString,'title'=>$title,'security_type'=>'closed|public']]

at line 557
array get_accessible_groups_by_policycheck(string $policy_instance = 'system', string $policy_name = 'page_accessible', string $policy_value = null, int $user_id = null, string $group_instance_id = null)

Determine the group_security_ids for a specific resource in a grouped module

Parameters

string $policy_instance
string $policy_name
string $policy_value
int $user_id

Default is current user
string $group_instance_id

If you want to filter groups from a specific group instance

Return Value

array

Group Security IDs

at line 643
array get_available_roles_for_global_group(int $gid)

retruns an array of all available role ids if detectable detectable means that the gid contains to a instance of the type group (other will come e.g. multitenant)

Parameters

int $gid

Return Value

array

role_ids or false if not detectable

at line 682
array get_available_users_for_global_group(int $gid, $include_roles = false)

retruns an array of all available role ids if detectable detectable means that the gid contains to a instance of the type group (other will come e.g. multitenant)

Parameters

int $gid
$include_roles

Return Value

array

group_ids or false if not detectable

at line 122
int get_global_group(string $instance_id, int $group_id, bool $usecache = true)

Get Global Group ID for your local ID (using your group module instance, e.g. groups or groupizer)

Parameters

string $instance_id

Instance ID
int $group_id

LOCAL group ID
bool $usecache

Allow cache value (not forced)

Return Value

int

or false

at line 193
array get_global_group_meta(int $group_id)

Get Metainformation Global Group ID for your global ID

Parameters

int $group_id

GLOBAL group ID

Return Value

array

(all information available in global security)

at line 214
int get_instance_global_group(string $instance_id, int $group_id)

Get Global Group ID for your local ID (using your grouped instance, e.g. forum) Function will traverse parent contexts and return the first global group found

Parameters

string $instance_id

Instance ID
int $group_id

LOCAL group ID

Return Value

int

or false

at line 283
int get_instance_local_group(string $instance_id, int $group_security_id)

Get LOCAL Group ID for your group_securiy_id (using your grouped instance, e.g. forum)

Parameters

string $instance_id

Instance ID
int $group_security_id group_securiy_id

Return Value

int

or false

at line 141
int get_local_group(string $instance_id, int $group_security_id)

Get local Group ID for your global group_security_id (using your group module instance, e.g. groups or groupizer)

Parameters

string $instance_id

Instance ID
int $group_security_id group_security_id

Return Value

int

or false

at line 174
array get_local_group_meta(string $instance_id, int $group_id)

Get Metainformation Global Group ID for your local ID (using your group module instance, e.g. groups or groupizer)

Parameters

string $instance_id

Instance ID
int $group_id

LOCAL group ID

Return Value

array

(all information available in global security)

at line 711
int[]|false get_members_for_global_group(int $gid)

Returns an array of all available role ids if detectable detectable means that the gid contains to a instance of the type group (other will come e.g. multitenant)

Parameters

int $gid

Return Value

int[]|false

user_ids or false if not detectable

at line 24
init()

No description

at line 426
remove_follow_user(int $group_security_id, int $user_id)

Remove user as follower for this group

Parameters

int $group_security_id
int $user_id

Exceptions

Exception

at line 102
remove_global_group(int $gid)

Remove security Group

Parameters

int $gid

at line 485
remove_group_member(int $gid, int $user_id = false, $set_follow_status = true)

Remove Member from security Group

Parameters

int $gid
int $user_id
$set_follow_status

at line 330
remove_groups(int $gid)

Remove security Group

Parameters

int $gid

at line 319
remove_local_group(string $instance_id, int $group_id)

Remove security Group

Parameters

string $instance_id

Instance ID
int $group_id

LOCAL group ID

at line 62
int|mixed update_global_group($gid, $module_name, $instance_id, $group_id, $title, string $security_type = 'public')

No description

Parameters

$gid
$module_name
$instance_id
$group_id
$title
string $security_type

Return Value

int|mixed

at line 474
mixed update_group_member(int $gid, int $user_id = false, array $role_ids = array(), bool $set_follow_status = false)

Add Member to security Group

Parameters

int $gid
int $user_id
array $role_ids
bool $set_follow_status

Set Follow Status for Group?

Return Value

mixed