InitResourceStorage Class Reference

Responsible for loading the Resource Storage into the dependency injection container of ILIAS. More...

Collaboration diagram for InitResourceStorage:

Public Member Functions
	getResourceBuilder (\ILIAS\DI\Container $c)
	getFlavourBuilder (\ILIAS\DI\Container $c)
	init (\ILIAS\DI\Container $c)

Data Fields
const	D_SERVICE = 'resource_storage'
const	D_REPOSITORIES = self::D_SERVICE . '.repositories'
const	D_STORAGE_HANDLERS = self::D_SERVICE . '.storage_handlers'
const	D_RESOURCE_BUILDER = self::D_SERVICE . '.resource_builder'
const	D_FLAVOUR_BUILDER = self::D_SERVICE . '.flavour_builder'
const	D_REPOSITORY_PRELOADER = self::D_SERVICE . '.repository_preloader'
const	D_SOURCE_BUILDER = self::D_SERVICE . '.source_builder'
const	D_LOCK_HANDLER = self::D_SERVICE . '.lock_handler'
const	D_FILENAME_POLICY = self::D_SERVICE . '.filename_policy'
const	D_STREAM_ACCESS = self::D_SERVICE . '.stream_access'
const	D_ARTIFACTS = self::D_SERVICE . '.artifacts'
const	D_MACHINE_FACTORY = self::D_SERVICE . '.machine_factory'
const	D_MIGRATOR = self::D_SERVICE . '.migrator'

Protected Member Functions
	buildBasePath ()

Private Attributes
bool	$init = false

Detailed Description

Responsible for loading the Resource Storage into the dependency injection container of ILIAS.

Definition at line 50 of file InitResourceStorage.php.

Member Function Documentation

buildBasePath()

InitResourceStorage::buildBasePath ( )

protected

Definition at line 225 of file InitResourceStorage.php.

References CLIENT_ID, and ILIAS_DATA_DIR.

Referenced by init().

                                      : string
    {
        return (defined('ILIAS_DATA_DIR') && defined('CLIENT_ID'))
            ? rtrim(ILIAS_DATA_DIR, "/") . "/" . CLIENT_ID
            : '-';
    }

Here is the caller graph for this function:

getFlavourBuilder()

InitResourceStorage::getFlavourBuilder

(

\ILIAS\DI\Container

$c

)

Definition at line 91 of file InitResourceStorage.php.

References $c, and init().

                                                             : FlavourBuilder
    {
        $this->init($c);
        $c[self::D_FLAVOUR_BUILDER] = function (Container $c): FlavourBuilder {
            return new FlavourBuilder(
                $c[self::D_REPOSITORIES]->getFlavourRepository(),
                $c[self::D_MACHINE_FACTORY],
                $c[self::D_RESOURCE_BUILDER],
                $c[self::D_STORAGE_HANDLERS],
                $c[self::D_STREAM_ACCESS],
                new Subject(),
            );
        };
        return $c[self::D_FLAVOUR_BUILDER];
    }

Here is the call graph for this function:

getResourceBuilder()

InitResourceStorage::getResourceBuilder

(

\ILIAS\DI\Container

$c

)

Definition at line 72 of file InitResourceStorage.php.

References $c, and init().

Referenced by init().

                                                              : ResourceBuilder
    {
        $this->init($c);
        $c[self::D_RESOURCE_BUILDER] = function (Container $c): ResourceBuilder {
            return new ResourceBuilder(
                $c[self::D_STORAGE_HANDLERS],
                $c[self::D_REPOSITORIES],
                $c[self::D_LOCK_HANDLER],
                $c[self::D_STREAM_ACCESS],
                $c[self::D_FILENAME_POLICY],
            );
        };
        return $c[self::D_RESOURCE_BUILDER];
    }

Here is the call graph for this function:

Here is the caller graph for this function:

init()

InitResourceStorage::init

(

\ILIAS\DI\Container

$c

)

Definition at line 107 of file InitResourceStorage.php.

References $c, ALL, buildBasePath(), getResourceBuilder(), and ILIAS\Setup\Artifact\BuildArtifactObjective\PATH().

Referenced by getFlavourBuilder(), and getResourceBuilder().

                                                : void
    {
        if ($this->init) {
            return;
        }
        $base_dir = $this->buildBasePath();

        // DB Repositories
        $c[self::D_REPOSITORIES] = static function (Container $c): Repositories {
            return new Repositories(
                new RevisionDBRepository($c->database()),
                new ResourceDBRepository($c->database()),
                new CollectionDBRepository($c->database()),
                new InformationDBRepository($c->database()),
                new StakeholderDBRepository($c->database()),
                new FlavourDBRepository($c->database()),
            );
        };

        // Repository Preloader
        $c[self::D_REPOSITORY_PRELOADER] = static function (Container $c) {
            return new DBRepositoryPreloader(
                $c->database(),
                $c[self::D_REPOSITORIES]
            );
        };

        // Lock Handler
        $c[self::D_LOCK_HANDLER] = static function (Container $c): LockHandler {
            return new LockHandlerilDB($c->database());
        };

        // Storage Handlers
        $c[self::D_STORAGE_HANDLERS] = static function (Container $c) use (
            $base_dir
        ): StorageHandlerFactory {
            return new StorageHandlerFactory([
                new MaxNestingFileSystemStorageHandler($c['filesystem.storage'], Location::STORAGE),
                new FileSystemStorageHandler($c['filesystem.storage'], Location::STORAGE)
            ], $base_dir);
        };

        // Source Builder for Consumers
        $c[self::D_SOURCE_BUILDER] = static function (Container $c): ?SrcBuilder {
            return new ilSecureTokenSrcBuilder(
                $c->fileDelivery()
            );
        };

        // Filename Policy for Consumers
        $c[self::D_FILENAME_POLICY] = static function (Container $c): FileNamePolicy {
            if ($c->isDependencyAvailable('settings') && $c->isDependencyAvailable('clientIni')) {
                return new ilFileServicesPolicy($c->fileServiceSettings());
            }
            return new NoneFileNamePolicy();
        };

        // Artifacts
        $c[self::D_ARTIFACTS] = static function (Container $c): Artifacts {
            $flavour_data = is_readable(ilResourceStorageFlavourArtifact::PATH()) ?
                include ilResourceStorageFlavourArtifact::PATH()
                : [];
            return new Artifacts(
                $flavour_data['machines'] ?? [],
                $flavour_data['definitions'] ?? []
            );
        };

        // Stream Access for Consumers and internal Usage
        $c[self::D_STREAM_ACCESS] = static function (Container $c) use ($base_dir): StreamAccess {
            return new StreamAccess(
                $base_dir,
                $c[self::D_STORAGE_HANDLERS]
            );
        };

        // Flavours
        $c[self::D_MACHINE_FACTORY] = static function (Container $c): Factory {
            return new Factory(
                new \ILIAS\ResourceStorage\Flavour\Engine\Factory(),
                $c[self::D_ARTIFACTS]->getFlavourMachines()
            );
        };

        //
        // IRSS
        //
        $c[self::D_SERVICE] = static function (Container $c): \ILIAS\ResourceStorage\Services {
            $services = new \ILIAS\ResourceStorage\Services(
                $c[self::D_STORAGE_HANDLERS],
                $c[self::D_REPOSITORIES],
                $c[self::D_ARTIFACTS],
                $c[self::D_LOCK_HANDLER],
                $c[self::D_FILENAME_POLICY],
                $c[self::D_STREAM_ACCESS],
                $c[self::D_MACHINE_FACTORY],
                $c[self::D_SOURCE_BUILDER],
                $c[self::D_REPOSITORY_PRELOADER],
            );

            // attach general observers
            $services->events()->attach(new IRSSEventLogObserver($c->logger()->irss()), Event::ALL);

            return $services;
        };

        $c[self::D_MIGRATOR] = function (Container $c) use ($base_dir): Migrator {
            return new Migrator(
                $c[self::D_STORAGE_HANDLERS],
                $this->getResourceBuilder($c),
                $c->database(),
                $base_dir
            );
        };

        $this->init = true;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

Field Documentation

$init

bool InitResourceStorage::$init = false

private

Definition at line 66 of file InitResourceStorage.php.

D_ARTIFACTS

const InitResourceStorage::D_ARTIFACTS = self::D_SERVICE . '.artifacts'

Definition at line 62 of file InitResourceStorage.php.

D_FILENAME_POLICY

const InitResourceStorage::D_FILENAME_POLICY = self::D_SERVICE . '.filename_policy'

Definition at line 60 of file InitResourceStorage.php.

D_FLAVOUR_BUILDER

const InitResourceStorage::D_FLAVOUR_BUILDER = self::D_SERVICE . '.flavour_builder'

Definition at line 56 of file InitResourceStorage.php.

D_LOCK_HANDLER

const InitResourceStorage::D_LOCK_HANDLER = self::D_SERVICE . '.lock_handler'

Definition at line 59 of file InitResourceStorage.php.

D_MACHINE_FACTORY

const InitResourceStorage::D_MACHINE_FACTORY = self::D_SERVICE . '.machine_factory'

Definition at line 63 of file InitResourceStorage.php.

D_MIGRATOR

const InitResourceStorage::D_MIGRATOR = self::D_SERVICE . '.migrator'

Definition at line 64 of file InitResourceStorage.php.

Referenced by ILIAS\ResourceStorage\Resource\ResourceBuilder\storeRevision().

D_REPOSITORIES

const InitResourceStorage::D_REPOSITORIES = self::D_SERVICE . '.repositories'

Definition at line 53 of file InitResourceStorage.php.

Referenced by ilResourceStorageMigrationHelper\__construct().

D_REPOSITORY_PRELOADER

const InitResourceStorage::D_REPOSITORY_PRELOADER = self::D_SERVICE . '.repository_preloader'

Definition at line 57 of file InitResourceStorage.php.

Referenced by ilResourceStorageMigrationHelper\__construct().

D_RESOURCE_BUILDER

const InitResourceStorage::D_RESOURCE_BUILDER = self::D_SERVICE . '.resource_builder'

Definition at line 55 of file InitResourceStorage.php.

D_SERVICE

const InitResourceStorage::D_SERVICE = 'resource_storage'

Definition at line 52 of file InitResourceStorage.php.

D_SOURCE_BUILDER

const InitResourceStorage::D_SOURCE_BUILDER = self::D_SERVICE . '.source_builder'

Definition at line 58 of file InitResourceStorage.php.

D_STORAGE_HANDLERS

const InitResourceStorage::D_STORAGE_HANDLERS = self::D_SERVICE . '.storage_handlers'

Definition at line 54 of file InitResourceStorage.php.

Referenced by ilWACSignedResourceStorage\__construct().

D_STREAM_ACCESS

const InitResourceStorage::D_STREAM_ACCESS = self::D_SERVICE . '.stream_access'

Definition at line 61 of file InitResourceStorage.php.

Referenced by ilWACSignedResourceStorage\__construct().

---

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

• components/ILIAS/Init/classes/Dependencies/InitResourceStorage.php