Collaboration diagram for ILIAS\Course\Grouping\Table\GroupingHandler:

Public Member Functions
	__construct (protected string $action, protected int $content_obj_id, protected ilLanguage $lng, protected UIFactory $ui_factory, protected DataFactory $data_factory, protected HTTP $http, protected Refinery $refinery, StaticURL $static_url)

	getTable ()

	getSelectedTableAction ()

	getSelectedGroupingIDs ()

Data Fields
const string	ACTION_DELETE = 'delete'

const string	ACTION_EDIT = 'edit'

const string	COL_TITLE = 'title'

const string	COL_DESCRIPTION = 'description'

const string	COL_SOURCE = 'source'

const string	COL_UNIQUE_FIELD = 'unique_field'

const string	COL_ASSIGNED_OBJS = 'assigned_objs'

Protected Member Functions
	buildColumns ()

	buildActions ()

	URLBuilder ()

	actionToken ()

	IDToken ()

	initURLBuilderAndTokens ()

Protected Attributes
const string	ID = 'grouping_id'

const string	ACTION = 'table_action'

const string	NAMESPACE = 'grouping'

URLBuilder	$url_builder

URLBuilderToken	$action_token

URLBuilderToken	$id_token

DataRetrieval	$data_retrieval

Detailed Description

Definition at line 37 of file GroupingHandler.php.

Constructor & Destructor Documentation

◆ __construct()

ILIAS\Course\Grouping\Table\GroupingHandler::__construct	(	protected string	$action,
		protected int	$content_obj_id,
		protected ilLanguage	$lng,
		protected UIFactory	$ui_factory,
		protected DataFactory	$data_factory,
		protected HTTP	$http,
		protected Refinery	$refinery,
		StaticURL	$static_url
	)

Definition at line 57 of file GroupingHandler.php.

References ILIAS\Repository\lng().

       {
         $this->data_retrieval = new GroupingRetrieval(
             $this->content_obj_id,
             $this->lng,
             $this->ui_factory,
             $this->data_factory,
             $static_url
         );
     }

Here is the call graph for this function:

Member Function Documentation

◆ actionToken()

ILIAS\Course\Grouping\Table\GroupingHandler::actionToken ( )

protected

Definition at line 130 of file GroupingHandler.php.

References ILIAS\Course\Grouping\Table\GroupingHandler\$action_token, and ILIAS\Course\Grouping\Table\GroupingHandler\initURLBuilderAndTokens().

Referenced by ILIAS\Course\Grouping\Table\GroupingHandler\buildActions(), and ILIAS\Course\Grouping\Table\GroupingHandler\getSelectedTableAction().

                                     : URLBuilderToken
     {
         if (!isset($this->action_token)) {
             $this->initURLBuilderAndTokens();
         }
         return $this->action_token;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ buildActions()

ILIAS\Course\Grouping\Table\GroupingHandler::buildActions ( )

protected

Returns: Action[]

Definition at line 105 of file GroupingHandler.php.

References Vendor\Package\$f, ILIAS\Course\Grouping\Table\GroupingHandler\actionToken(), ILIAS\Course\Grouping\Table\GroupingHandler\IDToken(), ILIAS\Repository\lng(), and ILIAS\Course\Grouping\Table\GroupingHandler\URLBuilder().

Referenced by ILIAS\Course\Grouping\Table\GroupingHandler\getTable().

                                      : array
     {
         $f = $this->ui_factory->table()->action();
         return [
             self::ACTION_EDIT => $f->single(
                 $this->lng->txt('edit'),
                 $this->URLBuilder()->withParameter($this->actionToken(), self::ACTION_EDIT),
                 $this->IDToken()
             ),
             self::ACTION_DELETE => $f->standard(
                 $this->lng->txt('delete'),
                 $this->URLBuilder()->withParameter($this->actionToken(), self::ACTION_DELETE),
                 $this->IDToken()
             )
         ];
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ buildColumns()

ILIAS\Course\Grouping\Table\GroupingHandler::buildColumns ( )

protected

Returns: Column[]

Definition at line 89 of file GroupingHandler.php.

References Vendor\Package\$f, ilObject\_lookupType(), and ILIAS\Repository\lng().

Referenced by ILIAS\Course\Grouping\Table\GroupingHandler\getTable().

                                      : array
     {
         $f = $this->ui_factory->table()->column();
         $type = ilObject::_lookupType($this->content_obj_id);
         return [
             self::COL_TITLE => $f->text($this->lng->txt('title'))->withIsSortable(true),
             self::COL_DESCRIPTION => $f->text($this->lng->txt('description'))->withIsSortable(true),
             self::COL_SOURCE => $f->link($this->lng->txt('groupings_source'))->withIsSortable(true),
             self::COL_UNIQUE_FIELD => $f->text($this->lng->txt('unambiguousness'))->withIsSortable(true),
             self::COL_ASSIGNED_OBJS => $f->linkListing($this->lng->txt('groupings_assigned_obj_' . $type))->withIsSortable(true)
         ];
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getSelectedGroupingIDs()

ILIAS\Course\Grouping\Table\GroupingHandler::getSelectedGroupingIDs ( )

Returns: int[]

Definition at line 176 of file GroupingHandler.php.

References ILIAS\Course\Grouping\Table\GroupingHandler\$data_retrieval, ILIAS\FileDelivery\http(), ILIAS\Course\Grouping\Table\GroupingHandler\IDToken(), and ILIAS\Repository\refinery().

                                             : array
     {
         $grouping_ids = [];
         $data_retrieval = $this->data_retrieval;
 
         $retrieval_trafo = $this->refinery->byTrying([
             $this->refinery->custom()->transformation(function ($v) use ($data_retrieval) {
                 if ((string) $v[0] === 'ALL_OBJECTS') {
                     return $data_retrieval->getAllGroupingIDs();
                 }
                 throw new \Exception('not all selected');
             }),
             $this->refinery->kindlyTo()->listOf(
                 $this->refinery->kindlyTo()->int()
             )
         ]);
 
         if ($this->http->wrapper()->query()->has($this->IDToken()->getName())) {
             $grouping_ids = $this->http->wrapper()->query()->retrieve(
                 $this->IDToken()->getName(),
                 $retrieval_trafo
             );
         }
 
         return $grouping_ids;
     }

Here is the call graph for this function:

◆ getSelectedTableAction()

ILIAS\Course\Grouping\Table\GroupingHandler::getSelectedTableAction ( )

Definition at line 161 of file GroupingHandler.php.

References ILIAS\Course\Grouping\Table\GroupingHandler\actionToken(), ILIAS\FileDelivery\http(), and ILIAS\Repository\refinery().

                                             : string
     {
         $action = '';
         if ($this->http->wrapper()->query()->has($this->actionToken()->getName())) {
             $action = $this->http->wrapper()->query()->retrieve(
                 $this->actionToken()->getName(),
                 $this->refinery->identity()
             );
         }
         return $action;
     }

Here is the call graph for this function:

◆ getTable()

ILIAS\Course\Grouping\Table\GroupingHandler::getTable ( )

Definition at line 76 of file GroupingHandler.php.

References ILIAS\Course\Grouping\Table\GroupingHandler\buildActions(), ILIAS\Course\Grouping\Table\GroupingHandler\buildColumns(), ILIAS\FileDelivery\http(), and ILIAS\Repository\lng().

                               : DataTable
     {
         return $this->ui_factory->table()->data(
             $this->data_retrieval,
             $this->lng->txt('groupings'),
             $this->buildColumns()
         )->withRequest($this->http->request())
          ->withActions($this->buildActions());
     }

Here is the call graph for this function:

◆ IDToken()

ILIAS\Course\Grouping\Table\GroupingHandler::IDToken ( )

protected

Definition at line 138 of file GroupingHandler.php.

References ILIAS\Course\Grouping\Table\GroupingHandler\$id_token, and ILIAS\Course\Grouping\Table\GroupingHandler\initURLBuilderAndTokens().

Referenced by ILIAS\Course\Grouping\Table\GroupingHandler\buildActions(), and ILIAS\Course\Grouping\Table\GroupingHandler\getSelectedGroupingIDs().

                                 : URLBuilderToken
     {
         if (!isset($this->id_token)) {
             $this->initURLBuilderAndTokens();
         }
         return $this->id_token;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ initURLBuilderAndTokens()

ILIAS\Course\Grouping\Table\GroupingHandler::initURLBuilderAndTokens ( )

protected

Definition at line 146 of file GroupingHandler.php.

References ILIAS\Course\Grouping\Table\GroupingHandler\$action_token, ILIAS\Course\Grouping\Table\GroupingHandler\$id_token, ILIAS\Course\Grouping\Table\GroupingHandler\$url_builder, ILIAS\UI\URLBuilder\acquireParameters(), and ILIAS\Course\Grouping\Table\GroupingHandler\URLBuilder().

Referenced by ILIAS\Course\Grouping\Table\GroupingHandler\actionToken(), ILIAS\Course\Grouping\Table\GroupingHandler\IDToken(), and ILIAS\Course\Grouping\Table\GroupingHandler\URLBuilder().

                                                 : void
     {
         $url_builder = new URLBuilder($this->data_factory->uri(
             ltrim(ILIAS_HTTP_PATH, '/') . '/' . $this->action
         ));
         list($url_builder, $action_token, $id_token) = $url_builder->acquireParameters(
             [self::NAMESPACE],
             self::ACTION,
             self::ID
         );
         $this->url_builder = $url_builder;
         $this->action_token = $action_token;
         $this->id_token = $id_token;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ URLBuilder()

ILIAS\Course\Grouping\Table\GroupingHandler::URLBuilder ( )

protected

Definition at line 122 of file GroupingHandler.php.

References ILIAS\Course\Grouping\Table\GroupingHandler\$url_builder, and ILIAS\Course\Grouping\Table\GroupingHandler\initURLBuilderAndTokens().

Referenced by ILIAS\Course\Grouping\Table\GroupingHandler\buildActions(), and ILIAS\Course\Grouping\Table\GroupingHandler\initURLBuilderAndTokens().

                                    : URLBuilder
     {
         if (!isset($this->url_builder)) {
             $this->initURLBuilderAndTokens();
         }
         return $this->url_builder;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

Field Documentation

◆ $action_token

URLBuilderToken ILIAS\Course\Grouping\Table\GroupingHandler::$action_token

protected

Definition at line 53 of file GroupingHandler.php.

Referenced by ILIAS\Course\Grouping\Table\GroupingHandler\actionToken(), and ILIAS\Course\Grouping\Table\GroupingHandler\initURLBuilderAndTokens().

◆ $data_retrieval

DataRetrieval ILIAS\Course\Grouping\Table\GroupingHandler::$data_retrieval

protected

Definition at line 55 of file GroupingHandler.php.

Referenced by ILIAS\Course\Grouping\Table\GroupingHandler\getSelectedGroupingIDs().

◆ $id_token

URLBuilderToken ILIAS\Course\Grouping\Table\GroupingHandler::$id_token

protected

Definition at line 54 of file GroupingHandler.php.

Referenced by ILIAS\Course\Grouping\Table\GroupingHandler\IDToken(), and ILIAS\Course\Grouping\Table\GroupingHandler\initURLBuilderAndTokens().

◆ $url_builder

URLBuilder ILIAS\Course\Grouping\Table\GroupingHandler::$url_builder

protected

Definition at line 52 of file GroupingHandler.php.

Referenced by ILIAS\Course\Grouping\Table\GroupingHandler\initURLBuilderAndTokens(), and ILIAS\Course\Grouping\Table\GroupingHandler\URLBuilder().

◆ ACTION

const string ILIAS\Course\Grouping\Table\GroupingHandler::ACTION = 'table_action'

protected

Definition at line 40 of file GroupingHandler.php.

◆ ACTION_DELETE

const string ILIAS\Course\Grouping\Table\GroupingHandler::ACTION_DELETE = 'delete'

Definition at line 43 of file GroupingHandler.php.

◆ ACTION_EDIT

const string ILIAS\Course\Grouping\Table\GroupingHandler::ACTION_EDIT = 'edit'

Definition at line 44 of file GroupingHandler.php.

◆ COL_ASSIGNED_OBJS

const string ILIAS\Course\Grouping\Table\GroupingHandler::COL_ASSIGNED_OBJS = 'assigned_objs'

Definition at line 50 of file GroupingHandler.php.

Referenced by ILIAS\Course\Grouping\Table\GroupingRetrieval\getRows(), and ILIAS\Course\Grouping\Table\GroupingRetrieval\sortRecords().

◆ COL_DESCRIPTION

const string ILIAS\Course\Grouping\Table\GroupingHandler::COL_DESCRIPTION = 'description'

Definition at line 47 of file GroupingHandler.php.

Referenced by ILIAS\Course\Grouping\Table\GroupingRetrieval\getRows(), and ILIAS\Course\Grouping\Table\GroupingRetrieval\sortRecords().

◆ COL_SOURCE

const string ILIAS\Course\Grouping\Table\GroupingHandler::COL_SOURCE = 'source'

Definition at line 48 of file GroupingHandler.php.

Referenced by ILIAS\Course\Grouping\Table\GroupingRetrieval\getRows(), and ILIAS\Course\Grouping\Table\GroupingRetrieval\sortRecords().

◆ COL_TITLE

const string ILIAS\Course\Grouping\Table\GroupingHandler::COL_TITLE = 'title'

Definition at line 46 of file GroupingHandler.php.

Referenced by ILIAS\Course\Grouping\Table\GroupingRetrieval\getRows(), and ILIAS\Course\Grouping\Table\GroupingRetrieval\sortRecords().

◆ COL_UNIQUE_FIELD

const string ILIAS\Course\Grouping\Table\GroupingHandler::COL_UNIQUE_FIELD = 'unique_field'

Definition at line 49 of file GroupingHandler.php.

Referenced by ILIAS\Course\Grouping\Table\GroupingRetrieval\getRows(), and ILIAS\Course\Grouping\Table\GroupingRetrieval\sortRecords().

◆ ID

const string ILIAS\Course\Grouping\Table\GroupingHandler::ID = 'grouping_id'

protected

Definition at line 39 of file GroupingHandler.php.

◆ NAMESPACE

const string ILIAS\Course\Grouping\Table\GroupingHandler::NAMESPACE = 'grouping'

protected

Definition at line 41 of file GroupingHandler.php.

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

components/ILIAS/Course/classes/Grouping/Table/GroupingHandler.php

Public Member Functions

Data Fields

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ actionToken()

◆ buildActions()

◆ buildColumns()

◆ getSelectedGroupingIDs()

◆ getSelectedTableAction()

◆ getTable()

◆ IDToken()

◆ initURLBuilderAndTokens()

◆ URLBuilder()

Field Documentation

◆ $action_token

◆ $data_retrieval

◆ $id_token

◆ $url_builder

◆ ACTION

◆ ACTION_DELETE

◆ ACTION_EDIT

◆ COL_ASSIGNED_OBJS

◆ COL_DESCRIPTION

◆ COL_SOURCE

◆ COL_TITLE

◆ COL_UNIQUE_FIELD

◆ ID

◆ NAMESPACE