BristolSU\Support\Action\Contracts\ActionInstanceRepository Interface Reference

Inheritance diagram for BristolSU\Support\Action\Contracts\ActionInstanceRepository:

Public Member Functions
	forEvent (int $moduleInstanceId, string $event)
	forModuleInstance (int $moduleInstanceId)
	getById (int $id)
	all ()
	update (int $id, array $attributes)
	delete (int $id)

Detailed Description

Definition at line 9 of file ActionInstanceRepository.php.

Member Function Documentation

all()

BristolSU\Support\Action\Contracts\ActionInstanceRepository::all

(

)

Get all action instances registered

Returns

Collection

Implemented in BristolSU\Support\Action\ActionInstanceRepository.

delete()

BristolSU\Support\Action\Contracts\ActionInstanceRepository::delete

(

int

$id

)

Delete an action instance

Parameters

int

$id

Returns

void

Exceptions

ModelNotFoundException

Implemented in BristolSU\Support\Action\ActionInstanceRepository.

forEvent()

BristolSU\Support\Action\Contracts\ActionInstanceRepository::forEvent	(	int	$moduleInstanceId,
		string	$event
	)

Get all action instances for a given event and module instance

Parameters

int	$moduleInstanceId	Module instance the action instances should be attached to
string	$event	The event the action instances should respond to

Returns

Collection

Implemented in BristolSU\Support\Action\ActionInstanceRepository.

forModuleInstance()

BristolSU\Support\Action\Contracts\ActionInstanceRepository::forModuleInstance

(

int

$moduleInstanceId

)

Get all action instances for a given module instance

Parameters

int

$moduleInstanceId

ID of the module instance to get the action instances from

Returns

Collection

Implemented in BristolSU\Support\Action\ActionInstanceRepository.

getById()

BristolSU\Support\Action\Contracts\ActionInstanceRepository::getById

(

int

$id

)

Get an action instance by ID

Parameters

int

$id

Returns

ActionInstance

Exceptions

ModelNotFoundException

Implemented in BristolSU\Support\Action\ActionInstanceRepository.

update()

BristolSU\Support\Action\Contracts\ActionInstanceRepository::update	(	int	$id,
		array	$attributes
	)

Update an action instance

Parameters

int	$id
array	$attributes

Returns

ActionInstance

Exceptions

ModelNotFoundException

Implemented in BristolSU\Support\Action\ActionInstanceRepository.

---

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

• src/Action/Contracts/ActionInstanceRepository.php