BristolSU\Support\Module\Module Class Reference

Inheritance diagram for BristolSU\Support\Module\Module:

Collaboration diagram for BristolSU\Support\Module\Module:

Public Member Functions
	setFor (string $for='user')
	getFor ()
	__toString ()
	toJson ($options=0)
	toArray ()
	getAlias ()
	setAlias (string $alias)
	getName ()
	setName (string $name)
	getDescription ()
	setDescription (string $description)
	getPermissions ()
	setPermissions (array $permissions)
	getSettings ()
	setSettings (array $settings)
	getTriggers ()
	setTriggers (array $triggers)
	getCompletionConditions ()
	setCompletionConditions (array $completionConditions)
	getServices ()
	setServices (array $services)

Protected Attributes
	$alias
	$name
	$description
	$permissions
	$settings
	$triggers
	$services
	$for
	$completionConditions

Detailed Description

Represents a module

Definition at line 11 of file Module.php.

Member Function Documentation

__toString()

BristolSU\Support\Module\Module::__toString

(

)

Return the module as a json representation

Returns

false|string

Definition at line 116 of file Module.php.

References BristolSU\Support\Module\Module\toJson().

getAlias()

BristolSU\Support\Module\Module::getAlias

(

)

Get the alias of the module

Returns

string

Implements BristolSU\Support\Module\Contracts\Module.

Definition at line 169 of file Module.php.

getCompletionConditions()

BristolSU\Support\Module\Module::getCompletionConditions

(

)

Get the completion conditions used by the module

Returns

array

Implements BristolSU\Support\Module\Contracts\Module.

Definition at line 301 of file Module.php.

getDescription()

BristolSU\Support\Module\Module::getDescription

(

)

Get the description for the module

Returns

string

Implements BristolSU\Support\Module\Contracts\Module.

Definition at line 209 of file Module.php.

getFor()

BristolSU\Support\Module\Module::getFor

(

)

Get what resource the module is for. One of user, group or role.

Returns

string One of user, group or role

Implements BristolSU\Support\Module\Contracts\Module.

Definition at line 106 of file Module.php.

getName()

BristolSU\Support\Module\Module::getName

(

)

Get the name of the module

Returns

string Name

Implements BristolSU\Support\Module\Contracts\Module.

Definition at line 189 of file Module.php.

getPermissions()

BristolSU\Support\Module\Module::getPermissions

(

)

Get the permissions for the module

Returns

array

Implements BristolSU\Support\Module\Contracts\Module.

Definition at line 229 of file Module.php.

getServices()

BristolSU\Support\Module\Module::getServices

(

)

Get the services for the module

[ 'required' => ['typeform', 'facebook', ... ], 'optional' => [] ]

Returns

array

Implements BristolSU\Support\Module\Contracts\Module.

Definition at line 326 of file Module.php.

getSettings()

BristolSU\Support\Module\Module::getSettings

(

)

Get the settings for the module

Returns

array

Implements BristolSU\Support\Module\Contracts\Module.

Definition at line 249 of file Module.php.

getTriggers()

BristolSU\Support\Module\Module::getTriggers

(

)

Get the triggers for the module

[ 'name' => 'Event Name', 'description' => 'Event Description', 'event' => 'EventClassName' ]

Returns

array

Implements BristolSU\Support\Module\Contracts\Module.

Definition at line 275 of file Module.php.

setAlias()

BristolSU\Support\Module\Module::setAlias

(

string

$alias

)

Set the alias of the module

Parameters

string

$alias

Alias of the module

Implements BristolSU\Support\Module\Contracts\Module.

Definition at line 179 of file Module.php.

References function\alias().

setCompletionConditions()

BristolSU\Support\Module\Module::setCompletionConditions

(

array

$completionConditions

)

Set the completion conditions used by the module

Parameters

array

$completionConditions

Implements BristolSU\Support\Module\Contracts\Module.

Definition at line 311 of file Module.php.

setDescription()

BristolSU\Support\Module\Module::setDescription

(

string

$description

)

Set the description for the module

Parameters

string

$description

Implements BristolSU\Support\Module\Contracts\Module.

Definition at line 219 of file Module.php.

setFor()

BristolSU\Support\Module\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

Implements BristolSU\Support\Module\Contracts\Module.

Definition at line 96 of file Module.php.

References BristolSU\Support\Module\Module\$for.

setName()

BristolSU\Support\Module\Module::setName

(

string

$name

)

Set the name of the module

Parameters

string

$name

Implements BristolSU\Support\Module\Contracts\Module.

Definition at line 199 of file Module.php.

setPermissions()

BristolSU\Support\Module\Module::setPermissions

(

array

$permissions

)

Set the permissions for the module

Parameters

array

$permissions

Implements BristolSU\Support\Module\Contracts\Module.

Definition at line 239 of file Module.php.

setServices()

BristolSU\Support\Module\Module::setServices

(

array

$services

)

Set the services for the module

[ 'required' => ['typeform', 'facebook', ... ], 'optional' => [] ]

Parameters

array

$services

Services for the module

Returns

void

Implements BristolSU\Support\Module\Contracts\Module.

Definition at line 342 of file Module.php.

setSettings()

BristolSU\Support\Module\Module::setSettings

(

array

$settings

)

Set the settings for the module

Parameters

array

$settings

Implements BristolSU\Support\Module\Contracts\Module.

Definition at line 259 of file Module.php.

References function\settings().

setTriggers()

BristolSU\Support\Module\Module::setTriggers

(

array

$triggers

)

Set the triggers for the module

[ 'name' => 'Event Name', 'description' => 'Event Description', 'event' => 'EventClassName' ]

Parameters

array

$triggers

Implements BristolSU\Support\Module\Contracts\Module.

Definition at line 291 of file Module.php.

toArray()

BristolSU\Support\Module\Module::toArray

(

)

Cast the module to an array

Returns an array of the form [ 'alias' => 'module_alias', 'name' => 'Module Name', 'description' => 'Module Description', 'permissions' => [], 'settings' => [], 'triggers' => [], 'completionConditions' => [], 'services' => [] ]

Returns

array

Definition at line 149 of file Module.php.

References BristolSU\Support\Module\Contracts\Module\getAlias(), BristolSU\Support\Module\Contracts\Module\getCompletionConditions(), BristolSU\Support\Module\Contracts\Module\getDescription(), BristolSU\Support\Module\Contracts\Module\getFor(), BristolSU\Support\Module\Contracts\Module\getName(), BristolSU\Support\Module\Contracts\Module\getPermissions(), BristolSU\Support\Module\Contracts\Module\getServices(), BristolSU\Support\Module\Contracts\Module\getSettings(), and BristolSU\Support\Module\Contracts\Module\getTriggers().

Referenced by BristolSU\Support\Module\Module\toJson().

toJson()

BristolSU\Support\Module\Module::toJson

(

$options = 0

)

Return the module as a json representation

Parameters

int

$options

Returns

false|string

Definition at line 127 of file Module.php.

References BristolSU\Support\Module\Module\toArray().

Referenced by BristolSU\Support\Module\Module\__toString().

Member Data Documentation

$alias

BristolSU\Support\Module\Module::$alias

protected

Definition at line 18 of file Module.php.

$completionConditions

BristolSU\Support\Module\Module::$completionConditions

protected

Definition at line 87 of file Module.php.

$description

BristolSU\Support\Module\Module::$description

protected

Definition at line 30 of file Module.php.

$for

BristolSU\Support\Module\Module::$for

protected

Definition at line 73 of file Module.php.

Referenced by BristolSU\Support\Module\Module\setFor().

$name

BristolSU\Support\Module\Module::$name

protected

Definition at line 24 of file Module.php.

$permissions

BristolSU\Support\Module\Module::$permissions

protected

Definition at line 36 of file Module.php.

$services

BristolSU\Support\Module\Module::$services

protected

Definition at line 66 of file Module.php.

$settings

BristolSU\Support\Module\Module::$settings

protected

Definition at line 42 of file Module.php.

$triggers

BristolSU\Support\Module\Module::$triggers

protected

Definition at line 54 of file Module.php.

---

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

• src/Module/Module.php