ilTaxonomyClassificationProvider Class Reference

This file is part of ILIAS, a powerful learning management system published by ILIAS open source e-Learning e.V. More...

Inheritance diagram for ilTaxonomyClassificationProvider:

Collaboration diagram for ilTaxonomyClassificationProvider:

Public Member Functions
	render (array &$a_html, object $a_parent_gui)
	importPostData (?array $a_saved=null)
	setSelection (array $a_value)
	getFilteredObjects ()
Public Member Functions inherited from ilClassificationProvider
	__construct (int $a_parent_ref_id, int $a_parent_obj_id, string $a_parent_obj_type)
	render (array &$a_html, object $a_parent_gui)
	Render HTML chunks. More...
	importPostData (?array $a_saved=null)
	Import post data. More...
	setSelection (array $a_value)
	Set selection. More...
	getFilteredObjects ()
	Get filtered object ref ids. More...
	initListGUI (ilObjectListGUI $a_list_gui)
	Init list gui properties. More...

Static Public Member Functions
static	isActive (int $a_parent_ref_id, int $a_parent_obj_id, string $a_parent_obj_type)
Static Public Member Functions inherited from ilClassificationProvider
static	getValidProviders (int $a_parent_ref_id, int $a_parent_obj_id, string $a_parent_obj_type)
	Get all valid providers (for parent container) More...
static	isActive (int $a_parent_ref_id, int $a_parent_obj_id, string $a_parent_obj_type)
	Is provider currently active? More...

Protected Member Functions
	init ()
Protected Member Functions inherited from ilClassificationProvider
	init ()

Static Protected Member Functions
static	getActiveTaxonomiesForParentRefId (int $a_parent_ref_id)

Protected Attributes
array	$selection = []
int	$incoming_id = 0
Protected Attributes inherited from ilClassificationProvider
int	$parent_ref_id
int	$parent_obj_id
string	$parent_type
RequestInterface	$request

Static Protected Attributes
static array	$valid_tax_map = []

Detailed Description

This file is part of ILIAS, a powerful learning management system published by ILIAS open source e-Learning e.V.

ILIAS is licensed with the GPL-3.0, see https://www.gnu.org/licenses/gpl-3.0.en.html You should have received a copy of said license along with the source code, too.

If this is not the case or you just want to try ILIAS, you'll find us at: https://www.ilias.de https://github.com/ILIAS-eLearning Taxonomy classification provider

Author

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

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

Member Function Documentation

getActiveTaxonomiesForParentRefId()

static ilTaxonomyClassificationProvider::getActiveTaxonomiesForParentRefId ( int  $a_parent_ref_id )

staticprotected

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

References $DIC, $id, ilContainer\_getContainerSettings(), ilContainer\_lookupContainerSetting(), ilObject\_lookupTitle(), ilObject\_lookupType(), ilObjCategoryGUI\CONTAINER_SETTING_TAXBLOCK, ilObjTaxonomy\getUsageOfObject(), ilArrayUtil\sortArray(), and ilObjectServiceSettingsGUI\TAXONOMIES.

                                                                                     : int
    {
        global $DIC;

        $tree = $DIC->repositoryTree();

        if (!isset(self::$valid_tax_map[$a_parent_ref_id])) {
            $prefix = ilObjCategoryGUI::CONTAINER_SETTING_TAXBLOCK;

            $all_valid = array();
            foreach ($tree->getPathFull($a_parent_ref_id) as $node) {
                if ($node["type"] == "cat") {
                    $node_valid = array();

                    if (ilContainer::_lookupContainerSetting(
                        (int) $node["obj_id"],
                        ilObjectServiceSettingsGUI::TAXONOMIES,
                        false
                    ) !== '') {
                        $all_valid = array_merge(
                            $all_valid,
                            ilObjTaxonomy::getUsageOfObject((int) $node["obj_id"])
                        );

                        $active = array();
                        foreach (ilContainer::_getContainerSettings((int) $node["obj_id"]) as $keyword => $value) {
                            if (substr($keyword, 0, strlen($prefix)) == $prefix && (bool) $value) {
                                $active[] = substr($keyword, strlen($prefix));
                            }
                        }

                        $node_valid = array_intersect($all_valid, $active);
                    }

                    if (count($node_valid) !== 0) {
                        foreach ($node_valid as $idx => $node_id) {
                            // #15268 - deleted taxonomy?
                            if (ilObject::_lookupType((int) $node_id) != "tax") {
                                unset($node_valid[$idx]);
                            }
                        }
                    }

                    $id_and_title = array_map(static function (int $id) {
                        return [
                           "id" => $id,
                           "title" => ilObject::_lookupTitle($id)
                        ];
                    }, $node_valid);
                    $id_and_title = ilArrayUtil::sortArray($id_and_title, "title");
                    $sorted_ids = array_map(static function (array $id_and_title) {
                        return (int) $id_and_title["id"];
                    }, $id_and_title);
                    self::$valid_tax_map[$node["ref_id"]] = $sorted_ids;
                }
            }
        }

        if (isset(self::$valid_tax_map[$a_parent_ref_id]) && is_array(self::$valid_tax_map[$a_parent_ref_id])) {
            return count(self::$valid_tax_map[$a_parent_ref_id]);
        }

        return 0;
    }

Here is the call graph for this function:

getFilteredObjects()

ilTaxonomyClassificationProvider::getFilteredObjects

(

)

Definition at line 157 of file class.ilTaxonomyClassificationProvider.php.

References ilTaxNodeAssignment\findObjectsByNode(), and ILIAS\Repository\int().

                                        : array
    {
        $tax_obj_ids = array();
        $tax_map = array();

        // :TODO: this could be smarter
        foreach ($this->selection as $node_id) {
            $node = new ilTaxonomyNode((int) $node_id);
            $tax_map[$node->getTaxonomyId()][] = (int) $node_id;
        }

        foreach ($tax_map as $tax_id => $node_ids) {
            $tax_tree = new ilTaxonomyTree((int) $tax_id);

            // combine taxonomy nodes OR
            $tax_nodes = array();
            foreach ($node_ids as $node_id) {
                $tax_nodes = array_merge($tax_nodes, $tax_tree->getSubTreeIds((int) $node_id));
                $tax_nodes[] = (int) $node_id;
            }
            $tax_obj_ids[$tax_id] = ilTaxNodeAssignment::findObjectsByNode((int) $tax_id, $tax_nodes, "obj");
        }

        // combine taxonomies AND
        $obj_ids = null;
        foreach ($tax_obj_ids as $tax_objs) {
            $obj_ids = $obj_ids === null ? $tax_objs : array_intersect($obj_ids, $tax_objs);
        }

        return (array) $obj_ids;
    }

Here is the call graph for this function:

importPostData()

ilTaxonomyClassificationProvider::importPostData

(

?array

$a_saved = null

)

Definition at line 64 of file class.ilTaxonomyClassificationProvider.php.

References $incoming_id.

                                                          : array
    {
        $incoming_id = $this->incoming_id;
        if ($incoming_id !== 0) {
            if (is_array($a_saved)) {
                foreach ($a_saved as $idx => $node_id) {
                    if ($node_id == $incoming_id) {
                        unset($a_saved[$idx]);
                        return $a_saved;
                    }
                }
                $a_saved[] = $incoming_id;
                return $a_saved;
            } else {
                return array($incoming_id);
            }
        }
        return [];
    }

init()

ilTaxonomyClassificationProvider::init ( )

protected

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

References $params, and ILIAS\Repository\int().

                             : void
    {
        $params = $this->request->getQueryParams();
        $body = $this->request->getParsedBody();
        $this->incoming_id = (int) ($body["tax_node"] ?? ($params["tax_node"] ?? null));
    }

Here is the call graph for this function:

isActive()

static ilTaxonomyClassificationProvider::isActive ( int  $a_parent_ref_id, int  $a_parent_obj_id, string  $a_parent_obj_type  )

static

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

Referenced by ilClassificationProvider\getValidProviders().

                                                                                                          : bool
    {
        return (bool) self::getActiveTaxonomiesForParentRefId($a_parent_ref_id);
    }

Here is the caller graph for this function:

render()

ilTaxonomyClassificationProvider::render	(	array &	$a_html,
		object	$a_parent_gui
	)

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

References ilObject\_lookupTitle().

                                                                : void
    {
        foreach (self::$valid_tax_map[$this->parent_ref_id] as $tax_id) {
            $tax_exp = new ilTaxonomyClassificationExplorerGUI($a_parent_gui, "", (int) $tax_id, "", "");
            $tax_exp->setSkipRootNode(true);
            $tax_exp->setOnClick("il.Classification.toggle({tax_node: '{NODE_CHILD}'});");

            if (isset($this->selection) && is_array($this->selection)) {
                foreach ($this->selection as $node_id) {
                    $tax_exp->setPathOpen($node_id);
                    $tax_exp->setNodeSelected($node_id);
                }
            }

            if (!$tax_exp->handleCommand()) {
                $a_html[] = array(
                    "title" => ilObject::_lookupTitle((int) $tax_id),
                    "html" => $tax_exp->getHTML(true)
                );
            }
        }
    }

Here is the call graph for this function:

setSelection()

ilTaxonomyClassificationProvider::setSelection

(

array

$a_value

)

Definition at line 87 of file class.ilTaxonomyClassificationProvider.php.

                                                : void
    {
        $this->selection = $a_value;
    }

Field Documentation

$incoming_id

int ilTaxonomyClassificationProvider::$incoming_id = 0

protected

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

Referenced by importPostData().

$selection

array ilTaxonomyClassificationProvider::$selection = []

protected

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

$valid_tax_map

array ilTaxonomyClassificationProvider::$valid_tax_map = []

staticprotected

Definition at line 26 of file class.ilTaxonomyClassificationProvider.php.

---

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

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