Collaboration diagram for ILIAS\Repository\Table\TableAdapterGUI:

Public Member Functions
	__construct (protected string $id, protected string $title, protected RetrievalInterface $retrieval, protected object $parent_gui, protected string $parent_cmd="tableCommand", protected string $namespace="", protected string $ordering_cmd="", protected ?\Closure $active_action_closure=null, protected ?\Closure $row_transformer=null, protected bool $numeric_ids=true)

	textColumn (string $key, string $title, bool $sortable=false)

	iconColumn (string $key, string $title, bool $sortable=false)

	dateColumn (string $key, string $title, bool $sortable=false)

	linkColumn (string $key, string $title, bool $sortable=false)

	linkListingColumn (string $key, string $title, bool $sortable=false)

	singleAction (string $action, string $title, bool $async=false)

	singleRedirectAction (string $action, string $title, array $class_path, string $cmd="", string $id_param="", bool $async=false)

	standardAction (string $action, string $title)

	multiAction (string $action, string $title)

	filterData (array $filter_data)
	Not applied if the table supports ordering. More...

	handleCommand ()

	getData ()

	render ()

	renderDeletionConfirmation (string $modal_title, string $modal_message, string $delete_cmd, array $items)

Protected Member Functions
	addAction (int $type, string $action, string $title, bool $async=false)

	addColumn (string $key, Column $column)

	getColumnForKey (string $key)

	getLastColumn ()

	replaceLastColumn (Column $column)

	getItemIds ()

	getTable ()

Protected Attributes
const int	STANDARD = 0

const int	SINGLE = 1

const int	MULTI = 2

string	$order_cmd = ""

string	$last_action_key

URLBuilderToken	$row_id_token

URLBuilderToken	$action_parameter_token

URLBuilder	$url_builder

ILIAS Data Factory	$df

ilLanguage	$lng

Table	$table = null

string	$last_key

ilCtrlInterface	$ctrl

ILIAS DI UIServices	$ui

ilObjUser	$user

array	$columns = []

array	$actions = []

array	$filter_data = []

Detailed Description

Definition at line 31 of file TableAdapterGUI.php.

Constructor & Destructor Documentation

◆ __construct()

ILIAS\Repository\Table\TableAdapterGUI::__construct	(	protected string	$id,
		protected string	$title,
		protected RetrievalInterface	$retrieval,
		protected object	$parent_gui,
		protected string	$parent_cmd = `"tableCommand"`,
		protected string	$namespace = `""`,
		protected string	$ordering_cmd = `""`,
		protected ?\Closure	$active_action_closure = `null`,
		protected ?\Closure	$row_transformer = `null`,
		protected bool	$numeric_ids = `true`
	)

Definition at line 55 of file TableAdapterGUI.php.

      {
        global $DIC;
        $this->ui = $DIC->ui();
        $this->ctrl = $DIC->ctrl();
        $this->http = $DIC->http();
        $this->lng = $DIC->language();
        $this->refinery = $DIC->refinery();
        $this->user = $DIC->user();
        $this->df = new \ILIAS\Data\Factory();
        $this->initRequest($this->http, $this->refinery);
        if ($namespace === "") {
            $this->namespace = $id;
        }
        $this->order_cmd = $ordering_cmd;
 
        $form_action = $this->df->uri(
            ILIAS_HTTP_PATH . '/' .
            $this->ctrl->getLinkTarget($this->parent_gui, $this->parent_cmd)
        );
        $this->url_builder = new URLBuilder($form_action);
        [$this->url_builder, $this->action_parameter_token, $this->row_id_token] =
            $this->url_builder->acquireParameters(
                [$this->namespace], // namespace
                "table_action", //this is the actions's parameter name
                "ids"   //this is the parameter name to be used for row-ids
            );
 
    }

References ILIAS\Repository\Table\TableAdapterGUI\$action_parameter_token, $DIC, $namespace, ILIAS\Repository\Table\TableAdapterGUI\$row_id_token, ILIAS\Repository\Table\TableAdapterGUI\$url_builder, ILIAS\Repository\ctrl(), ILIAS\Repository\http(), ILIAS\Repository\initRequest(), ILIAS\Repository\lng(), ILIAS\Repository\refinery(), ILIAS\Repository\ui(), and ILIAS\Repository\user().

Here is the call graph for this function:

Member Function Documentation

◆ addAction()

ILIAS\Repository\Table\TableAdapterGUI::addAction	(	int	$type,
		string	$action,
		string	$title,
		bool	$async = `false`
	)

protected

Definition at line 198 of file TableAdapterGUI.php.

                                                                                               : void
    {
        $this->actions[$action] = [
            "type" => $type,
            "action" => $action,
            "title" => $title,
            "async" => $async
        ];
        $this->last_action_key = $action;
    }

◆ addColumn()

ILIAS\Repository\Table\TableAdapterGUI::addColumn	(	string	$key,
		Column	$column
	)

protected

Definition at line 209 of file TableAdapterGUI.php.

                                                             : void
    {
        if ($key === "") {
            throw new \ilException("Missing Input Key: " . $key);
        }
        if (isset($this->columns[$key])) {
            throw new \ilException("Duplicate Input Key: " . $key);
        }
        $this->columns[$key] = $column;
        $this->last_key = $key;
    }

◆ dateColumn()

ILIAS\Repository\Table\TableAdapterGUI::dateColumn	(	string	$key,
		string	$title,
		bool	$sortable = `false`
	)

Definition at line 115 of file TableAdapterGUI.php.

     : self {
        $column = $this->ui->factory()->table()->column()->date($title, $this->user->getDateTimeFormat())->withIsSortable($sortable);
        $this->addColumn($key, $column);
        return $this;
    }

◆ filterData()

ILIAS\Repository\Table\TableAdapterGUI::filterData ( array $filter_data )

Not applied if the table supports ordering.

Definition at line 192 of file TableAdapterGUI.php.

                                                  : self
    {
        $this->filter_data = $filter_data;
        return $this;
    }

◆ getColumnForKey()

ILIAS\Repository\Table\TableAdapterGUI::getColumnForKey ( string $key )

protected

Definition at line 221 of file TableAdapterGUI.php.

                                                   : Column
    {
        if (!isset($this->columns[$key])) {
            throw new \ilException("Unknown Key: " . $key);
        }
        return $this->columns[$key];
    }

◆ getData()

ILIAS\Repository\Table\TableAdapterGUI::getData ( )

Definition at line 368 of file TableAdapterGUI.php.

                             : ?array
    {
        return $this->getTable()->getData();
    }

◆ getItemIds()

ILIAS\Repository\Table\TableAdapterGUI::getItemIds ( )

protected

Definition at line 241 of file TableAdapterGUI.php.

                                   : array
    {
        if ($this->numeric_ids) {
            $ids = $this->intArray($this->row_id_token->getName());
        } else {
            $ids = $this->strArray($this->row_id_token->getName());
        }
        if (count($ids) > 0) {
            return $ids;           // from table multi action
        }
        if ($this->numeric_ids) {
            $ids = $this->intArray("interruptive_items");   // from confirmation
        } else {
            $ids = $this->strArray("interruptive_items");   // from confirmation
        }
        if (count($ids) > 0) {
            return $ids;
        }
        return [];
    }

References ILIAS\Repository\intArray(), and ILIAS\Repository\strArray().

Here is the call graph for this function:

◆ getLastColumn()

ILIAS\Repository\Table\TableAdapterGUI::getLastColumn ( )

protected

Definition at line 229 of file TableAdapterGUI.php.

                                      : ?Column
    {
        return $this->columns[$this->last_key] ?? null;
    }

◆ getTable()

ILIAS\Repository\Table\TableAdapterGUI::getTable ( )

protected

Definition at line 290 of file TableAdapterGUI.php.

                                 : Table
    {
        $a = $this->ui->factory()->table()->action();
 
        if (is_null($this->table)) {
            $columns = [];
            foreach ($this->columns as $key => $column) {
                $columns[$key] = $column;
            }
            $actions = [];
            foreach ($this->actions as $act) {
                switch ($act["type"]) {
                    case self::SINGLE:
                        $actions[$act["action"]] = $a->single(
                            $act["title"],
                            $this->url_builder->withParameter($this->action_parameter_token, $act["action"]),
                            $this->row_id_token
                        );
                        break;
                    case self::STANDARD:
                        $actions[$act["action"]] = $a->standard(
                            $act["title"],
                            $this->url_builder->withParameter($this->action_parameter_token, $act["action"]),
                            $this->row_id_token
                        );
                        break;
                    case self::MULTI:
                        $actions[$act["action"]] = $a->multi(
                            $act["title"],
                            $this->url_builder->withParameter($this->action_parameter_token, $act["action"]),
                            $this->row_id_token
                        );
                        break;
                }
                if ($act["async"]) {
                    $actions[$act["action"]] = $actions[$act["action"]]->withAsync(true);
                }
            }
            if ($this->order_cmd !== "") {
                $uri = $this->df->uri(
                    ILIAS_HTTP_PATH . '/' .
                    $this->ctrl->getLinkTarget($this->parent_gui, $this->order_cmd)
                );
                $table_retrieval = new OrderingRetrieval(
                    $this->retrieval,
                    array_keys($actions),
                    $this->active_action_closure,
                    $this->row_transformer
                );
                $this->table = $this
                    ->ui
                    ->factory()
                    ->table()
                    ->ordering($table_retrieval, $uri, $this->title, $columns)
                    ->withId($this->id)
                    ->withActions($actions)
                    ->withRequest($this->http->request());
            } else {
                $table_retrieval = new TableRetrieval(
                    $this->retrieval,
                    array_keys($actions),
                    $this->active_action_closure,
                    $this->row_transformer
                );
                $this->table = $this
                    ->ui
                    ->factory()
                    ->table()
                    ->data($table_retrieval, $this->title, $columns)
                    ->withId($this->id)
                    ->withActions($actions)
                    ->withRequest($this->http->request())
                    ->withFilter($this->filter_data);
            }
        }
        return $this->table;
    }

References Vendor\Package\$a, ILIAS\Repository\ctrl(), ILIAS\FileDelivery\http(), and ILIAS\Repository\ui().

Referenced by ILIAS\LearningModule\Editing\EditSubObjectsGUI\getTable().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ handleCommand()

ILIAS\Repository\Table\TableAdapterGUI::handleCommand ( )

Definition at line 262 of file TableAdapterGUI.php.

                                   : bool
    {
        $action = $this->str($this->action_parameter_token->getName());
        if ($action !== "") {
            if ($this->actions[$action]["type"] === self::SINGLE) {
                $id = $this->getItemIds()[0];
                if ($this->actions[$action]["redirect_class_path"] ?? false) {
                    $path = $this->actions[$action]["redirect_class_path"];
                    if ($this->actions[$action]["redirect_id_param"] ?? false) {
                        $this->ctrl->setParameterByClass(
                            $path[count($path) - 1],
                            $this->actions[$action]["redirect_id_param"],
                            $id
                        );
                    }
                    $cmd = $this->actions[$action]["redirect_cmd"] ?? $action;
                    $this->ctrl->redirectByClass($this->actions[$action]["redirect_class_path"], $cmd);
                }
                $this->parent_gui->$action($id);
                return true;
            } else {
                $this->parent_gui->$action($this->getItemIds());
                return true;
            }
        }
        return false;
    }

References $id, $path, ILIAS\Repository\ctrl(), and ILIAS\Repository\str().

Here is the call graph for this function:

◆ iconColumn()

ILIAS\Repository\Table\TableAdapterGUI::iconColumn	(	string	$key,
		string	$title,
		bool	$sortable = `false`
	)

Definition at line 105 of file TableAdapterGUI.php.

     : self {
        $column = $this->ui->factory()->table()->column()->statusIcon($title)->withIsSortable($sortable);
        $this->addColumn($key, $column);
        return $this;
    }

Referenced by ILIAS\Container\StartObjects\Objects\Table\ObjectsBuilder\build(), ILIAS\Container\StartObjects\Objects\Table\PossibleObjectsBuilder\build(), ILIAS\LearningModule\Editing\SubObjectTableBuilder\build(), ILIAS\MediaObjects\OverviewGUI\Table\Builder\build(), and ILIAS\Repository\Ownership\OwnershipManagementTableBuilder\build().

Here is the caller graph for this function:

◆ linkColumn()

ILIAS\Repository\Table\TableAdapterGUI::linkColumn	(	string	$key,
		string	$title,
		bool	$sortable = `false`
	)

Definition at line 125 of file TableAdapterGUI.php.

     : self {
        $column = $this->ui->factory()->table()->column()->link($title)->withIsSortable($sortable);
        $this->addColumn($key, $column);
        return $this;
    }

◆ linkListingColumn()

ILIAS\Repository\Table\TableAdapterGUI::linkListingColumn	(	string	$key,
		string	$title,
		bool	$sortable = `false`
	)

Definition at line 135 of file TableAdapterGUI.php.

     : self {
        $column = $this->ui->factory()->table()->column()->linkListing($title)->withIsSortable($sortable);
        $this->addColumn($key, $column);
        return $this;
    }

Referenced by ILIAS\MediaObjects\OverviewGUI\Table\Builder\build().

Here is the caller graph for this function:

◆ multiAction()

ILIAS\Repository\Table\TableAdapterGUI::multiAction	(	string	$action,
		string	$title
	)

Definition at line 181 of file TableAdapterGUI.php.

     : self {
        $this->addAction(self::MULTI, $action, $title);
        return $this;
    }

Referenced by ILIAS\Blog\Contributor\ContributorTableBuilder\build(), and ILIAS\Catgory\AssignRoleTableBuilder\build().

Here is the caller graph for this function:

◆ render()

ILIAS\Repository\Table\TableAdapterGUI::render ( )

Definition at line 373 of file TableAdapterGUI.php.

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

References ILIAS\Repository\ui().

Here is the call graph for this function:

◆ renderDeletionConfirmation()

ILIAS\Repository\Table\TableAdapterGUI::renderDeletionConfirmation	(	string	$modal_title,
		string	$modal_message,
		string	$delete_cmd,
		array	$items
	)

Definition at line 379 of file TableAdapterGUI.php.

     : void {
        $f = $this->ui->factory();
        $r = $this->ui->renderer();
        $del_items = [];
        foreach ($items as $id => $title) {
            if (is_array($title)) {
                $key = $title[0] ?? "";
                $val = $title[1] ?? "";
            } else {
                $key = $title;
                $val = "";
            }
            $del_items[] = $f->modal()->interruptiveItem()->keyValue((string) $id, $key, $val);
        }
        $action = $this->ctrl->getLinkTarget($this->parent_gui, $delete_cmd);
 
        echo($r->renderAsync([
            $f->modal()->interruptive(
                $modal_title,
                $modal_message,
                $action
            )->withAffectedItems($del_items)
        ]));
        exit();
    }

References Vendor\Package\$f, and $id.

◆ replaceLastColumn()

ILIAS\Repository\Table\TableAdapterGUI::replaceLastColumn ( Column $column )

protected

Definition at line 234 of file TableAdapterGUI.php.

                                                        : void
    {
        if ($this->last_key !== "") {
            $this->columns[$this->last_key] = $column;
        }
    }

◆ singleAction()

ILIAS\Repository\Table\TableAdapterGUI::singleAction	(	string	$action,
		string	$title,
		bool	$async = `false`
	)

Definition at line 145 of file TableAdapterGUI.php.

     : self {
        $this->addAction(self::SINGLE, $action, $title, $async);
        return $this;
    }

Referenced by ILIAS\Container\Skills\ContSkillMemberTableBuilder\build(), ILIAS\Container\Skills\ContSkillTableBuilder\build(), ILIAS\LearningModule\Editing\SubObjectTableBuilder\build(), and ILIAS\Repository\Ownership\OwnershipManagementTableBuilder\build().

Here is the caller graph for this function:

◆ singleRedirectAction()

ILIAS\Repository\Table\TableAdapterGUI::singleRedirectAction	(	string	$action,
		string	$title,
		array	$class_path,
		string	$cmd = `""`,
		string	$id_param = `""`,
		bool	$async = `false`
	)

Definition at line 154 of file TableAdapterGUI.php.

     : self {
        $this->addAction(self::SINGLE, $action, $title, $async);
        $act = $this->actions[$this->last_action_key] ?? false;
        if ($act && $act["type"] === self::SINGLE) {
            $act["redirect_class_path"] = $class_path;
            $act["redirect_cmd"] = $cmd;
            $act["redirect_id_param"] = $id_param;
            $this->actions[$this->last_action_key] = $act;
        }
        return $this;
    }

Referenced by ILIAS\Container\Skills\ContProfileTableBuilder\build(), and ILIAS\LearningModule\Editing\SubObjectTableBuilder\build().

Here is the caller graph for this function:

◆ standardAction()

ILIAS\Repository\Table\TableAdapterGUI::standardAction	(	string	$action,
		string	$title
	)

Definition at line 173 of file TableAdapterGUI.php.

     : self {
        $this->addAction(self::STANDARD, $action, $title);
        return $this;
    }

Referenced by ILIAS\Container\Skills\ContSkillMemberTableBuilder\build(), and ILIAS\LearningModule\Editing\SubObjectTableBuilder\build().

Here is the caller graph for this function:

◆ textColumn()

ILIAS\Repository\Table\TableAdapterGUI::textColumn	(	string	$key,
		string	$title,
		bool	$sortable = `false`
	)

Definition at line 95 of file TableAdapterGUI.php.

     : self {
        $column = $this->ui->factory()->table()->column()->text($title)->withIsSortable($sortable);
        $this->addColumn($key, $column);
        return $this;
    }

Here is the caller graph for this function:

Field Documentation

◆ $action_parameter_token

URLBuilderToken ILIAS\Repository\Table\TableAdapterGUI::$action_parameter_token

protected

Definition at line 41 of file TableAdapterGUI.php.

Referenced by ILIAS\Repository\Table\TableAdapterGUI\__construct().

◆ $actions

array ILIAS\Repository\Table\TableAdapterGUI::$actions = []

protected

Definition at line 52 of file TableAdapterGUI.php.

◆ $columns

array ILIAS\Repository\Table\TableAdapterGUI::$columns = []

protected

Definition at line 51 of file TableAdapterGUI.php.

◆ $ctrl

ilCtrlInterface ILIAS\Repository\Table\TableAdapterGUI::$ctrl

protected

Definition at line 48 of file TableAdapterGUI.php.

◆ $df

ILIAS Data Factory ILIAS\Repository\Table\TableAdapterGUI::$df

protected

Definition at line 43 of file TableAdapterGUI.php.

◆ $filter_data

array ILIAS\Repository\Table\TableAdapterGUI::$filter_data = []

protected

Definition at line 53 of file TableAdapterGUI.php.

◆ $last_action_key

string ILIAS\Repository\Table\TableAdapterGUI::$last_action_key

protected

Definition at line 39 of file TableAdapterGUI.php.

◆ $last_key

string ILIAS\Repository\Table\TableAdapterGUI::$last_key

protected

Definition at line 47 of file TableAdapterGUI.php.

◆ $lng

ilLanguage ILIAS\Repository\Table\TableAdapterGUI::$lng

protected

Definition at line 45 of file TableAdapterGUI.php.

◆ $order_cmd

string ILIAS\Repository\Table\TableAdapterGUI::$order_cmd = ""

protected

Definition at line 38 of file TableAdapterGUI.php.

◆ $row_id_token

URLBuilderToken ILIAS\Repository\Table\TableAdapterGUI::$row_id_token

protected

Definition at line 40 of file TableAdapterGUI.php.

Referenced by ILIAS\Repository\Table\TableAdapterGUI\__construct().

◆ $table

Table ILIAS\Repository\Table\TableAdapterGUI::$table = null

protected

Definition at line 46 of file TableAdapterGUI.php.

◆ $ui

ILIAS DI UIServices ILIAS\Repository\Table\TableAdapterGUI::$ui

protected

Definition at line 49 of file TableAdapterGUI.php.

◆ $url_builder

URLBuilder ILIAS\Repository\Table\TableAdapterGUI::$url_builder

protected

Definition at line 42 of file TableAdapterGUI.php.

Referenced by ILIAS\Repository\Table\TableAdapterGUI\__construct().

◆ $user

ilObjUser ILIAS\Repository\Table\TableAdapterGUI::$user

protected

Definition at line 50 of file TableAdapterGUI.php.

◆ MULTI

const int ILIAS\Repository\Table\TableAdapterGUI::MULTI = 2

protected

Definition at line 37 of file TableAdapterGUI.php.

◆ SINGLE

const int ILIAS\Repository\Table\TableAdapterGUI::SINGLE = 1

protected

Definition at line 36 of file TableAdapterGUI.php.

◆ STANDARD

const int ILIAS\Repository\Table\TableAdapterGUI::STANDARD = 0

protected

Definition at line 35 of file TableAdapterGUI.php.

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

components/ILIAS/Repository/Service/Table/TableAdapterGUI.php

Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ addAction()

◆ addColumn()

◆ dateColumn()

◆ filterData()

◆ getColumnForKey()

◆ getData()

◆ getItemIds()

◆ getLastColumn()

◆ getTable()

◆ handleCommand()

◆ iconColumn()

◆ linkColumn()

◆ linkListingColumn()

◆ multiAction()

◆ render()

◆ renderDeletionConfirmation()

◆ replaceLastColumn()

◆ singleAction()

◆ singleRedirectAction()

◆ standardAction()

◆ textColumn()

Field Documentation

◆ $action_parameter_token

◆ $actions

◆ $columns

◆ $ctrl

◆ $df

◆ $filter_data

◆ $last_action_key

◆ $last_key

◆ $lng

◆ $order_cmd

◆ $row_id_token

◆ $table

◆ $ui

◆ $url_builder

◆ $user

◆ MULTI

◆ SINGLE

◆ STANDARD