Bristol SU Support Package
Public Member Functions | Private Attributes | List of all members
BristolSU\Support\Completion\CompletionConditionRepository Class Reference
Inheritance diagram for BristolSU\Support\Completion\CompletionConditionRepository:
Inheritance graph
[legend]
Collaboration diagram for BristolSU\Support\Completion\CompletionConditionRepository:
Collaboration graph
[legend]

Public Member Functions

 __construct (CompletionConditionManagerContract $manager, CompletionConditionFactoryContract $completionConditionFactory)
 
 getByAlias ($moduleAlias, $alias)
 
 getAllForModule ($moduleAlias)
 

Private Attributes

 $manager
 
 $completionConditionFactory
 

Detailed Description

Access and build Completion Conditions

Definition at line 15 of file CompletionConditionRepository.php.

Constructor & Destructor Documentation

◆ __construct()

BristolSU\Support\Completion\CompletionConditionRepository::__construct ( CompletionConditionManagerContract  $manager,
CompletionConditionFactoryContract  $completionConditionFactory 
)
Parameters
CompletionConditionManagerContract$managerManager to get the registered completion conditions
CompletionConditionFactoryContract$completionConditionFactoryFactory to create the completion conditions

Definition at line 36 of file CompletionConditionRepository.php.

References BristolSU\Support\Completion\CompletionConditionRepository\$completionConditionFactory, and BristolSU\Support\Completion\CompletionConditionRepository\$manager.

Member Function Documentation

◆ getAllForModule()

BristolSU\Support\Completion\CompletionConditionRepository::getAllForModule (   $moduleAlias)

Get all completion conditions for a given module alias

Parameters
string$moduleAliasAlias of the module
Returns
CompletionCondition[] [CompletionCondition1, CompletionCondition2]

Implements BristolSU\Support\Completion\Contracts\CompletionConditionRepository.

Definition at line 63 of file CompletionConditionRepository.php.

◆ getByAlias()

BristolSU\Support\Completion\CompletionConditionRepository::getByAlias (   $moduleAlias,
  $alias 
)

Get a completion condition by its alias

Parameters
string$moduleAliasAlias of the module
string$aliasAlias of the completion condition
Returns
CompletionCondition
Exceptions

Implements BristolSU\Support\Completion\Contracts\CompletionConditionRepository.

Definition at line 51 of file CompletionConditionRepository.php.

Member Data Documentation

◆ $completionConditionFactory

BristolSU\Support\Completion\CompletionConditionRepository::$completionConditionFactory
private

◆ $manager

BristolSU\Support\Completion\CompletionConditionRepository::$manager
private

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