ILIAS\DI\Container Class Reference

Customizing of pimple-DIC for ILIAS. More...

Inheritance diagram for ILIAS\DI\Container:

Collaboration diagram for ILIAS\DI\Container:

Public Member Functions
	database ()
	Get interface to the Database. More...
	rbac ()
	Get interface to get interfaces to all things rbac. More...
	ctrl ()
	Get the interface to the control structure. More...
	user ()
	Get the current user. More...
	access ()
	Get interface for access checks. More...
	repositoryTree ()
	Get interface to the repository tree. More...
	language ()
	Get interface to the i18n service. More...
	logger ()
	Get interface to get interfaces to different loggers. More...
	toolbar ()
	Get interface to the toolbar. More...
	tabs ()
	Get interface to the tabs. More...
	ui ()
	Get the interface to get services from UI framework. More...
	settings ()
	Get the interface to the settings. More...
	filesystem ()
	Get the Filesystem service interface. More...
	upload ()
	Gets the file upload interface. More...
	backgroundTasks ()
	globalScreen ()
	http ()
	event ()
	iliasIni ()
	clientIni ()
	systemStyle ()
	help ()
	question ()
	conditions ()
	Get conditions service. More...
	learningHistory ()
	news ()
	object ()
	exercise ()
	task ()
	refinery ()
	uiService ()
	bookingManager ()
	skills ()
	resourceStorage ()
	isDependencyAvailable ($name)
	Note: Only use isDependencyAvailable if strictly required. More...

Detailed Description

Customizing of pimple-DIC for ILIAS.

This just exposes some of the services in the container as plain methods to help IDEs when using ILIAS.

Definition at line 18 of file Container.php.

Member Function Documentation

access()

ILIAS\DI\Container::access

(

)

Get interface for access checks.

Returns

Definition at line 65 of file Container.php.

Referenced by ILIAS\DI\Container\learningHistory(), ILIAS\BackgroundTasks\Dependencies\DependencyMap\BaseDependencyMap\resolveBaseDependencies(), and ILIAS\DI\Container\task().

    {
        return $this["ilAccess"];
    }

Here is the caller graph for this function:

backgroundTasks()

ILIAS\DI\Container::backgroundTasks

(

)

Returns

BackgroundTaskServices

Definition at line 166 of file Container.php.

Referenced by ILIAS\BackgroundTasks\Dependencies\DependencyMap\BaseDependencyMap\resolveBaseDependencies().

    {
        return new BackgroundTaskServices($this);
    }

Here is the caller graph for this function:

bookingManager()

ILIAS\DI\Container::bookingManager

(

)

Returns

Definition at line 315 of file Container.php.

    {
        return new \ilBookingManagerService();
    }

clientIni()

ILIAS\DI\Container::clientIni

(

)

Returns

Definition at line 208 of file Container.php.

    {
        return $this['ilClientIniFile'];
    }

conditions()

ILIAS\DI\Container::conditions

(

)

Get conditions service.

Returns

Definition at line 242 of file Container.php.

    {
        return \ilConditionService::getInstance(new \ilConditionObjectAdapter());
    }

ctrl()

ILIAS\DI\Container::ctrl

(

)

Get the interface to the control structure.

Returns

Definition at line 45 of file Container.php.

Referenced by ILIAS\BackgroundTasks\Dependencies\DependencyMap\BaseDependencyMap\resolveBaseDependencies().

    {
        return $this["ilCtrl"];
    }

Here is the caller graph for this function:

database()

ILIAS\DI\Container::database

(

)

Get interface to the Database.

Returns

Definition at line 25 of file Container.php.

Referenced by ILIAS\OnScreenChat\Provider\OnScreenChatNotificationProvider\__construct(), and ILIAS\BackgroundTasks\Dependencies\DependencyMap\BaseDependencyMap\resolveBaseDependencies().

    {
        return $this["ilDB"];
    }

Here is the caller graph for this function:

event()

ILIAS\DI\Container::event

(

)

Returns

Definition at line 192 of file Container.php.

    {
        return $this['ilAppEventHandler'];
    }

exercise()

ILIAS\DI\Container::exercise

(

)

Returns

Definition at line 280 of file Container.php.

    {
        return new \ilExerciseFactory();
    }

filesystem()

ILIAS\DI\Container::filesystem

(

)

Get the Filesystem service interface.

Returns

Filesystems

Definition at line 146 of file Container.php.

Referenced by ILIAS\DI\Container\object().

    {
        return $this['filesystem'];
    }

Here is the caller graph for this function:

globalScreen()

ILIAS\DI\Container::globalScreen

(

)

Returns

Services

Definition at line 175 of file Container.php.

Referenced by ILIAS\GlobalScreen\Provider\AbstractPluginProvider\__construct().

    {
        return $this['global_screen'];
    }

Here is the caller graph for this function:

help()

ILIAS\DI\Container::help

(

)

Returns

Definition at line 224 of file Container.php.

    {
        return $this['ilHelp'];
    }

http()

ILIAS\DI\Container::http

(

)

Returns

HTTPServices

Definition at line 184 of file Container.php.

Referenced by ILIAS\DI\Container\uiService().

    {
        return $this['http'];
    }

Here is the caller graph for this function:

iliasIni()

ILIAS\DI\Container::iliasIni

(

)

Returns

Definition at line 200 of file Container.php.

    {
        return $this['ilIliasIniFile'];
    }

isDependencyAvailable()

ILIAS\DI\Container::isDependencyAvailable

(

$name

)

Note: Only use isDependencyAvailable if strictly required.

The need for this, mostly points to some underlying problem needing to be solved instead of using this. This was introduced as temporary workaround. See: https://github.com/ILIAS-eLearning/ILIAS/pull/1064

This is syntactic sugar for executing the try catch statement in the clients code. Note that the use of the offsetSet code of the default container should be avoided, since knowledge about the containers internal mechanism is injected.

Example: //This is bad since the client should not need to know about the id's name $DIC->offsetSet("styleDefinition")

//This is better, since the client just needs to know the name defined in the //interface of the component $DIC->isDependencyAvailable("systemStyle")

Parameters

$name

Returns

bool

Definition at line 355 of file Container.php.

References Vendor\Package\$e, and $name.

    {
        try {
            $this->$name();
        } catch (\InvalidArgumentException $e) {
            return false;
        }
        return true;
    }

language()

ILIAS\DI\Container::language

(

)

Get interface to the i18n service.

Returns

Definition at line 85 of file Container.php.

Referenced by ILIAS\OnScreenChat\Provider\OnScreenChatNotificationProvider\__construct(), ILIAS\DI\Container\learningHistory(), ILIAS\DI\Container\news(), ILIAS\DI\Container\object(), ILIAS\BackgroundTasks\Dependencies\DependencyMap\BaseDependencyMap\resolveBaseDependencies(), and ILIAS\DI\Container\task().

    {
        return $this["lng"];
    }

Here is the caller graph for this function:

learningHistory()

ILIAS\DI\Container::learningHistory

(

)

Returns

Definition at line 250 of file Container.php.

References ILIAS\DI\Container\access(), ILIAS\DI\Container\language(), ILIAS\DI\Container\repositoryTree(), ILIAS\DI\Container\ui(), and ILIAS\DI\Container\user().

    {
        return new \ilLearningHistoryService(
            $this->user(),
            $this->language(),
            $this->ui(),
            $this->access(),
            $this->repositoryTree()
        );
    }

Here is the call graph for this function:

logger()

ILIAS\DI\Container::logger

(

)

Get interface to get interfaces to different loggers.

Returns

LoggingServices

Definition at line 95 of file Container.php.

Referenced by ILIAS\BackgroundTasks\Dependencies\DependencyMap\BaseDependencyMap\resolveBaseDependencies().

    {
        return new LoggingServices($this);
    }

Here is the caller graph for this function:

news()

ILIAS\DI\Container::news

(

)

Returns

Definition at line 264 of file Container.php.

References ILIAS\DI\Container\language(), ILIAS\DI\Container\settings(), and ILIAS\DI\Container\user().

    {
        return new \ilNewsService($this->language(), $this->settings(), $this->user());
    }

Here is the call graph for this function:

object()

ILIAS\DI\Container::object

(

)

Returns

Definition at line 272 of file Container.php.

References ILIAS\DI\Container\filesystem(), ILIAS\DI\Container\language(), ILIAS\DI\Container\settings(), and ILIAS\DI\Container\upload().

    {
        return new \ilObjectService($this->language(), $this->settings(), $this->filesystem(), $this->upload());
    }

Here is the call graph for this function:

question()

ILIAS\DI\Container::question

(

)

Returns

Definition at line 232 of file Container.php.

    {
        return new \ilAsqFactory();
    }

rbac()

ILIAS\DI\Container::rbac

(

)

Get interface to get interfaces to all things rbac.

Returns

RBACServices

Definition at line 35 of file Container.php.

Referenced by ILIAS\BackgroundTasks\Dependencies\DependencyMap\BaseDependencyMap\resolveBaseDependencies().

    {
        return new RBACServices($this);
    }

Here is the caller graph for this function:

refinery()

ILIAS\DI\Container::refinery

(

)

Returns

Factory

Definition at line 297 of file Container.php.

    {
        return $this['refinery'];
    }

repositoryTree()

ILIAS\DI\Container::repositoryTree

(

)

Get interface to the repository tree.

Returns

Definition at line 75 of file Container.php.

Referenced by ILIAS\DI\Container\learningHistory(), and ILIAS\BackgroundTasks\Dependencies\DependencyMap\BaseDependencyMap\resolveBaseDependencies().

    {
        return $this["tree"];
    }

Here is the caller graph for this function:

resourceStorage()

ILIAS\DI\Container::resourceStorage

(

)

Definition at line 329 of file Container.php.

                                      : \ILIAS\ResourceStorage\Services
    {
        return $this['resource_storage'];
    }

settings()

ILIAS\DI\Container::settings

(

)

Get the interface to the settings.

Returns

Definition at line 135 of file Container.php.

Referenced by ILIAS\DI\Container\news(), ILIAS\DI\Container\object(), and ILIAS\BackgroundTasks\Dependencies\DependencyMap\BaseDependencyMap\resolveBaseDependencies().

    {
        return $this["ilSetting"];
    }

Here is the caller graph for this function:

skills()

ILIAS\DI\Container::skills

(

)

Returns

SkillService

Definition at line 324 of file Container.php.

    {
        return new SkillService();
    }

systemStyle()

ILIAS\DI\Container::systemStyle

(

)

Returns

Definition at line 216 of file Container.php.

    {
        return $this['styleDefinition'];
    }

tabs()

ILIAS\DI\Container::tabs

(

)

Get interface to the tabs.

Returns

Definition at line 115 of file Container.php.

Referenced by ILIAS\BackgroundTasks\Dependencies\DependencyMap\BaseDependencyMap\resolveBaseDependencies().

    {
        return $this["ilTabs"];
    }

Here is the caller graph for this function:

task()

ILIAS\DI\Container::task

(

)

Returns

Definition at line 288 of file Container.php.

References ILIAS\DI\Container\access(), ILIAS\DI\Container\language(), ILIAS\DI\Container\ui(), and ILIAS\DI\Container\user().

    {
        return new \ilTaskService($this->user(), $this->language(), $this->ui(), $this->access());
    }

Here is the call graph for this function:

toolbar()

ILIAS\DI\Container::toolbar

(

)

Get interface to the toolbar.

Returns

Definition at line 105 of file Container.php.

Referenced by ILIAS\BackgroundTasks\Dependencies\DependencyMap\BaseDependencyMap\resolveBaseDependencies().

    {
        return $this["ilToolbar"];
    }

Here is the caller graph for this function:

ui()

ILIAS\DI\Container::ui

(

)

Get the interface to get services from UI framework.

Returns

UIServices

Definition at line 125 of file Container.php.

Referenced by ILIAS\DI\Container\learningHistory(), ILIAS\BackgroundTasks\Dependencies\DependencyMap\BaseDependencyMap\resolveBaseDependencies(), ILIAS\DI\Container\task(), and ILIAS\DI\Container\uiService().

    {
        return new UIServices($this);
    }

Here is the caller graph for this function:

uiService()

ILIAS\DI\Container::uiService

(

)

Returns

Definition at line 306 of file Container.php.

References ILIAS\DI\Container\http(), and ILIAS\DI\Container\ui().

    {
        return new \ilUIService($this->http()->request(), $this->ui());
    }

Here is the call graph for this function:

upload()

ILIAS\DI\Container::upload

(

)

Gets the file upload interface.

Returns

FileUpload

Definition at line 157 of file Container.php.

Referenced by ILIAS\DI\Container\object().

    {
        return $this['upload'];
    }

Here is the caller graph for this function:

user()

ILIAS\DI\Container::user

(

)

Get the current user.

Returns

Definition at line 55 of file Container.php.

Referenced by ILIAS\OnScreenChat\Provider\OnScreenChatNotificationProvider\__construct(), ILIAS\DI\Container\learningHistory(), ILIAS\DI\Container\news(), ILIAS\BackgroundTasks\Dependencies\DependencyMap\BaseDependencyMap\resolveBaseDependencies(), and ILIAS\DI\Container\task().

    {
        return $this["ilUser"];
    }

Here is the caller graph for this function:

---

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

• src/DI/Container.php