ILIAS\Skill\Table\ProfileTable Class Reference

Collaboration diagram for ILIAS\Skill\Table\ProfileTable:

Public Member Functions
	__construct (int $ref_id, int $skill_tree_id)
	getComponent ()

Protected Member Functions
	getColumns ()
	getActions ()
	getDataRetrieval ()

Protected Attributes
ilCtrl	$ctrl
ilLanguage	$lng
UI Factory	$ui_fac
UI Renderer	$ui_ren
ServerRequestInterface	$request
ArrayBasedRequestWrapper	$query
Data Factory	$df
Access SkillTreeAccess	$tree_access_manager
Profile SkillProfileManager	$profile_manager
Service SkillAdminGUIRequest	$admin_gui_request
string	$requested_table_profile_action = ""
array	$requested_table_profile_ids = []
int	$skill_tree_id = 0

Detailed Description

Author

Thomas Famula famul.nosp@m.a@le.nosp@m.ifos..nosp@m.de

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

Constructor & Destructor Documentation

__construct()

ILIAS\Skill\Table\ProfileTable::__construct	(	int	$ref_id,
		int	$skill_tree_id
	)

Definition at line 55 of file class.ProfileTable.php.

References $DIC, ILIAS\Skill\Table\ProfileTable\$skill_tree_id, ILIAS\Repository\ctrl(), and ILIAS\Repository\lng().

Referenced by ILIAS\Skill\Table\ProfileTable\getDataRetrieval().

    {
        global $DIC;

        $this->ctrl = $DIC->ctrl();
        $this->lng = $DIC->language();
        $this->ui_fac = $DIC->ui()->factory();
        $this->ui_ren = $DIC->ui()->renderer();
        $this->request = $DIC->http()->request();
        $this->query = $DIC->http()->wrapper()->query();
        $this->df = new Data\Factory();
        $this->tree_access_manager = $DIC->skills()->internal()->manager()->getTreeAccessManager($ref_id);
        $this->profile_manager = $DIC->skills()->internal()->manager()->getProfileManager();
        $this->admin_gui_request = $DIC->skills()->internal()->gui()->admin_request();
        $this->requested_table_profile_action = $this->admin_gui_request->getTableProfileAction();
        $this->requested_table_profile_ids = $this->admin_gui_request->getTableProfileIds();
        $this->skill_tree_id = $skill_tree_id;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

Member Function Documentation

getActions()

ILIAS\Skill\Table\ProfileTable::getActions ( )

protected

Definition at line 139 of file class.ProfileTable.php.

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

Referenced by ILIAS\Skill\Table\ProfileTable\getComponent().

                                   : array
    {
        $query_params_namespace = ["skl_profile_table"];

        $uri_edit = $this->df->uri(
            ILIAS_HTTP_PATH . "/" . $this->ctrl->getLinkTargetByClass("ilskillprofilegui", "showLevelsWithTableContext")
        );
        $url_builder_edit = new UI\URLBuilder($uri_edit);
        list($url_builder_edit, $action_parameter_token_edit, $row_id_token_edit) =
            $url_builder_edit->acquireParameters(
                $query_params_namespace,
                "action",
                "profile_ids"
            );

        $url_builder_delete = new UI\URLBuilder($this->df->uri($this->request->getUri()->__toString()));
        list($url_builder_delete, $action_parameter_token_delete, $row_id_token_delete) =
            $url_builder_delete->acquireParameters(
                $query_params_namespace,
                "action",
                "profile_ids"
            );

        $uri_export = $this->df->uri(
            ILIAS_HTTP_PATH . "/" . $this->ctrl->getLinkTargetByClass("ilskillprofilegui", "exportProfiles")
        );
        $url_builder_export = new UI\URLBuilder($uri_export);
        list($url_builder_export, $action_parameter_token_export, $row_id_token_export) =
            $url_builder_export->acquireParameters(
                $query_params_namespace,
                "action",
                "profile_ids"
            );

        $actions = [
            "edit" => $this->ui_fac->table()->action()->single(
                $this->tree_access_manager->hasManageProfilesPermission() ? $this->lng->txt("edit") : $this->lng->txt("show"),
                $url_builder_edit->withParameter($action_parameter_token_edit, "editProfile"),
                $row_id_token_edit
            )
        ];
        if ($this->tree_access_manager->hasManageProfilesPermission()) {
            $actions["delete"] = $this->ui_fac->table()->action()->multi(
                $this->lng->txt("delete"),
                $url_builder_delete->withParameter($action_parameter_token_delete, "deleteProfiles"),
                $row_id_token_delete
            )
                                              ->withAsync();
            $actions["export"] = $this->ui_fac->table()->action()->multi(
                $this->lng->txt("export"),
                $url_builder_export->withParameter($action_parameter_token_export, "exportProfiles"),
                $row_id_token_export
            );
        }

        return $actions;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getColumns()

ILIAS\Skill\Table\ProfileTable::getColumns ( )

protected

Definition at line 124 of file class.ProfileTable.php.

References ILIAS\Repository\lng().

Referenced by ILIAS\Skill\Table\ProfileTable\getComponent().

                                   : array
    {
        $columns = [
            "title" => $this->ui_fac->table()->column()->text($this->lng->txt("title")),
            "context" => $this->ui_fac->table()->column()->text($this->lng->txt("context"))
                                      ->withIsSortable(false),
            "users" => $this->ui_fac->table()->column()->text($this->lng->txt("users"))
                                    ->withIsSortable(false),
            "roles" => $this->ui_fac->table()->column()->text($this->lng->txt("roles"))
                                    ->withIsSortable(false),
        ];

        return $columns;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getComponent()

ILIAS\Skill\Table\ProfileTable::getComponent

(

)

Definition at line 74 of file class.ProfileTable.php.

References $id, ILIAS\Repository\ctrl(), exit, ILIAS\Skill\Table\ProfileTable\getActions(), ILIAS\Skill\Table\ProfileTable\getColumns(), ILIAS\Skill\Table\ProfileTable\getDataRetrieval(), and ILIAS\Repository\lng().

                                  : UI\Component\Table\Data
    {
        $columns = $this->getColumns();
        $actions = $this->getActions();
        $data_retrieval = $this->getDataRetrieval();

        if ($this->requested_table_profile_action === "deleteProfiles") {
            $items = [];
            foreach ($this->requested_table_profile_ids as $id) {
                if ($id === "ALL_OBJECTS") {
                    $profiles = $this->skill_tree_id
                        ? $this->profile_manager->getProfilesForSkillTree($this->skill_tree_id)
                        : $this->profile_manager->getProfilesForAllSkillTrees();
                    foreach ($profiles as $profile) {
                        $items[] = $this->ui_fac->modal()->interruptiveItem()->standard(
                            (string) $profile->getId(),
                            $profile->getTitle()
                        );
                    }
                } else {
                    $items[] = $this->ui_fac->modal()->interruptiveItem()->standard(
                        $id,
                        $this->profile_manager->lookupTitle((int) $id)
                    );
                }
            }
            echo($this->ui_ren->renderAsync([
                $this->ui_fac->modal()->interruptive(
                    "",
                    empty($items) ? $this->lng->txt("no_checkbox") : $this->lng->txt("skmg_delete_profiles"),
                    $this->ctrl->getFormActionByClass("ilskillprofilegui", "deleteProfiles")
                )
                    ->withAffectedItems($items)
                    ->withActionButtonLabel(empty($items) ? $this->lng->txt("ok") : $this->lng->txt("delete"))
            ]));
            exit();
        }

        $table = $this->ui_fac->table()
                              ->data($this->lng->txt("skmg_skill_profiles"), $columns, $data_retrieval)
                              ->withId(
                                  self::class . "_" .
                                  $this->skill_tree_id
                              )
                              ->withActions($actions)
                              ->withRequest($this->request);

        return $table;
    }

Here is the call graph for this function:

getDataRetrieval()

ILIAS\Skill\Table\ProfileTable::getDataRetrieval ( )

protected

Definition at line 197 of file class.ProfileTable.php.

References ILIAS\Skill\Table\ProfileTable\$lng, ILIAS\Skill\Table\ProfileTable\$profile_manager, ILIAS\UI\Implementation\Component\Table\$range, ILIAS\Skill\Table\ProfileTable\$skill_tree_id, ILIAS\Skill\Table\ProfileTable\__construct(), ilObject\_lookupObjectId(), ilObject\_lookupTitle(), and ILIAS\Repository\lng().

Referenced by ILIAS\Skill\Table\ProfileTable\getComponent().

                                         : UI\Component\Table\DataRetrieval
    {
        $data_retrieval = new class (
            $this->lng,
            $this->skill_tree_id,
            $this->profile_manager
        ) implements UI\Component\Table\DataRetrieval {
            use TableRecords;

            public function __construct(
                protected \ilLanguage $lng,
                protected int $skill_tree_id,
                protected Profile\SkillProfileManager $skill_profile_manager
            ) {
            }

            public function getRows(
                UI\Component\Table\DataRowBuilder $row_builder,
                array $visible_column_ids,
                Data\Range $range,
                Data\Order $order,
                ?array $filter_data,
                ?array $additional_parameters
            ): \Generator {
                $records = $this->getRecords($range, $order);
                foreach ($records as $idx => $record) {
                    $row_id = (string) $record["profile_id"];

                    yield $row_builder->buildDataRow($row_id, $record);
                }
            }

            public function getTotalRowCount(
                ?array $filter_data,
                ?array $additional_parameters
            ): ?int {
                return count($this->getRecords());
            }

            protected function getRecords(Data\Range $range = null, Data\Order $order = null): array
            {
                if ($this->skill_tree_id) {
                    $profiles = $this->skill_profile_manager->getProfilesForSkillTree($this->skill_tree_id);
                } else {
                    $profiles = $this->skill_profile_manager->getProfilesForAllSkillTrees();
                }

                $records = [];
                $i = 0;
                foreach ($profiles as $profile) {
                    $records[$i]["profile_id"] = $profile->getId();
                    $records[$i]["title"] = $profile->getTitle();
                    $profile_ref_id = $this->skill_profile_manager->lookupRefId($profile->getId());
                    $profile_obj_id = \ilContainerReference::_lookupObjectId($profile_ref_id);
                    $profile_obj_title = \ilObject::_lookupTitle($profile_obj_id);
                    if ($profile_ref_id > 0) {
                        $records[$i]["context"] = $this->lng->txt("skmg_context_local") . " (" . $profile_obj_title . ")";
                    } else {
                        $records[$i]["context"] = $this->lng->txt("skmg_context_global");
                    }
                    $records[$i]["users"] = $this->skill_profile_manager->countUsers($profile->getId());
                    $records[$i]["roles"] = $this->skill_profile_manager->countRoles($profile->getId());
                    $i++;
                }

                if ($order) {
                    $records = $this->orderRecords($records, $order);
                }

                if ($range) {
                    $records = $this->limitRecords($records, $range);
                }

                return $records;
            }
        };

        return $data_retrieval;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

Field Documentation

$admin_gui_request

Service SkillAdminGUIRequest ILIAS\Skill\Table\ProfileTable::$admin_gui_request

protected

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

$ctrl

ilCtrl ILIAS\Skill\Table\ProfileTable::$ctrl

protected

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

$df

Data Factory ILIAS\Skill\Table\ProfileTable::$df

protected

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

$lng

ilLanguage ILIAS\Skill\Table\ProfileTable::$lng

protected

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

Referenced by ILIAS\Skill\Table\ProfileTable\getDataRetrieval().

$profile_manager

Profile SkillProfileManager ILIAS\Skill\Table\ProfileTable::$profile_manager

protected

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

Referenced by ILIAS\Skill\Table\ProfileTable\getDataRetrieval().

$query

ArrayBasedRequestWrapper ILIAS\Skill\Table\ProfileTable::$query

protected

Definition at line 42 of file class.ProfileTable.php.

$request

ServerRequestInterface ILIAS\Skill\Table\ProfileTable::$request

protected

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

$requested_table_profile_action

string ILIAS\Skill\Table\ProfileTable::$requested_table_profile_action = ""

protected

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

$requested_table_profile_ids

array ILIAS\Skill\Table\ProfileTable::$requested_table_profile_ids = []

protected

Definition at line 52 of file class.ProfileTable.php.

$skill_tree_id

int ILIAS\Skill\Table\ProfileTable::$skill_tree_id = 0

protected

Definition at line 53 of file class.ProfileTable.php.

Referenced by ILIAS\Skill\Table\ProfileTable\__construct(), and ILIAS\Skill\Table\ProfileTable\getDataRetrieval().

$tree_access_manager

Access SkillTreeAccess ILIAS\Skill\Table\ProfileTable::$tree_access_manager

protected

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

$ui_fac

UI Factory ILIAS\Skill\Table\ProfileTable::$ui_fac

protected

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

$ui_ren

UI Renderer ILIAS\Skill\Table\ProfileTable::$ui_ren

protected

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

---

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

• Services/Skill/Table/classes/class.ProfileTable.php