Class GroupsCache

Summary

File
Package hierarchy PHPBoost\Cache
Class hierarchy \GroupsCache
Implements \CacheData

package
PHPBoost
subpackage
Cache
copyright
© 2005-2020 PHPBoost
license
https://www.gnu.org/licenses/gpl-3.0.html GNU/GPL-3.0
author
Benoit SAUTEL ben.popeye@phpboost.com
version
PHPBoost 6.0 - last update: 2017 05 28
since
PHPBoost 3.0 - 2009 09 29
contributor
Julien BRISWALTER j1.seth@phpboost.com
contributor
janus57 janus57@janus57.fr

This class contains the cache data of the groups which group users having common criteria.

Methods

synchronize()

synchronize()

This method is called when the data needs to be sychronized.

For instance,

Inherited from \GroupsCache

Tags

None found

get_groups()

get_groups() : array

Returns the list of the groups

Returns

array —

id_group => group properties (map)

Inherited from \GroupsCache

Tags

None found

group_exists()

group_exists( $group_id)

Parameters

$group_id

Inherited from \GroupsCache

Tags

None found

group_name_exists()

group_name_exists( $group_name)

Parameters

$group_name

Inherited from \GroupsCache

Tags

None found

get_group()

get_group( $group_id) : array<mixed,string>

Returns a group

Parameters

$group_id

Id of the group

Returns

array<mixed,string> —

A map of the properties of the group

Inherited from \GroupsCache

Tags

None found

set_groups()

set_groups( $groups_list)

Sets the groups list

Parameters

$groups_list

The groups list

Inherited from \GroupsCache

Tags

None found

load()

load() : \GroupsCache

Loads and returns the groups cached data.

Returns

\GroupsCache —

The cached data

static

Inherited from \GroupsCache

Tags

None found

invalidate()

invalidate()

Invalidates the current groups cached data.

static

Inherited from \GroupsCache

Tags

None found

Properties

$default_groups_value

$default_groups_value :

Tags

None found

$groups

$groups :

Tags

None found