InitCtrlService Class Reference

Class InitCtrlService wraps the initialization of ilCtrl. More...

Collaboration diagram for InitCtrlService:

Public Member Functions
	init (Container $dic)
	Initializes the ilCtrl service. More...

Private Member Functions
	abortIfMissingDependencies (Container $dic)
	Aborts if another dependency required by the ctrl service is not yet available. More...

Detailed Description

Class InitCtrlService wraps the initialization of ilCtrl.

Author

Thibeau Fuhrer thf@s.nosp@m.tude.nosp@m.r-rai.nosp@m.mann.nosp@m..ch This class exists because due to dependency-injection the initialization of ilCtrl got a little more complicated - and is used on several occasions.

Definition at line 16 of file InitCtrlService.php.

Member Function Documentation

abortIfMissingDependencies()

InitCtrlService::abortIfMissingDependencies ( Container  $dic )

private

Aborts if another dependency required by the ctrl service is not yet available.

Parameters

Container

$dic

Exceptions

ilCtrlException

if a necessary dependency is not yet initialized.

Definition at line 77 of file InitCtrlService.php.

Referenced by init().

                                                               : void
    {
        if (!$dic->offsetExists('http')) {
            throw new ilCtrlException("Cannot initialize ilCtrl if HTTP Services are not yet available.");
        }

        if (!$dic->offsetExists('refinery')) {
            throw new ilCtrlException("Cannot initialize ilCtrl if Refinery Factory is not yet available.");
        }

        // if (!$dic->offsetExists('ilDB')) {
        //     throw new ilCtrlException("Cannot initialize ilCtrl if Database is not yet available.");
        // }
    }

Here is the caller graph for this function:

init()

InitCtrlService::init

(

Container

$dic

)

Initializes the ilCtrl service.

This method EXPECTS that $GLOBALS['DIC'] is already initialized with the http services and the refinery factory.

Parameters

Container

$dic

Exceptions

ilCtrlException

if the initialization fails.

Definition at line 25 of file InitCtrlService.php.

References $context, $GLOBALS, abortIfMissingDependencies(), ilCtrlStructureArtifactObjective\ARTIFACT_PATH, ilCtrlBaseClassArtifactObjective\ARTIFACT_PATH, ilCtrlSecurityArtifactObjective\ARTIFACT_PATH, ILIAS\DI\Container\http(), and ILIAS\DI\Container\refinery().

                                        : void
    {
        $this->abortIfMissingDependencies($dic);
        $ilias_path = dirname(__FILE__, 5) . '/';

        try {
            $ctrl_structure = new ilCtrlStructure(
                require $ilias_path . ilCtrlStructureArtifactObjective::ARTIFACT_PATH,
                require $ilias_path . ilCtrlBaseClassArtifactObjective::ARTIFACT_PATH,
                require $ilias_path . ilCtrlSecurityArtifactObjective::ARTIFACT_PATH
            );
        } catch (Throwable $t) {
            throw new ilCtrlException(self::class . " could not require artifacts, try `composer du` first.");
        }

        $token_repository = new ilCtrlTokenRepository();
        $path_factory = new ilCtrlPathFactory($ctrl_structure);
        $context = new ilCtrlContext(
            $path_factory,
            $dic->http()->wrapper()->query(),
            $dic->refinery()
        );

        // create global instance of ilCtrl
        $GLOBALS['ilCtrl'] = new ilCtrl(
            $ctrl_structure,
            $token_repository,
            $path_factory,
            $context,
            $dic["http.response_sender_strategy"],
            $dic->http()->request(),
            $dic->http()->wrapper()->post(),
            $dic->http()->wrapper()->query(),
            $dic->refinery(),
            $dic["component.factory"],
            new ilCtrlQueryRegexParser()
        );

        // add helper function to DI container that
        // returns the global instance.
        $dic['ilCtrl'] = static function () {
            return $GLOBALS['ilCtrl'];
        };
    }

Here is the call graph for this function:

---

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

• Services/Init/classes/Dependencies/InitCtrlService.php