class.ilObjectPlugin.php

Go to the documentation of this file.

<?php
/* Copyright (c) 1998-2009 ILIAS open source, Extended GPL, see docs/LICENSE */

include_once("./Services/Object/classes/class.ilObject2.php");
require_once('./Services/Component/classes/class.ilPlugin.php');

/*
* Object class for plugins. This one wraps around ilObject
*
* @author Alex Killing <alex.killing@gmx.de>
* @version $Id$
* @ingroup ServicesRepository
*/
abstract class ilObjectPlugin extends ilObject2
{
    private $object;

    protected $plugin;

    protected static $plugin_by_type = array();


    public function __construct($a_ref_id = 0)
    {
        $this->initType();
        parent::__construct($a_ref_id, true);
        $this->plugin = $this->getPlugin();
    }


    public static function getPluginObjectByType($type)
    {
        if (!self::$plugin_by_type[$type]) {
            list($component, $component_name) = ilPlugin::lookupTypeInformationsForId($type);
            if (
                $component == IL_COMP_SERVICE &&
                $component_name == "Repository"
            ) {
                self::loadRepoPlugin($type);
            }

            if (
                $component == IL_COMP_MODULE &&
                $component_name == "OrgUnit"
            ) {
                self::loadOrgUnitPlugin($type);
            }
        }

        return self::$plugin_by_type[$type];
    }

    protected static function loadRepoPlugin(string $type_id)
    {
        $plugin = null;
        $name = ilPlugin::lookupNameForId(IL_COMP_SERVICE, "Repository", "robj", $type_id);

        if (!is_null($name)) {
            $plugin = ilPlugin::getPluginObject(IL_COMP_SERVICE, "Repository", "robj", $name);
        }

        if (is_null($plugin)) {
            ilLoggerFactory::getLogger("obj")->log("Try to get repo plugin obj by type: $type_id. No such type exists for Repository and Org Unit pluginss.");
        }
        self::$plugin_by_type[$type_id] = $plugin;
    }

    protected static function loadOrgUnitPlugin(string $type_id)
    {
        $plugin = null;
        $name = ilPlugin::lookupNameForId(IL_COMP_MODULE, "OrgUnit", "orguext", $type_id);
        if (!is_null($name)) {
            $plugin = ilPlugin::getPluginObject(IL_COMP_MODULE, "OrgUnit", "orguext", $name);
        }

        if (is_null($plugin)) {
            ilLoggerFactory::getLogger("obj")->log("Try to get repo plugin obj by type: $type_id. No such type exists for Repository and Org Unit pluginss.");
        }
        self::$plugin_by_type[$type_id] = $plugin;
    }

    public static function lookupTxtById($plugin_id, $lang_var)
    {
        $pl = self::getPluginObjectByType($plugin_id);
        return $pl->txt($lang_var);
    }

    protected function getPlugin()
    {
        if (!$this->plugin) {
            $this->plugin =
                ilPlugin::getPluginObject(
                    IL_COMP_SERVICE,
                    "Repository",
                    "robj",
                    ilPlugin::lookupNameForId(IL_COMP_SERVICE, "Repository", "robj", $this->getType())
                );
            if (!is_object($this->plugin)) {
                throw new ilPluginException("ilObjectPlugin: Could not instantiate plugin object for type " . $this->getType() . ".");
            }
        }
        return $this->plugin;
    }

    final protected function txt($a_var)
    {
        return $this->getPlugin()->txt($a_var);
    }

    public function getParentTypes()
    {
        return $this->plugin->getParentTypes();
    }
}