ilFileObjectToStorageDirectory Class Reference

This file is part of ILIAS, a powerful learning management system published by ILIAS open source e-Learning e.V. More...

Collaboration diagram for ilFileObjectToStorageDirectory:

Public Member Functions
	__construct (int $object_id, string $path)
	ilFileObjectToStorageDirectory constructor. More...
	getVersions ()
	getObjectId ()
	tearDown ()

Static Public Member Functions
static	parseInfoParams (array $entry)

Protected Attributes
int	$object_id
string	$path
array	$versions = []

Private Member Functions
	initVersions ()
	getHistoryData ()

Detailed Description

This file is part of ILIAS, a powerful learning management system published by ILIAS open source e-Learning e.V.

ILIAS is licensed with the GPL-3.0, see https://www.gnu.org/licenses/gpl-3.0.en.html You should have received a copy of said license along with the source code, too.

If this is not the case or you just want to try ILIAS, you'll find us at: https://www.ilias.de https://github.com/ILIAS-eLearning Class ilFileObjectToStorageDirectory

Author

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

Definition at line 23 of file class.ilFileObjectToStorageDirectory.php.

Constructor & Destructor Documentation

__construct()

ilFileObjectToStorageDirectory::__construct	(	int	$object_id,
		string	$path
	)

ilFileObjectToStorageDirectory constructor.

Parameters

int	$object_id
string	$path

Definition at line 37 of file class.ilFileObjectToStorageDirectory.php.

References $object_id, $path, and initVersions().

    {
        $this->object_id = $object_id;
        $this->path = $path;
        $this->initVersions();
    }

Here is the call graph for this function:

Member Function Documentation

getHistoryData()

ilFileObjectToStorageDirectory::getHistoryData ( )

private

Definition at line 87 of file class.ilFileObjectToStorageDirectory.php.

References $i, $version, ilHistory\_getEntriesForObject(), and ILIAS\Repository\int().

Referenced by initVersions().

                                     : array
    {
        $info = ilHistory::_getEntriesForObject($this->object_id, 'file');
        $history_data = [];
        foreach ($info as $i) {
            $parsed_info = self::parseInfoParams($i);
            $version = (int) $parsed_info['version'];
            $history_data[$version] = $parsed_info;
            $history_data[$version]['owner_id'] = (int) $i['user_id'];
            $history_data[$version]['date'] = (string) $i['date'];
            $history_data[$version]['action'] = (string) $i['action'];
        }

        uasort($history_data, static function ($v1, $v2) {
            return (int) $v2["version"] - (int) $v1["version"];
        });
        return $history_data;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getObjectId()

ilFileObjectToStorageDirectory::getObjectId

(

)

Returns

int

Definition at line 117 of file class.ilFileObjectToStorageDirectory.php.

References $object_id.

Referenced by ilFileObjectToStorageMigrationRunner\getResource(), and ilFileObjectToStorageMigrationRunner\migrate().

                                 : int
    {
        return $this->object_id;
    }

Here is the caller graph for this function:

getVersions()

ilFileObjectToStorageDirectory::getVersions

(

)

Returns

Generator|ilFileObjectToStorageVersion[]

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

References $versions.

Referenced by ilFileObjectToStorageMigrationRunner\migrate().

                                 : Generator
    {
        yield from $this->versions;
    }

Here is the caller graph for this function:

initVersions()

ilFileObjectToStorageDirectory::initVersions ( )

private

Definition at line 44 of file class.ilFileObjectToStorageDirectory.php.

References $version, getHistoryData(), and ILIAS\Repository\int().

Referenced by __construct().

                                   : void
    {
        $history_data = $this->getHistoryData();

        $g = new RegexIterator(
            new RecursiveIteratorIterator(
                new RecursiveDirectoryIterator(
                    $this->path,
                    FilesystemIterator::KEY_AS_PATHNAME
                    | FilesystemIterator::CURRENT_AS_FILEINFO
                    | FilesystemIterator::SKIP_DOTS
                ),
                RecursiveIteratorIterator::LEAVES_ONLY
            ),
            '/.*\/file_[\d]*\/([\d]*)\/(.*)/',
            RegexIterator::GET_MATCH
        );

        $this->versions = [];

        foreach ($g as $item) {
            $version = (int) $item[1];
            $title = $history_data[$version]['filename'] ?? $item[2];
            $action = $history_data[$version]['action'] ?? 'create';
            $owner = $history_data[$version]['owner_id'] ?? 13;
            $creation_date_timestamp = strtotime($history_data[$version]['date'] ?? '0');
            if ($creation_date_timestamp === false) {
                $creation_date_timestamp = 0;
            }
            $this->versions[$version] = new ilFileObjectToStorageVersion(
                $version,
                $item[0],
                $title,
                $title,
                $action,
                $creation_date_timestamp,
                $owner
            );
        }
        ksort($this->versions);
    }

Here is the call graph for this function:

Here is the caller graph for this function:

parseInfoParams()

static ilFileObjectToStorageDirectory::parseInfoParams ( array  $entry )

static

Definition at line 127 of file class.ilFileObjectToStorageDirectory.php.

References $data.

                                                        : array
    {
        $data = explode(",", $entry["info_params"]);

        // bugfix: first created file had no version number
        // this is a workaround for all files created before the bug was fixed
        if (empty($data[1])) {
            $data[1] = "1";
        }

        if (empty($data[2])) {
            $data[2] = "1";
        }

        // BEGIN bugfix #31730
        // if more than 2 commas are detected, the need for reassembling the filename is: possible to necessary
        if (sizeof($data) > 2) {
            $last = sizeof($data) - 1;
            for ($n = 1; $n < $last - 1; $n++) {
                $data[0] .= "," . $data[$n];
            }

            // trying to distinguish the next-to-last being a 'last part of the filename'
            // or a 'version information',  based on having a dot included or not
            if (strpos($data[$last - 1], ".") !== false) {
                $data[0] .= "," . $data[$last - 1];
                $data[1] = $data[$last];
                $data[2] = $data[$last];
            } else {
                $data[1] = $data[$last - 1];
                $data[2] = $data[$last];
            }
        }
        // END bugfix #31730

        $result = array(
            "filename" => $data[0],
            "version" => $data[1],
            "max_version" => $data[2],
            "rollback_version" => "",
            "rollback_user_id" => "",
        );

        // if rollback, the version contains the rollback version as well
        if ($entry["action"] == "rollback") {
            $tokens = explode("|", $result["max_version"]);
            if (count($tokens) > 1) {
                $result["max_version"] = $tokens[0];
                $result["rollback_version"] = $tokens[1];

                if (count($tokens) > 2) {
                    $result["rollback_user_id"] = $tokens[2];
                }
            }
        }

        return $result;
    }

tearDown()

ilFileObjectToStorageDirectory::tearDown

(

)

Definition at line 122 of file class.ilFileObjectToStorageDirectory.php.

References ilFileObjectToStorageMigrationHelper\MIGRATED.

Referenced by ilFileObjectToStorageMigrationRunner\migrate().

                              : void
    {
        touch(rtrim($this->path, "/") . "/" . ilFileObjectToStorageMigrationHelper::MIGRATED);
    }

Here is the caller graph for this function:

Field Documentation

$object_id

int ilFileObjectToStorageDirectory::$object_id

protected

Definition at line 25 of file class.ilFileObjectToStorageDirectory.php.

Referenced by __construct(), and getObjectId().

$path

string ilFileObjectToStorageDirectory::$path

protected

Definition at line 26 of file class.ilFileObjectToStorageDirectory.php.

Referenced by __construct().

$versions

array ilFileObjectToStorageDirectory::$versions = []

protected

Definition at line 30 of file class.ilFileObjectToStorageDirectory.php.

Referenced by getVersions().

---

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

• Modules/File/classes/Setup/class.ilFileObjectToStorageDirectory.php