ILIAS\Badge\ilBadgeImage Class Reference

Collaboration diagram for ILIAS\Badge\ilBadgeImage:

Public Member Functions
	__construct (Services $resourceStorage, FileUpload $uploadService, ilGlobalTemplateInterface $main_template)
	getImageFromBadge (ilBadge $badge, int $size=self::IMAGE_SIZE_XS)
	getImageFromResourceId (ilBadge $badge, int $size=self::IMAGE_SIZE_XS)
	processImageUpload (ilBadge $badge)
	cloneBadgeImageByRid (ResourceIdentification $identification)

Data Fields
const	IMAGE_SIZE_XS = 4
const	IMAGE_SIZE_S = 3
const	IMAGE_SIZE_M = 2
const	IMAGE_SIZE_L = 1
const	IMAGE_SIZE_XL = 0
const	IMAGE_URL_COUNT = 5

Private Attributes
Services	$resource_storage
FileUpload	$upload_service
ilGlobalTemplateInterface	$main_template

Detailed Description

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

Constructor & Destructor Documentation

__construct()

ILIAS\Badge\ilBadgeImage::__construct	(	Services	$resourceStorage,
		FileUpload	$uploadService,
		ilGlobalTemplateInterface	$main_template
	)

Definition at line 46 of file class.ilBadgeImage.php.

References ILIAS\Badge\ilBadgeImage\$main_template.

      {
        $this->resource_storage = $resourceStorage;
        $this->upload_service = $uploadService;
        $this->main_template = $main_template;
    }

Member Function Documentation

cloneBadgeImageByRid()

ILIAS\Badge\ilBadgeImage::cloneBadgeImageByRid

(

ResourceIdentification

$identification

)

Exceptions

Exception

Definition at line 102 of file class.ilBadgeImage.php.

                                                                                : string
    {
        return $this->resource_storage->manage()->clone($identification)->serialize();
    }

getImageFromBadge()

ILIAS\Badge\ilBadgeImage::getImageFromBadge	(	ilBadge	$badge,
		int	$size = self::IMAGE_SIZE_XS
	)

Definition at line 56 of file class.ilBadgeImage.php.

References ILIAS\Badge\ilBadgeImage\getImageFromResourceId().

                                                                                    : string
    {
        return $this->getImageFromResourceId($badge, $size);
    }

Here is the call graph for this function:

getImageFromResourceId()

ILIAS\Badge\ilBadgeImage::getImageFromResourceId	(	ilBadge	$badge,
		int	$size = self::IMAGE_SIZE_XS
	)

Definition at line 61 of file class.ilBadgeImage.php.

References ilBadge\getImage(), ilBadge\getImagePath(), ilBadge\getImageRid(), and ilWACSignedPath\signFile().

Referenced by ILIAS\Badge\ilBadgeImage\getImageFromBadge().

     : string {
        $image_src = '';

        if ($badge->getImageRid() !== '' && $badge->getImageRid() !== null) {
            $identification = $this->resource_storage->manage()->find($badge->getImageRid());
            if ($identification !== null) {
                $flavour = $this->resource_storage->flavours()->get($identification, new \ilBadgePictureDefinition());
                $urls = $this->resource_storage->consume()->flavourUrls($flavour)->getURLsAsArray();
                if (\count($urls) === self::IMAGE_URL_COUNT && isset($urls[$size])) {
                    $image_src = $urls[$size];
                }
            }
        } elseif ($badge->getImage()) {
            $image_src = ilWACSignedPath::signFile($badge->getImagePath());
        }

        return $image_src;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

processImageUpload()

ILIAS\Badge\ilBadgeImage::processImageUpload

(

ilBadge

$badge

)

Definition at line 84 of file class.ilBadgeImage.php.

References Vendor\Package\$e, ilBadge\setImageRid(), and ilBadge\update().

                                                      : void
    {
        try {
            $array_result = $this->upload_service->getResults();
            $array_result = array_pop($array_result);
            $stakeholder = new ilBadgeFileStakeholder();
            $identification = $this->resource_storage->manage()->upload($array_result, $stakeholder);
            $this->resource_storage->flavours()->ensure($identification, new \ilBadgePictureDefinition());
            $badge->setImageRid($identification->serialize());
            $badge->update();
        } catch (IllegalStateException $e) {
            $this->main_template->setOnScreenMessage('failure', $e->getMessage(), true);
        }
    }

Here is the call graph for this function:

Field Documentation

$main_template

ilGlobalTemplateInterface ILIAS\Badge\ilBadgeImage::$main_template

private

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

Referenced by ILIAS\Badge\ilBadgeImage\__construct().

$resource_storage

Services ILIAS\Badge\ilBadgeImage::$resource_storage

private

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

$upload_service

FileUpload ILIAS\Badge\ilBadgeImage::$upload_service

private

Definition at line 43 of file class.ilBadgeImage.php.

IMAGE_SIZE_L

const ILIAS\Badge\ilBadgeImage::IMAGE_SIZE_L = 1

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

IMAGE_SIZE_M

const ILIAS\Badge\ilBadgeImage::IMAGE_SIZE_M = 2

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

IMAGE_SIZE_S

const ILIAS\Badge\ilBadgeImage::IMAGE_SIZE_S = 3

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

IMAGE_SIZE_XL

const ILIAS\Badge\ilBadgeImage::IMAGE_SIZE_XL = 0

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

Referenced by ILIAS\Badge\Modal\components(), ILIAS\Badge\ilBadgeTableGUI\enrichRecord(), ILIAS\Badge\ilObjectBadgeTableGUI\enrichRecord(), and ILIAS\Badge\ilBadgeImageTemplateTableGUI\getRecords().

IMAGE_SIZE_XS

const ILIAS\Badge\ilBadgeImage::IMAGE_SIZE_XS = 4

Definition at line 35 of file class.ilBadgeImage.php.

IMAGE_URL_COUNT

const ILIAS\Badge\ilBadgeImage::IMAGE_URL_COUNT = 5

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

---

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

• components/ILIAS/Badge/classes/class.ilBadgeImage.php