ILIAS  trunk Revision v11.0_alpha-1831-g8615d53dadb
•All Data Structures Namespaces Files Functions Variables Enumerations Enumerator Modules Pages
Public Member Functions | Data Fields
ILIAS\Setup\Environment Interface Reference

An environment holds resources to be used in the setup process. More...

+ Inheritance diagram for ILIAS\Setup\Environment:
+ Collaboration diagram for ILIAS\Setup\Environment:

Public Member Functions

 getResource (string $id)
 Consumers of this method should check if the result is what they expect, e.g. More...
 
 withResource (string $id, $resource)
 
 withConfigFor (string $component, $config)
 Stores a config for some component in the environment. More...
 
 getConfigFor (string $component)
 
 hasConfigFor (string $component)
 

Data Fields

const RESOURCE_DATABASE = "resource_database"
 
const RESOURCE_ADMIN_INTERACTION = "resource_admin_interaction"
 
const RESOURCE_ILIAS_INI = "resource_ilias_ini"
 
const RESOURCE_CLIENT_INI = "resource_client_ini"
 
const RESOURCE_SETTINGS_FACTORY = "resource_settings_factory"
 
const RESOURCE_CLIENT_ID = "resource_client_id"
 
const RESOURCE_PLUGIN_ADMIN = "resource_plugin_admin"
 
const RESOURCE_COMPONENT_REPOSITORY = "resource_component_repository"
 
const RESOURCE_COMPONENT_FACTORY = "resource_component_factory"
 

Detailed Description

An environment holds resources to be used in the setup process.

Objectives might add resources when they have been achieved.

Definition at line 27 of file Environment.php.

Member Function Documentation

◆ getConfigFor()

ILIAS\Setup\Environment::getConfigFor ( string  $component)
Exceptions

Implemented in ILIAS\Setup\ArrayEnvironment.

Referenced by ILIAS\Setup\CLI\ImportFileUnzippedFileObjective\achieve(), ilExportZipBuiltObjective\achieve(), ilFileSystemDirectoriesCreatedObjective\achieve(), ilDatabaseInitializedObjective\getPreconditions(), ilFileSystemDirectoriesCreatedObjective\getPreconditions(), ilDatabasePopulatedObjective\getPreconditions(), ilStorageContainersExistingObjective\getPreconditions(), and ilFileSystemComponentDataDirectoryCreatedObjective\getPreconditions().

+ Here is the caller graph for this function:

◆ getResource()

ILIAS\Setup\Environment::getResource ( string  $id)

Consumers of this method should check if the result is what they expect, e.g.

implements some known interface.

Returns
mixed|null

Implemented in ILIAS\Setup\ArrayEnvironment.

Referenced by ilResourceStorageMigrationHelper\__construct(), ilEventHandlingBuildEventInfoObjective\achieve(), ILIAS\Wiki\Setup\AccessRBACOperationClonedObjective\achieve(), ilDBStepExecutionDBExistsObjective\achieve(), ilInstIdDefaultStoredObjective\achieve(), ILIAS\Setup\AccessRBACOperationClonedObjective\achieve(), ilNICKeyStoredObjective\achieve(), ilDataCollectionObjective\achieve(), ilSettingsFactoryExistsObjective\achieve(), ilMakeInstallationAccessibleObjective\achieve(), ilGlobalCacheAllFlushedObjective\achieve(), ilDatabaseUpdatedObjective\achieve(), ilOrgUnitRemoveDeletedUsersObjective\achieve(), ilDatabaseConfigStoredObjective\achieve(), ilUITestRailExampleTestCasesObjective\achieve(), ilChatroomServerConfigStoredObjective\achieve(), ilNICKeyRegisteredObjective\achieve(), ilFileSystemClientDirectoryRenamedObjective\achieve(), ilFileSystemConfigNotChangedObjective\achieve(), ilLoggingConfigStoredObjective\achieve(), ilAccessRBACOperationOrderUpdatedObjective\achieve(), ilAccessRBACOperationDeletedObjective\achieve(), ilNoMajorVersionSkippedConditionObjective\achieve(), ilNoVersionDowngradeConditionObjective\achieve(), ilWebServicesConfigStoredObjective\achieve(), ilObjectNewTypeAddedObjective\achieve(), ilOrgUnitOperationContextRegisteredObjective\achieve(), ilVersionWrittenToSettingsObjective\achieve(), ilInstallationInformationStoredObjective\achieve(), ilDatabaseInitializedObjective\achieve(), ilAccessRBACTemplateAddedObjective\achieve(), ilAccessRBACOperationClonedObjective\achieve(), ilComponentRepositoryExistsObjective\achieve(), ilOrgUnitOperationRegisteredObjective\achieve(), ilStyleClassAddedObjective\achieve(), ilStyleClassCopiedObjective\achieve(), ilAccessRolePermissionSetObjective\achieve(), ilTreeImplementationSwitch\achieve(), ilDefaultLanguageSetObjective\achieve(), ilComponentFactoryExistsObjective\achieve(), ilAccessCustomRBACOperationAddedObjective\achieve(), ilOverwritesExistingInstallationConfirmed\achieve(), ilUseRootConfirmed\achieve(), ilDatabaseResetStepsObjective\achieve(), ilDatabaseDumpedToDirectoryObjective\achieve(), ilAccessRbacStandardOperationsAddedObjective\achieve(), ilTreeAdminNodeAddedObjective\achieve(), ilPluginLanguageUpdatedObjective\achieve(), ILIAS\Setup\Objective\AdminConfirmedObjective\achieve(), ilComponentActivatePluginsObjective\achieve(), ilLanguagesUpdatedObjective\achieve(), ilDatabaseUpdateStepsExecutedObjective\achieve(), ilComponentInstallPluginObjective\achieve(), ilComponentUpdatePluginObjective\achieve(), ilLanguagesInstalledAndUpdatedObjective\achieve(), ILIAS\Setup\Condition\ExternalConditionObjective\achieve(), ilFileSystemDirectoriesCreatedObjective\achieve(), ilAccessInitialPermissionGuidelineAppliedObjective\achieve(), ILIAS\FileDelivery\Setup\BaseDirObjective\buildIn(), ilFileSystemComponentDataDirectoryCreatedObjective\buildPath(), ilStorageContainersExistingObjective\buildStorageBasePath(), ilFileSystemComponentDataDirectoryCreatedObjective\checkEnvironment(), ilLoggingMetricsCollectedObjective\collectFrom(), ilBackgroundTasksMetricsCollectedObjective\collectFrom(), ilGlobalCacheMetricsCollectedObjective\collectFrom(), ilTreeMetricsCollectedObjective\collectFrom(), ilFileSystemMetricsCollectedObjective\collectFrom(), ilDatabaseUpdateStepsMetricsCollectedObjective\collectFrom(), ilDatabaseMetricsCollectedObjective\collectFrom(), ILIAS\Test\Setup\DatabaseInconsistencyMetricsCollectedObjective\collectFrom(), ilFileObjectSettingsUpdatedObjective\getPreconditions(), ilGlobalCacheConfigStoredObjective\getPreconditions(), ilBackgroundTasksConfigStoredObjective\getPreconditions(), ILIAS\Setup\ilMysqlMyIsamToInnoDbMigration\getPreconditions(), ilFileSystemDirectoriesCreatedObjective\getPreconditions(), ilDatabasePopulatedObjective\getPreconditions(), ilDatabaseEnvironmentValidObjective\getPreconditions(), ilFileSystemDirectoryCopiedRecursivelyObjective\getPreconditions(), ILIAS\Setup\Objective\MigrationObjective\getPreconditions(), ILIAS\File\Icon\ilObjFileDefaultIconsObjective\getPreconditions(), ilDBStepReaderExistsObjective\isApplicable(), ilDBStepExecutionDBExistsObjective\isApplicable(), ILIAS\Wiki\Setup\AccessRBACOperationClonedObjective\isApplicable(), ILIAS\Setup\AccessRBACOperationClonedObjective\isApplicable(), ilAccessRBACOperationOrderUpdatedObjective\isApplicable(), ilFileSystemConfigNotChangedObjective\isApplicable(), ilDatabaseConfigStoredObjective\isApplicable(), ilDatabaseResetStepsObjective\isApplicable(), ilBackgroundTasksConfigStoredObjective\isApplicable(), ilObjectNewTypeAddedObjective\isApplicable(), ilLoggingConfigStoredObjective\isApplicable(), ilDatabaseInitializedObjective\isApplicable(), ilOrgUnitOperationContextRegisteredObjective\isApplicable(), ilOrgUnitOperationRegisteredObjective\isApplicable(), ilAccessRbacStandardOperationsAddedObjective\isApplicable(), ilDatabasePopulatedObjective\isApplicable(), ilStyleClassAddedObjective\isApplicable(), ilDatabaseUpdateStepsExecutedObjective\isApplicable(), ilStyleClassCopiedObjective\isApplicable(), ilFileSystemDirectoriesCreatedObjective\isApplicable(), ilAccessCustomRBACOperationAddedObjective\isApplicable(), ilTreeImplementationSwitch\isApplicable(), ilTreeAdminNodeAddedObjective\isApplicable(), ilMDCopyrightMigration\prepare(), ilBadgesFilesMigration\prepare(), ilBadgeTemplatesFilesMigration\prepare(), ilPollImagesMigration\prepare(), ILIAS\Setup\SelectOptionsMigration\prepare(), ILIAS\Test\Setup\CloneIntroductionAndClosingRemarksMigration\prepare(), ilExportFilesToIRSSMigration\prepare(), ilGlossaryDefinitionMigration\prepare(), LSOMigratePageIdsExtro\prepare(), LSOMigratePageIdsIntro\prepare(), ilGlossaryCollectionMigration\prepare(), ilMDLOMConformanceMigration\prepare(), ILIAS\MetaData\Setup\DeleteLOMForObjectTypeMigration\prepare(), ILIAS\MetaData\Setup\InitLOMForObjectTypeMigration\prepare(), and ILIAS\Setup\RecordFilesMigration\prepare().

+ Here is the caller graph for this function:

◆ hasConfigFor()

ILIAS\Setup\Environment::hasConfigFor ( string  $component)

Implemented in ILIAS\Setup\ArrayEnvironment.

Referenced by ilFileSystemClientDirectoryRenamedObjective\achieve(), ilFileSystemDirectoriesCreatedObjective\achieve(), ilDatabaseInitializedObjective\getPreconditions(), ilFileSystemDirectoriesCreatedObjective\getPreconditions(), ilDatabasePopulatedObjective\getPreconditions(), ilStorageContainersExistingObjective\getPreconditions(), ilFileSystemComponentDataDirectoryCreatedObjective\getPreconditions(), ilDatabasePopulatedObjective\isApplicable(), and ilFileSystemDirectoriesCreatedObjective\isApplicable().

+ Here is the caller graph for this function:

◆ withConfigFor()

ILIAS\Setup\Environment::withConfigFor ( string  $component,
  $config 
)

Stores a config for some component in the environment.

Exceptions

Implemented in ILIAS\Setup\ArrayEnvironment.

Referenced by ilExportMetadataGatheredObjective\achieve(), and ILIAS\Setup\CLI\addAgentConfigsToEnvironment().

+ Here is the caller graph for this function:

◆ withResource()

ILIAS\Setup\Environment::withResource ( string  $id,
  $resource 
)
Exceptions

Implemented in ILIAS\Setup\ArrayEnvironment.

Referenced by ilDBStepExecutionDBExistsObjective\achieve(), ilDBStepReaderExistsObjective\achieve(), ilDatabaseExistsObjective\achieve(), and ilDatabaseInitializedObjective\achieve().

+ Here is the caller graph for this function:

Field Documentation

◆ RESOURCE_ADMIN_INTERACTION

const ILIAS\Setup\Environment::RESOURCE_ADMIN_INTERACTION = "resource_admin_interaction"

Definition at line 32 of file Environment.php.

Referenced by ILIAS\Setup\Objective\AdminConfirmedObjective\achieve(), ILIAS\Setup\Condition\ExternalConditionObjective\achieve(), ILIAS\Setup\CLI\BuildCommand\execute(), ILIAS\Setup\CLI\UpdateCommand\execute(), ILIAS\Setup\CLI\AchieveCommand\executeAchieveObjective(), ILIAS\Setup\Objective\MigrationObjective\getPreconditions(), ILIAS\Setup\CLI\MigrateCommand\listMigrations(), ILIAS\MetaData\Setup\DeleteLOMForObjectTypeMigration\prepare(), ILIAS\MetaData\Setup\InitLOMForObjectTypeMigration\prepare(), ILIAS\Setup\CLI\InstallCommand\prepareILIASInstallation(), ILIAS\Setup\CLI\InstallCommand\preparePluginInstallation(), ILIAS\Setup\CLI\MigrateCommand\runMigration(), ILIAS\Tests\Setup\Objective\AdminConfirmedObjectiveTest\testAchieveWithConfirmation(), and ILIAS\Tests\Setup\Objective\AdminConfirmedObjectiveTest\testAchieveWithDenial().

◆ RESOURCE_CLIENT_ID

const ILIAS\Setup\Environment::RESOURCE_CLIENT_ID = "resource_client_id"

Definition at line 36 of file Environment.php.

Referenced by ILIAS\Setup\Objective\ClientIdReadObjective\achieve(), ILIAS\Setup\Objective\ClientIdReadObjective\isApplicable(), ILIAS\Setup\CLI\InstallCommand\prepareILIASInstallation(), and ILIAS\Tests\Setup\Objective\ClientIdReadObjectiveTest\testAchieve().

◆ RESOURCE_CLIENT_INI

const ILIAS\Setup\Environment::RESOURCE_CLIENT_INI = "resource_client_ini"

Definition at line 34 of file Environment.php.

Referenced by ILIAS\Setup\ilMysqlMyIsamToInnoDbMigration\getPreconditions().

◆ RESOURCE_COMPONENT_FACTORY

const ILIAS\Setup\Environment::RESOURCE_COMPONENT_FACTORY = "resource_component_factory"

Definition at line 39 of file Environment.php.

◆ RESOURCE_COMPONENT_REPOSITORY

const ILIAS\Setup\Environment::RESOURCE_COMPONENT_REPOSITORY = "resource_component_repository"

Definition at line 38 of file Environment.php.

◆ RESOURCE_DATABASE

const ILIAS\Setup\Environment::RESOURCE_DATABASE = "resource_database"

Definition at line 31 of file Environment.php.

Referenced by ILIAS\Setup\AccessRBACOperationClonedObjective\achieve(), ILIAS\Test\Setup\DatabaseInconsistencyMetricsCollectedObjective\collectFrom(), ILIAS\Setup\ilMysqlMyIsamToInnoDbMigration\getPreconditions(), ILIAS\Setup\AccessRBACOperationClonedObjective\isApplicable(), ILIAS\Test\Setup\CloneIntroductionAndClosingRemarksMigration\prepare(), ILIAS\Setup\SelectOptionsMigration\prepare(), ILIAS\MetaData\Setup\DeleteLOMForObjectTypeMigration\prepare(), ILIAS\MetaData\Setup\InitLOMForObjectTypeMigration\prepare(), and ILIAS\Setup\RecordFilesMigration\prepare().

◆ RESOURCE_ILIAS_INI

const ILIAS\Setup\Environment::RESOURCE_ILIAS_INI = "resource_ilias_ini"

Definition at line 33 of file Environment.php.

Referenced by ILIAS\FileDelivery\Setup\BaseDirObjective\buildIn().

◆ RESOURCE_PLUGIN_ADMIN

const ILIAS\Setup\Environment::RESOURCE_PLUGIN_ADMIN = "resource_plugin_admin"

Definition at line 37 of file Environment.php.

◆ RESOURCE_SETTINGS_FACTORY

const ILIAS\Setup\Environment::RESOURCE_SETTINGS_FACTORY = "resource_settings_factory"

Definition at line 35 of file Environment.php.

Referenced by ILIAS\MetaData\Setup\InitLOMForObjectTypeMigration\prepare().

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