Bristol SU Support Package
Public Member Functions | List of all members
BristolSU\Support\Logic\Audience\AudienceMemberFactory Class Reference
Inheritance diagram for BristolSU\Support\Logic\Audience\AudienceMemberFactory:
Inheritance graph
[legend]
Collaboration diagram for BristolSU\Support\Logic\Audience\AudienceMemberFactory:
Collaboration graph
[legend]

Public Member Functions

 fromUser (User $user)
 
 withAccessToResource ($resource)
 
 withAccessToLogicGroupWithResource ($resource, Logic $logic)
 

Detailed Description

Creates an audience member

Definition at line 17 of file AudienceMemberFactory.php.

Member Function Documentation

◆ fromUser()

BristolSU\Support\Logic\Audience\AudienceMemberFactory::fromUser ( User  $user)

Create an audience member from a user

Parameters
User$userUser to create the audience member around
Returns
AudienceMember

Implements BristolSU\Support\Logic\Contracts\Audience\AudienceMemberFactory.

Definition at line 27 of file AudienceMemberFactory.php.

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

◆ withAccessToLogicGroupWithResource()

BristolSU\Support\Logic\Audience\AudienceMemberFactory::withAccessToLogicGroupWithResource (   $resource,
Logic  $logic 
)

Audience members who have access to a logic group, with a certain resource.

This function will return all audience members who have an audience in the logic group which uses a given resource.

Parameters
User | Group | Role$resourceResource that must be in the logic group
Logic$logicLogic group the resource must be in for an audience member
Returns
Collection

Implements BristolSU\Support\Logic\Contracts\Audience\AudienceMemberFactory.

Definition at line 70 of file AudienceMemberFactory.php.

References BristolSU\Support\Logic\Audience\AudienceMember\filterForLogic(), BristolSU\Support\Logic\Audience\AudienceMember\groups(), BristolSU\Support\Logic\Audience\AudienceMember\hasAudience(), BristolSU\Support\Logic\Audience\AudienceMember\roles(), and BristolSU\Support\Logic\Audience\AudienceMemberFactory\withAccessToResource().

◆ withAccessToResource()

BristolSU\Support\Logic\Audience\AudienceMemberFactory::withAccessToResource (   $resource)

Audience members who have access to a given resource in some way.

Parameters
User | Group | Role$resourceResource audience members must have access to
Returns
Collection

Implements BristolSU\Support\Logic\Contracts\Audience\AudienceMemberFactory.

Definition at line 37 of file AudienceMemberFactory.php.

References BristolSU\Support\Logic\Audience\AudienceMemberFactory\fromUser().

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


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