Inheritance diagram for ILIAS\News\Table\NewsItemTable:

Collaboration diagram for ILIAS\News\Table\NewsItemTable:

Public Member Functions
	__construct (protected Factory $ui_factory, protected ilLanguage $lng, protected ServerRequestInterface $request, protected ilCtrl $ctrl, protected ilSetting $setting, protected Renderer $ui_renderer, protected NewsAccess $news_access, protected ilUIFilterService $filter_service, protected NewsCollectionService $news_collection_service, protected ilObjUser $user, protected HttpService $http_service, protected ilGlobalTemplateInterface $main_tpl, protected Refinery $refinery,)

	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...

	getTableId ()

	getComponents (URLBuilder $url_builder)

	execute (URLBuilder $url_builder)

	getTableId ()

	execute (URLBuilder $url_builder)

	getComponents (URLBuilder $url_builder)

	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...

Data Fields
const string	URL_NS = 'nmit'

const string	ROW_ID_PARAMETER = 'news_item_row'

const string	ACTION_PARAMETER = 'action'

const string	ACTION_TYPE_PARAMETER = 'action_type'

Protected Member Functions
	acquireParameters (URLBuilder $url_builder)

	getTableActions ()

Protected Attributes
StandardFilter	$filter = null

Private Member Functions
	getColumns ()

	extractFilterData (mixed $filter_data)

	getNewsRequestContext ()

	isInternalRssEnabled ()

	sortRecords (array $records, Order $order)

	limitRecords (array $records, Range $range)

	getFilter ()

	buildOverviewCriteria (string $context_obj_type)

	loadNewsCollection ()

	loadRecords (?array $filter_data=null)

	itemMatchesFilters (NewsItem $item, string $search_text, string $filter_access, string $filter_author, bool $enable_internal_rss)

	itemShouldAppearInTable (NewsItem $item)

	renderPostCell (NewsItem $item)

	renderAccessDisplay (NewsItem $item)

	renderAuthorDisplay (NewsItem $item)

	assignedToMarkupOrNull (NewsItem $item)

	getItemAccess (NewsItem $item, bool $enable_internal_rss)

Detailed Description

Definition at line 58 of file NewsItemTable.php.

Constructor & Destructor Documentation

◆ __construct()

ILIAS\News\Table\NewsItemTable::__construct	(	protected Factory	$ui_factory,
		protected ilLanguage	$lng,
		protected ServerRequestInterface	$request,
		protected ilCtrl	$ctrl,
		protected ilSetting	$setting,
		protected Renderer	$ui_renderer,
		protected NewsAccess	$news_access,
		protected ilUIFilterService	$filter_service,
		protected NewsCollectionService	$news_collection_service,
		protected ilObjUser	$user,
		protected HttpService	$http_service,
		protected ilGlobalTemplateInterface	$main_tpl,
		protected Refinery	$refinery
	)

Definition at line 69 of file NewsItemTable.php.

83 {

84 }

Member Function Documentation

◆ acquireParameters()

ILIAS\News\Table\NewsItemTable::acquireParameters ( URLBuilder $url_builder )

protected

Returns: array{0: URLBuilder, 1: URLBuilderToken, 2: URLBuilderToken, 3: URLBuilderToken}

Definition at line 217 of file NewsItemTable.php.

                                                                 : array
    {
        return $url_builder->acquireParameters(
            [$this->getTableId()],
            self::ROW_ID_PARAMETER,
            self::ACTION_PARAMETER,
            self::ACTION_TYPE_PARAMETER
        );
    }

References ILIAS\UI\URLBuilder\acquireParameters().

Here is the call graph for this function:

◆ assignedToMarkupOrNull()

ILIAS\News\Table\NewsItemTable::assignedToMarkupOrNull ( NewsItem $item )

private

Definition at line 437 of file NewsItemTable.php.

                                                           : ?string
    {
        $context_obj_type = $item->getContextObjType();
        $context_obj_id = $item->getContextObjId();
        if ($context_obj_type === '' || $context_obj_id <= 0) {
            return '';
        }
 
        $ref_ids = ilObject::_getAllReferences($context_obj_id);
        $item_ref_id = array_values($ref_ids)[0] ?? 0;
 
        if ($item_ref_id <= 0) {
            return null;
        }
 
        $obj_title = ilObject::_lookupTitle($context_obj_id);
        $obj_type_txt = $this->lng->txt("obj_{$context_obj_type}");
 
        $this->ctrl->setParameterByClass(ilRepositoryGUI::class, 'ref_id', $item_ref_id);
        $link_url = $this->ctrl->getLinkTargetByClass(ilRepositoryGUI::class, '');
        $this->ctrl->setParameterByClass(ilRepositoryGUI::class, 'ref_id', null);
 
        $obj_link = $this->ui_factory->link()->standard($obj_title, $link_url);
 
        return "{$obj_type_txt}: {$this->ui_renderer->render($obj_link)}";
    }

References ilObject\_getAllReferences(), ilObject\_lookupTitle(), ILIAS\Repository\ctrl(), ILIAS\News\Data\NewsItem\getContextObjId(), ILIAS\News\Data\NewsItem\getContextObjType(), and ILIAS\Repository\lng().

Here is the call graph for this function:

◆ buildOverviewCriteria()

ILIAS\News\Table\NewsItemTable::buildOverviewCriteria ( string $context_obj_type )

private

Definition at line 283 of file NewsItemTable.php.

                                                                    : NewsCriteria
    {
        return new NewsCriteria(
            limit: null,
            prevent_nesting: !in_array($context_obj_type, ['cat', 'grp', 'crs', 'root'], true),
            no_auto_generated: true,
            include_read_status: false
        );
    }

◆ execute()

ILIAS\News\Table\NewsItemTable::execute ( URLBuilder $url_builder )

Implements ILIAS\News\Common\Table\Table.

Definition at line 481 of file NewsItemTable.php.

                                                    : ?Modal
    {
        return $this->getTableActions()->execute(...$this->acquireParameters($url_builder));
    }

References ILIAS\BookingManager\Common\Table\getTableActions().

Here is the call graph for this function:

◆ extractFilterData()

ILIAS\News\Table\NewsItemTable::extractFilterData ( mixed $filter_data )

private

Definition at line 141 of file NewsItemTable.php.

                                                          : ?array
    {
        return $filter_data instanceof StandardFilter
            ? $this->filter_service->getData($filter_data)
            : null;
    }

◆ getColumns()

ILIAS\News\Table\NewsItemTable::getColumns ( )

private

Definition at line 113 of file NewsItemTable.php.

                                 : array
    {
        $column_factory = $this->ui_factory->table()->column();
 
        $columns = [
            'post' => $column_factory->text($this->lng->txt('news_news_item_post'))->withIsSortable(false),
            'assigned_to' => $column_factory->text($this->lng->txt('news_attached_to'))->withIsSortable(false),
        ];
 
        if ($this->isInternalRssEnabled()) {
            $columns['access'] = $column_factory->text($this->lng->txt('access'))->withIsSortable(false);
        }
 
        $date_format = $this->user->getDateTimeFormat();
        $columns += [
            'author' => $column_factory->text($this->lng->txt('author'))->withIsSortable(false),
            'created_at' => $column_factory->date($this->lng->txt('created'), $date_format)->withIsSortable(true),
            'updated_at' => $column_factory->date($this->lng->txt('last_update'), $date_format)->withIsSortable(true),
        ];
 
        return $columns;
    }

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

Here is the call graph for this function:

◆ getComponents()

ILIAS\News\Table\NewsItemTable::getComponents ( URLBuilder $url_builder )

Returns: array<Component>

Implements ILIAS\News\Common\Table\Table.

Definition at line 195 of file NewsItemTable.php.

                                                          : array
    {
        $this->filter = $this->getFilter();
        $table = $this->ui_factory->table()->data(
            $this,
            $this->lng->txt('news'),
            $this->getColumns()
        )
            ->withRequest($this->request)
            ->withFilter($this->filter)
            ->withActions($this->getTableActions()->getEnabledActions(...$this->acquireParameters($url_builder)))
            ->withId($this->getTableId());
 
        return [
            $this->filter,
            $table
        ];
    }

References ILIAS\Repository\filter(), ILIAS\BookingManager\Common\Table\getTableActions(), and ILIAS\Repository\lng().

Here is the call graph for this function:

◆ getFilter()

ILIAS\News\Table\NewsItemTable::getFilter ( )

private

Definition at line 242 of file NewsItemTable.php.

                                : StandardFilter
    {
        $author_options = [];
 
        foreach ($this->loadNewsCollection()->getNewsItems() as $item) {
            $user_id = $item->getUserId();
            if ($user_id <= 0) {
                continue;
            }
 
            $login = ilObjUser::_lookupLogin($user_id);
            $author_options[$login] = $login;
        }
 
        $field_factory = $this->ui_factory->input()->field();
        $filter_inputs = [
            'text' => $field_factory->text($this->lng->txt('news_news_item_content')),
        ];
 
        if ($this->isInternalRssEnabled()) {
            $filter_inputs['access'] = $field_factory->select(
                $this->lng->txt('access'),
                [
                    'public' => $this->lng->txt('news_visibility_public'),
                    'users' => $this->lng->txt('news_visibility_users'),
                ]
            );
        }
 
        $filter_inputs['author'] = $field_factory->select($this->lng->txt('author'), $author_options);
 
        return $this->filter_service->standard(
            'news_item_table_filter',
            $this->ctrl->getLinkTargetByClass(ilNewsItemGUI::class, 'editNews', ''),
            $filter_inputs,
            array_fill(0, count($filter_inputs), true),
            true,
            true
        );
    }

References $user_id, ilObjUser\_lookupLogin(), ILIAS\Repository\ctrl(), and ILIAS\Repository\lng().

Here is the call graph for this function:

◆ getItemAccess()

ILIAS\News\Table\NewsItemTable::getItemAccess	(	NewsItem	$item,
		bool	$enable_internal_rss
	)

private

Definition at line 464 of file NewsItemTable.php.

                                                                             : string
    {
        if (!$enable_internal_rss) {
            return '';
        }
 
        $public_notifications_for_context = (bool) ilBlockSetting::_lookup(
            'news',
            'public_notifications',
            0,
            $item->getContextObjId()
        );
        $public_via_block_defaults = $item->getPriority() === 0 && $public_notifications_for_context;
 
        return ($item->getVisibility() === 'public' || $public_via_block_defaults) ? 'public' : 'users';
    }

References ilBlockSetting\_lookup(), ILIAS\News\Data\NewsItem\getContextObjId(), ILIAS\News\Data\NewsItem\getPriority(), and ILIAS\News\Data\NewsItem\getVisibility().

Here is the call graph for this function:

◆ getNewsRequestContext()

ILIAS\News\Table\NewsItemTable::getNewsRequestContext ( )

private

Definition at line 148 of file NewsItemTable.php.

                                            : array
    {
        return [
            'ref_id' => (int) ($this->request->getQueryParams()['ref_id'] ?? 0),
            'context_obj_id' => $this->ctrl->getContextObjId() ?? 0,
            'context_obj_type' => $this->ctrl->getContextObjType() ?? '',
            'context_sub_obj_id' => 0,
        ];
    }

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

Here is the call graph for this function:

◆ getRows()

ILIAS\News\Table\NewsItemTable::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 86 of file NewsItemTable.php.

     : Generator {
        $records = $this->limitRecords(
            $this->sortRecords(
                $this->loadRecords(
                    $this->extractFilterData($filter_data)
                ),
                $order
            ),
            $range
        );
 
        foreach ($records as $record) {
            yield $this->getTableActions()->onDataRow(
                $row_builder->buildDataRow((string) $record['id'], $record),
                $record
            );
        }
    }

References ILIAS\UI\Component\Table\DataRowBuilder\buildDataRow(), and ILIAS\News\Table\NewsItemTable\getTableActions().

Here is the call graph for this function:

◆ getTableActions()

ILIAS\News\Table\NewsItemTable::getTableActions ( )

protected

Definition at line 227 of file NewsItemTable.php.

                                        : TableActions
    {
        return (new NewsItemTableActionsFactory(
            $this->ui_factory,
            $this->lng,
            $this->news_access,
            $this->ctrl,
            $this->ui_renderer,
            $this->refinery,
            $this->http_service,
            $this->main_tpl,
            $this->loadRecords()
        ))->getTableActions();
    }

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

Referenced by ILIAS\News\Table\NewsItemTable\getRows().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getTableId()

ILIAS\News\Table\NewsItemTable::getTableId ( )

Implements ILIAS\News\Common\Table\Table.

Definition at line 187 of file NewsItemTable.php.

                                : string
    {
        return self::URL_NS;
    }

◆ getTotalRowCount()

ILIAS\News\Table\NewsItemTable::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 136 of file NewsItemTable.php.

                                                                                                                          : ?int
    {
        return count($this->loadRecords($this->extractFilterData($filter_data)));
    }

◆ isInternalRssEnabled()

ILIAS\News\Table\NewsItemTable::isInternalRssEnabled ( )

private

Definition at line 158 of file NewsItemTable.php.

                                           : bool
    {
        return (bool) $this->setting->get('enable_rss_for_internal');
    }

◆ itemMatchesFilters()

ILIAS\News\Table\NewsItemTable::itemMatchesFilters	(	NewsItem	$item,
		string	$search_text,
		string	$filter_access,
		string	$filter_author,
		bool	$enable_internal_rss
	)

private

Definition at line 360 of file NewsItemTable.php.

     : bool {
        if ($search_text !== '') {
            $search_text = strtolower($search_text);
 
            if (
                !str_contains(strtolower($item->getTitle()), $search_text)
                && !str_contains(strtolower($item->getContent() . $item->getContentLong()), $search_text)
            ) {
                return false;
            }
        }
 
        if (
            $filter_access !== ''
            && $this->getItemAccess($item, $enable_internal_rss) !== $filter_access
        ) {
            return false;
        }
 
        if ($filter_author !== '') {
            $filter_user_id = $item->getUserId();
            if (
                $filter_user_id <= 0
                || ilObjUser::_lookupLogin($filter_user_id) !== $filter_author
            ) {
                return false;
            }
        }
 
        return true;
    }

References ILIAS\News\Data\NewsItem\getContent(), ILIAS\News\Data\NewsItem\getContentLong(), and ILIAS\News\Data\NewsItem\getTitle().

Here is the call graph for this function:

◆ itemShouldAppearInTable()

ILIAS\News\Table\NewsItemTable::itemShouldAppearInTable ( NewsItem $item )

private

Definition at line 398 of file NewsItemTable.php.

                                                            : bool
    {
        return $item->getId() > 0 && ($this->news_access->canEdit($item) || $this->news_access->canDelete($item));
    }

References ILIAS\News\Data\NewsItem\getId().

Here is the call graph for this function:

◆ limitRecords()

ILIAS\News\Table\NewsItemTable::limitRecords	(	array	$records,
		Range	$range
	)

private

Definition at line 182 of file NewsItemTable.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:

◆ loadNewsCollection()

ILIAS\News\Table\NewsItemTable::loadNewsCollection ( )

private

Definition at line 293 of file NewsItemTable.php.

                                         : NewsCollection
    {
        $news_request_context = $this->getNewsRequestContext();
 
        return $this->news_collection_service->getNewsForContext(
            new NewsContext(
                $news_request_context['ref_id'],
                $news_request_context['context_obj_id'],
                $news_request_context['context_obj_type']
            ),
            $this->buildOverviewCriteria($this->getNewsRequestContext()['context_obj_type']),
            $this->user->getId()
        );
    }

References ILIAS\Repository\user().

Here is the call graph for this function:

◆ loadRecords()

ILIAS\News\Table\NewsItemTable::loadRecords ( ?array $filter_data = null )

private

Definition at line 308 of file NewsItemTable.php.

                                                            : array
    {
        $data = $this->loadNewsCollection()->getNewsItems();
        if ($data === []) {
            return [];
        }
 
        $filter = $filter_data ?? [];
        $filter_raw = $filter['text'] ?? '';
        $filter_text = $filter_raw !== '' ? strtolower($filter_raw) : '';
        $filter_access = $filter['access'] ?? '';
        $filter_author = $filter['author'] ?? '';
        $enable_internal_rss = $this->isInternalRssEnabled();
 
        $records = [];
        foreach ($data as $item) {
            $item_matches_filters = $this->itemMatchesFilters(
                $item,
                $filter_text,
                $filter_access,
                $filter_author,
                $enable_internal_rss
            );
 
            if (!$item_matches_filters || !$this->itemShouldAppearInTable($item)) {
                continue;
            }
 
            $assigned_to = $this->assignedToMarkupOrNull($item);
            if ($assigned_to === null) {
                continue;
            }
 
            $record = [
                'id' => (string) $item->getId(),
                'post' => $this->renderPostCell($item),
                'assigned_to' => $assigned_to,
                'author' => $this->renderAuthorDisplay($item),
                'created_at' => $item->getCreationDate(),
                'updated_at' => $item->getUpdateDate(),
            ];
 
            if ($enable_internal_rss) {
                $record['access'] = $this->renderAccessDisplay($item);
            }
 
            $records[] = $record;
        }
 
        return $records;
    }

References $data.

◆ renderAccessDisplay()

ILIAS\News\Table\NewsItemTable::renderAccessDisplay ( NewsItem $item )

private

Definition at line 422 of file NewsItemTable.php.

                                                        : string
    {
        return $this->lng->txt(
            $this->getItemAccess($item, true) === 'public'
                ? 'news_visibility_public'
                : 'news_visibility_users'
        );
    }

References ILIAS\Repository\lng().

Here is the call graph for this function:

◆ renderAuthorDisplay()

ILIAS\News\Table\NewsItemTable::renderAuthorDisplay ( NewsItem $item )

private

Definition at line 431 of file NewsItemTable.php.

                                                        : string
    {
        $author_user_id = $item->getUserId();
        return $author_user_id <= 0 ? '' : ilObjUser::_lookupLogin($author_user_id);
    }

References ilObjUser\_lookupLogin(), and ILIAS\News\Data\NewsItem\getUserId().

Here is the call graph for this function:

◆ renderPostCell()

ILIAS\News\Table\NewsItemTable::renderPostCell ( NewsItem $item )

private

Definition at line 403 of file NewsItemTable.php.

                                                   : string
    {
        $post_title = $item->getTitle();
        if ($post_title === '' || $item->getId() <= 0) {
            return '';
        }
 
        $post_content = "{$item->getContent()}{$item->getContentLong()}";
        $lightbox_page = $this->ui_factory->modal()->lightboxTextPage(
            $post_content ?: $this->lng->txt('news_news_item_no_content'),
            $post_title
        );
        $modal = $this->ui_factory->modal()->lightbox([$lightbox_page]);
        $post_button = $this->ui_factory->button()->shy($post_title, '')
            ->withOnClick($modal->getShowSignal());
 
        return $this->ui_renderer->render([$post_button, $modal]);
    }

References ILIAS\News\Data\NewsItem\getId(), ILIAS\News\Data\NewsItem\getTitle(), and ILIAS\Repository\lng().

Here is the call graph for this function:

◆ sortRecords()

ILIAS\News\Table\NewsItemTable::sortRecords	(	array	$records,
		Order	$order
	)

private

Definition at line 163 of file NewsItemTable.php.

                                                              : array
    {
        foreach ($order->get() as $order_field => $order_direction) {
            usort($records, static function (array $left, array $right) use ($order_field): int {
                $l = $left[$order_field] ?? null;
                $r = $right[$order_field] ?? null;
                return is_string($l) && is_string($r) ? strcmp($l, $r) : $l <=> $r;
            });
 
            if ($order_direction !== Order::DESC) {
                continue;
            }
 
            $records = array_reverse($records);
        }
 
        return $records;
    }

References ILIAS\Data\Order\DESC, and ILIAS\Data\Order\get().

Here is the call graph for this function:

Field Documentation

◆ $filter

StandardFilter ILIAS\News\Table\NewsItemTable::$filter = null

protected

Definition at line 67 of file NewsItemTable.php.

◆ ACTION_PARAMETER

const string ILIAS\News\Table\NewsItemTable::ACTION_PARAMETER = 'action'

Definition at line 64 of file NewsItemTable.php.

◆ ACTION_TYPE_PARAMETER

const string ILIAS\News\Table\NewsItemTable::ACTION_TYPE_PARAMETER = 'action_type'

Definition at line 65 of file NewsItemTable.php.

◆ ROW_ID_PARAMETER

const string ILIAS\News\Table\NewsItemTable::ROW_ID_PARAMETER = 'news_item_row'

Definition at line 63 of file NewsItemTable.php.

◆ URL_NS

const string ILIAS\News\Table\NewsItemTable::URL_NS = 'nmit'

Definition at line 62 of file NewsItemTable.php.

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

components/ILIAS/News/src/NewsItem/Table/NewsItemTable.php

Public Member Functions

Data Fields

Protected Member Functions

Protected Attributes

Private Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ acquireParameters()

◆ assignedToMarkupOrNull()

◆ buildOverviewCriteria()

◆ execute()

◆ extractFilterData()

◆ getColumns()

◆ getComponents()

◆ getFilter()

◆ getItemAccess()

◆ getNewsRequestContext()

◆ getRows()

◆ getTableActions()

◆ getTableId()

◆ getTotalRowCount()

◆ isInternalRssEnabled()

◆ itemMatchesFilters()

◆ itemShouldAppearInTable()

◆ limitRecords()

◆ loadNewsCollection()

◆ loadRecords()

◆ renderAccessDisplay()

◆ renderAuthorDisplay()

◆ renderPostCell()

◆ sortRecords()

Field Documentation

◆ $filter

◆ ACTION_PARAMETER

◆ ACTION_TYPE_PARAMETER

◆ ROW_ID_PARAMETER

◆ URL_NS