ILIAS\Forum\Drafts\ForumDraftsTable Class Reference

Inheritance diagram for ILIAS\Forum\Drafts\ForumDraftsTable:

Collaboration diagram for ILIAS\Forum\Drafts\ForumDraftsTable:

Public Member Functions
	__construct (private readonly ilObjForum $forum, private readonly UIFactory $ui_factory, private readonly ServerRequestInterface $httpRequest, private readonly ilLanguage $lng, private readonly string $parent_cmd, private readonly ilCtrlInterface $ctrl, private readonly DataFactory $data_factory, private readonly ilObjUser $user, private readonly bool $mayEdit, private readonly ilObjForumGUI $parent_object,)
	getRows (\ILIAS\UI\Component\Table\DataRowBuilder $row_builder, array $visible_column_ids, Range $range, Order $order, mixed $additional_viewcontrol_data, mixed $filter_data, mixed $additional_parameters,)
	initRecords ()
	getComponent ()
	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...
Public Member Functions inherited from ILIAS\UI\Component\Table\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. 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...

Private Member Functions
	getRecords (Range $range, Order $order)
	limitRecords (array $records, Range $range)
	getColumns ()

Private Attributes
array	$records = null

Detailed Description

Definition at line 41 of file ForumDraftsTable.php.

Constructor & Destructor Documentation

__construct()

ILIAS\Forum\Drafts\ForumDraftsTable::__construct	(	private readonly ilObjForum	$forum,
		private readonly UIFactory	$ui_factory,
		private readonly ServerRequestInterface	$httpRequest,
		private readonly ilLanguage	$lng,
		private readonly string	$parent_cmd,
		private readonly ilCtrlInterface	$ctrl,
		private readonly DataFactory	$data_factory,
		private readonly ilObjUser	$user,
		private readonly bool	$mayEdit,
		private readonly ilObjForumGUI	$parent_object
	)

Definition at line 46 of file ForumDraftsTable.php.

      {
    }

Member Function Documentation

getColumns()

ILIAS\Forum\Drafts\ForumDraftsTable::getColumns ( )

private

Returns

array{ draft: \ILIAS\UI\Component\Table\Column\Link, edited_on: \ILIAS\UI\Component\Table\Column\Text }

Definition at line 183 of file ForumDraftsTable.php.

                                 : array
    {
        return [
            'draft' => $this->ui_factory->table()->column()->link($this->lng->txt('drafts'))->withIsSortable(
                false
            )->withIsSortable(false),
            'edited_on' => $this->ui_factory->table()->column()->date(
                $this->lng->txt('edited_on'),
                $this->user->getDateTimeFormat()
            )->withIsSortable(false)
        ];
    }

References ILIAS\Repository\lng().

Here is the call graph for this function:

getComponent()

ILIAS\Forum\Drafts\ForumDraftsTable::getComponent

(

)

Definition at line 109 of file ForumDraftsTable.php.

                                  : DataTable
    {
        $query_params_namespace = ['forum', 'drafts', 'delete'];
        $uri = $this->data_factory->uri(
            ILIAS_HTTP_PATH . '/' . $this->ctrl->getLinkTargetByClass(ilObjForumGUI::class, 'confirmDeleteThreadDrafts')
        );
        $url_builder = new URLBuilder($uri);
        [$url_builder, $action_parameter_token, $row_id_token] = $url_builder->acquireParameters(
            $query_params_namespace,
            'table_action',
            'draft_ids'
        );
 
        return $this->ui_factory
            ->table()
            ->data(
                $this,
                $this->lng->txt('drafts'),
                $this->getColumns(),
            )
            ->withId(
                'frm_drafts_' . substr(
                    md5($this->parent_cmd),
                    0,
                    3
                ) . '_' . $this->forum->getId()
            )
            ->withRequest($this->httpRequest)
            ->withActions(
                [
                    'delete' => $this->ui_factory->table()->action()->multi(
                        $this->lng->txt('delete'),
                        $url_builder->withParameter($action_parameter_token, 'delete'),
                        $row_id_token
                    )
                ]
            );
    }

References ILIAS\Repository\ctrl(), and ILIAS\Repository\lng().

Here is the call graph for this function:

getRecords()

ILIAS\Forum\Drafts\ForumDraftsTable::getRecords ( Range  $range, Order  $order  )

private

Returns

list<array{draft_id: int, draft: string, edited_on: string}>

Definition at line 161 of file ForumDraftsTable.php.

                                                           : array
    {
        $this->initRecords();
 
        return $this->limitRecords($this->records, $range);
    }

References ILIAS\UI\Implementation\Component\Table\$range.

getRows()

ILIAS\Forum\Drafts\ForumDraftsTable::getRows	(	\ILIAS\UI\Component\Table\DataRowBuilder	$row_builder,
		array	$visible_column_ids,
		Range	$range,
		Order	$order,
		mixed	$additional_viewcontrol_data,
		mixed	$filter_data,
		mixed	$additional_parameters
	)

Definition at line 60 of file ForumDraftsTable.php.

     : Generator {
        $records = $this->getRecords($range, $order);
        foreach ($records as $record) {
            yield $row_builder->buildDataRow((string) $record['draft_id'], $record);
        }
    }

getTotalRowCount()

ILIAS\Forum\Drafts\ForumDraftsTable::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 148 of file ForumDraftsTable.php.

     : ?int {
        $this->initRecords();
 
        return count((array) $this->records);
    }

initRecords()

ILIAS\Forum\Drafts\ForumDraftsTable::initRecords

(

)

Definition at line 75 of file ForumDraftsTable.php.

                                 : void
    {
        if ($this->records === null) {
            $this->records = [];
            $drafts = ilForumPostDraft::getThreadDraftData(
                $this->user->getId(),
                ilObjForum::lookupForumIdByObjId($this->forum->getId())
            );
 
            foreach ($drafts as $draft) {
                if (!isset($draft['draft_id'], $draft['subject'], $draft['post_update'])) {
                    continue;
                }
 
                $draft_id = $draft['draft_id'];
                $this->records[$draft_id] = ['draft_id' => $draft_id];
                if ($this->mayEdit) {
                    $this->ctrl->setParameter($this->parent_object, 'draft_id', $draft_id);
                    $url = $this->ctrl->getLinkTarget($this->parent_object, 'editThreadDraft');
                    $this->records[$draft_id]['draft'] = $this->ui_factory->link()->standard(
                        $draft['subject'],
                        $url
                    );
                    $this->ctrl->setParameter($this->parent_object, 'draft_id', null);
                } else {
                    $this->records[$draft_id]['draft'] = $draft['subject'];
                }
                $this->records[$draft_id]['edited_on'] = new DateTimeImmutable(
                    $draft['post_update']
                );
            }
        }
    }

References $url, ILIAS\Repository\ctrl(), ilForumPostDraft\getThreadDraftData(), ilObjForum\lookupForumIdByObjId(), and ILIAS\Repository\user().

Here is the call graph for this function:

limitRecords()

ILIAS\Forum\Drafts\ForumDraftsTable::limitRecords ( array  $records, Range  $range  )

private

Parameters

list<array{draft_id

int, draft: string, edited_on: string}> $records

Returns

list<array{draft_id: int, draft: string, edited_on: string}>

Definition at line 172 of file ForumDraftsTable.php.

                                                               : array
    {
        return array_slice($records, $range->getStart(), $range->getLength());
    }

References ILIAS\UI\Implementation\Component\Table\$range, ILIAS\Data\Range\getLength(), and ILIAS\Data\Range\getStart().

Here is the call graph for this function:

Field Documentation

$records

array ILIAS\Forum\Drafts\ForumDraftsTable::$records = null

private

Definition at line 44 of file ForumDraftsTable.php.

---

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

• components/ILIAS/Forum/classes/Drafts/ForumDraftsTable.php