ILIAS\Help\GuidedTour\StepRetrieval Class Reference

Inheritance diagram for ILIAS\Help\GuidedTour\StepRetrieval:

Collaboration diagram for ILIAS\Help\GuidedTour\StepRetrieval:

Public Member Functions
	__construct (protected InternalDomainService $domain, protected int $tour_id)
	getData (array $fields, ?Range $range=null, ?Order $order=null, array $filter=[], array $parameters=[])
	count (array $filter=[], array $parameters=[])
	isFieldNumeric (string $field)
	getData (array $fields, ?Range $range=null, ?Order $order=null, array $filter=[], array $parameters=[])
	count (array $filter, array $parameters)
	isFieldNumeric (string $field)

Protected Attributes
ILIAS Help GuidedTour Step StepManager	$step_manager

Detailed Description

Definition at line 28 of file StepRetrieval.php.

Constructor & Destructor Documentation

__construct()

ILIAS\Help\GuidedTour\StepRetrieval::__construct	(	protected InternalDomainService	$domain,
		protected int	$tour_id
	)

Definition at line 32 of file StepRetrieval.php.

      {
        $this->step_manager = $domain->step();
    }

References ILIAS\Help\GuidedTour\InternalDomainService\step().

Here is the call graph for this function:

Member Function Documentation

count()

ILIAS\Help\GuidedTour\StepRetrieval::count	(	array	$filter = [],
		array	$parameters = []
	)

Implements ILIAS\Repository\RetrievalInterface.

Definition at line 55 of file StepRetrieval.php.

     : int {
        return $this->step_manager->countStepsOfTour($this->tour_id);
    }

getData()

ILIAS\Help\GuidedTour\StepRetrieval::getData	(	array	$fields,
		?Range	$range = null,
		?Order	$order = null,
		array	$filter = [],
		array	$parameters = []
	)

Implements ILIAS\Repository\RetrievalInterface.

Definition at line 39 of file StepRetrieval.php.

     : \Generator {
        foreach ($this->step_manager->getStepsOfTour($this->tour_id) as $step) {
            yield [
                "id" => $step->getId(),
                "type" => $this->step_manager->getStepName($step->getType()),
                "element_id" => $step->getElementId()
            ];
        }
    }

isFieldNumeric()

ILIAS\Help\GuidedTour\StepRetrieval::isFieldNumeric

(

string

$field

)

Implements ILIAS\Repository\RetrievalInterface.

Definition at line 62 of file StepRetrieval.php.

                                                 : bool
    {
        return false;
    }

Field Documentation

$step_manager

ILIAS Help GuidedTour Step StepManager ILIAS\Help\GuidedTour\StepRetrieval::$step_manager

protected

Definition at line 30 of file StepRetrieval.php.

---

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

• components/ILIAS/Help/GuidedTour/Step/StepRetrieval.php