ILIAS\SystemCheck\Table\Task\Handler Class Reference

Inheritance diagram for ILIAS\SystemCheck\Table\Task\Handler:

Collaboration diagram for ILIAS\SystemCheck\Table\Task\Handler:

Public Member Functions
	__construct (protected readonly DataFactory $data_factory, protected readonly UIServices $ui, protected readonly ilLanguage $lng, protected readonly HTTPServices $http, protected readonly DataRetrievalInterface $data_retrieval, protected readonly RefineryFactory $refinery, protected readonly ilCtrl $ctrl, protected readonly bool $actions_permitted=false)
	getHTML ()
	handleTableActions ()
	handleTableActions ()
	getHTML ()

Data Fields
const string	TABLE_COL_TITLE = 'title'
const string	TABLE_COL_DESCRIPTION = 'description'
const string	TABLE_COL_LAST_UPDATE = 'last_update'
const string	TABLE_COL_STATUS = 'status'

Protected Member Functions
	getColumns ()
	getActions ()
	initTable ()
	getTable ()

Protected Attributes
const string	TABLE_ID = "sc_groups"
const string	TABLE_ACTION_ID = "table_action"
const string	ROW_ID = "row_ids"
const string	LNG_TABLE_TITLE = 'sysc_task_overview'
const string	LNG_TABLE_COL_TITLE = 'title'
const string	LNG_TABLE_COL_DESCRIPTION = 'description'
const string	LNG_TABLE_COL_LAST_UPDATE = 'last_update'
const string	LNG_TABLE_COL_STATUS = 'status'
DataTable	$table
URLBuilder	$url_builder
ilURLBuilderToken	$action_parameter_token
ilURLBuilderToken	$row_id_token

Detailed Description

Definition at line 36 of file Handler.php.

Constructor & Destructor Documentation

__construct()

ILIAS\SystemCheck\Table\Task\Handler::__construct	(	protected readonly DataFactory	$data_factory,
		protected readonly UIServices	$ui,
		protected readonly ilLanguage	$lng,
		protected readonly HTTPServices	$http,
		protected readonly DataRetrievalInterface	$data_retrieval,
		protected readonly RefineryFactory	$refinery,
		protected readonly ilCtrl	$ctrl,
		protected readonly bool	$actions_permitted = false
	)

Definition at line 56 of file Handler.php.

      {
        $this->initTable();
    }

References ILIAS\SystemCheck\Table\Task\Handler\initTable().

Here is the call graph for this function:

Member Function Documentation

getActions()

ILIAS\SystemCheck\Table\Task\Handler::getActions ( )

finalprotected

Definition at line 87 of file Handler.php.

                                         : array
    {
        if (!$this->actions_permitted) {
            return [];
        }
        $this->url_builder = new URLBuilder($this->data_factory->uri($this->http->request()->getUri()->__toString()));
        list($this->url_builder, $this->action_parameter_token, $this->row_id_token) =
            $this->url_builder->acquireParameters(
                ['datatable', self::TABLE_ID],
                self::TABLE_ACTION_ID,
                self::ROW_ID
            );
        $actions = [];
        foreach ($this->data_retrieval->getAllActions() as $command => $txt) {
            $actions[$command] = $this->ui->factory()->table()->action()->single(
                $txt,
                $this->url_builder->withParameter($this->action_parameter_token, $command),
                $this->row_id_token
            );
        }
        return $actions;
    }

References ILIAS\Repository\ui().

Referenced by ILIAS\SystemCheck\Table\Task\Handler\initTable().

Here is the call graph for this function:

Here is the caller graph for this function:

getColumns()

ILIAS\SystemCheck\Table\Task\Handler::getColumns ( )

finalprotected

Definition at line 69 of file Handler.php.

                                         : array
    {
        return [
            self::TABLE_COL_TITLE => $this->ui->factory()->table()->column()->text(
                $this->lng->txt(self::LNG_TABLE_COL_TITLE)
            )->withIsSortable(true),
            self::TABLE_COL_DESCRIPTION => $this->ui->factory()->table()->column()->text(
                $this->lng->txt(self::LNG_TABLE_COL_DESCRIPTION)
            )->withIsSortable(true),
            self::TABLE_COL_LAST_UPDATE => $this->ui->factory()->table()->column()->text(
                $this->lng->txt(self::LNG_TABLE_COL_LAST_UPDATE)
            )->withIsSortable(true),
            self::TABLE_COL_STATUS => $this->ui->factory()->table()->column()->text(
                $this->lng->txt(self::LNG_TABLE_COL_STATUS)
            )->withIsSortable(true)
        ];
    }

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

Here is the call graph for this function:

getHTML()

ILIAS\SystemCheck\Table\Task\Handler::getHTML ( )

final

Implements ILIAS\SystemCheck\I\Table\Task\HandlerInterface.

Definition at line 128 of file Handler.php.

                                   : string
    {
        return $this->ui->renderer()->render([$this->getTable()]);
    }

References ILIAS\SystemCheck\Table\Task\Handler\getTable(), and ILIAS\Repository\ui().

Here is the call graph for this function:

getTable()

ILIAS\SystemCheck\Table\Task\Handler::getTable ( )

finalprotected

Definition at line 123 of file Handler.php.

                                       : DataTable
    {
        return $this->table;
    }

References ILIAS\SystemCheck\Table\Task\Handler\$table.

Referenced by ILIAS\SystemCheck\Table\Task\Handler\getHTML().

Here is the caller graph for this function:

handleTableActions()

ILIAS\SystemCheck\Table\Task\Handler::handleTableActions ( )

final

Implements ILIAS\SystemCheck\I\Table\Task\HandlerInterface.

Definition at line 133 of file Handler.php.

                                              : void
    {
        if (!$this->http->wrapper()->query()->has($this->action_parameter_token->getName())) {
            return;
        }
        if (!$this->http->wrapper()->query()->has($this->row_id_token->getName())) {
            return;
        }
        if (!$this->actions_permitted) {
            return;
        }
        $action = $this->http->wrapper()->query()->retrieve(
            $this->action_parameter_token->getName(),
            $this->refinery->kindlyTo()->string()
        );
        $tokens = $this->http->wrapper()->query()->retrieve(
            $this->row_id_token->getName(),
            $this->refinery->kindlyTo()->listOf($this->refinery->kindlyTo()->int())
        );
        $task_id = (int) $tokens[0];
        $task_handler = ilSCComponentTaskFactory::getComponentTask($task_id);
        $this->ctrl->setParameterByClass(get_class($task_handler), 'task_id', $task_id);
        $this->ctrl->redirectByClass(get_class($task_handler), $action);
        $this->ctrl->clearParameterByClass(get_class($task_handler), 'task_id');
    }

References ILIAS\Repository\ctrl(), ilSCComponentTaskFactory\getComponentTask(), ILIAS\FileDelivery\http(), and ILIAS\Repository\int().

Here is the call graph for this function:

initTable()

ILIAS\SystemCheck\Table\Task\Handler::initTable ( )

finalprotected

Definition at line 110 of file Handler.php.

                                        : void
    {
        if (!isset($this->table)) {
            $this->table = $this->ui->factory()->table()->data(
                $this->data_retrieval,
                $this->lng->txt(self::LNG_TABLE_TITLE),
                $this->getColumns(),
            )
                ->withActions($this->getActions())
                ->withId(self::TABLE_ID)->withRequest($this->http->request());
        }
    }

References ILIAS\SystemCheck\Table\Task\Handler\getActions(), ILIAS\FileDelivery\http(), ILIAS\Repository\lng(), and ILIAS\Repository\ui().

Referenced by ILIAS\SystemCheck\Table\Task\Handler\__construct().

Here is the call graph for this function:

Here is the caller graph for this function:

Field Documentation

$action_parameter_token

ilURLBuilderToken ILIAS\SystemCheck\Table\Task\Handler::$action_parameter_token

protected

Definition at line 53 of file Handler.php.

$row_id_token

ilURLBuilderToken ILIAS\SystemCheck\Table\Task\Handler::$row_id_token

protected

Definition at line 54 of file Handler.php.

$table

DataTable ILIAS\SystemCheck\Table\Task\Handler::$table

protected

Definition at line 51 of file Handler.php.

Referenced by ILIAS\SystemCheck\Table\Task\Handler\getTable().

$url_builder

URLBuilder ILIAS\SystemCheck\Table\Task\Handler::$url_builder

protected

Definition at line 52 of file Handler.php.

LNG_TABLE_COL_DESCRIPTION

const string ILIAS\SystemCheck\Table\Task\Handler::LNG_TABLE_COL_DESCRIPTION = 'description'

protected

Definition at line 47 of file Handler.php.

LNG_TABLE_COL_LAST_UPDATE

const string ILIAS\SystemCheck\Table\Task\Handler::LNG_TABLE_COL_LAST_UPDATE = 'last_update'

protected

Definition at line 48 of file Handler.php.

LNG_TABLE_COL_STATUS

const string ILIAS\SystemCheck\Table\Task\Handler::LNG_TABLE_COL_STATUS = 'status'

protected

Definition at line 49 of file Handler.php.

LNG_TABLE_COL_TITLE

const string ILIAS\SystemCheck\Table\Task\Handler::LNG_TABLE_COL_TITLE = 'title'

protected

Definition at line 46 of file Handler.php.

LNG_TABLE_TITLE

const string ILIAS\SystemCheck\Table\Task\Handler::LNG_TABLE_TITLE = 'sysc_task_overview'

protected

Definition at line 45 of file Handler.php.

ROW_ID

const string ILIAS\SystemCheck\Table\Task\Handler::ROW_ID = "row_ids"

protected

Definition at line 40 of file Handler.php.

TABLE_ACTION_ID

const string ILIAS\SystemCheck\Table\Task\Handler::TABLE_ACTION_ID = "table_action"

protected

Definition at line 39 of file Handler.php.

TABLE_COL_DESCRIPTION

const string ILIAS\SystemCheck\Table\Task\Handler::TABLE_COL_DESCRIPTION = 'description'

Definition at line 42 of file Handler.php.

TABLE_COL_LAST_UPDATE

const string ILIAS\SystemCheck\Table\Task\Handler::TABLE_COL_LAST_UPDATE = 'last_update'

Definition at line 43 of file Handler.php.

TABLE_COL_STATUS

const string ILIAS\SystemCheck\Table\Task\Handler::TABLE_COL_STATUS = 'status'

Definition at line 44 of file Handler.php.

TABLE_COL_TITLE

const string ILIAS\SystemCheck\Table\Task\Handler::TABLE_COL_TITLE = 'title'

Definition at line 41 of file Handler.php.

TABLE_ID

const string ILIAS\SystemCheck\Table\Task\Handler::TABLE_ID = "sc_groups"

protected

Definition at line 38 of file Handler.php.

---

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

• components/ILIAS/SystemCheck/classes/Table/Task/Handler.php