Inheritance diagram for BristolSU\Support\ModuleInstance\ModuleInstanceRepository:

Collaboration diagram for BristolSU\Support\ModuleInstance\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

Class to interact with module instances through

Definition at line 16 of file ModuleInstanceRepository.php.

Member Function Documentation

◆ all()

BristolSU\Support\ModuleInstance\ModuleInstanceRepository::all ( )

Implements BristolSU\Support\ModuleInstance\Contracts\ModuleInstanceRepository.

Definition at line 52 of file ModuleInstanceRepository.php.

◆ allEnabledThroughActivity()

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

Implements BristolSU\Support\ModuleInstance\Contracts\ModuleInstanceRepository.

Definition at line 84 of file ModuleInstanceRepository.php.

References BristolSU\Support\Activity\Activity\moduleInstances().

◆ allThroughActivity()

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

Implements BristolSU\Support\ModuleInstance\Contracts\ModuleInstanceRepository.

Definition at line 72 of file ModuleInstanceRepository.php.

References BristolSU\Support\Activity\Activity\moduleInstances().

◆ allWithAlias()

BristolSU\Support\ModuleInstance\ModuleInstanceRepository::allWithAlias ( string $alias = '' )

Implements BristolSU\Support\ModuleInstance\Contracts\ModuleInstanceRepository.

Definition at line 60 of file ModuleInstanceRepository.php.

◆ create()

BristolSU\Support\ModuleInstance\ModuleInstanceRepository::create ( array $attributes )

Create a new module instance

The attributes must be of the following form: [ 'alias' => 'alias_of_the_module', '' => '', ]

Parameters

array $attributes

Returns: ModuleInstanceContract

Implements BristolSU\Support\ModuleInstance\Contracts\ModuleInstanceRepository.

Definition at line 44 of file ModuleInstanceRepository.php.

◆ delete()

BristolSU\Support\ModuleInstance\ModuleInstanceRepository::delete ( int $id )

Delete a module instance

Parameters

int $id

Returns: void

Implements BristolSU\Support\ModuleInstance\Contracts\ModuleInstanceRepository.

Definition at line 115 of file ModuleInstanceRepository.php.

References BristolSU\Support\ModuleInstance\ModuleInstanceRepository\getById().

◆ getById()

BristolSU\Support\ModuleInstance\ModuleInstanceRepository::getById ( int $id )

Get a module instance by ID

Parameters

int $id ID of the module instance

Returns: ModuleInstanceContract Module instance with the given ID

Exceptions

ModelNotFoundException If the model does not exist.

Implements BristolSU\Support\ModuleInstance\Contracts\ModuleInstanceRepository.

Definition at line 27 of file ModuleInstanceRepository.php.

Referenced by BristolSU\Support\ModuleInstance\ModuleInstanceRepository\delete(), and BristolSU\Support\ModuleInstance\ModuleInstanceRepository\update().

◆ update()

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