Inheritance diagram for BristolSU\Support\Completion\CompletionConditions\EventFired\EventFired:

Collaboration diagram for BristolSU\Support\Completion\CompletionConditions\EventFired\EventFired:

Public Member Functions
	__construct (string $moduleAlias, EventRepository $eventRepository)

	options ()

	name ()

	description ()

	alias ()

	isComplete ($settings, ActivityInstance $activityInstance, ModuleInstance $moduleInstance)

Public Member Functions inherited from BristolSU\Support\Completion\Contracts\CompletionCondition
	__construct (string $moduleAlias)

	moduleAlias ()

	percentage ($settings, ActivityInstance $activityInstance, ModuleInstance $moduleInstance)

	isComplete ($settings, ActivityInstance $activityInstance, ModuleInstance $moduleInstance)

	options ()

	name ()

	description ()

	alias ()

	toJson ($options=0)

	toArray ()

Private Attributes
	$eventRepository

Detailed Description

Has an event been fired

Definition at line 15 of file EventFired.php.

Constructor & Destructor Documentation

◆ __construct()

BristolSU\Support\Completion\CompletionConditions\EventFired\EventFired::__construct	(	string	$moduleAlias,
		EventRepository	$eventRepository
	)

Parameters

string	$moduleAlias	Alias of the module the completion condition is for
EventRepository	$eventRepository	The event repository to get events from

Definition at line 29 of file EventFired.php.

References BristolSU\Support\Completion\CompletionConditions\EventFired\EventFired\$eventRepository.

Member Function Documentation

◆ alias()

BristolSU\Support\Completion\CompletionConditions\EventFired\EventFired::alias ( )

Alias of the completion condition

Returns: string

Definition at line 77 of file EventFired.php.

◆ description()

BristolSU\Support\Completion\CompletionConditions\EventFired\EventFired::description ( )

Description of the completion condition

Returns: string

Definition at line 67 of file EventFired.php.

◆ isComplete()

BristolSU\Support\Completion\CompletionConditions\EventFired\EventFired::isComplete	(		$settings,
		ActivityInstance	$activityInstance,
		ModuleInstance	$moduleInstance
	)

Is the condition satisfied?

Parameters

array	$settings	Settings
ActivityInstance	$activityInstance	Activity instance to test
ModuleInstance	$moduleInstance	Module instance to test

Returns: bool

Definition at line 92 of file EventFired.php.

◆ name()

BristolSU\Support\Completion\CompletionConditions\EventFired\EventFired::name ( )

Name of the completion condition

Returns: string

Definition at line 57 of file EventFired.php.

◆ options()

BristolSU\Support\Completion\CompletionConditions\EventFired\EventFired::options ( )

Get all events for the module instance

Returns: Form

Exceptions

Definition at line 41 of file EventFired.php.

References BristolSU\Support\Completion\Contracts\CompletionCondition\toArray().

Member Data Documentation

◆ $eventRepository

BristolSU\Support\Completion\CompletionConditions\EventFired\EventFired::$eventRepository

private

Definition at line 23 of file EventFired.php.

Referenced by BristolSU\Support\Completion\CompletionConditions\EventFired\EventFired\__construct().

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

src/Completion/CompletionConditions/EventFired/EventFired.php

Public Member Functions

Private Attributes