ilDidacticTemplateSettingsTableDataRetrieval Class Reference

Inheritance diagram for ilDidacticTemplateSettingsTableDataRetrieval:

Collaboration diagram for ilDidacticTemplateSettingsTableDataRetrieval:

Public Member Functions
	__construct (ilDidacticTemplateSettingsTableFilter $filter, ilLanguage $lng, UIFactory $ui_factory, UIRenderer $ui_renderer,)
	getRows (DataRowBuilder $row_builder, array $visible_column_ids, Range $range, Order $order, ?array $filter_data, ?array $additional_parameters)
	This is called by the table to retrieve rows; map data-records to rows using the $row_builder e.g. More...
	getTotalRowCount (?array $filter_data, ?array $additional_parameters)
	Mainly for the purpose of pagination-support, it is important to know about the total number of records available. More...

Protected Member Functions
	getTemplates ()
	getRecords (Order $order, Range $range)

Protected Attributes
ilDidacticTemplateSettingsTableFilter	$filter
ilLanguage	$lng
UIFactory	$ui_factory
UIRenderer	$ui_renderer

Detailed Description

Definition at line 29 of file class.ilDidacticTemplateSettingsTableDataRetrieval.php.

Constructor & Destructor Documentation

__construct()

ilDidacticTemplateSettingsTableDataRetrieval::__construct	(	ilDidacticTemplateSettingsTableFilter	$filter,
		ilLanguage	$lng,
		UIFactory	$ui_factory,
		UIRenderer	$ui_renderer
	)

Definition at line 36 of file class.ilDidacticTemplateSettingsTableDataRetrieval.php.

References $filter, $lng, $ui_factory, $ui_renderer, ILIAS\Repository\filter(), and ILIAS\Repository\lng().

      {
        $this->filter = $filter;
        $this->lng = $lng;
        $this->ui_factory = $ui_factory;
        $this->ui_renderer = $ui_renderer;
    }

Here is the call graph for this function:

Member Function Documentation

getRecords()

ilDidacticTemplateSettingsTableDataRetrieval::getRecords ( Order  $order, Range  $range  )

protected

Definition at line 83 of file class.ilDidacticTemplateSettingsTableDataRetrieval.php.

References Vendor\Package\$a, Vendor\Package\$b, ILIAS\LTI\ToolProvider\$key, $ref_id, ilObject\_lookupObjId(), ilObject\_lookupTitle(), ilUtil\getImagePath(), ILIAS\Data\Range\getLength(), ILIAS\Data\Range\getStart(), getTemplates(), ILIAS\Data\Order\join(), and ILIAS\Repository\lng().

Referenced by getRows().

                                                             : array
    {
        $records = [];
        foreach ($this->getTemplates() as $tpl) {
            /* @var $tpl ilDidacticTemplateSetting */
            $atxt = '';
            foreach ($tpl->getAssignments() as $obj_type) {
                $atxt .= ($this->lng->txt('objs_' . $obj_type) . '<br/>');
            }
            $title_desc = $tpl->getPresentationTitle()
                . "<br><br>"
                . $tpl->getPresentationDescription()
                . (trim($tpl->getInfo()) ? "<br><br>" . $tpl->getInfo() : '')
                . ($tpl->isAutoGenerated() ? "<br><br>" . $this->lng->txt("didactic_auto_generated") : '');

            $scope_str = '';
            if (count($tpl->getEffectiveFrom()) > 0) {
                $scope_str .= $this->lng->txt('didactic_scope_list_header');
                foreach ($tpl->getEffectiveFrom() as $ref_id) {
                    $link = $this->ui_renderer->render($this->ui_factory->link()->standard(
                        ilObject::_lookupTitle(ilObject::_lookupObjId($ref_id)),
                        ilLink::_getLink($ref_id)
                    ));
                    $scope_str .= "<br>";
                    $scope_str .= $link;
                }
            } else {
                $scope_str .= (isset($a_set['local']) ? $this->lng->txt('meta_local') : $this->lng->txt('meta_global'));
            }
            $scope_str .= "<br>";

            $icon_label = '';
            $icon_path = $tpl->getIconHandler()->getAbsolutePath();
            foreach ($tpl->getAssignments() as $obj_type) {
                $icon_label = $this->lng->txt('objs_' . $obj_type);
            }
            if ($icon_path) {
                $icon = $this->ui_factory->symbol()->icon()->custom(
                    $icon_path,
                    $icon_label
                );
            }

            $icon_active = $this->ui_factory->symbol()->icon()->custom(
                $tpl->isEnabled() ?
                    ilUtil::getImagePath('standard/icon_ok.svg') :
                    ilUtil::getImagePath('standard/icon_not_ok.svg'),
                $tpl->isEnabled() ? $this->lng->txt('active') : $this->lng->txt('inactive'),
                Icon::MEDIUM
            );

            $record = [
                'template_id' => $tpl->getId(),
                'title' => $title_desc,
                'applicable' => $atxt,
                'scope' => $scope_str,
                'enabled' => $icon_active,
                'automatically_generated' => $tpl->isAutoGenerated()
            ];
            if (isset($icon)) {
                $record['icon'] = $icon;
            }
            $records[] = $record;
        }
        list($order_field, $order_direction) = $order->join([], fn($ret, $key, $value) => [$key, $value]);
        usort($records, fn($a, $b) => $a[$order_field] <=> $b[$order_field]);
        if (
            $order_direction === 'DESC'
        ) {
            $records = array_reverse($records);
        }
        $selected_records = array_slice(
            $records,
            $range->getStart(),
            $range->getLength()
        );
        return $selected_records;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getRows()

ilDidacticTemplateSettingsTableDataRetrieval::getRows	(	DataRowBuilder	$row_builder,
		array	$visible_column_ids,
		Range	$range,
		Order	$order,
		?array	$filter_data,
		?array	$additional_parameters
	)

This is called by the table to retrieve rows; map data-records to rows using the $row_builder e.g.

yield $row_builder->buildStandardRow($row_id, $record).

Parameters

string[]

$visible_column_ids

Implements ILIAS\UI\Component\Table\DataRetrieval.

Definition at line 48 of file class.ilDidacticTemplateSettingsTableDataRetrieval.php.

References ILIAS\UI\Component\Table\DataRowBuilder\buildDataRow(), and getRecords().

     : Generator {
        $records = $this->getRecords($order, $range);
        foreach ($records as $record) {
            $row = $row_builder->buildDataRow((string) $record['template_id'], $record);
            if ($record['automatically_generated']) {
                $row = $row->withDisabledAction('didactic_do_export');
            }
            yield $row;
        }
    }

Here is the call graph for this function:

getTemplates()

ilDidacticTemplateSettingsTableDataRetrieval::getTemplates ( )

protected

Returns

ilDidacticTemplateSetting[]

Definition at line 76 of file class.ilDidacticTemplateSettingsTableDataRetrieval.php.

References ILIAS\Repository\filter(), and ilDidacticTemplateSettings\getInstance().

Referenced by getRecords(), and getTotalRowCount().

                                     : array
    {
        $tpls = ilDidacticTemplateSettings::getInstance();
        $tpls->readInactive();
        return $this->filter->filter($tpls->getTemplates());
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getTotalRowCount()

ilDidacticTemplateSettingsTableDataRetrieval::getTotalRowCount	(	?array	$filter_data,
		?array	$additional_parameters
	)

Mainly for the purpose of pagination-support, it is important to know about the total number of records available.

Given the nature of a DataTable, which is, opposite to a PresentationTable, rather administrative than explorative, this information will increase user experience quite a bit. However, you may return null, if the call is to costly, but expect the View Control to look a little different in this case.

Make sure that potential filters or user restrictions are being applied to the count.

Implements ILIAS\UI\Component\Table\DataRetrieval.

Definition at line 66 of file class.ilDidacticTemplateSettingsTableDataRetrieval.php.

References getTemplates().

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

Here is the call graph for this function:

Field Documentation

$filter

ilDidacticTemplateSettingsTableFilter ilDidacticTemplateSettingsTableDataRetrieval::$filter

protected

Definition at line 31 of file class.ilDidacticTemplateSettingsTableDataRetrieval.php.

Referenced by __construct().

$lng

ilLanguage ilDidacticTemplateSettingsTableDataRetrieval::$lng

protected

Definition at line 32 of file class.ilDidacticTemplateSettingsTableDataRetrieval.php.

Referenced by __construct().

$ui_factory

UIFactory ilDidacticTemplateSettingsTableDataRetrieval::$ui_factory

protected

Definition at line 33 of file class.ilDidacticTemplateSettingsTableDataRetrieval.php.

Referenced by __construct().

$ui_renderer

UIRenderer ilDidacticTemplateSettingsTableDataRetrieval::$ui_renderer

protected

Definition at line 34 of file class.ilDidacticTemplateSettingsTableDataRetrieval.php.

Referenced by __construct().

---

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

• Services/DidacticTemplate/classes/Setting/class.ilDidacticTemplateSettingsTableDataRetrieval.php