ILIAS\Help\Module\ModuleRetrieval Class Reference

Inheritance diagram for ILIAS\Help\Module\ModuleRetrieval:

Collaboration diagram for ILIAS\Help\Module\ModuleRetrieval:

Public Member Functions
	__construct (protected InternalDomainService $domain)
	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 Member Functions
	collectData ()

Detailed Description

Definition at line 29 of file ModuleRetrieval.php.

Constructor & Destructor Documentation

__construct()

ILIAS\Help\Module\ModuleRetrieval::__construct

(

protected InternalDomainService

$domain

)

Definition at line 33 of file ModuleRetrieval.php.

      {
    }

Member Function Documentation

collectData()

ILIAS\Help\Module\ModuleRetrieval::collectData ( )

protected

Definition at line 66 of file ModuleRetrieval.php.

                                    : array
    {
        $data = [];
        foreach ($this->domain->module()->getHelpModules() as $module) {
            $data[] = [
                'id' => (int) $module['id'],
                'order_nr' => (int) $module['order_nr'],
                'title' => (string) ($module['title'] ?? ''),
                'create_date' => strtotime((string) ($module['create_date'] ?? '')) ?: 0,
                'active' => (bool) $module['active']
            ];
        }
 
        return $data;
    }

References $data, $module, and ILIAS\Repository\int().

Here is the call graph for this function:

count()

ILIAS\Help\Module\ModuleRetrieval::count	(	array	$filter = [],
		array	$parameters = []
	)

Implements ILIAS\Repository\RetrievalInterface.

Definition at line 54 of file ModuleRetrieval.php.

     : int {
        return count($this->collectData());
    }

getData()

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

Implements ILIAS\Repository\RetrievalInterface.

Definition at line 38 of file ModuleRetrieval.php.

     : \Generator {
        $data = $this->collectData();
        $data = $this->applyOrder($data, $order);
        $data = $this->applyRange($data, $range);
 
        foreach ($data as $row) {
            yield $row;
        }
    }

isFieldNumeric()

ILIAS\Help\Module\ModuleRetrieval::isFieldNumeric

(

string

$field

)

Implements ILIAS\Repository\RetrievalInterface.

Definition at line 61 of file ModuleRetrieval.php.

                                                 : bool
    {
        return in_array($field, ['id', 'create_date', 'order_nr'], true);
    }

---

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

• components/ILIAS/Help/Module/ModuleRetrieval.php