Collaboration diagram for ILIAS\LearningModule\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="")

	ordering (string $order_cmd)

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

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

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

	redirect (array $class_path, string $cmd="", string $id_param="")

	standardAction (string $action, string $title)

	multiAction (string $action, string $title)

	getItemIds ()

	handleCommand ()

	getData ()

	render ()

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)

	getTable ()

Protected Attributes
const	STANDARD = 0

const	SINGLE = 1

const	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

array	$columns = []

array	$actions = []

Detailed Description

Definition at line 29 of file class.TableAdapterGUI.php.

Constructor & Destructor Documentation

◆ __construct()

ILIAS\LearningModule\Table\TableAdapterGUI::__construct	(	protected string	$id,
		protected string	$title,
		protected RetrievalInterface	$retrieval,
		protected object	$parent_gui,
		protected string	$parent_cmd = `"tableCommand"`,
		protected string	$namespace = `""`
	)

Definition at line 51 of file class.TableAdapterGUI.php.

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

       {
         global $DIC;
         $this->ui = $DIC->ui();
         $this->ctrl = $DIC->ctrl();
         $this->http = $DIC->http();
         $this->lng = $DIC->language();
         $this->refinery = $DIC->refinery();
         $this->df = new \ILIAS\Data\Factory();
         $this->initRequest($this->http, $this->refinery);
         if ($namespace === "") {
             $this->namespace = $id;
         }
 
         $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
             );
 
     }

Here is the call graph for this function:

Member Function Documentation

◆ addAction()

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

protected

Definition at line 152 of file class.TableAdapterGUI.php.

Referenced by ILIAS\LearningModule\Table\TableAdapterGUI\multiAction(), ILIAS\LearningModule\Table\TableAdapterGUI\singleAction(), and ILIAS\LearningModule\Table\TableAdapterGUI\standardAction().

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

Here is the caller graph for this function:

◆ addColumn()

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

protected

Definition at line 163 of file class.TableAdapterGUI.php.

Referenced by ILIAS\LearningModule\Table\TableAdapterGUI\iconColumn(), and ILIAS\LearningModule\Table\TableAdapterGUI\textColumn().

                                                              : 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;
     }

Here is the caller graph for this function:

◆ getColumnForKey()

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

protected

Definition at line 175 of file class.TableAdapterGUI.php.

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

◆ getData()

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

Definition at line 300 of file class.TableAdapterGUI.php.

References ILIAS\LearningModule\Table\TableAdapterGUI\getTable().

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

Here is the call graph for this function:

◆ getItemIds()

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

Definition at line 195 of file class.TableAdapterGUI.php.

References ILIAS\Repository\intArray().

Referenced by ILIAS\LearningModule\Table\TableAdapterGUI\handleCommand().

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getLastColumn()

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

protected

Definition at line 183 of file class.TableAdapterGUI.php.

References ILIAS\LearningModule\Table\TableAdapterGUI\$last_key, and null.

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

◆ getTable()

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

protected

Definition at line 233 of file class.TableAdapterGUI.php.

References Vendor\Package\$a, ILIAS\LearningModule\Table\TableAdapterGUI\$row_id_token, ILIAS\LearningModule\Table\TableAdapterGUI\$table, ILIAS\Repository\ctrl(), ILIAS\FileDelivery\http(), and ILIAS\Repository\ui().

Referenced by ILIAS\LearningModule\Table\TableAdapterGUI\getData(), and ILIAS\LearningModule\Table\TableAdapterGUI\render().

                                  : 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);
                 $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);
                 $this->table = $this
                     ->ui
                     ->factory()
                     ->table()
                     ->data($table_retrieval, $this->title, $columns)
                     ->withId($this->id)
                     ->withActions($actions)
                     ->withRequest($this->http->request());
             }
         }
         return $this->table;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ handleCommand()

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

Definition at line 208 of file class.TableAdapterGUI.php.

References $id, $path, ILIAS\Repository\ctrl(), ILIAS\LearningModule\Table\TableAdapterGUI\getItemIds(), and ILIAS\Repository\str().

                                    : void
     {
         $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);
             } else {
                 $this->parent_gui->$action($this->getItemIds());
             }
         }
     }

Here is the call graph for this function:

◆ iconColumn()

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

Definition at line 102 of file class.TableAdapterGUI.php.

References ILIAS\LearningModule\Table\TableAdapterGUI\addColumn(), and ILIAS\Repository\ui().

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

Here is the call graph for this function:

◆ multiAction()

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

Definition at line 144 of file class.TableAdapterGUI.php.

References ILIAS\LearningModule\Table\TableAdapterGUI\addAction().

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

Here is the call graph for this function:

◆ ordering()

ILIAS\LearningModule\Table\TableAdapterGUI::ordering ( string $order_cmd )

Definition at line 85 of file class.TableAdapterGUI.php.

References ILIAS\LearningModule\Table\TableAdapterGUI\$order_cmd.

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

◆ redirect()

ILIAS\LearningModule\Table\TableAdapterGUI::redirect	(	array	$class_path,
		string	$cmd = `""`,
		string	$id_param = `""`
	)

Definition at line 121 of file class.TableAdapterGUI.php.

References ILIAS\LearningModule\Table\TableAdapterGUI\$last_action_key.

      : self {
         $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;
     }

◆ render()

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

Definition at line 305 of file class.TableAdapterGUI.php.

References ILIAS\LearningModule\Table\TableAdapterGUI\getTable(), and ILIAS\Repository\ui().

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

Here is the call graph for this function:

◆ replaceLastColumn()

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

protected

Definition at line 188 of file class.TableAdapterGUI.php.

References ILIAS\LearningModule\Table\TableAdapterGUI\$last_key.

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

◆ singleAction()

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

Definition at line 112 of file class.TableAdapterGUI.php.

References ILIAS\LearningModule\Table\TableAdapterGUI\addAction().

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

Here is the call graph for this function:

◆ standardAction()

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

Definition at line 136 of file class.TableAdapterGUI.php.

References ILIAS\LearningModule\Table\TableAdapterGUI\addAction().

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

Here is the call graph for this function:

◆ textColumn()

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

Definition at line 92 of file class.TableAdapterGUI.php.

References ILIAS\LearningModule\Table\TableAdapterGUI\addColumn(), and ILIAS\Repository\ui().

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

Here is the call graph for this function:

Field Documentation

◆ $action_parameter_token

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

protected

Definition at line 39 of file class.TableAdapterGUI.php.

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

◆ $actions

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

protected

Definition at line 49 of file class.TableAdapterGUI.php.

◆ $columns

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

protected

Definition at line 48 of file class.TableAdapterGUI.php.

◆ $ctrl

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

protected

Definition at line 46 of file class.TableAdapterGUI.php.

◆ $df

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

protected

Definition at line 41 of file class.TableAdapterGUI.php.

◆ $last_action_key

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

protected

Definition at line 37 of file class.TableAdapterGUI.php.

Referenced by ILIAS\LearningModule\Table\TableAdapterGUI\redirect().

◆ $last_key

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

protected

Definition at line 45 of file class.TableAdapterGUI.php.

Referenced by ILIAS\LearningModule\Table\TableAdapterGUI\getLastColumn(), and ILIAS\LearningModule\Table\TableAdapterGUI\replaceLastColumn().

◆ $lng

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

protected

Definition at line 43 of file class.TableAdapterGUI.php.

◆ $order_cmd

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

protected

Definition at line 36 of file class.TableAdapterGUI.php.

Referenced by ILIAS\LearningModule\Table\TableAdapterGUI\ordering().

◆ $row_id_token

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

protected

Definition at line 38 of file class.TableAdapterGUI.php.

Referenced by ILIAS\LearningModule\Table\TableAdapterGUI\__construct(), and ILIAS\LearningModule\Table\TableAdapterGUI\getTable().

◆ $table

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

protected

Definition at line 44 of file class.TableAdapterGUI.php.

Referenced by ILIAS\LearningModule\Table\TableAdapterGUI\getTable().

◆ $ui

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

protected

Definition at line 47 of file class.TableAdapterGUI.php.

◆ $url_builder

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

protected

Definition at line 40 of file class.TableAdapterGUI.php.

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

◆ MULTI

const ILIAS\LearningModule\Table\TableAdapterGUI::MULTI = 2

protected

Definition at line 35 of file class.TableAdapterGUI.php.

◆ SINGLE

const ILIAS\LearningModule\Table\TableAdapterGUI::SINGLE = 1

protected

Definition at line 34 of file class.TableAdapterGUI.php.

◆ STANDARD

const ILIAS\LearningModule\Table\TableAdapterGUI::STANDARD = 0

protected

Definition at line 33 of file class.TableAdapterGUI.php.

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

components/ILIAS/LearningModule/Editing/class.TableAdapterGUI.php

Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ addAction()

◆ addColumn()

◆ getColumnForKey()

◆ getData()

◆ getItemIds()

◆ getLastColumn()

◆ getTable()

◆ handleCommand()

◆ iconColumn()

◆ multiAction()

◆ ordering()

◆ redirect()

◆ render()

◆ replaceLastColumn()

◆ singleAction()

◆ standardAction()

◆ textColumn()

Field Documentation

◆ $action_parameter_token

◆ $actions

◆ $columns

◆ $ctrl

◆ $df

◆ $last_action_key

◆ $last_key

◆ $lng

◆ $order_cmd

◆ $row_id_token

◆ $table

◆ $ui

◆ $url_builder

◆ MULTI

◆ SINGLE

◆ STANDARD