BristolSU\Support\Module\Contracts\ModuleBuilder Interface Reference

Inheritance diagram for BristolSU\Support\Module\Contracts\ModuleBuilder:

Public Member Functions
	create (string $alias)
	setAlias ()
	setPermissions ()
	setName ()
	setDescription ()
	setSettings ()
	setTriggers ()
	setCompletionConditions ()
	setServices ()
	setFor ()
	getModule ()

Detailed Description

A class with the knowledge of how to build a module class

Definition at line 8 of file ModuleBuilder.php.

Member Function Documentation

create()

BristolSU\Support\Module\Contracts\ModuleBuilder::create

(

string

$alias

)

Initialise the module builder

Parameters

string

$alias

Alias of the module

Returns

void

Implemented in BristolSU\Support\Module\ModuleBuilder.

getModule()

BristolSU\Support\Module\Contracts\ModuleBuilder::getModule

(

)

Get the built module

Returns

Module

Implemented in BristolSU\Support\Module\ModuleBuilder.

setAlias()

BristolSU\Support\Module\Contracts\ModuleBuilder::setAlias

(

)

Set the alias of the module

Returns

void

Implemented in BristolSU\Support\Module\ModuleBuilder.

setCompletionConditions()

BristolSU\Support\Module\Contracts\ModuleBuilder::setCompletionConditions

(

)

Set the completion conditions of the module

Returns

void

Implemented in BristolSU\Support\Module\ModuleBuilder.

setDescription()

BristolSU\Support\Module\Contracts\ModuleBuilder::setDescription

(

)

Set the description of the module

Returns

void

Implemented in BristolSU\Support\Module\ModuleBuilder.

setFor()

BristolSU\Support\Module\Contracts\ModuleBuilder::setFor

(

)

Set what resource the module is for

This should be one of user, group or role

Returns

void

Implemented in BristolSU\Support\Module\ModuleBuilder.

setName()

BristolSU\Support\Module\Contracts\ModuleBuilder::setName

(

)

Set the name of the module

Returns

void

Implemented in BristolSU\Support\Module\ModuleBuilder.

setPermissions()

BristolSU\Support\Module\Contracts\ModuleBuilder::setPermissions

(

)

Set the permissions of the module

Returns

void

Implemented in BristolSU\Support\Module\ModuleBuilder.

setServices()

BristolSU\Support\Module\Contracts\ModuleBuilder::setServices

(

)

Set the services of the module

Returns

void

Implemented in BristolSU\Support\Module\ModuleBuilder.

setSettings()

BristolSU\Support\Module\Contracts\ModuleBuilder::setSettings

(

)

Set the settings of the module

Returns

void

Implemented in BristolSU\Support\Module\ModuleBuilder.

setTriggers()

BristolSU\Support\Module\Contracts\ModuleBuilder::setTriggers

(

)

Set the triggers of the module

Returns

void

Implemented in BristolSU\Support\Module\ModuleBuilder.

---

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

• src/Module/Contracts/ModuleBuilder.php