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
-
RuntimeException if there is no config for the component
- Returns
- mixed
Implemented in ILIAS\Setup\ArrayEnvironment.
Referenced by ilFileSystemDirectoriesCreatedObjective\achieve(), ILIAS\Setup\CLI\ImportFileUnzippedFileObjective\achieve(), ilExportZipBuiltObjective\achieve(), ilDatabaseInitializedObjective\getPreconditions(), ilDatabasePopulatedObjective\getPreconditions(), ilFileSystemComponentDataDirectoryCreatedObjective\getPreconditions(), ilFileSystemDirectoriesCreatedObjective\getPreconditions(), and ilStorageContainersExistingObjective\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(), ilAccessCustomRBACOperationAddedObjective\achieve(), ilAccessInitialPermissionGuidelineAppliedObjective\achieve(), ilAccessRBACOperationClonedObjective\achieve(), ilAccessRBACOperationDeletedObjective\achieve(), ilAccessRBACOperationOrderUpdatedObjective\achieve(), ilAccessRbacStandardOperationsAddedObjective\achieve(), ilAccessRBACTemplateAddedObjective\achieve(), ilAccessRolePermissionSetObjective\achieve(), ILIAS\Administration\Setup\Objective\CopyPermissions\achieve(), ILIAS\Administration\Setup\Objective\DropPermissions\achieve(), ILIAS\BookingManager\Setup\AccessRBACOperationClonedObjective\achieve(), ilGlobalCacheAllFlushedObjective\achieve(), ilDatabaseConfigStoredObjective\achieve(), ilDatabaseDumpedToDirectoryObjective\achieve(), ilDatabaseInitializedObjective\achieve(), ilDatabaseResetStepsObjective\achieve(), ilDatabaseUpdatedObjective\achieve(), ilDatabaseUpdateStepsExecutedObjective\achieve(), ilDBStepExecutionDBExistsObjective\achieve(), ilDataCollectionObjective\achieve(), ilFileSystemClientDirectoryRenamedObjective\achieve(), ilFileSystemConfigNotChangedObjective\achieve(), ilFileSystemDirectoriesCreatedObjective\achieve(), ILIAS\ILIASObject\Setup\NewTypeAddedObjective\achieve(), ilLoggingConfigStoredObjective\achieve(), PushNotificationObjective\achieve(), ilOrgUnitOperationContextRegisteredObjective\achieve(), ilOrgUnitOperationRegisteredObjective\achieve(), ilOrgUnitRemoveDeletedUsersObjective\achieve(), ilStyleClassAddedObjective\achieve(), ilStyleClassCopiedObjective\achieve(), ilTreeAdminNodeAddedObjective\achieve(), ilTreeImplementationSwitch\achieve(), ILIAS\Wiki\Setup\AccessRBACOperationClonedObjective\achieve(), ilInstallationInformationStoredObjective\achieve(), ilSettingsFactoryExistsObjective\achieve(), ilChatroomServerConfigStoredObjective\achieve(), ilComponentActivatePluginsObjective\achieve(), ilComponentFactoryExistsObjective\achieve(), ilComponentInstallPluginObjective\achieve(), ilComponentRepositoryExistsObjective\achieve(), ilComponentUpdatePluginObjective\achieve(), ilEventHandlingBuildEventInfoObjective\achieve(), ilDefaultLanguageSetObjective\achieve(), ilLanguagesInstalledAndUpdatedObjective\achieve(), ilLanguagesUpdatedObjective\achieve(), ilPluginLanguageUpdatedObjective\achieve(), ILIAS\Setup\Condition\ExternalConditionObjective\achieve(), ILIAS\Setup\Objective\AdminConfirmedObjective\achieve(), ilInstIdDefaultStoredObjective\achieve(), ilMakeInstallationAccessibleObjective\achieve(), ilNICKeyRegisteredObjective\achieve(), ilNICKeyStoredObjective\achieve(), ilNoMajorVersionSkippedConditionObjective\achieve(), ilNoVersionDowngradeConditionObjective\achieve(), ilOverwritesExistingInstallationConfirmed\achieve(), ilUseRootConfirmed\achieve(), ilVersionWrittenToSettingsObjective\achieve(), ilUITestRailExampleTestCasesObjective\achieve(), ilWebServicesConfigStoredObjective\achieve(), ILIAS\FileDelivery\Setup\BaseDirObjective\buildIn(), ilFileSystemComponentDataDirectoryCreatedObjective\buildPath(), ilStorageContainersExistingObjective\buildStorageBasePath(), ilFileSystemComponentDataDirectoryCreatedObjective\checkEnvironment(), ilBackgroundTasksMetricsCollectedObjective\collectFrom(), ilGlobalCacheMetricsCollectedObjective\collectFrom(), ilDatabaseMetricsCollectedObjective\collectFrom(), ilDatabaseUpdateStepsMetricsCollectedObjective\collectFrom(), ilFileSystemMetricsCollectedObjective\collectFrom(), ilLoggingMetricsCollectedObjective\collectFrom(), ILIAS\Test\Setup\DatabaseInconsistencyMetricsCollectedObjective\collectFrom(), ilTreeMetricsCollectedObjective\collectFrom(), ilDatabasePopulatedObjective\getPreconditions(), ilFileSystemDirectoriesCreatedObjective\getPreconditions(), ILIAS\Administration\Setup\AdminNodesVisibilityRemovedObjective\getTypesToChange(), ilAccessCustomRBACOperationAddedObjective\isApplicable(), ilAccessRBACOperationOrderUpdatedObjective\isApplicable(), ilAccessRbacStandardOperationsAddedObjective\isApplicable(), ILIAS\Administration\Setup\Objective\CopyPermissions\isApplicable(), ilBackgroundTasksConfigStoredObjective\isApplicable(), ILIAS\BookingManager\Setup\AccessRBACOperationClonedObjective\isApplicable(), ilDatabaseConfigStoredObjective\isApplicable(), ilDatabaseInitializedObjective\isApplicable(), ilDatabasePopulatedObjective\isApplicable(), ilDatabaseResetStepsObjective\isApplicable(), ilDatabaseUpdateStepsExecutedObjective\isApplicable(), ilDBStepExecutionDBExistsObjective\isApplicable(), ilDBStepReaderExistsObjective\isApplicable(), ilFileSystemConfigNotChangedObjective\isApplicable(), ilFileSystemDirectoriesCreatedObjective\isApplicable(), ILIAS\ILIASObject\Setup\NewTypeAddedObjective\isApplicable(), ilLoggingConfigStoredObjective\isApplicable(), ilOrgUnitOperationContextRegisteredObjective\isApplicable(), ilOrgUnitOperationRegisteredObjective\isApplicable(), ilStyleClassAddedObjective\isApplicable(), ilStyleClassCopiedObjective\isApplicable(), ilTreeAdminNodeAddedObjective\isApplicable(), ilTreeImplementationSwitch\isApplicable(), ILIAS\Wiki\Setup\AccessRBACOperationClonedObjective\isApplicable(), ILIAS\Administration\Setup\Objective\DropPermissions\operations(), ILIAS\AdvancedMetaData\Setup\SelectOptionsMigration\prepare(), ilBadgesFilesMigration\prepare(), ilBadgeTemplatesFilesMigration\prepare(), ilExportFilesToIRSSMigration\prepare(), ilGlossaryCollectionMigration\prepare(), ilGlossaryDefinitionMigration\prepare(), ILIAS\ILIASObject\Setup\MigrateTranslations\prepare(), LSOMigratePageIdsExtro\prepare(), LSOMigratePageIdsIntro\prepare(), ilMobLastChangeMigration\prepare(), ilMDCopyrightMigration\prepare(), ilMDLOMConformanceMigration\prepare(), ILIAS\MetaData\Setup\DeleteLOMForObjectTypeMigration\prepare(), ILIAS\MetaData\Setup\InitLOMForObjectTypeMigration\prepare(), ILIAS\Test\Setup\MoveSettingsTemplatesMigration\prepare(), ILIAS\Test\Setup\MoveTestSettingsMigration\prepare(), ILIAS\Test\Setup\RemoveLegacyTestSettingsMigration\prepare(), and ILIAS\User\Setup\UserProfileMigrations\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(), ilDatabasePopulatedObjective\getPreconditions(), ilFileSystemComponentDataDirectoryCreatedObjective\getPreconditions(), ilFileSystemDirectoriesCreatedObjective\getPreconditions(), ilStorageContainersExistingObjective\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
-
RuntimeException if this config is already in the environment.
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
-
RuntimeException if this resource is already in the environment.
Implemented in ILIAS\Setup\ArrayEnvironment.
Referenced by ilDatabaseExistsObjective\achieve(), ilDatabaseInitializedObjective\achieve(), ilDBStepExecutionDBExistsObjective\achieve(), and ilDBStepReaderExistsObjective\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\Condition\ExternalConditionObjective\achieve(), ILIAS\Setup\Objective\AdminConfirmedObjective\achieve(), ILIAS\Setup\CLI\BuildCommand\execute(), ILIAS\Setup\CLI\UpdateCommand\execute(), ILIAS\Setup\CLI\AchieveCommand\executeAchieveObjective(), ILIAS\Setup\CLI\MigrateCommand\listMigrations(), ILIAS\MetaData\Setup\DeleteLOMForObjectTypeMigration\prepare(), ILIAS\MetaData\Setup\InitLOMForObjectTypeMigration\prepare(), ILIAS\Test\Setup\MoveTestSettingsMigration\prepare(), ILIAS\User\Setup\UserProfileMigrations\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\Administration\Setup\AdminNodesVisibilityRemovedObjective\getTypesToChange().
◆ 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\Administration\Setup\Objective\CopyPermissions\achieve(), ILIAS\Administration\Setup\Objective\DropPermissions\achieve(), ILIAS\BookingManager\Setup\AccessRBACOperationClonedObjective\achieve(), ILIAS\ILIASObject\Setup\NewTypeAddedObjective\achieve(), ILIAS\Wiki\Setup\AccessRBACOperationClonedObjective\achieve(), ILIAS\Test\Setup\DatabaseInconsistencyMetricsCollectedObjective\collectFrom(), ILIAS\Administration\Setup\AdminNodesVisibilityRemovedObjective\getTypesToChange(), ILIAS\Administration\Setup\Objective\CopyPermissions\isApplicable(), ILIAS\BookingManager\Setup\AccessRBACOperationClonedObjective\isApplicable(), ILIAS\ILIASObject\Setup\NewTypeAddedObjective\isApplicable(), ILIAS\Wiki\Setup\AccessRBACOperationClonedObjective\isApplicable(), ILIAS\Administration\Setup\Objective\DropPermissions\operations(), ILIAS\AdvancedMetaData\Setup\SelectOptionsMigration\prepare(), ILIAS\ILIASObject\Setup\MigrateTranslations\prepare(), ILIAS\MetaData\Setup\DeleteLOMForObjectTypeMigration\prepare(), ILIAS\MetaData\Setup\InitLOMForObjectTypeMigration\prepare(), ILIAS\Test\Setup\MoveSettingsTemplatesMigration\prepare(), ILIAS\Test\Setup\MoveTestSettingsMigration\prepare(), ILIAS\Test\Setup\RemoveLegacyTestSettingsMigration\prepare(), and ILIAS\User\Setup\UserProfileMigrations\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(), and ILIAS\User\Setup\UserProfileMigrations\prepare().
The documentation for this interface was generated from the following file:
- components/ILIAS/Setup/src/Environment.php
