Class ilResourceStorageMigrationHelper. More...

Collaboration diagram for ilResourceStorageMigrationHelper:

Public Member Functions
	__construct (ResourceStakeholder $stakeholder, Environment $environment)
	ilResourceStorageMigrationHelper constructor. More...

	getClientDataDir ()

	getDatabase ()

	getStakeholder ()

	getResourceBuilder ()

	getCollectionBuilder ()

	getManager ()

	moveFilesOfPatternToCollection (string $absolute_base_path, string $pattern, int $resource_owner_id, int $collection_owner_user_id=ResourceCollection::NO_SPECIFIC_OWNER, ?Closure $file_name_callback=null, ?Closure $revision_name_callback=null)

	movePathToStorage (string $absolute_path, int $owner_user_id, ?Closure $file_name_callback=null, ?Closure $revision_name_callback=null)

Static Public Member Functions
static	getPreconditions ()

Protected Attributes
string	$client_data_dir

ilDBInterface	$database

ResourceBuilder	$resource_builder

CollectionBuilder	$collection_builder

ResourceStakeholder	$stakeholder

Manager	$manager

Detailed Description

Class ilResourceStorageMigrationHelper.

Author: Fabian Schmid fs@st.nosp@m.uder.nosp@m.-raim.nosp@m.ann..nosp@m.ch

Definition at line 40 of file class.ilResourceStorageMigrationHelper.php.

Constructor & Destructor Documentation

◆ __construct()

ilResourceStorageMigrationHelper::__construct	(	ResourceStakeholder	$stakeholder,
		Environment	$environment
	)

ilResourceStorageMigrationHelper constructor.

Parameters

string	$client_data_dir
ilDBInterface	$database

PhpFieldAssignmentTypeMismatchInspection

Definition at line 54 of file class.ilResourceStorageMigrationHelper.php.

References $client_data_dir, $client_id, $container, $data_dir, Vendor\Package\$f, $stakeholder, InitResourceStorage\D_REPOSITORY_PRELOADER, and ILIAS\Setup\Environment\getResource().

       {
         $this->stakeholder = $stakeholder;
         $db = $environment->getResource(Environment::RESOURCE_DATABASE);
         $ilias_ini = $environment->getResource(Environment::RESOURCE_ILIAS_INI);
         $client_id = $environment->getResource(Environment::RESOURCE_CLIENT_ID);
         $data_dir = $ilias_ini->readVariable('clients', 'datadir');
         $client_data_dir = "{$data_dir}/{$client_id}";
         if (!defined("CLIENT_WEB_DIR")) {
             define("CLIENT_WEB_DIR", dirname(__DIR__, 4) . "/data/" . $client_id);
         }
         if (!defined("ILIAS_WEB_DIR")) {
             define("ILIAS_WEB_DIR", dirname(__DIR__, 4));
         }
         if (!defined("CLIENT_ID")) {
             define("CLIENT_ID", $client_id);
         }
         $this->client_data_dir = $client_data_dir;
         $this->database = $db;
 
         // Build Container
         $init = new InitResourceStorage();
         $container = new Container();
         $container['ilDB'] = $db;
         $storageConfiguration = new LocalConfig($client_data_dir);
         $f = new FlySystemFilesystemFactory();
         $container['filesystem.storage'] = $f->getLocal($storageConfiguration);
 
         $this->resource_builder = $init->getResourceBuilder($container);
         $this->collection_builder = new CollectionBuilder(
             new CollectionDBRepository($db)
         );
 
         $this->manager = new Manager(
             $this->resource_builder,
             $this->collection_builder,
             $container[InitResourceStorage::D_REPOSITORY_PRELOADER]
         );
     }

Here is the call graph for this function:

Member Function Documentation

◆ getClientDataDir()

ilResourceStorageMigrationHelper::getClientDataDir ( )

Definition at line 109 of file class.ilResourceStorageMigrationHelper.php.

References $client_data_dir.

Referenced by ilFileObjectToStorageMigrationHelper\__construct(), and ilFileObjectToStorageMigrationRunner\__construct().

                                       : string
     {
         return $this->client_data_dir;
     }

Here is the caller graph for this function:

◆ getCollectionBuilder()

ilResourceStorageMigrationHelper::getCollectionBuilder ( )

Definition at line 129 of file class.ilResourceStorageMigrationHelper.php.

References $collection_builder.

Referenced by getManager(), and moveFilesOfPatternToCollection().

                                           : CollectionBuilder
     {
         return $this->collection_builder;
     }

Here is the caller graph for this function:

◆ getDatabase()

ilResourceStorageMigrationHelper::getDatabase ( )

Definition at line 114 of file class.ilResourceStorageMigrationHelper.php.

References $database.

Referenced by ilFileObjectToStorageMigrationHelper\__construct(), and ilFileObjectToStorageMigrationRunner\__construct().

                                  : ilDBInterface
     {
         return $this->database;
     }

Here is the caller graph for this function:

◆ getManager()

ilResourceStorageMigrationHelper::getManager ( )

Definition at line 134 of file class.ilResourceStorageMigrationHelper.php.

References $manager, getCollectionBuilder(), and movePathToStorage().

Referenced by ilFileObjectToStorageMigrationRunner\__construct().

                                 : Manager
     {
         return $this->manager;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getPreconditions()

static ilResourceStorageMigrationHelper::getPreconditions ( )

static

Returns: []|[]|[]

Definition at line 100 of file class.ilResourceStorageMigrationHelper.php.

Referenced by ilBibliographicStorageMigration\getPreconditions(), and ilFileObjectToStorageMigration\getPreconditions().

                                              : array
     {
         return [
             new ilIniFilesLoadedObjective(),
             new ilDatabaseInitializedObjective(),
             new ilDatabaseUpdatedObjective(),
         ];
     }

Here is the caller graph for this function:

◆ getResourceBuilder()

ilResourceStorageMigrationHelper::getResourceBuilder ( )

Definition at line 124 of file class.ilResourceStorageMigrationHelper.php.

References $resource_builder.

Referenced by ilFileObjectToStorageMigrationRunner\__construct().

                                         : ResourceBuilder
     {
         return $this->resource_builder;
     }

Here is the caller graph for this function:

◆ getStakeholder()

ilResourceStorageMigrationHelper::getStakeholder ( )

Definition at line 119 of file class.ilResourceStorageMigrationHelper.php.

References $stakeholder.

Referenced by ilFileObjectToStorageMigrationRunner\__construct().

                                     : ResourceStakeholder
     {
         return $this->stakeholder;
     }

Here is the caller graph for this function:

◆ moveFilesOfPatternToCollection()

ilResourceStorageMigrationHelper::moveFilesOfPatternToCollection	(	string	$absolute_base_path,
		string	$pattern,
		int	$resource_owner_id,
		int	$collection_owner_user_id = `ResourceCollection::NO_SPECIFIC_OWNER`,
		?Closure	$file_name_callback = `null`,
		?Closure	$revision_name_callback = `null`
	)

Definition at line 172 of file class.ilResourceStorageMigrationHelper.php.

References getCollectionBuilder(), and movePathToStorage().

      : ?ResourceCollectionIdentification {
         $collection = $this->getCollectionBuilder()->new($collection_owner_user_id);
 
         $regex_iterator = new RecursiveRegexIterator(
             new RecursiveDirectoryIterator($absolute_base_path),
             $pattern,
             RecursiveRegexIterator::MATCH
         );
 
         foreach ($regex_iterator as $file_info) {
             if (!$file_info->isFile()) {
                 continue;
             }
             $resource_id = $this->movePathToStorage(
                 $file_info->getRealPath(),
                 $resource_owner_id,
                 $file_name_callback,
                 $revision_name_callback
             );
             if ($resource_id !== null) {
                 $collection->add($resource_id);
             }
         }
         if ($collection->count() === 0) {
             return null;
         }
 
         if ($this->getCollectionBuilder()->store($collection)) {
             return $collection->getIdentification();
         }
         return null;
     }

Here is the call graph for this function:

◆ movePathToStorage()

ilResourceStorageMigrationHelper::movePathToStorage	(	string	$absolute_path,
		int	$owner_user_id,
		?Closure	$file_name_callback = `null`,
		?Closure	$revision_name_callback = `null`
	)

Definition at line 212 of file class.ilResourceStorageMigrationHelper.php.

References Vendor\Package\$e.

Referenced by getManager(), and moveFilesOfPatternToCollection().

      : ?ResourceIdentification {
         try {
             // in some cases fopen throws a warning instead of returning false
             $open_path = fopen($absolute_path, 'rb');
         } catch (Throwable $e) {
             return null;
         }
 
         if ($open_path === false) {
             return null;
         }
         $stream = Streams::ofResource($open_path);
 
         // create new resource from legacy files stream
         $revision_title = $revision_name_callback !== null
             ? $revision_name_callback(basename($absolute_path))
             : basename($absolute_path);
 
         $file_name = $file_name_callback !== null
             ? $file_name_callback(basename($absolute_path))
             : null;
 
         $resource = $this->resource_builder->newFromStream(
             $stream,
             new StreamInfoResolver(
                 $stream,
                 1,
                 $owner_user_id,
                 $revision_title,
                 $file_name
             ),
             false
         );
 
         // add bibliographic stakeholder and store resource
         $resource->addStakeholder($this->stakeholder);
         $this->resource_builder->store($resource);
 
         return $resource->getIdentification();
     }