BristolSU\Support\Logic\Audience\LogicAudience Class Reference

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

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

Public Member Functions
	__construct (UserRepository $userRepository, AudienceMemberFactoryContract $audienceMemberFactory)
	audience (Logic $logic)
Public Member Functions inherited from BristolSU\Support\Logic\Contracts\Audience\LogicAudience
	audience (Logic $logic)
	userAudience (Logic $logic)
	groupAudience (Logic $logic)
	roleAudience (Logic $logic)

Private Member Functions
	possibleAudience ()

Private Attributes
	$userRepository
	$audienceMemberFactory

Detailed Description

Get the audience of a logic group

See also

LogicAudienceContract

Definition at line 16 of file LogicAudience.php.

Constructor & Destructor Documentation

__construct()

BristolSU\Support\Logic\Audience\LogicAudience::__construct	(	UserRepository	$userRepository,
		AudienceMemberFactoryContract	$audienceMemberFactory
	)

Parameters

UserRepository	$userRepository	User Repository to resolve all users from
AudienceMemberFactoryContract	$audienceMemberFactory	Audience member factory to construct audience members from users

Definition at line 36 of file LogicAudience.php.

References BristolSU\Support\Logic\Audience\LogicAudience\$audienceMemberFactory, and BristolSU\Support\Logic\Audience\LogicAudience\$userRepository.

Member Function Documentation

audience()

BristolSU\Support\Logic\Audience\LogicAudience::audience

(

Logic

$logic

)

Get the audience of a logic group

Will return an array of AudienceMember objects representing the audience of the given logic group.

Parameters

Logic

$logic

Logic group to get the audience for

Returns

AudienceMember[]

Definition at line 50 of file LogicAudience.php.

References BristolSU\Support\Logic\Audience\LogicAudience\possibleAudience().

possibleAudience()

BristolSU\Support\Logic\Audience\LogicAudience::possibleAudience ( )

private

Get the possible audience

Returns all users of the portal as AudienceMembers.

Returns

Used as an array, eases memory constraints at runtime

Definition at line 69 of file LogicAudience.php.

Referenced by BristolSU\Support\Logic\Audience\LogicAudience\audience().

Member Data Documentation

$audienceMemberFactory

BristolSU\Support\Logic\Audience\LogicAudience::$audienceMemberFactory

private

Definition at line 30 of file LogicAudience.php.

Referenced by BristolSU\Support\Logic\Audience\LogicAudience\__construct().

$userRepository

BristolSU\Support\Logic\Audience\LogicAudience::$userRepository

private

Definition at line 23 of file LogicAudience.php.

Referenced by BristolSU\Support\Logic\Audience\LogicAudience\__construct().

---

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

• src/Logic/Audience/LogicAudience.php