ILIAS\Component\Activities\StaticRepository Class Reference

Inheritance diagram for ILIAS\Component\Activities\StaticRepository:

Collaboration diagram for ILIAS\Component\Activities\StaticRepository:

Public Member Functions
	__construct (array $activities)
	getActivitiesByName (string $name_matcher, ?ActivityType $type=null, ?Range $range=null)
	Get all activities where the name matches the provided regexp. More...
	getActivitiesByName (string $name_matcher, ?ActivityType $type=null, ?Range $range=null)
	Get all activities where the name matches the provided regexp. More...

Protected Attributes
array	$activities = []

Detailed Description

Definition at line 23 of file StaticRepository.php.

Constructor & Destructor Documentation

__construct()

ILIAS\Component\Activities\StaticRepository::__construct

(

array

$activities

)

Parameters

array<Activity>

$ativities

Definition at line 30 of file StaticRepository.php.

      {
        foreach ($activities as $activity) {
            if (!($activity instanceof Activity)) {
                throw new \InvalidArgumentException(
                    "Expected `Activity`, got: " . get_class($activity)
                );
            }
            $this->activities[(string) $activity->getName()] = $activity;
        }
    }

References ILIAS\Component\Activities\StaticRepository\$activities.

Member Function Documentation

getActivitiesByName()

ILIAS\Component\Activities\StaticRepository::getActivitiesByName	(	string	$name_matcher,
		?ActivityType	$type = null,
		?Range	$range = null
	)

Get all activities where the name matches the provided regexp.

Parameters

string

$name_matcher

as preg_match can understand

Returns

Iterator<string, Activity> where keys are the name

Implements ILIAS\Component\Activities\Repository.

Definition at line 43 of file StaticRepository.php.

                                                                                                               : \Iterator
    {
        foreach ($this->activities as $name => $activity) {
            if (preg_match($name_matcher, $name)) {
                yield $name => $activity;
            }
        }
    }

Field Documentation

$activities

array ILIAS\Component\Activities\StaticRepository::$activities = []

protected

Definition at line 25 of file StaticRepository.php.

Referenced by ILIAS\Component\Activities\StaticRepository\__construct().

---

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

• components/ILIAS/Component/src/Activities/StaticRepository.php