ILIAS\AdministrativeNotification\Table Class Reference

Collaboration diagram for ILIAS\AdministrativeNotification\Table:

Public Member Functions
	__construct (private ilADNNotificationGUI $calling_gui)
	getHTML ()
	getUrlBuilder ()
	getIdToken ()

Data Fields
const	ACTION_EDIT = 'edit'
const	ACTION_DELETE = 'delete'
const	ACTION_RESET = 'reset'
const	ACTION_DUPLICATE = 'duplicate'

Protected Member Functions
	initColumns ()
	initActions ()
	getURI (string $command)
	@description Unfortunately, I have not yet found an easier way to generate this URI. More...

Protected Attributes
array	$components = []

Private Member Functions
	initURIBuilder ()

Private Attributes
Factory	$ui_factory
Renderer	$ui_renderer
ilCtrlInterface	$ctrl
ilLanguage	$lng
URLBuilder	$url_builder
URLBuilderToken	$id_token
bool	$write_access

Detailed Description

Author

Fabian Schmid fabia.nosp@m.n@sr.nosp@m..solu.nosp@m.tion.nosp@m.s

Definition at line 36 of file Table.php.

Constructor & Destructor Documentation

__construct()

ILIAS\AdministrativeNotification\Table::__construct

(

private ilADNNotificationGUI

$calling_gui

)

Definition at line 52 of file Table.php.

      {
        global $DIC;
        $this->ui_factory = $DIC['ui.factory'];
        $this->ui_renderer = $DIC['ui.renderer'];
        $this->ctrl = $DIC['ilCtrl'];
        $this->lng = $DIC['lng'];
 
        $this->url_builder = $this->initURIBuilder();
        $this->write_access = (new ilObjAdministrativeNotificationAccess())->hasUserPermissionTo('write');
        $columns = $this->initColumns();
        $actions = $this->initActions();
        $data_retrieval = new DataRetrieval(
            $this->write_access
        );
 
        $this->components[] = $this->ui_factory->table()->data(
            $data_retrieval,
            $this->lng->txt('msg_table_title'),
            $columns,
        )->withActions($actions)->withRequest(
            $DIC->http()->request()
        );
    }

References $DIC, ILIAS\Repository\ctrl(), ILIAS\AdministrativeNotification\Table\initActions(), ILIAS\AdministrativeNotification\Table\initColumns(), ILIAS\AdministrativeNotification\Table\initURIBuilder(), and ILIAS\Repository\lng().

Here is the call graph for this function:

Member Function Documentation

getHTML()

ILIAS\AdministrativeNotification\Table::getHTML

(

)

Definition at line 152 of file Table.php.

                             : string
    {
        return $this->ui_renderer->render($this->components);
    }

getIdToken()

ILIAS\AdministrativeNotification\Table::getIdToken

(

)

Definition at line 162 of file Table.php.

                                : URLBuilderToken
    {
        return $this->id_token;
    }

References ILIAS\AdministrativeNotification\Table\$id_token.

getURI()

ILIAS\AdministrativeNotification\Table::getURI ( string  $command )

protected

@description Unfortunately, I have not yet found an easier way to generate this URI.

However, it is important that it points to the calling-gui

Definition at line 142 of file Table.php.

                                              : URI
    {
        return new URI(
            ILIAS_HTTP_PATH . "/" . $this->ctrl->getLinkTarget(
                $this->calling_gui,
                $command
            )
        );
    }

References ILIAS\Repository\ctrl().

Referenced by ILIAS\AdministrativeNotification\Table\initURIBuilder().

Here is the call graph for this function:

Here is the caller graph for this function:

getUrlBuilder()

ILIAS\AdministrativeNotification\Table::getUrlBuilder

(

)

Definition at line 157 of file Table.php.

                                   : URLBuilder
    {
        return $this->url_builder;
    }

References ILIAS\AdministrativeNotification\Table\$url_builder.

initActions()

ILIAS\AdministrativeNotification\Table::initActions ( )

protected

Definition at line 108 of file Table.php.

                                    : array
    {
        if ($this->write_access === false) {
            return [];
        }
 
        return [
            self::ACTION_EDIT => $this->ui_factory->table()->action()->single(
                $this->lng->txt("btn_edit"),
                $this->url_builder->withURI($this->getURI(ilADNNotificationGUI::CMD_EDIT)),
                $this->id_token
            ),
            self::ACTION_DELETE => $this->ui_factory->table()->action()->standard(
                $this->lng->txt("btn_delete"),
                $this->url_builder->withURI($this->getURI(ilADNNotificationGUI::CMD_CONFIRM_DELETE)),
                $this->id_token
            )->withAsync(true),
            self::ACTION_RESET => $this->ui_factory->table()->action()->standard(
                $this->lng->txt("btn_reset"),
                $this->url_builder->withURI($this->getURI(ilADNNotificationGUI::CMD_RESET)),
                $this->id_token
            ),
            self::ACTION_DUPLICATE => $this->ui_factory->table()->action()->single(
                $this->lng->txt("btn_duplicate"),
                $this->url_builder->withURI($this->getURI(ilADNNotificationGUI::CMD_DUPLICATE)),
                $this->id_token
            ),
        ];
    }

References ilADNNotificationGUI\CMD_CONFIRM_DELETE, ilADNNotificationGUI\CMD_DUPLICATE, ilADNNotificationGUI\CMD_EDIT, ilADNNotificationGUI\CMD_RESET, and ILIAS\Repository\lng().

Referenced by ILIAS\AdministrativeNotification\Table\__construct().

Here is the call graph for this function:

Here is the caller graph for this function:

initColumns()

ILIAS\AdministrativeNotification\Table::initColumns ( )

protected

Definition at line 94 of file Table.php.

                                    : array
    {
        return [
            'title' => $this->ui_factory->table()->column()->text($this->lng->txt('msg_title')),
            'type' => $this->ui_factory->table()->column()->text($this->lng->txt('msg_type')),
            'languages' => $this->ui_factory->table()->column()->text($this->lng->txt('msg_languages')),
            'type_during_event' => $this->ui_factory->table()->column()->text($this->lng->txt('msg_type_during_event')),
            'event_start' => $this->ui_factory->table()->column()->text($this->lng->txt('msg_event_date_start')),
            'event_end' => $this->ui_factory->table()->column()->text($this->lng->txt('msg_event_date_end')),
            'display_start' => $this->ui_factory->table()->column()->text($this->lng->txt('msg_display_date_start')),
            'display_end' => $this->ui_factory->table()->column()->text($this->lng->txt('msg_display_date_end'))
        ];
    }

References ILIAS\Repository\lng().

Referenced by ILIAS\AdministrativeNotification\Table\__construct().

Here is the call graph for this function:

Here is the caller graph for this function:

initURIBuilder()

ILIAS\AdministrativeNotification\Table::initURIBuilder ( )

private

Definition at line 78 of file Table.php.

                                     : URLBuilder
    {
        $url_builder = new URLBuilder(
            $this->getURI(ilBiblFieldFilterGUI::CMD_STANDARD)
        );
 
        // these are the query parameters this instance is controlling
        $query_params_namespace = ['msg', 'notifications'];
        [$url_builder, $this->id_token] = $url_builder->acquireParameters(
            $query_params_namespace,
            ilADNAbstractGUI::IDENTIFIER
        );
 
        return $url_builder;
    }

References ILIAS\AdministrativeNotification\Table\$id_token, ILIAS\AdministrativeNotification\Table\$url_builder, ILIAS\UI\URLBuilder\acquireParameters(), ilBiblFieldFilterGUI\CMD_STANDARD, ILIAS\AdministrativeNotification\Table\getURI(), and ilADNAbstractGUI\IDENTIFIER.

Referenced by ILIAS\AdministrativeNotification\Table\__construct().

Here is the call graph for this function:

Here is the caller graph for this function:

Field Documentation

$components

array ILIAS\AdministrativeNotification\Table::$components = []

protected

Definition at line 50 of file Table.php.

$ctrl

ilCtrlInterface ILIAS\AdministrativeNotification\Table::$ctrl

private

Definition at line 44 of file Table.php.

$id_token

URLBuilderToken ILIAS\AdministrativeNotification\Table::$id_token

private

Definition at line 47 of file Table.php.

Referenced by ILIAS\AdministrativeNotification\Table\getIdToken(), and ILIAS\AdministrativeNotification\Table\initURIBuilder().

$lng

ilLanguage ILIAS\AdministrativeNotification\Table::$lng

private

Definition at line 45 of file Table.php.

$ui_factory

Factory ILIAS\AdministrativeNotification\Table::$ui_factory

private

Definition at line 42 of file Table.php.

$ui_renderer

Renderer ILIAS\AdministrativeNotification\Table::$ui_renderer

private

Definition at line 43 of file Table.php.

$url_builder

URLBuilder ILIAS\AdministrativeNotification\Table::$url_builder

private

Definition at line 46 of file Table.php.

Referenced by ILIAS\AdministrativeNotification\Table\getUrlBuilder(), and ILIAS\AdministrativeNotification\Table\initURIBuilder().

$write_access

bool ILIAS\AdministrativeNotification\Table::$write_access

private

Definition at line 48 of file Table.php.

ACTION_DELETE

const ILIAS\AdministrativeNotification\Table::ACTION_DELETE = 'delete'

Definition at line 39 of file Table.php.

Referenced by ILIAS\AdministrativeNotification\DataRetrieval\getRows().

ACTION_DUPLICATE

const ILIAS\AdministrativeNotification\Table::ACTION_DUPLICATE = 'duplicate'

Definition at line 41 of file Table.php.

Referenced by ILIAS\AdministrativeNotification\DataRetrieval\getRows().

ACTION_EDIT

const ILIAS\AdministrativeNotification\Table::ACTION_EDIT = 'edit'

Definition at line 38 of file Table.php.

Referenced by ILIAS\AdministrativeNotification\DataRetrieval\getRows().

ACTION_RESET

const ILIAS\AdministrativeNotification\Table::ACTION_RESET = 'reset'

Definition at line 40 of file Table.php.

Referenced by ILIAS\AdministrativeNotification\DataRetrieval\getRows().

---

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

• components/ILIAS/AdministrativeNotification/classes/Table.php