BristolSU\Support\ModuleInstance\Contracts\ModuleInstanceRepository Interface Reference

Inheritance diagram for BristolSU\Support\ModuleInstance\Contracts\ModuleInstanceRepository:

Public Member Functions
	getById (int $id)
	create (array $attributes)
	all ()
	allWithAlias (string $alias='')
	allThroughActivity (Activity $activity)
	allEnabledThroughActivity (Activity $activity)
	update (int $id, array $attributes=[])
	delete (int $id)

Detailed Description

Handle interacting with module instances

Definition at line 12 of file ModuleInstanceRepository.php.

Member Function Documentation

all()

BristolSU\Support\ModuleInstance\Contracts\ModuleInstanceRepository::all

(

)

Get all module instances

Returns

ModuleInstance[]|Collection

Implemented in BristolSU\Support\ModuleInstance\ModuleInstanceRepository.

allEnabledThroughActivity()

BristolSU\Support\ModuleInstance\Contracts\ModuleInstanceRepository::allEnabledThroughActivity

(

Activity

$activity

)

Get all enabled module instances that belong to a given activity

Parameters

Activity

$activity

Activity to retrieve enabled module instances through

Returns

Collection

Implemented in BristolSU\Support\ModuleInstance\ModuleInstanceRepository.

allThroughActivity()

BristolSU\Support\ModuleInstance\Contracts\ModuleInstanceRepository::allThroughActivity

(

Activity

$activity

)

Get all module instances that belong to a given activity

Parameters

Activity

$activity

Activity to retrieve module instances through

Returns

Collection

Implemented in BristolSU\Support\ModuleInstance\ModuleInstanceRepository.

allWithAlias()

BristolSU\Support\ModuleInstance\Contracts\ModuleInstanceRepository::allWithAlias

(

string

$alias = ''

)

Get all module instances belonging to a module alias

Parameters

string

$alias

Alias of the module

Returns

ModuleInstance[]|Collection

Implemented in BristolSU\Support\ModuleInstance\ModuleInstanceRepository.

create()

BristolSU\Support\ModuleInstance\Contracts\ModuleInstanceRepository::create

(

array

$attributes

)

Create a new module instance

The module instance has the following attributes [ 'alias' => 'alias of the module', 'activity_id' => 1, 'slug' => 'slug-of-the-module', 'completion_condition_instance_id' => 1, // nullable 'name' => 'Name of the module', 'description' => 'Description', 'active' => Logic ID for the active logic, 'visible' => Logic ID for the visible logic, 'mandatory' => Nullable logic ID for the mandatory logic ]

Parameters

array

$attributes

Attributes as defined in the description

Returns

ModuleInstance Created module instance

Implemented in BristolSU\Support\ModuleInstance\ModuleInstanceRepository.

delete()

BristolSU\Support\ModuleInstance\Contracts\ModuleInstanceRepository::delete

(

int

$id

)

Delete a module instance

Parameters

int

$id

Returns

void

Implemented in BristolSU\Support\ModuleInstance\ModuleInstanceRepository.

getById()

BristolSU\Support\ModuleInstance\Contracts\ModuleInstanceRepository::getById

(

int

$id

)

Get a module instance by ID

Parameters

int

$id

ID of the module instance

Returns

ModuleInstance Module instance with the given ID

Implemented in BristolSU\Support\ModuleInstance\ModuleInstanceRepository.

update()

BristolSU\Support\ModuleInstance\Contracts\ModuleInstanceRepository::update	(	int	$id,
		array	$attributes = []
	)

Update a module instance

Parameters should be of the form ['key' => 'newValue']. Multiple values may be updated at the same time. Available keys are alias, activity_id, name, description, slug, active, visible, mandatory, completion_condition_instance_id, enabled, user_id

Parameters

int	$id	ID of the module instance
array	$attributes	Attributes to be updated

Returns

ModuleInstanceContract The updated module instance

Implemented in BristolSU\Support\ModuleInstance\ModuleInstanceRepository.

---

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

• src/ModuleInstance/Contracts/ModuleInstanceRepository.php