ILIAS\Calendar\Manage\DataRetrieval Class Reference

Inheritance diagram for ILIAS\Calendar\Manage\DataRetrieval:

Collaboration diagram for ILIAS\Calendar\Manage\DataRetrieval:

Public Member Functions
	__construct (protected ilCalendarCategories $categories, protected ilCalendarActions $actions, protected ilLanguage $lng, protected UIFactory $ui_factory)
	getRows (DataRowBuilder $row_builder, array $visible_column_ids, Range $range, Order $order, mixed $additional_viewcontrol_data, mixed $filter_data, mixed $additional_parameters)
	This is called by the table to retrieve rows; map data-records to rows using the $row_builder e.g. More...
	getTotalRowCount (mixed $additional_viewcontrol_data, mixed $filter_data, mixed $additional_parameters)
	Mainly for the purpose of pagination-support, it is important to know about the total number of records available. More...
	getRows (DataRowBuilder $row_builder, array $visible_column_ids, Range $range, Order $order, mixed $additional_viewcontrol_data, mixed $filter_data, mixed $additional_parameters)
	This is called by the table to retrieve rows; map data-records to rows using the $row_builder e.g. More...
	getTotalRowCount (mixed $additional_viewcontrol_data, mixed $filter_data, mixed $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
	buildTypeIcon (int $type, string $obj_type)
	disableInactiveActions (int $id, DataRow $row)

Detailed Description

Definition at line 37 of file DataRetrieval.php.

Constructor & Destructor Documentation

__construct()

ILIAS\Calendar\Manage\DataRetrieval::__construct	(	protected ilCalendarCategories	$categories,
		protected ilCalendarActions	$actions,
		protected ilLanguage	$lng,
		protected UIFactory	$ui_factory
	)

Definition at line 39 of file DataRetrieval.php.

      {
    }

Member Function Documentation

buildTypeIcon()

ILIAS\Calendar\Manage\DataRetrieval::buildTypeIcon ( int  $type, string  $obj_type  )

protected

Definition at line 106 of file DataRetrieval.php.

                                                                 : ?Icon
    {
        $f = $this->ui_factory->symbol()->icon();
        $size = Icon::MEDIUM;
        return match ($type) {
            ilCalendarCategory::TYPE_GLOBAL => $f->custom(
                'assets/images/standard/icon_calg.svg',
                $this->lng->txt('cal_type_system'),
                $size
            ),
            ilCalendarCategory::TYPE_CH => $f->custom(
                'assets/images/standard/icon_calch.svg',
                $this->lng->txt('cal_ch_ch'),
                $size
            ),
            ilCalendarCategory::TYPE_USR => $f->standard(
                'usr',
                $this->lng->txt('cal_type_personal'),
                $size
            ),
            ilCalendarCategory::TYPE_OBJ => $f->standard(
                $obj_type,
                $this->lng->txt('cal_type_' . $type),
                $size
            ),
            ilCalendarCategory::TYPE_BOOK => $f->standard(
                'book',
                $this->lng->txt('cal_type_' . $type),
                $size
            ),
            default => null
        };
    }

References Vendor\Package\$f, ILIAS\Repository\lng(), ilCalendarCategory\TYPE_BOOK, ilCalendarCategory\TYPE_CH, ilCalendarCategory\TYPE_GLOBAL, ilCalendarCategory\TYPE_OBJ, and ilCalendarCategory\TYPE_USR.

Here is the call graph for this function:

disableInactiveActions()

ILIAS\Calendar\Manage\DataRetrieval::disableInactiveActions ( int  $id, DataRow  $row  )

protected

Definition at line 140 of file DataRetrieval.php.

                                                                    : DataRow
    {
        if (!$this->actions->checkSettingsCal($id)) {
            $row = $row->withDisabledAction(TableBuilder::ACTION_EDIT);
        }
        if (!$this->actions->checkAddEvent($id)) {
            $row = $row->withDisabledAction(TableBuilder::ACTION_IMPORT);
        }
        if (!$this->actions->checkShareCal($id)) {
            $row = $row->withDisabledAction(TableBuilder::ACTION_SHARE);
        }
        if (!$this->actions->checkSynchronizeCal($id)) {
            $row = $row->withDisabledAction(TableBuilder::ACTION_SYNCHRONIZE);
        }
        if (!$this->actions->checkDeleteCal($id)) {
            $row = $row->withDisabledAction(TableBuilder::ACTION_DELETE);
        }
        return $row;
    }

References $id, and ILIAS\UI\Component\Table\DataRow\withDisabledAction().

Here is the call graph for this function:

getRows()

ILIAS\Calendar\Manage\DataRetrieval::getRows	(	DataRowBuilder	$row_builder,
		array	$visible_column_ids,
		Range	$range,
		Order	$order,
		mixed	$additional_viewcontrol_data,
		mixed	$filter_data,
		mixed	$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 47 of file DataRetrieval.php.

     : Generator {
        $data = [];
        foreach ($this->categories->getCategoriesInfo() as $info) {
            $datum = [];
            $datum['title'] = $info['title'];
            $datum['type'] = $info['type'];
            $datum['obj_id'] = $info['obj_id'];
            $datum['obj_type'] =
                in_array($info['type'], [ilCalendarCategory::TYPE_OBJ, ilCalendarCategory::TYPE_BOOK], true) ?
                ilObject::_lookupType($info['obj_id']) : '';
            $datum['type_sortable'] = ilCalendarCategory::lookupCategorySortIndex($info['type']) .
                ($info['type'] === ilCalendarCategory::TYPE_OBJ ? $datum['obj_type'] : ''); // Append object type to make type sortable
            $data[$info['cat_id']] = $datum;
        }
 
        $order_field = array_keys($order->get())[0];
        $order_direction = $order->get()[$order_field];
        $order_field = match($order_field) {
            TableBuilder::TYPE_COLUMN => 'type_sortable',
            default => 'title'
        };
        uasort($data, fn($a, $b) => strtolower((string) $a[$order_field]) <=> strtolower((string) $b[$order_field]));
        if ($order_direction === Order::DESC) {
            $data = array_reverse($data, true);
        }
        $data = array_slice($data, $range->getStart(), $range->getLength(), true);
 
        $usr_icon = $this->ui_factory->symbol()->icon()->standard('usr', $this->lng->txt('obj_usr'));
        $role_icon = $this->ui_factory->symbol()->icon()->standard('role', $this->lng->txt('obj_role'));
 
        foreach ($data as $id => $datum) {
            $row_datum = [TableBuilder::TITLE_COLUMN => $datum['title']];
            if ($icon = $this->buildTypeIcon($datum['type'], $datum['obj_type'])) {
                $row_datum[TableBuilder::TYPE_COLUMN] = $icon;
            }
            $row = $row_builder->buildDataRow(
                (string) $id,
                $row_datum
            );
            yield $this->disableInactiveActions($id, $row);
        }
    }

References $data, $info, ilObject\_lookupType(), ilCalendarCategory\lookupCategorySortIndex(), ilCalendarCategory\TYPE_BOOK, and ilCalendarCategory\TYPE_OBJ.

Here is the call graph for this function:

getTotalRowCount()

ILIAS\Calendar\Manage\DataRetrieval::getTotalRowCount	(	mixed	$additional_viewcontrol_data,
		mixed	$filter_data,
		mixed	$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 98 of file DataRetrieval.php.

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

---

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

• components/ILIAS/Calendar/classes/Manage/DataRetrieval.php