BristolSU\Support\Completion\CompletionConditionManager Class Reference

Inheritance diagram for BristolSU\Support\Completion\CompletionConditionManager:

Collaboration diagram for BristolSU\Support\Completion\CompletionConditionManager:

Public Member Functions
	registerGlobalCondition ($alias, $class)
	register ($moduleAlias, $alias, $class)
	getForModule ($moduleAlias)
	getClassFromAlias ($moduleAlias, $alias)

Protected Attributes
	$conditions = []
	$global = []

Detailed Description

Register and retrieve completion conditions

Definition at line 10 of file CompletionConditionManager.php.

Member Function Documentation

getClassFromAlias()

BristolSU\Support\Completion\CompletionConditionManager::getClassFromAlias	(		$moduleAlias,
			$alias
	)

Get a class name given the completion condition alias

Parameters

string	$moduleAlias	Module requesting the completion condition alias
string	$alias	Alias of the completion condition

Returns

string Class name of the completion condition

Exceptions

Implements BristolSU\Support\Completion\Contracts\CompletionConditionManager.

Definition at line 92 of file CompletionConditionManager.php.

getForModule()

BristolSU\Support\Completion\CompletionConditionManager::getForModule

(

$moduleAlias

)

Get all completion conditions for a given module

Parameters

string

$moduleAlias

Alias of the module

Returns

array [ 'condition_alias' => 'ConditionClass', ...]

Implements BristolSU\Support\Completion\Contracts\CompletionConditionManager.

Definition at line 76 of file CompletionConditionManager.php.

register()

BristolSU\Support\Completion\CompletionConditionManager::register	(		$moduleAlias,
			$alias,
			$class
	)

Register a completion condition for a module

Parameters

string	$moduleAlias	Module which owns the completion condition
string	$alias	Alias of the completion condition
string	$class	Class name for the completion condition

Returns

void

Implements BristolSU\Support\Completion\Contracts\CompletionConditionManager.

Definition at line 61 of file CompletionConditionManager.php.

registerGlobalCondition()

BristolSU\Support\Completion\CompletionConditionManager::registerGlobalCondition	(		$alias,
			$class
	)

Register a condition which all modules can use

Parameters

string	$alias	Alias of the completion condition
string	$class	Completion condition class name

Returns

void

Implements BristolSU\Support\Completion\Contracts\CompletionConditionManager.

Definition at line 47 of file CompletionConditionManager.php.

Member Data Documentation

$conditions

BristolSU\Support\Completion\CompletionConditionManager::$conditions = []

protected

Definition at line 25 of file CompletionConditionManager.php.

$global

BristolSU\Support\Completion\CompletionConditionManager::$global = []

protected

Definition at line 37 of file CompletionConditionManager.php.

---

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

• src/Completion/CompletionConditionManager.php