Inheritance diagram for BristolSU\Support\Logic\Audience\AudienceMember:

Collaboration diagram for BristolSU\Support\Logic\Audience\AudienceMember:

Public Member Functions
	__construct (User $user)

	groups ()

	roles ()

	user ()

	canBeUser ()

	filterForLogic (Logic $logic)

	hasAudience ()

	toArray ()

	toJson ($options=0)

	__toString ()

Private Attributes
	$user

	$canBeUser

	$roles

	$groups

Detailed Description

Represents a user and their roles/memberships, and allows for logic filtering

Definition at line 19 of file AudienceMember.php.

Constructor & Destructor Documentation

◆ __construct()

BristolSU\Support\Logic\Audience\AudienceMember::__construct ( User $user )

Parameters

User $user User to construct the audience member with

Definition at line 53 of file AudienceMember.php.

References BristolSU\Support\Logic\Audience\AudienceMember\$user, and BristolSU\Support\Logic\Audience\AudienceMember\user().

Member Function Documentation

◆ __toString()

BristolSU\Support\Logic\Audience\AudienceMember::__toString ( )

Convert the object to a string, a JSON representation

Returns: string

Definition at line 191 of file AudienceMember.php.

References BristolSU\Support\Logic\Audience\AudienceMember\toJson().

◆ canBeUser()

BristolSU\Support\Logic\Audience\AudienceMember::canBeUser ( )

Can the user themselves be in the logic group?

Returns: bool

Definition at line 103 of file AudienceMember.php.

Referenced by BristolSU\Support\Logic\Audience\AudienceMember\filterForLogic(), BristolSU\Support\Logic\Audience\AudienceMember\hasAudience(), and BristolSU\Support\Logic\Audience\AudienceMember\toArray().

◆ filterForLogic()

BristolSU\Support\Logic\Audience\AudienceMember::filterForLogic ( Logic $logic )

Filter the audience member down to those in the logic group

If passed a logic group, the audience member will only then contain roles and groups which are in the given logic group with the user. It will also set canBeUser, as to whether just the user is in the logic group (without their roles or groups).

Parameters

Logic $logic Logic group to test

Returns: void

Definition at line 119 of file AudienceMember.php.

References BristolSU\Support\Logic\Audience\AudienceMember\canBeUser(), BristolSU\Support\Logic\LogicTester\evaluate(), BristolSU\Support\Logic\Audience\AudienceMember\groups(), BristolSU\Support\Logic\Audience\AudienceMember\roles(), and BristolSU\Support\Logic\Audience\AudienceMember\user().

Referenced by BristolSU\Support\Logic\Audience\AudienceMemberFactory\withAccessToLogicGroupWithResource().

◆ groups()

BristolSU\Support\Logic\Audience\AudienceMember::groups ( )

Get all groups for which the user has a membership to

Returns: Collection

Definition at line 63 of file AudienceMember.php.

References BristolSU\Support\Logic\Audience\AudienceMember\$groups, and BristolSU\Support\Logic\Audience\AudienceMember\user().

Referenced by BristolSU\Support\Logic\Audience\AudienceMember\filterForLogic(), BristolSU\Support\Logic\Contracts\Audience\LogicAudience\groupAudience(), BristolSU\Support\Logic\Audience\AudienceMember\hasAudience(), BristolSU\Support\Logic\Audience\AudienceMember\toArray(), and BristolSU\Support\Logic\Audience\AudienceMemberFactory\withAccessToLogicGroupWithResource().

◆ hasAudience()

BristolSU\Support\Logic\Audience\AudienceMember::hasAudience ( )

Does the audience member have an audience at all?

After filtering for logic, this function will return true if the user can access the logic group in any way, or false or otherwise.

Returns: bool

Definition at line 140 of file AudienceMember.php.

References BristolSU\Support\Logic\Audience\AudienceMember\canBeUser(), BristolSU\Support\Logic\Audience\AudienceMember\groups(), and BristolSU\Support\Logic\Audience\AudienceMember\roles().

Referenced by BristolSU\Support\Logic\Contracts\Audience\LogicAudience\userAudience(), and BristolSU\Support\Logic\Audience\AudienceMemberFactory\withAccessToLogicGroupWithResource().

◆ roles()

BristolSU\Support\Logic\Audience\AudienceMember::roles ( )

Get all roles which the user is in

Returns: Collection

Definition at line 76 of file AudienceMember.php.

References BristolSU\Support\Logic\Audience\AudienceMember\$roles, and BristolSU\Support\Logic\Audience\AudienceMember\user().

Referenced by BristolSU\Support\Logic\Audience\AudienceMember\filterForLogic(), BristolSU\Support\Logic\Contracts\Audience\LogicAudience\groupAudience(), BristolSU\Support\Logic\Audience\AudienceMember\hasAudience(), BristolSU\Support\Logic\Contracts\Audience\LogicAudience\roleAudience(), BristolSU\Support\Logic\Audience\AudienceMember\toArray(), and BristolSU\Support\Logic\Audience\AudienceMemberFactory\withAccessToLogicGroupWithResource().

◆ toArray()

BristolSU\Support\Logic\Audience\AudienceMember::toArray ( )

Get the instance as an array.

Returns the audience member in the following form [ 'user' => (), 'can_be_user' => true/false, // Does just the user belong in the logic group? 'groups' => [ // All groups for which the user has a membership that belongs in the logic group (), ... ], 'roles' => [ // All roles for which the user belongs to and is in the logic group () ] ]