Tilmeld\Entities\Group Class Reference

A group entity. More...

Inheritance diagram for Tilmeld\Entities\Group:

Public Member Functions
	__construct ($id=0)
	Load a group. More...
	getAvatar ()
	putData ($data, $sdata=[])
	updateDataProtection ($user=null)
	Update the data protection arrays for a user. More...
	isDescendant ($group=null)
	Check whether the group is a descendant of a group. More...
	getChildren ()
	Gets an array of the group's child groups. More...
	getDescendants ($andSelf=false)
	Gets an array of the group's descendant groups. More...
	getLevel ()
	Get the number of parents the group has. More...
	getUsers ( $descendants=false, $limit=null, $offset=null)
	Gets an array of users in the group. More...
	checkGroupname ()
	Check that a groupname is valid. More...
	checkEmail ()
	Check that an email is unique. More...
	save ()
	saveSkipAC ()
	tilmeldSaveSkipAC ()
	delete ()
Public Member Functions inherited from Tilmeld\Entities\AbleObject
	grant ($ability)
	Grant an ability. More...
	revoke ($ability)
	Revoke an ability. More...

Static Public Member Functions
static	getPrimaryGroups ($search=null)
	Get all the groups that can be assigned as primary groups. More...
static	getSecondaryGroups ($search=null)
	Get all the groups that can be assigned as secondary groups. More...

Public Attributes
const	ETYPE = 'tilmeld_group'
const	DEFAULT_PRIVATE_DATA
const	DEFAULT_WHITELIST_DATA = []
	$clientEnabledMethods

Static Public Attributes
static	$clientEnabledStaticMethods
static	$searchRestrictedData = Group::DEFAULT_PRIVATE_DATA

Protected Attributes
	$tags = []
	$privateData = Group::DEFAULT_PRIVATE_DATA
	$whitelistData = Group::DEFAULT_WHITELIST_DATA
	$whitelistTags = []

Detailed Description

A group entity.

Note: When delete() is called all descendants of this group will also be deleted.

Properties:

• int $this->guid The GUID of the group.
• string $this->groupname The group's groupname.
• string $this->name The group's name.
• string $this->email The group's email address.
• string $this->avatar The group's avatar URL. (Use getAvatar() to support Gravatar.)
• string $this->phone The group's telephone number.
• string $this->addressType The group's address type. "us" or "international".
• string $this->addressStreet The group's address line 1 for US addresses.
• string $this->addressStreet2 The group's address line 2 for US addresses.
• string $this->addressCity The group's city for US addresses.
• string $this->addressState The group's state abbreviation for US addresses.
• string $this->addressZip The group's ZIP code for US addresses.
• string $this->addressInternational The group's full address for international addresses.
• Group $this->parent The group's parent.
• User|null $this->user If generate_primary is on, this will be the user who generated this group.

Author

Hunter Perrin hperr.nosp@m.in@g.nosp@m.mail..nosp@m.com

Copyright

SciActive.com

See also

http://tilmeld.org/

Definition at line 49 of file Group.php.

Constructor & Destructor Documentation

__construct()

Tilmeld\Entities\Group::__construct

(

$id = 0

)

Load a group.

Parameters

int

$id

The ID of the group to load, 0 for a new group.

Definition at line 97 of file Group.php.

Member Function Documentation

checkEmail()

Tilmeld\Entities\Group::checkEmail

(

)

Check that an email is unique.

Returns

array An associative array with a boolean 'result' entry and a 'message' entry.

Definition at line 463 of file Group.php.

checkGroupname()

Tilmeld\Entities\Group::checkGroupname

(

)

Check that a groupname is valid.

Returns

array An associative array with a boolean 'result' entry and a 'message' entry.

Definition at line 393 of file Group.php.

getChildren()

Tilmeld\Entities\Group::getChildren

(

)

Gets an array of the group's child groups.

Returns

array An array of groups.

Definition at line 287 of file Group.php.

getDescendants()

Tilmeld\Entities\Group::getDescendants

(

$andSelf = false

)

Gets an array of the group's descendant groups.

Parameters

bool

$andSelf

Include this group in the returned array.

Returns

array An array of groups.

Definition at line 304 of file Group.php.

getLevel()

Tilmeld\Entities\Group::getLevel

(

)

Get the number of parents the group has.

If the group is a top level group, this will return 0. If it is a child of a top level group, this will return 1. If it is a grandchild of a top level group, this will return 2, and so on.

Returns

int The level of the group.

Definition at line 337 of file Group.php.

getPrimaryGroups()

static Tilmeld\Entities\Group::getPrimaryGroups (   $search = null )

static

Get all the groups that can be assigned as primary groups.

Parameters

string | null

$search

A search query. If null, all will be returned. Uses ilike on name and groupname.

Returns

array An array of the assignable primary groups.

Definition at line 137 of file Group.php.

getSecondaryGroups()

static Tilmeld\Entities\Group::getSecondaryGroups (   $search = null )

static

Get all the groups that can be assigned as secondary groups.

Parameters

string | null

$search

A search query. If null, all will be returned. Uses ilike on name and groupname.

Returns

array An array of the assignable secondary groups.

Definition at line 150 of file Group.php.

getUsers()

Tilmeld\Entities\Group::getUsers	(		$descendants = false,
			$limit = null,
			$offset = null
	)

Gets an array of users in the group.

Parameters

bool	$descendants	Include users in all descendant groups too.
int | null	$limit	The limit for the query.
int | null	$offset	The offset for the query.

Returns

array An array of users.

Definition at line 355 of file Group.php.

isDescendant()

Tilmeld\Entities\Group::isDescendant

(

$group = null

)

Check whether the group is a descendant of a group.

Parameters

mixed

$group

The group, or the group's GUID.

Returns

bool True or false.

Definition at line 262 of file Group.php.

updateDataProtection()

Tilmeld\Entities\Group::updateDataProtection

(

$user = null

)

Update the data protection arrays for a user.

Parameters

\Tilmeld\Entities\User | null

$user

User to update protection for. If null, will use the currently logged in user.

Definition at line 233 of file Group.php.

Member Data Documentation

$clientEnabledMethods

Tilmeld\Entities\Group::$clientEnabledMethods

Initial value:

= [
    'checkGroupname',
    'checkEmail',
    'getAvatar',
    'getChildren',
    'getDescendants',
    'getLevel',
    'isDescendant',
  ]

Definition at line 66 of file Group.php.

$clientEnabledStaticMethods

Tilmeld\Entities\Group::$clientEnabledStaticMethods

static

Initial value:

= [
    'getPrimaryGroups',
    'getSecondaryGroups',
  ]

Definition at line 75 of file Group.php.

DEFAULT_PRIVATE_DATA

const Tilmeld\Entities\Group::DEFAULT_PRIVATE_DATA

Initial value:

= [
    'email',
    'phone',
    'addressType',
    'addressStreet',
    'addressStreet2',
    'addressCity',
    'addressState',
    'addressZip',
    'addressInternational',
    'abilities',
    'user',
  ]

Definition at line 51 of file Group.php.

---

The documentation for this class was generated from the following file:

• Group.php