ILIAS\Component\Resource\PublicAssetManager Class Reference

Will take care of the public assets, just like a good manager does. More...

Collaboration diagram for ILIAS\Component\Resource\PublicAssetManager:

Public Member Functions
	addAssets (PublicAsset ... $assets)
	buildPublicFolder (string $ilias_base, string $target)

Data Fields
const	REGEXP = '%^(/\w+|\w+[\-.]\w+)+$%'
const	DONT_PURGE = ["data", "Customizing"]

Protected Member Functions
	insertInto (array &$assets, array $path, PublicAsset $asset)
	buildPublicFolderRecursively (string $ilias_base, string $target, PublicAsset|array $asset)
	buildPublicFolderRecursivelyArray (string $ilias_base, string $target, array $assets)
	copy (string $source, string $target)
	purge (string $path, array $dont_purge)
	makeDir (string $path)

Protected Attributes
	$assets = []

Detailed Description

Will take care of the public assets, just like a good manager does.

Definition at line 26 of file PublicAssetManager.php.

Member Function Documentation

addAssets()

ILIAS\Component\Resource\PublicAssetManager::addAssets

(

PublicAsset ...

$assets

)

Definition at line 35 of file PublicAssetManager.php.

References ILIAS\Component\Resource\PublicAssetManager\insertInto().

                                                     : void
    {
        foreach ($assets as $asset) {
            $this->insertInto($this->assets, explode("/", $asset->getTarget()), $asset);
        }
    }

Here is the call graph for this function:

buildPublicFolder()

ILIAS\Component\Resource\PublicAssetManager::buildPublicFolder	(	string	$ilias_base,
		string	$target
	)

Parameters

string	$ilias_base	full path to ILIAS base folder
string	$target	full path to public folder

Definition at line 76 of file PublicAssetManager.php.

References ILIAS\Component\Resource\PublicAssetManager\buildPublicFolderRecursivelyArray(), ILIAS\Component\Resource\PublicAssetManager\makeDir(), and ILIAS\Component\Resource\PublicAssetManager\purge().

                                                                         : void
    {
        if (!preg_match(self::REGEXP, $ilias_base)) {
            throw new \InvalidArgumentException(
                "'{$ilias_base}' is not a valid path to ILIAS base folder."
            );
        }
        if (!preg_match(self::REGEXP, $target)) {
            throw new \InvalidArgumentException(
                "'{$target}' is not a valid target path for public assets."
            );
        }

        $this->purge($target, array_map(fn($v) => $target . "/" . $v, self::DONT_PURGE));
        $this->makeDir($target);
        $this->buildPublicFolderRecursivelyArray($ilias_base, $target, $this->assets);
    }

Here is the call graph for this function:

buildPublicFolderRecursively()

ILIAS\Component\Resource\PublicAssetManager::buildPublicFolderRecursively ( string  $ilias_base, string  $target, PublicAsset|array  $asset  )

protected

Definition at line 94 of file PublicAssetManager.php.

References ILIAS\Component\Resource\PublicAssetManager\buildPublicFolderRecursivelyArray(), ILIAS\Component\Resource\PublicAssetManager\copy(), and ILIAS\Component\Resource\PublicAssetManager\makeDir().

Referenced by ILIAS\Component\Resource\PublicAssetManager\buildPublicFolderRecursivelyArray().

                                                                                                                 : void
    {
        if (is_array($asset)) {
            $this->makeDir("$target");
            $this->buildPublicFolderRecursivelyArray($ilias_base, $target, $asset);
        } else {
            $targets = explode("/", $asset->getTarget());
            $this->copy("$ilias_base/{$asset->getSource()}", "$target");
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

buildPublicFolderRecursivelyArray()

ILIAS\Component\Resource\PublicAssetManager::buildPublicFolderRecursivelyArray ( string  $ilias_base, string  $target, array  $assets  )

protected

Definition at line 105 of file PublicAssetManager.php.

References ILIAS\Component\Resource\PublicAssetManager\buildPublicFolderRecursively().

Referenced by ILIAS\Component\Resource\PublicAssetManager\buildPublicFolder(), and ILIAS\Component\Resource\PublicAssetManager\buildPublicFolderRecursively().

                                                                                                           : void
    {
        foreach ($assets as $key => $asset) {
            $this->buildPublicFolderRecursively($ilias_base, "$target/$key", $asset);
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

copy()

ILIAS\Component\Resource\PublicAssetManager::copy ( string  $source, string  $target  )

protected

Definition at line 112 of file PublicAssetManager.php.

References Vendor\Package\$d, and ILIAS\Component\Resource\PublicAssetManager\makeDir().

Referenced by ILIAS\Component\Resource\PublicAssetManager\buildPublicFolderRecursively().

                                                           : void
    {
        if (is_file($source)) {
            copy($source, $target);
        } elseif (is_dir($source)) {
            $dir = new \RecursiveDirectoryIterator($source, \FilesystemIterator::SKIP_DOTS);
            $this->makeDir($target);
            foreach ($dir as $d) {
                $name = $d->getBasename();
                $this->copy("$source/$name", "$target/$name");
            }
        } else {
            throw new \RuntimeException(
                "Cannot copy $source, not a file or directory."
            );
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

insertInto()

ILIAS\Component\Resource\PublicAssetManager::insertInto ( array &  $assets, array  $path, PublicAsset  $asset  )

protected

Definition at line 42 of file PublicAssetManager.php.

Referenced by ILIAS\Component\Resource\PublicAssetManager\addAssets().

                                                                                  : void
    {
        $key = array_shift($path);
        $key_exists = array_key_exists($key, $assets);
        $target_reached = count($path) === 0;

        if (!$key_exists && $target_reached) {
            $assets[$key] = $asset;
            return;
        }

        if (!$target_reached && (!$key_exists || is_array($assets[$key]))) {
            if (!$key_exists) {
                $assets[$key] = [];
            }
            $this->insertInto($assets[$key], $path, $asset);
            return;
        }

        $first_asset = $assets[$key];
        while (!$first_asset instanceof PublicAsset) {
            $first_asset = array_shift($first_asset);
        }

        throw new \LogicException(
            "There are (at least) two assets for the same target '{$asset->getTarget()}': " .
            "'{$first_asset->getSource()}' and '{$asset->getSource()}'"
        );
    }

Here is the caller graph for this function:

makeDir()

ILIAS\Component\Resource\PublicAssetManager::makeDir ( string  $path )

protected

Definition at line 159 of file PublicAssetManager.php.

Referenced by ILIAS\Component\Resource\PublicAssetManager\buildPublicFolder(), ILIAS\Component\Resource\PublicAssetManager\buildPublicFolderRecursively(), and ILIAS\Component\Resource\PublicAssetManager\copy().

                                            : void
    {
        if (!file_exists($path)) {
            mkdir($path, 0755);
        }
    }

Here is the caller graph for this function:

purge()

ILIAS\Component\Resource\PublicAssetManager::purge ( string  $path, array  $dont_purge  )

protected

Definition at line 130 of file PublicAssetManager.php.

Referenced by ILIAS\Component\Resource\PublicAssetManager\buildPublicFolder().

                                                             : bool
    {
        if (in_array($path, $dont_purge)) {
            return false;
        }

        if (!file_exists($path)) {
            return true;
        }

        if (is_file($path)) {
            unlink($path);
            return true;
        }

        if (is_dir($path)) {
            $purged = true;
            foreach (array_diff(scandir($path), ['.', '..']) as $item) {
                $purged = $this->purge($path . "/" . $item, $dont_purge) && $purged;
            }
            if ($purged) {
                rmdir($path);
            }
            return $purged;
        }

        throw new \LogicException("Don't know how to purge $path");
    }

Here is the caller graph for this function:

Field Documentation

$assets

ILIAS\Component\Resource\PublicAssetManager::$assets = []

protected

Definition at line 32 of file PublicAssetManager.php.

DONT_PURGE

const ILIAS\Component\Resource\PublicAssetManager::DONT_PURGE = ["data", "Customizing"]

Definition at line 30 of file PublicAssetManager.php.

REGEXP

const ILIAS\Component\Resource\PublicAssetManager::REGEXP = '%^(/\w+|\w+[\-.]\w+)+$%'

Definition at line 28 of file PublicAssetManager.php.

---

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

• components/ILIAS/Component/src/Resource/PublicAssetManager.php