Public Member Functions | |
| setAlias (string $alias) | |
| getAlias () | |
| setName (string $name) | |
| getName () | |
| setCompletionConditions (array $completionConditions) | |
| getCompletionConditions () | |
| setDescription (string $description) | |
| getDescription () | |
| setPermissions (array $permissions) | |
| getPermissions () | |
| setSettings (array $settings) | |
| getSettings () | |
| setTriggers (array $triggers) | |
| getTriggers () | |
| setServices (array $services) | |
| getServices () | |
| setFor (string $for='user') | |
| getFor () | |
Detailed Description
Represents a registered module in the framework
Definition at line 12 of file Module.php.
Member Function Documentation
◆ getAlias()
| BristolSU\Support\Module\Contracts\Module::getAlias | ( | ) |
Get the alias associated with the module
- Returns
- string
Implemented in BristolSU\Support\Module\Module.
Referenced by BristolSU\Support\Module\Module\toArray().
◆ getCompletionConditions()
| BristolSU\Support\Module\Contracts\Module::getCompletionConditions | ( | ) |
Get the completion conditions for the module
Return [ 'name' => '', 'description' => '', 'options' => [], 'alias' => '' ]
- Returns
- array
Implemented in BristolSU\Support\Module\Module.
Referenced by BristolSU\Support\Module\Module\toArray().
◆ getDescription()
| BristolSU\Support\Module\Contracts\Module::getDescription | ( | ) |
Get the description of the module
- Returns
- string Description of the module
Implemented in BristolSU\Support\Module\Module.
Referenced by BristolSU\Support\Module\Module\toArray().
◆ getFor()
| BristolSU\Support\Module\Contracts\Module::getFor | ( | ) |
Get what resource the module is for. One of user, group or role.
- Returns
- string One of user, group or role
Implemented in BristolSU\Support\Module\Module.
Referenced by BristolSU\Support\Module\Module\toArray().
◆ getName()
| BristolSU\Support\Module\Contracts\Module::getName | ( | ) |
Get the name of the module
- Returns
- string Name of the module
Implemented in BristolSU\Support\Module\Module.
Referenced by BristolSU\Support\Module\Module\toArray().
◆ getPermissions()
| BristolSU\Support\Module\Contracts\Module::getPermissions | ( | ) |
Get the permissions for the module
- Returns
- Permission[]
Implemented in BristolSU\Support\Module\Module.
Referenced by BristolSU\Support\Module\Module\toArray().
◆ getServices()
| BristolSU\Support\Module\Contracts\Module::getServices | ( | ) |
Get the services for the module
- Returns
- array
Implemented in BristolSU\Support\Module\Module.
Referenced by BristolSU\Support\Module\Module\toArray().
◆ getSettings()
| BristolSU\Support\Module\Contracts\Module::getSettings | ( | ) |
Get the settings for the module
- Returns
- array Form schema settings
Implemented in BristolSU\Support\Module\Module.
Referenced by BristolSU\Support\Module\Module\toArray().
◆ getTriggers()
| BristolSU\Support\Module\Contracts\Module::getTriggers | ( | ) |
Get the triggers for the module
- Returns
- array Triggers
Implemented in BristolSU\Support\Module\Module.
Referenced by BristolSU\Support\Module\Module\toArray().
◆ setAlias()
| BristolSU\Support\Module\Contracts\Module::setAlias | ( | string | $alias | ) |
Set the alias of the module
- Parameters
-
string $alias Alias of the module
- Returns
- void
Implemented in BristolSU\Support\Module\Module.
◆ setCompletionConditions()
| BristolSU\Support\Module\Contracts\Module::setCompletionConditions | ( | array | $completionConditions | ) |
Set the completion conditions for the module
Conditions should be set as [ 'name' => '', 'description' => '', 'options' => [], 'alias' => '' ]
- Parameters
-
array $completionConditions
- Returns
- void
Implemented in BristolSU\Support\Module\Module.
◆ setDescription()
| BristolSU\Support\Module\Contracts\Module::setDescription | ( | string | $description | ) |
Set the description of the module
- Parameters
-
string $description Description of the module
- Returns
- void
Implemented in BristolSU\Support\Module\Module.
◆ setFor()
| BristolSU\Support\Module\Contracts\Module::setFor | ( | string | $for = 'user' | ) |
Set what resource the module is for. One of user, group or role.
- Parameters
-
string $for One of user, group or role
- Returns
- void
Implemented in BristolSU\Support\Module\Module.
◆ setName()
| BristolSU\Support\Module\Contracts\Module::setName | ( | string | $name | ) |
Set the name of the module
- Parameters
-
string $name Name of the module
- Returns
- void
Implemented in BristolSU\Support\Module\Module.
◆ setPermissions()
| BristolSU\Support\Module\Contracts\Module::setPermissions | ( | array | $permissions | ) |
Set the permissions for the module
- Parameters
-
Permission[] $permissions Set the permissions for the module
- Returns
- void
Implemented in BristolSU\Support\Module\Module.
◆ setServices()
| BristolSU\Support\Module\Contracts\Module::setServices | ( | array | $services | ) |
Set the services for the module
[ 'required' => ['typeform', 'facebook', ... ], 'optional' => [] ]
- Parameters
-
array $services Services for the module
- Returns
- void
Implemented in BristolSU\Support\Module\Module.
◆ setSettings()
| BristolSU\Support\Module\Contracts\Module::setSettings | ( | array | $settings | ) |
Set the settings for the module
- Parameters
-
array $settings Form schema settings
- Returns
- void
Implemented in BristolSU\Support\Module\Module.
◆ setTriggers()
| BristolSU\Support\Module\Contracts\Module::setTriggers | ( | array | $triggers | ) |
Set the triggers for the module
[ 'name' => 'Event Name', 'description' => 'Event Description', 'event' => 'EventClassName' ]
- Parameters
-
array $triggers Triggers for the module
- Returns
- void
Implemented in BristolSU\Support\Module\Module.
The documentation for this interface was generated from the following file:
- src/Module/Contracts/Module.php
