BristolSU\Support\ModuleInstance\ModuleInstance Class Reference

Inheritance diagram for BristolSU\Support\ModuleInstance\ModuleInstance:

Collaboration diagram for BristolSU\Support\ModuleInstance\ModuleInstance:

Public Member Functions
	__construct (array $attributes=[])
	alias ()
	id ()
	activity ()
	moduleInstanceSettings ()
	moduleInstancePermissions ()
	completionConditionInstance ()
	activeLogic ()
	visibleLogic ()
	mandatoryLogic ()
	actionInstances ()
	moduleInstanceServices ()
	setting ($key, $default=null)
	scopeEnabled (Builder $query)
	user ()
	grouping ()

Protected Attributes
	$fillable
	$casts

Detailed Description

Represents a module instance in the database

Definition at line 25 of file ModuleInstance.php.

Constructor & Destructor Documentation

__construct()

BristolSU\Support\ModuleInstance\ModuleInstance::__construct

(

array

$attributes = []

)

When the model is saved, the slug will be dynamically set if not given

Parameters

array

$attributes

Attributes for the model

Definition at line 64 of file ModuleInstance.php.

Member Function Documentation

actionInstances()

BristolSU\Support\ModuleInstance\ModuleInstance::actionInstances

(

)

Action instances relationship

Returns

Definition at line 171 of file ModuleInstance.php.

activeLogic()

BristolSU\Support\ModuleInstance\ModuleInstance::activeLogic

(

)

Active logic relationship

Returns

Definition at line 142 of file ModuleInstance.php.

activity()

BristolSU\Support\ModuleInstance\ModuleInstance::activity

(

)

Activity relationship

Returns

Definition at line 102 of file ModuleInstance.php.

alias()

BristolSU\Support\ModuleInstance\ModuleInstance::alias

(

)

Get the alias of the module

Returns

string

Implements BristolSU\Support\ModuleInstance\Contracts\ModuleInstance.

Definition at line 82 of file ModuleInstance.php.

Referenced by BristolSU\Support\Http\Controllers\ModuleInstanceRedirectController\index().

completionConditionInstance()

BristolSU\Support\ModuleInstance\ModuleInstance::completionConditionInstance

(

)

Completion condition relationship

Returns

Definition at line 132 of file ModuleInstance.php.

grouping()

BristolSU\Support\ModuleInstance\ModuleInstance::grouping

(

)

Definition at line 228 of file ModuleInstance.php.

id()

BristolSU\Support\ModuleInstance\ModuleInstance::id

(

)

Get the ID of the module

Returns

int

Implements BristolSU\Support\ModuleInstance\Contracts\ModuleInstance.

Definition at line 92 of file ModuleInstance.php.

mandatoryLogic()

BristolSU\Support\ModuleInstance\ModuleInstance::mandatoryLogic

(

)

Mandatory logic relationship

Returns

Definition at line 162 of file ModuleInstance.php.

moduleInstancePermissions()

BristolSU\Support\ModuleInstance\ModuleInstance::moduleInstancePermissions

(

)

Permissions relationship

Returns

Definition at line 122 of file ModuleInstance.php.

moduleInstanceServices()

BristolSU\Support\ModuleInstance\ModuleInstance::moduleInstanceServices

(

)

Services relationship

Returns

Definition at line 181 of file ModuleInstance.php.

moduleInstanceSettings()

BristolSU\Support\ModuleInstance\ModuleInstance::moduleInstanceSettings

(

)

Settings relationship

Returns

Definition at line 112 of file ModuleInstance.php.

Referenced by BristolSU\Support\ModuleInstance\ModuleInstance\setting().

scopeEnabled()

BristolSU\Support\ModuleInstance\ModuleInstance::scopeEnabled

(

Builder

$query

)

Return only enabled module instances

Parameters

Builder

$query

Returns

Builder

Definition at line 209 of file ModuleInstance.php.

setting()

BristolSU\Support\ModuleInstance\ModuleInstance::setting	(		$key,
			$default = null
	)

Get a setting from the module instance

Parameters

string	$key	Key of the setting
mixed | null	$default	Default value if the setting is not found

Returns

mixed|null

Definition at line 193 of file ModuleInstance.php.

References BristolSU\Support\ModuleInstance\ModuleInstance\moduleInstanceSettings().

user()

BristolSU\Support\ModuleInstance\ModuleInstance::user

(

)

Get the user who created the module instance

Returns

Exceptions

Implements BristolSU\Support\ModuleInstance\Contracts\ModuleInstance.

Definition at line 220 of file ModuleInstance.php.

visibleLogic()

BristolSU\Support\ModuleInstance\ModuleInstance::visibleLogic

(

)

Visible logic relationship

Returns

Definition at line 152 of file ModuleInstance.php.

Member Data Documentation

$casts

BristolSU\Support\ModuleInstance\ModuleInstance::$casts

protected

Initial value:

= [
        'enabled' => 'boolean'
    ]

Definition at line 55 of file ModuleInstance.php.

$fillable

BristolSU\Support\ModuleInstance\ModuleInstance::$fillable

protected

Initial value:

= [
        'alias',
        'activity_id',
        'name',
        'slug',
        'description',
        'active',
        'visible',
        'mandatory',
        'completion_condition_instance_id',
        'enabled',
        'user_id',
        'order',
        'grouping_id'
    ]

Definition at line 34 of file ModuleInstance.php.

---

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

• src/ModuleInstance/ModuleInstance.php