BristolSU\Support\Completion\Contracts\CompletionConditionManager Interface Reference

Inheritance diagram for BristolSU\Support\Completion\Contracts\CompletionConditionManager:

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

Detailed Description

Allow for registration of completion conditions

Definition at line 10 of file CompletionConditionManager.php.

Member Function Documentation

getClassFromAlias()

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

Get a class name of a completion condition given an alias

Parameters

string	$moduleAlias	Alias of the module calling for a completion condition
string	$alias	Alias of the completion condition

Returns

string Class name

Exceptions

Exception

If the alias is not registered or accessible

Implemented in BristolSU\Support\Completion\CompletionConditionManager.

getForModule()

BristolSU\Support\Completion\Contracts\CompletionConditionManager::getForModule

(

$moduleAlias

)

Get all completion conditions for a module

Parameters

string

$moduleAlias

Module alias to get completion conditions for

Returns

mixed Array of aliases and classes e.g. ['alias1' => 'classname', ...]

Implemented in BristolSU\Support\Completion\CompletionConditionManager.

register()

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

Register a completion condition specific to a module

Parameters

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

Returns

void

Implemented in BristolSU\Support\Completion\CompletionConditionManager.

registerGlobalCondition()

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

Register a completion condition usable by all modules

Parameters

string	$alias	Alias of the completion condition
string	$class	Class name for the completion condition

Returns

void

Implemented in BristolSU\Support\Completion\CompletionConditionManager.

---

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

• src/Completion/Contracts/CompletionConditionManager.php