Collaboration diagram for ILIAS\Style\Content\ImageFileRepo:

Public Member Functions
	__construct (InternalDataService $factory, Filesystem\Filesystem $web_files, FileUpload $upload, protected IRSSWrapper $irss)

	getImages (int $style_id, string $rid, bool $include_size_info=false, bool $include_legacy_dir=true)
	Get images of style. More...

	hasLegacyDir (int $style_id)

	hasImages (int $style_id, string $rid)

	getImageStream (string $rid, string $image)

	addStream (string $rid, string $image, FileStream $stream)

	getWebPath (string $path)

	deleteImageByFilename (int $style_id, string $filename)

	importFromUploadResult (string $rid, UploadResult $result,)

Protected Member Functions
	dir (int $style_id)

Protected Attributes
const	DIR_PATH = "sty/sty_%id%/images"

InternalDataService	$factory

Filesystem Filesystem	$web_files

FileUpload	$upload

Detailed Description

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

Constructor & Destructor Documentation

◆ __construct()

ILIAS\Style\Content\ImageFileRepo::__construct	(	InternalDataService	$factory,
		Filesystem\Filesystem	$web_files,
		FileUpload	$upload,
		protected IRSSWrapper	$irss
	)

Definition at line 42 of file class.ImageFileRepo.php.

      {
        $this->web_files = $web_files;
        $this->factory = $factory;
        $this->upload = $upload;
    }

References ILIAS\Style\Content\ImageFileRepo\$factory, ILIAS\Style\Content\ImageFileRepo\$upload, ILIAS\Style\Content\ImageFileRepo\$web_files, factory(), and ILIAS\Repository\upload().

Here is the call graph for this function:

Member Function Documentation

◆ addStream()

ILIAS\Style\Content\ImageFileRepo::addStream	(	string	$rid,
		string	$image,
		FileStream	$stream
	)

Definition at line 167 of file class.ImageFileRepo.php.

     : void {
        $this->irss->addStreamToContainer(
            $rid,
            $stream,
            "images/" . $image
        );
    }

◆ deleteImageByFilename()

ILIAS\Style\Content\ImageFileRepo::deleteImageByFilename	(	int	$style_id,
		string	$filename
	)

Definition at line 201 of file class.ImageFileRepo.php.

                                                                          : void
    {
        $dir = $this->dir($style_id);
        $this->web_files->delete($dir . "/" . $filename);
    }

References $filename.

◆ dir()

ILIAS\Style\Content\ImageFileRepo::dir ( int $style_id )

protected

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

                                         : string
    {
        return str_replace("%id%", (string) $style_id, self::DIR_PATH);
    }

◆ getImages()

ILIAS\Style\Content\ImageFileRepo::getImages	(	int	$style_id,
		string	$rid,
		bool	$include_size_info = `false`,
		bool	$include_legacy_dir = `true`
	)

Get images of style.

Parameters

int $style_id

Returns: Generator

Exceptions

Filesystem

Exception\DirectoryNotFoundException

Definition at line 65 of file class.ImageFileRepo.php.

     : Generator {
        $has_images = false;
        if ($rid !== "") {
            $unzip = $this->irss->getContainerZip($rid);
            $uri = $this->irss->stream($rid)->getMetadata("uri");
            $zip_archive = new \ZipArchive();
            $zip_archive->open($uri, \ZipArchive::RDONLY);
 
            foreach ($unzip->getPaths() as $path) {
                if (str_starts_with($path, ".")) {
                    continue;
                }
                if (!str_starts_with($path, "images")) {
                    continue;
                }
                if (!in_array(strtolower(pathinfo($path, PATHINFO_EXTENSION)), ["jpg", "png", "gif", "svg"])) {
                    continue;
                }
                $att = $zip_archive->statName($path);
                if ($include_size_info) {
                    $full_path = $this->irss->getContainerUri($rid, $path);
                    try {
                        $stream = $this->irss->getStreamOfContainerEntry($rid, $path);
                        $content = $stream->getContents();
                        $image_size = getimagesizefromstring($content);
                    } catch (\Exception $e) {
                    }
                    $width = $image_size[0] ?? 0;
                    $height = $image_size[1] ?? 0;
                } else {
                    $width = 0;
                    $height = 0;
                }
                $has_images = true;
                yield $this->factory->image(
                    $this->irss->getContainerUri($rid, $path),
                    new DataSize($att["size"], DataSize::KB),
                    $width,
                    $height
                );
            }
        }
 
        if ($has_images || !$include_legacy_dir) {
            return;
        }
 
        $dir = $this->dir($style_id);
        if ($this->web_files->hasDir($dir)) {
            foreach ($this->web_files->listContents($dir) as $meta) {
                if ($meta->isFile()) {
                    $size = $this->web_files->getSize(
                        $meta->getPath(),
                        DataSize::KB
                    );
                    $image_size = getimagesize($this->getWebPath($meta->getPath()));
                    $width = $image_size[0] ?? 0;
                    $height = $image_size[1] ?? 0;
                    yield $this->factory->image(
                        $meta->getPath(),
                        $size,
                        $width,
                        $height
                    );
                }
            }
        }
    }

References Vendor\Package\$e, $path, factory(), and ILIAS\Data\DataSize\KB.

Here is the call graph for this function:

◆ getImageStream()

ILIAS\Style\Content\ImageFileRepo::getImageStream	(	string	$rid,
		string	$image
	)

Definition at line 157 of file class.ImageFileRepo.php.

     : ZIPStream {
        return $this->irss->getStreamOfContainerEntry(
            $rid,
            "images/" . $image
        );
    }

◆ getWebPath()

ILIAS\Style\Content\ImageFileRepo::getWebPath ( string $path )

Definition at line 180 of file class.ImageFileRepo.php.

                                            : string
    {
        if (str_starts_with($path, "http")) {
            return $path;
        }
        return ILIAS_WEB_DIR . "/" . CLIENT_ID . "/" . $path;
    }

References $path, CLIENT_ID, and ILIAS_WEB_DIR.

◆ hasImages()

ILIAS\Style\Content\ImageFileRepo::hasImages	(	int	$style_id,
		string	$rid
	)

Definition at line 149 of file class.ImageFileRepo.php.

     : bool {
        $images = iterator_to_array($this->getImages($style_id, $rid, false, false));
        return count($images) > 0;
    }

◆ hasLegacyDir()

ILIAS\Style\Content\ImageFileRepo::hasLegacyDir ( int $style_id )

Definition at line 139 of file class.ImageFileRepo.php.

     : bool {
        $dir = $this->dir($style_id);
        if ($this->web_files->hasDir($dir)) {
            return true;
        }
        return false;
    }

◆ importFromUploadResult()

ILIAS\Style\Content\ImageFileRepo::importFromUploadResult	(	string	$rid,
		UploadResult	$result
	)

Definition at line 207 of file class.ImageFileRepo.php.

     : void {
        $this->irss->addUploadToContainer(
            $rid,
            $result
        );
    }

Field Documentation

◆ $factory

InternalDataService ILIAS\Style\Content\ImageFileRepo::$factory

protected

Definition at line 38 of file class.ImageFileRepo.php.

Referenced by ILIAS\Style\Content\ImageFileRepo\__construct().

◆ $upload

FileUpload ILIAS\Style\Content\ImageFileRepo::$upload

protected

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

Referenced by ILIAS\Style\Content\ImageFileRepo\__construct().

◆ $web_files

Filesystem Filesystem ILIAS\Style\Content\ImageFileRepo::$web_files

protected

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

Referenced by ILIAS\Style\Content\ImageFileRepo\__construct().

◆ DIR_PATH

const ILIAS\Style\Content\ImageFileRepo::DIR_PATH = "sty/sty_%id%/images"

protected

Definition at line 36 of file class.ImageFileRepo.php.

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

components/ILIAS/Style/Content/Images/class.ImageFileRepo.php

Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ addStream()

◆ deleteImageByFilename()

◆ dir()

◆ getImages()

◆ getImageStream()

◆ getWebPath()

◆ hasImages()

◆ hasLegacyDir()

◆ importFromUploadResult()

Field Documentation

◆ $factory

◆ $upload

◆ $web_files

◆ DIR_PATH