ILIAS\OrgUnit\Provider\OrgUnitToolProvider Class Reference

Class OrgUnitToolProvider. More...

Inheritance diagram for ILIAS\OrgUnit\Provider\OrgUnitToolProvider:

Collaboration diagram for ILIAS\OrgUnit\Provider\OrgUnitToolProvider:

Public Member Functions
	isInterestedInContexts ()
	getToolsForContextStack (CalledContexts $called_contexts)
Public Member Functions inherited from ILIAS\GlobalScreen\Scope\Tool\Provider\AbstractDynamicToolProvider
	__construct (Container $dic)
Public Member Functions inherited from ILIAS\GlobalScreen\Provider\AbstractProvider
	__construct (Container $dic)
	getFullyQualifiedClassName ()
	getProviderNameForPresentation ()

Data Fields
const	SHOW_ORGU_TREE = 'show_orgu_tree'

Private Member Functions
	getTree ()
	getTreeRecursion ()
	getTreeWhiteList ()

Additional Inherited Members
Protected Member Functions inherited from ILIAS\GlobalScreen\Provider\AbstractProvider
	globalScreen ()
Protected Attributes inherited from ILIAS\GlobalScreen\Scope\Tool\Provider\AbstractDynamicToolProvider
ToolIdentificationProviderInterface	$identification_provider
ContextCollection	$context_collection
ToolFactory	$factory
Protected Attributes inherited from ILIAS\GlobalScreen\Provider\AbstractProvider
Container	$dic

Detailed Description

Class OrgUnitToolProvider.

Author

Fabian Schmid fs@st.nosp@m.uder.nosp@m.-raim.nosp@m.ann..nosp@m.ch

Definition at line 36 of file OrgUnitToolProvider.php.

Member Function Documentation

getToolsForContextStack()

ILIAS\OrgUnit\Provider\OrgUnitToolProvider::getToolsForContextStack

(

CalledContexts

$called_contexts

)

Parameters

CalledContexts

$called_contexts

Returns

[]

Implements ILIAS\GlobalScreen\Scope\Tool\Provider\DynamicToolProvider.

Definition at line 49 of file OrgUnitToolProvider.php.

References $id, ILIAS\LTI\ToolProvider\$key, ILIAS\GlobalScreen\ScreenContext\Stack\CalledContexts\current(), and ILIAS\OrgUnit\Provider\OrgUnitToolProvider\getTree().

                                                                            : array
    {
        $tools = [];

        if ($called_contexts->current()->getAdditionalData()->is(self::SHOW_ORGU_TREE, true)) {
            $iff = function (string $id) {
                return $this->identification_provider->contextAwareIdentifier($id);
            };

            $t = function (string $key): string {
                return $this->dic->language()->txt($key);
            };

            $tools[] = $this->factory->treeTool($iff('tree_new'))
                                     ->withTitle($t('tree'))
                                     ->withSymbol($this->dic->ui()->factory()->symbol()->icon()->standard(
                                         'orgu',
                                         'Orgu'
                                     ))
                                     ->withTree($this->getTree());
        }

        return $tools;
    }

Here is the call graph for this function:

getTree()

ILIAS\OrgUnit\Provider\OrgUnitToolProvider::getTree ( )

private

Definition at line 74 of file OrgUnitToolProvider.php.

References $DIC, $lng, ilObjOrgUnit\getRootOrgRefId(), and ILIAS\OrgUnit\Provider\OrgUnitToolProvider\getTreeRecursion().

Referenced by ILIAS\OrgUnit\Provider\OrgUnitToolProvider\getToolsForContextStack().

                              : Tree
    {
        global $DIC;
        $lng = $DIC->language();
        $tree = $this->getTreeRecursion();

        $parent_node_id = $DIC->repositoryTree()->getParentId(ilObjOrgUnit::getRootOrgRefId());

        return $this->dic->ui()->factory()->tree()->expandable($lng->txt("org_units"), $tree)
                         ->withData($tree->getChildsOfNode($parent_node_id));
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getTreeRecursion()

ILIAS\OrgUnit\Provider\OrgUnitToolProvider::getTreeRecursion ( )

private

Definition at line 86 of file OrgUnitToolProvider.php.

References $_GET, $ref_id, ilObjOrgUnit\getRootOrgRefId(), ILIAS\OrgUnit\Provider\OrgUnitToolProvider\getTreeWhiteList(), and ILIAS\Repository\int().

Referenced by ILIAS\OrgUnit\Provider\OrgUnitToolProvider\getTree().

                                       : TreeRecursion
    {
        $tree = new ilOrgUnitExplorerGUI(
            "orgu_explorer",
            ilObjOrgUnitGUI::class,
            "showTree",
            new ilTree(1),
            $this->dic["ilAccess"]
        );
        $tree->setTypeWhiteList($this->getTreeWhiteList());
        $tree->setRootId(ilObjOrgUnit::getRootOrgRefId());
        $ref_id = (int)($_GET['item_ref_id'] ?? $_GET['ref_id'] ?? 0);
        if ($ref_id !== 0) {
            $tree->setPathOpen((int)$ref_id);
        }
        $tree->setOrderField('title');

        return $tree;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getTreeWhiteList()

ILIAS\OrgUnit\Provider\OrgUnitToolProvider::getTreeWhiteList ( )

private

Returns

int[]

Definition at line 109 of file OrgUnitToolProvider.php.

Referenced by ILIAS\OrgUnit\Provider\OrgUnitToolProvider\getTreeRecursion().

                                       : array
    {
        $whiteList = array('orgu');
        $pls = ilOrgUnitExtension::getActivePluginIdsForTree();

        return array_merge($whiteList, $pls);
    }

Here is the caller graph for this function:

isInterestedInContexts()

ILIAS\OrgUnit\Provider\OrgUnitToolProvider::isInterestedInContexts

(

)

Returns

ContextCollection

Implements ILIAS\GlobalScreen\ScreenContext\ScreenContextAwareProvider.

Definition at line 40 of file OrgUnitToolProvider.php.

References ILIAS\GlobalScreen\ScreenContext\Stack\ContextCollection\main().

                                            : ContextCollection
    {
        return $this->context_collection->main()->administration();
    }

Here is the call graph for this function:

Field Documentation

SHOW_ORGU_TREE

const ILIAS\OrgUnit\Provider\OrgUnitToolProvider::SHOW_ORGU_TREE = 'show_orgu_tree'

Definition at line 38 of file OrgUnitToolProvider.php.

---

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

• Modules/OrgUnit/classes/Provider/OrgUnitToolProvider.php