ILIAS\COPage\Setup\EditorAssetVersionObjective Class Reference

Inheritance diagram for ILIAS\COPage\Setup\EditorAssetVersionObjective:

Collaboration diagram for ILIAS\COPage\Setup\EditorAssetVersionObjective:

Public Member Functions
	getArtifactName ()
	Get the filename where the builder wants to put its artifact. More...
	build ()
	Build the artifact based. More...
Public Member Functions inherited from ILIAS\Setup\Artifact\BuildArtifactObjective
	getArtifactName ()
	Get the filename where the builder wants to put its artifact. More...
	build ()
	Build the artifact based. More...
	buildIn (Setup\Environment $env)
	Builds an artifact in some given Environment. More...
	getPreconditions (Setup\Environment $environment)
	Defaults to no preconditions. More...
	getHash ()
	Uses hashed Path. More...
	getLabel ()
	Defaults to 'Build ' . More...
	isNotable ()
	Defaults to 'true'. More...
	achieve (Setup\Environment $environment)
	Builds the artifact and puts it in its location. More...
	isApplicable (Setup\Environment $environment)
Public Member Functions inherited from ILIAS\Setup\Objective
	getHash ()
	Get a hash for this objective. More...
	getLabel ()
	Get a label that describes this objective. More...
	isNotable ()
	Get to know if this is an interesting objective for a human. More...
	getPreconditions (Environment $environment)
	Objectives might depend on other objectives. More...
	achieve (Environment $environment)
	Objectives can be achieved. More...
	isApplicable (Environment $environment)
	Get to know whether the objective is applicable. More...

Static Public Member Functions
static	getVersionFromSource ()
static	getVersion ()
Static Public Member Functions inherited from ILIAS\Setup\Artifact\BuildArtifactObjective
static	PATH ()

Additional Inherited Members
Protected Member Functions inherited from ILIAS\Setup\Artifact\BuildArtifactObjective
	getPath ()
	makeDirectoryFor (string $path)
Protected Attributes inherited from ILIAS\Setup\Artifact\BuildArtifactObjective
const	ARTIFACTS = __DIR__ . "/../../../../../artifacts"

Detailed Description

Definition at line 27 of file class.EditorAssetVersionObjective.php.

Member Function Documentation

build()

ILIAS\COPage\Setup\EditorAssetVersionObjective::build

(

)

Build the artifact based.

If you want to use the environment reimplement buildIn instead.

Reimplemented from ILIAS\Setup\Artifact\BuildArtifactObjective.

Definition at line 34 of file class.EditorAssetVersionObjective.php.

                           : Artifact
    {
        return new ArrayArtifact([self::getVersionFromSource()]);
    }

getArtifactName()

ILIAS\COPage\Setup\EditorAssetVersionObjective::getArtifactName

(

)

Get the filename where the builder wants to put its artifact.

This is understood to be a path relative to the ILIAS root directory.

Reimplemented from ILIAS\Setup\Artifact\BuildArtifactObjective.

Definition at line 29 of file class.EditorAssetVersionObjective.php.

                                     : string
    {
        return "copage_editor_asset_version";
    }

getVersion()

static ILIAS\COPage\Setup\EditorAssetVersionObjective::getVersion ( )

static

Definition at line 66 of file class.EditorAssetVersionObjective.php.

                                       : string
    {
        $path = self::PATH();
        if (!is_readable($path)) {
            throw new \RuntimeException(
                "Missing COPage editor asset version artifact. Run setup build."
            );
        }
 
        $artifact = require $path;
        $version = is_array($artifact) ? ($artifact[0] ?? null) : null;
        if (!is_string($version) || !preg_match('/^[a-f0-9]{16}$/', $version)) {
            throw new \RuntimeException("Invalid COPage editor asset version artifact.");
        }
 
        return $version;
    }

References $version, and ILIAS\Setup\Artifact\BuildArtifactObjective\PATH().

Here is the call graph for this function:

getVersionFromSource()

static ILIAS\COPage\Setup\EditorAssetVersionObjective::getVersionFromSource ( )

static

Definition at line 39 of file class.EditorAssetVersionObjective.php.

                                                 : string
    {
        $files = [];
        foreach (["Editor/js", "PC/InteractiveImage/js"] as $directory) {
            $iterator = new \RecursiveIteratorIterator(
                new \RecursiveDirectoryIterator(
                    dirname(__DIR__, 2) . "/" . $directory,
                    \FilesystemIterator::SKIP_DOTS
                )
            );
            foreach ($iterator as $file) {
                if ($file->isFile()) {
                    $files[] = $directory . "/" . $iterator->getSubPathName();
                }
            }
        }
        sort($files, SORT_STRING);
 
        $hash = hash_init("sha256");
        foreach ($files as $file) {
            hash_update($hash, $file);
            hash_update_file($hash, dirname(__DIR__, 2) . "/" . $file);
        }
 
        return substr(hash_final($hash), 0, 16);
    }

References $files, ILIAS\Scripts\PHPStan\$iterator, and ILIAS\UI\examples\Symbol\Glyph\Sort\sort().

Referenced by ILIAS\COPage\init().

Here is the call graph for this function:

Here is the caller graph for this function:

---

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

• components/ILIAS/COPage/classes/Setup/class.EditorAssetVersionObjective.php