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

Collaboration diagram for InitResourceStorage:

Public Member Functions
	getResourceBuilder (Container $c)

	getFlavourBuilder (Container $c)

	init (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.

Deprecated:: Use from bootstrapping

Definition at line 51 of file InitResourceStorage.php.

Member Function Documentation

◆ buildBasePath()

InitResourceStorage::buildBasePath ( )

protected

Definition at line 201 of file InitResourceStorage.php.

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

References CLIENT_ID, and ILIAS_DATA_DIR.

Referenced by init().

Here is the caller graph for this function:

◆ getFlavourBuilder()

InitResourceStorage::getFlavourBuilder ( Container $c )

Definition at line 90 of file InitResourceStorage.php.

                                                   : FlavourBuilder
    {
        $this->init($c);
        $c[self::D_FLAVOUR_BUILDER] = (fn(Container $c): FlavourBuilder => 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];
    }

References Vendor\Package\$c, D_FLAVOUR_BUILDER, and init().

Here is the call graph for this function:

◆ getResourceBuilder()

InitResourceStorage::getResourceBuilder ( Container $c )

Definition at line 73 of file InitResourceStorage.php.

                                                    : ResourceBuilder
    {
        $this->init($c);
        $c[self::D_RESOURCE_BUILDER] = (fn(Container $c): ResourceBuilder => 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];
    }

References Vendor\Package\$c, D_RESOURCE_BUILDER, and init().

Referenced by init().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ init()

InitResourceStorage::init ( Container $c )

Definition at line 104 of file InitResourceStorage.php.

                                      : void
    {
        if ($this->init) {
            return;
        }
        $base_dir = $this->buildBasePath();
 
        // DB Repositories
        $c[self::D_REPOSITORIES] = (static fn(Container $c): Repositories => 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 fn(Container $c): DBRepositoryPreloader => new DBRepositoryPreloader(
            $c->database(),
            $c[self::D_REPOSITORIES]
        ));
 
        // Lock Handler
        $c[self::D_LOCK_HANDLER] = (static fn(Container $c): LockHandler => new LockHandlerilDB($c->database()));
 
        // Storage Handlers
        $c[self::D_STORAGE_HANDLERS] = (static fn(Container $c): StorageHandlerFactory => 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 fn(Container $c): SrcBuilder => 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 fn(Container $c): StreamAccess => new StreamAccess(
            $base_dir,
            $c[self::D_STORAGE_HANDLERS]
        ));
 
        // Flavours
        $c[self::D_MACHINE_FACTORY] = (static fn(Container $c): Factory => new Factory(
            new \ILIAS\ResourceStorage\Flavour\Engine\Factory(),
            $c[self::D_ARTIFACTS]->getFlavourMachines()
        ));
 
        //
        // IRSS
        //
        $c[self::D_SERVICE] = (static fn(Container $c): Services => new 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],
            static fn(): \ilLogger => $c->logger()->irss(),
        ));
 
        $c[self::D_MIGRATOR] = function (Container $c) use ($base_dir): Migrator {
            $rb = $this->getResourceBuilder($c);
            return new Migrator(
                $c[self::D_STORAGE_HANDLERS],
                static fn(StorableResource $r): bool => $rb->remove($r),
                $c->database(),
                $base_dir
            );
        };
 
        $this->init = true;
    }

References Vendor\Package\$c, buildBasePath(), D_ARTIFACTS, D_FILENAME_POLICY, D_LOCK_HANDLER, D_MACHINE_FACTORY, D_MIGRATOR, D_REPOSITORIES, D_REPOSITORY_PRELOADER, D_SERVICE, D_SOURCE_BUILDER, D_STORAGE_HANDLERS, D_STREAM_ACCESS, getResourceBuilder(), init(), and ILIAS\Setup\Artifact\BuildArtifactObjective\PATH().

Referenced by getFlavourBuilder(), getResourceBuilder(), and init().

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 67 of file InitResourceStorage.php.

◆ D_ARTIFACTS

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

Definition at line 63 of file InitResourceStorage.php.

Referenced by init().

◆ D_FILENAME_POLICY

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

Definition at line 61 of file InitResourceStorage.php.

Referenced by init().

◆ D_FLAVOUR_BUILDER

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

Definition at line 57 of file InitResourceStorage.php.

Referenced by getFlavourBuilder().

◆ D_LOCK_HANDLER

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

Definition at line 60 of file InitResourceStorage.php.

Referenced by init().

◆ D_MACHINE_FACTORY

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

Definition at line 64 of file InitResourceStorage.php.

Referenced by init().

◆ D_MIGRATOR

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

Definition at line 65 of file InitResourceStorage.php.

Referenced by init().

◆ D_REPOSITORIES

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

Definition at line 54 of file InitResourceStorage.php.

Referenced by ilResourceStorageMigrationHelper\__construct(), init(), and ILIAS\TestQuestionPool\ExportImport\Foundation\Normalize\NormalizerRegistration\register().

◆ D_REPOSITORY_PRELOADER

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

Definition at line 58 of file InitResourceStorage.php.

Referenced by ilResourceStorageMigrationHelper\__construct(), and init().

◆ D_RESOURCE_BUILDER

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

Definition at line 56 of file InitResourceStorage.php.

Referenced by getResourceBuilder().

◆ D_SERVICE

const InitResourceStorage::D_SERVICE = 'resource_storage'

Definition at line 53 of file InitResourceStorage.php.

Referenced by init().

◆ D_SOURCE_BUILDER

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

Definition at line 59 of file InitResourceStorage.php.

Referenced by init().

◆ D_STORAGE_HANDLERS

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

Definition at line 55 of file InitResourceStorage.php.

Referenced by init().

◆ D_STREAM_ACCESS

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

Definition at line 62 of file InitResourceStorage.php.

Referenced by init().

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

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

Public Member Functions

Data Fields

Protected Member Functions

Private Attributes

Detailed Description

Member Function Documentation

◆ buildBasePath()

◆ getFlavourBuilder()

◆ getResourceBuilder()

◆ init()

Field Documentation

◆ $init

◆ D_ARTIFACTS

◆ D_FILENAME_POLICY

◆ D_FLAVOUR_BUILDER

◆ D_LOCK_HANDLER

◆ D_MACHINE_FACTORY

◆ D_MIGRATOR

◆ D_REPOSITORIES

◆ D_REPOSITORY_PRELOADER

◆ D_RESOURCE_BUILDER

◆ D_SERVICE

◆ D_SOURCE_BUILDER

◆ D_STORAGE_HANDLERS

◆ D_STREAM_ACCESS