ilTaxMDGUI Class Reference

Taxonomies selection for metadata helper GUI. More...

Collaboration diagram for ilTaxMDGUI:

Public Member Functions
	__construct (int $a_md_rbac_id, int $a_md_obj_id, string $a_md_obj_type, int $a_ref_id)
	Constructor. More...
	executeCommand ()
	Execute command. More...
	show ()
	save ()
	initForm ()
	Init taxonomy form. More...
	getSelectableTaxonomies ()
	addToMDForm (ilPropertyFormGUI $a_form)
	Add taxonomy selector to MD (quick edit) form. More...
	updateFromMDForm ()
	Import settings from MD (quick edit) form. More...
	addSubTab ()
	addSubTab More...

Protected Member Functions
	initTaxNodeAssignment (int $a_tax_id)

Protected Attributes
ilObjectDefinition	$obj_definition
ilTree	$tree
int	$md_rbac_id
int	$md_obj_id
string	$md_obj_type
string	$requested_post_var
RequestInterface	$request
ilCtrl	$ctrl
ilGlobalTemplateInterface	$tpl
ilLanguage	$lng
ilTabsGUI	$tabs
int	$ref_id

Detailed Description

Taxonomies selection for metadata helper GUI.

Author

Jörg Lützenkirchen luetz.nosp@m.enki.nosp@m.rchen.nosp@m.@lei.nosp@m.fos.c.nosp@m.om ilTaxMDGUI: ilFormPropertyDispatchGUI

Definition at line 27 of file class.ilTaxMDGUI.php.

Constructor & Destructor Documentation

__construct()

ilTaxMDGUI::__construct	(	int	$a_md_rbac_id,
		int	$a_md_obj_id,
		string	$a_md_obj_type,
		int	$a_ref_id
	)

Constructor.

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

References $DIC, $params, ILIAS\Repository\ctrl(), ILIAS\Repository\lng(), and ILIAS\Repository\tabs().

      {
        global $DIC;

        $this->obj_definition = $DIC["objDefinition"];
        $this->tree = $DIC->repositoryTree();


        $this->tabs = $DIC->tabs();
        $this->ctrl = $DIC->ctrl();
        $this->lng = $DIC->language();
        $this->tpl = $DIC->ui()->mainTemplate();

        // @todo introduce request wrapper
        $this->request = $DIC->http()->request();

        $this->md_rbac_id = $a_md_rbac_id;
        $this->md_obj_id = $a_md_obj_id;
        $this->md_obj_type = $a_md_obj_type;
        $this->ref_id = $a_ref_id;

        $params = $this->request->getQueryParams();
        $this->requested_post_var = $params["postvar"] ?? "";
    }

Here is the call graph for this function:

Member Function Documentation

addSubTab()

ilTaxMDGUI::addSubTab

(

)

addSubTab

Definition at line 220 of file class.ilTaxMDGUI.php.

References $ctrl, $lng, $tabs, ilTabsGUI\addSubTab(), ilCtrl\getLinkTarget(), getSelectableTaxonomies(), and ilLanguage\txt().

                               : void
    {
        $tabs = $this->tabs;
        $ctrl = $this->ctrl;
        $lng = $this->lng;

        $tax_ids = $this->getSelectableTaxonomies();
        if (is_array($tax_ids)) {
            $tabs->addSubTab(
                "tax_assignment",
                $lng->txt("tax_tax_assignment"),
                $ctrl->getLinkTarget($this, "")
            );
        }
    }

Here is the call graph for this function:

addToMDForm()

ilTaxMDGUI::addToMDForm

(

ilPropertyFormGUI

$a_form

)

Add taxonomy selector to MD (quick edit) form.

Definition at line 174 of file class.ilTaxMDGUI.php.

References ilPropertyFormGUI\addItem(), getSelectableTaxonomies(), and initTaxNodeAssignment().

Referenced by initForm().

                                                          : void
    {
        $tax_ids = $this->getSelectableTaxonomies();
        if (is_array($tax_ids)) {
            foreach ($tax_ids as $tax_id) {
                // get existing assignments
                $node_ids = array();
                $ta = $this->initTaxNodeAssignment((int) $tax_id);
                foreach ($ta->getAssignmentsOfItem($this->md_obj_id) as $ass) {
                    $node_ids[] = $ass["node_id"];
                }

                $tax_sel = new ilTaxSelectInputGUI($tax_id, "md_tax_" . $tax_id, true);
                $tax_sel->setValue($node_ids);
                $a_form->addItem($tax_sel);
            }
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

executeCommand()

ilTaxMDGUI::executeCommand

(

)

Execute command.

Returns

mixed|string

Exceptions

ilCtrlException

Definition at line 79 of file class.ilTaxMDGUI.php.

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

    {
        $next_class = $this->ctrl->getNextClass($this);
        $cmd = $this->ctrl->getCmd("show");

        if ($next_class == 'ilformpropertydispatchgui') {
            $form = $this->initForm();
            $form_prop_dispatch = new ilFormPropertyDispatchGUI();
            $item = $form->getItemByPostVar($this->requested_post_var);
            $form_prop_dispatch->setItem($item);
            return $this->ctrl->forwardCommand($form_prop_dispatch);
        } elseif (in_array($cmd, array("show", "save"))) {
            $this->$cmd();
        }
        return "";
    }

Here is the call graph for this function:

getSelectableTaxonomies()

ilTaxMDGUI::getSelectableTaxonomies

(

)

Definition at line 135 of file class.ilTaxMDGUI.php.

References $obj_definition, $res, $tree, ilContainer\_lookupContainerSetting(), ilTree\getPathFull(), ilObjTaxonomy\getUsageOfObject(), and ilObjectServiceSettingsGUI\TAXONOMIES.

Referenced by ilObjectMetaDataGUI\__construct(), addSubTab(), addToMDForm(), and updateFromMDForm().

                                             : array
    {
        $objDefinition = $this->obj_definition;
        $tree = $this->tree;

        $res = [];
        if ($this->ref_id > 0 && $objDefinition->isRBACObject($this->md_obj_type)) {
            // get all active taxonomies of parent objects
            foreach ($tree->getPathFull($this->ref_id) as $node) {
                // currently only active for categories
                if ((int) $node["ref_id"] != $this->ref_id && $node["type"] == "cat") {
                    if (ilContainer::_lookupContainerSetting(
                        (int) $node["obj_id"],
                        ilObjectServiceSettingsGUI::TAXONOMIES,
                        false
                    ) !== ''
                    ) {
                        $tax_ids = ilObjTaxonomy::getUsageOfObject((int) $node["obj_id"]);
                        if (count($tax_ids) !== 0) {
                            $res = array_merge($res, $tax_ids);
                        }
                    }
                }
            }
        }
        return $res;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

initForm()

ilTaxMDGUI::initForm

(

)

Init taxonomy form.

Definition at line 122 of file class.ilTaxMDGUI.php.

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

Referenced by executeCommand(), save(), and show().

                              : ilPropertyFormGUI
    {
        $form = new ilPropertyFormGUI();

        $this->addToMDForm($form);
        $form->addCommandButton("save", $this->lng->txt("save"));
        $form->setTitle($this->lng->txt("tax_tax_assignment"));
        $form->setFormAction($this->ctrl->getFormAction($this));

        return $form;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

initTaxNodeAssignment()

ilTaxMDGUI::initTaxNodeAssignment ( int  $a_tax_id )

protected

Exceptions

ilTaxonomyException

Definition at line 166 of file class.ilTaxMDGUI.php.

Referenced by addToMDForm(), and updateFromMDForm().

                                                           : ilTaxNodeAssignment
    {
        return new ilTaxNodeAssignment($this->md_obj_type, $this->md_obj_id, "obj", $a_tax_id);
    }

Here is the caller graph for this function:

save()

ilTaxMDGUI::save

(

)

Definition at line 103 of file class.ilTaxMDGUI.php.

References $ctrl, $tpl, initForm(), ILIAS\Repository\lng(), ilCtrl\redirect(), ilGlobalTemplateInterface\setContent(), and updateFromMDForm().

                          : void
    {
        $tpl = $this->tpl;
        $ctrl = $this->ctrl;

        $form = $this->initForm();
        if ($form->checkInput()) {
            $this->updateFromMDForm();
            $this->tpl->setOnScreenMessage('success', $this->lng->txt("msg_obj_modified"), true);
            $ctrl->redirect($this, "show");
        } else {
            $form->setValuesByPost();
            $tpl->setContent($form->getHTML());
        }
    }

Here is the call graph for this function:

show()

ilTaxMDGUI::show

(

)

Definition at line 96 of file class.ilTaxMDGUI.php.

References $tpl, initForm(), and ilGlobalTemplateInterface\setContent().

                          : void
    {
        $tpl = $this->tpl;
        $form = $this->initForm();
        $tpl->setContent($form->getHTML());
    }

Here is the call graph for this function:

updateFromMDForm()

ilTaxMDGUI::updateFromMDForm

(

)

Import settings from MD (quick edit) form.

Definition at line 196 of file class.ilTaxMDGUI.php.

References getSelectableTaxonomies(), and initTaxNodeAssignment().

Referenced by save().

                                      : void
    {
        $body = $this->request->getParsedBody();
        $tax_ids = $this->getSelectableTaxonomies();
        if (is_array($tax_ids)) {
            foreach ($tax_ids as $tax_id) {
                $ta = $this->initTaxNodeAssignment($tax_id);

                // delete existing assignments
                $ta->deleteAssignmentsOfItem($this->md_obj_id);

                // set current assignment
                if (isset($body["md_tax_" . $tax_id])) {
                    foreach ($body["md_tax_" . $tax_id] as $node_id) {
                        $ta->addAssignment($node_id, $this->md_obj_id);
                    }
                }
            }
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

Field Documentation

$ctrl

ilCtrl ilTaxMDGUI::$ctrl

protected

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

Referenced by addSubTab(), and save().

$lng

ilLanguage ilTaxMDGUI::$lng

protected

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

Referenced by addSubTab().

$md_obj_id

int ilTaxMDGUI::$md_obj_id

protected

Definition at line 32 of file class.ilTaxMDGUI.php.

$md_obj_type

string ilTaxMDGUI::$md_obj_type

protected

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

$md_rbac_id

int ilTaxMDGUI::$md_rbac_id

protected

Definition at line 31 of file class.ilTaxMDGUI.php.

$obj_definition

ilObjectDefinition ilTaxMDGUI::$obj_definition

protected

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

Referenced by getSelectableTaxonomies().

$ref_id

int ilTaxMDGUI::$ref_id

protected

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

$request

RequestInterface ilTaxMDGUI::$request

protected

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

$requested_post_var

string ilTaxMDGUI::$requested_post_var

protected

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

$tabs

ilTabsGUI ilTaxMDGUI::$tabs

protected

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

Referenced by addSubTab().

$tpl

ilGlobalTemplateInterface ilTaxMDGUI::$tpl

protected

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

Referenced by save(), and show().

$tree

ilTree ilTaxMDGUI::$tree

protected

Definition at line 30 of file class.ilTaxMDGUI.php.

Referenced by getSelectableTaxonomies().

---

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

• Services/Taxonomy/classes/class.ilTaxMDGUI.php