ilTaxMDGUI Class Reference

Taxonomies selection for metadata helper GUI. More...

Collaboration diagram for ilTaxMDGUI:

Public Member Functions
	__construct ($a_md_rbac_id, $a_md_obj_id, $a_md_obj_type, $a_ref_id)
	Constructor. More...
	executeCommand ()
	Execute command. More...
	show ()
	Show. More...
	save ()
	Save form. More...
	initForm ()
	Init taxonomy form. More...
	getSelectableTaxonomies ()
	Get selectable taxonomies for current object. More...
	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 ($a_tax_id)
	Init tax node assignment. More...

Protected Attributes
	$obj_definition
	$tree
	$md_rbac_id
	$md_obj_id
	$md_obj_type

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 11 of file class.ilTaxMDGUI.php.

Constructor & Destructor Documentation

__construct()

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

Constructor.

Parameters

int	$a_md_rbac_id
int	$a_md_obj_id
int	$a_md_obj_type

Returns

self

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

References $DIC.

    {
        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["tpl"];

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

Member Function Documentation

addSubTab()

ilTaxMDGUI::addSubTab

(

)

addSubTab

Parameters

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

References $lng, $tabs, and getSelectableTaxonomies().

    {
        $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.

Parameters

ilPropertyFormGUI

$a_form

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

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

Referenced by initForm().

    {
        $tax_ids = $this->getSelectableTaxonomies();
        if (is_array($tax_ids)) {
            include_once "Services/Taxonomy/classes/class.ilTaxSelectInputGUI.php";
            foreach ($tax_ids as $tax_id) {
                // get existing assignments
                $node_ids = array();
                $ta = $this->initTaxNodeAssignment($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.

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

References $_GET, $form, array, and initForm().

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

        switch ($next_class) {
            case 'ilformpropertydispatchgui':
                $form = $this->initForm();
                include_once './Services/Form/classes/class.ilFormPropertyDispatchGUI.php';
                $form_prop_dispatch = new ilFormPropertyDispatchGUI();
                $item = $form->getItemByPostVar($_GET["postvar"]);
                $form_prop_dispatch->setItem($item);
                return $this->ctrl->forwardCommand($form_prop_dispatch);

            default:
                if (in_array($cmd, array("show", "save"))) {
                    $this->$cmd();
                }
        }
    }

Here is the call graph for this function:

getSelectableTaxonomies()

ilTaxMDGUI::getSelectableTaxonomies

(

)

Get selectable taxonomies for current object.

Returns

array

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

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

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

    {
        $objDefinition = $this->obj_definition;
        $tree = $this->tree;
        
        if ($this->ref_id > 0 && $objDefinition->isRBACObject($this->md_obj_type)) {
            $res = array();
            
            // see ilTaxonomyBlockGUI::getActiveTaxonomies()
                        
            // get all active taxonomies of parent objects
            foreach ($tree->getPathFull((int) $this->ref_id) as $node) {
                if ($node["ref_id"] != (int) $this->ref_id) {
                    // currently only active for categories
                    if ($node["type"] == "cat") {
                        include_once "Services/Object/classes/class.ilObjectServiceSettingsGUI.php";
                        include_once "Services/Container/classes/class.ilContainer.php";
                        if (ilContainer::_lookupContainerSetting(
                            $node["obj_id"],
                            ilObjectServiceSettingsGUI::TAXONOMIES,
                            false
                        )
                        ) {
                            include_once "Services/Taxonomy/classes/class.ilObjTaxonomy.php";
                            $tax_ids = ilObjTaxonomy::getUsageOfObject($node["obj_id"]);
                            if (sizeof($tax_ids)) {
                                $res = array_merge($res, $tax_ids);
                            }
                        }
                    }
                }
            }
            
            if (sizeof($res)) {
                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 115 of file class.ilTaxMDGUI.php.

References $form, and addToMDForm().

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

    {
        include_once("Services/Form/classes/class.ilPropertyFormGUI.php");
        $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 (   $a_tax_id )

protected

Init tax node assignment.

Parameters

int

$a_tax_id

Returns

ilTaxNodeAssignment

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

Referenced by addToMDForm(), and updateFromMDForm().

    {
        include_once("./Services/Taxonomy/classes/class.ilTaxNodeAssignment.php");
        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

(

)

Save form.

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

References $form, $tpl, initForm(), ilUtil\sendSuccess(), and updateFromMDForm().

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

        $form = $this->initForm();
        if ($form->checkInput()) {
            $this->updateFromMDForm();
            ilUtil::sendSuccess($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

(

)

Show.

Parameters

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

References $form, $tpl, and initForm().

    {
        $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 215 of file class.ilTaxMDGUI.php.

References $_POST, getSelectableTaxonomies(), and initTaxNodeAssignment().

Referenced by save().

    {
        $tax_ids = $this->getSelectableTaxonomies();
        if (is_array($tax_ids)) {
            include_once("./Services/Taxonomy/classes/class.ilTaxNodeAssignment.php");
            
            foreach ($tax_ids as $tax_id) {
                $ta = $this->initTaxNodeAssignment($tax_id);
                
                // delete existing assignments
                $ta->deleteAssignmentsOfItem($this->md_obj_id);
                            
                // set current assignment
                if (is_array($_POST["md_tax_" . $tax_id])) {
                    foreach ($_POST["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

$md_obj_id

ilTaxMDGUI::$md_obj_id

protected

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

$md_obj_type

ilTaxMDGUI::$md_obj_type

protected

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

$md_rbac_id

ilTaxMDGUI::$md_rbac_id

protected

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

$obj_definition

ilTaxMDGUI::$obj_definition

protected

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

Referenced by getSelectableTaxonomies().

$tree

ilTaxMDGUI::$tree

protected

Definition at line 21 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