ILIAS\Style\Content\ImageFileRepo Class Reference

Collaboration diagram for ILIAS\Style\Content\ImageFileRepo:

Public Member Functions
	__construct (InternalDataService $factory, Filesystem\Filesystem $web_files, FileUpload $upload)
	getImages (int $style_id)
	Get images of style. More...
	getWebPath (string $path)
	uploadImage (int $style_id)
	deleteImageByFilename (int $style_id, string $filename)

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

Author

Alexander Killing killi.nosp@m.ng@l.nosp@m.eifos.nosp@m..de

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

Constructor & Destructor Documentation

__construct()

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

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

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

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

Here is the call graph for this function:

Member Function Documentation

deleteImageByFilename()

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

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

References ILIAS\Style\Content\ImageFileRepo\dir().

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

Here is the call graph for this function:

dir()

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

protected

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

Referenced by ILIAS\Style\Content\ImageFileRepo\deleteImageByFilename(), ILIAS\Style\Content\ImageFileRepo\getImages(), and ILIAS\Style\Content\ImageFileRepo\uploadImage().

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

Here is the caller graph for this function:

getImages()

ILIAS\Style\Content\ImageFileRepo::getImages

(

int

$style_id

)

Get images of style.

Parameters

int

$style_id

Returns

Generator

Exceptions

Filesystem

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

References ILIAS\Style\Content\ImageFileRepo\dir(), ILIAS\Style\Content\ImageFileRepo\getWebPath(), and ILIAS\Data\DataSize\KB.

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

     : Generator {
        $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
                    );
                }
            }
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getWebPath()

ILIAS\Style\Content\ImageFileRepo::getWebPath

(

string

$path

)

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

References $filename, $path, CLIENT_ID, ILIAS\Style\Content\ImageFileRepo\getImages(), and ILIAS_WEB_DIR.

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

                                            : string
    {
        return ILIAS_WEB_DIR . "/" . CLIENT_ID . "/" . $path;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

uploadImage()

ILIAS\Style\Content\ImageFileRepo::uploadImage

(

int

$style_id

)

Parameters

int

$style_id

Exceptions

Filesystem

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

References ILIAS\Style\Content\ImageFileRepo\$upload, ILIAS\Style\Content\ImageFileRepo\dir(), ILIAS\FileUpload\FileUpload\getResults(), ILIAS\FileUpload\FileUpload\hasBeenProcessed(), ILIAS\FileUpload\FileUpload\hasUploads(), ILIAS\FileUpload\FileUpload\moveFilesTo(), ILIAS\FileUpload\DTO\ProcessingStatus\OK, ILIAS\FileUpload\FileUpload\process(), and ILIAS\FileUpload\Location\WEB.

                                              : void
    {
        $upload = $this->upload;
        $dir = $this->dir($style_id);
        if (!$this->web_files->hasDir($dir)) {
            $this->web_files->createDir($dir);
        }
        if ($upload->hasUploads()) {
            if  (!$upload->hasBeenProcessed()) {
                $upload->process();
            }
            $result = array_values($upload->getResults())[0];
            if ($result->getStatus()->getCode() === ProcessingStatus::OK) {
                $upload->moveFilesTo($dir, Location::WEB);
            }
        }
    }

Here is the call graph for this function:

Field Documentation

$factory

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

protected

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

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

$upload

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

protected

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

Referenced by ILIAS\Style\Content\ImageFileRepo\__construct(), and ILIAS\Style\Content\ImageFileRepo\uploadImage().

$web_files

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

protected

Definition at line 38 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 35 of file class.ImageFileRepo.php.

---

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

• Services/Style/Content/Images/class.ImageFileRepo.php