FileObjectPropertyProviders Class Reference

Inheritance diagram for FileObjectPropertyProviders:

Collaboration diagram for FileObjectPropertyProviders:

Public Member Functions
	__construct ()
	getObjectTypeSpecificTileImage (int $obj_id, ImageFactory $factory, StorageService $irss)
	getObjectTypeSpecificIcon (int $obj_id, IconFactory $icon_factory, StorageService $irss)

Private Member Functions
	getImageFromIRSS (StorageService $irss, ImageFactory $factory, Flavour $flavour)

Private Attributes
FlavourDefinition	$crop_definition
FlavourDefinition	$extract_definition
Settings	$settings
IconDatabaseRepository	$icons
ilObjFileInfoRepository	$info

Detailed Description

Definition at line 35 of file FileObjectPropertyProviders.php.

Constructor & Destructor Documentation

__construct()

FileObjectPropertyProviders::__construct

(

)

Definition at line 43 of file FileObjectPropertyProviders.php.

References ILIAS\UI\examples\MessageBox\Info\info(), and ILIAS\Repository\settings().

    {
        $this->crop_definition = new ilObjectTileImageFlavourDefinition();
        $this->extract_definition = new FirstPageToTileImageFlavourDefinition();
        $this->settings = (new SettingsFactory())->getSettings();
        $this->info = new ilObjFileInfoRepository();
        $this->icons = new IconDatabaseRepository();
    }

Here is the call graph for this function:

Member Function Documentation

getImageFromIRSS()

FileObjectPropertyProviders::getImageFromIRSS ( StorageService  $irss, ImageFactory  $factory, Flavour  $flavour  )

private

Definition at line 78 of file FileObjectPropertyProviders.php.

Referenced by getObjectTypeSpecificTileImage().

     : ?Image {
        $urls = $irss->consume()->flavourUrls($flavour)->getURLsAsArray();

        if ($urls === []) {
            return null;
        }

        $available_widths = $this->crop_definition->getWidths();
        array_pop($available_widths);

        if (!isset($urls[count($available_widths)])) {
            return null;
        }

        $image = $factory->responsive($urls[count($available_widths)], '');
        return array_reduce(
            $available_widths,
            function ($carry, $size) use ($urls) {
                $image = $carry['image']->withAdditionalHighResSource($urls[$carry['counter']], $size / 2);
                $counter = ++$carry['counter'];
                return [
                    'image' => $image,
                    'counter' => $counter
                ];
            },
            ['image' => $image, 'counter' => 0]
        )['image'];
    }

Here is the caller graph for this function:

getObjectTypeSpecificIcon()

FileObjectPropertyProviders::getObjectTypeSpecificIcon	(	int	$obj_id,
		IconFactory	$icon_factory,
		StorageService	$irss
	)

Implements ILIAS\Object\Properties\ObjectTypeSpecificProperties\ilObjectTypeSpecificPropertyProviders.

Definition at line 111 of file FileObjectPropertyProviders.php.

References $path, and ILIAS\UI\examples\MessageBox\Info\info().

     : ?CustomIcon {
        $info = $this->info->getByObjectId($obj_id);
        if (($path = $this->icons->getIconFilePathBySuffix($info->getSuffix()))) {
            return $icon_factory->custom($path, $info->getSuffix());
        }

        return null;
    }

Here is the call graph for this function:

getObjectTypeSpecificTileImage()

FileObjectPropertyProviders::getObjectTypeSpecificTileImage	(	int	$object_id,
		ImageFactory	$factory,
		StorageService	$irss
	)

Parameters

int

$card_size

Specifies what CardSize this will be displayed as, thus allowing for responsive images.

Implements ILIAS\Object\Properties\ObjectTypeSpecificProperties\ilObjectTypeSpecificPropertyProviders.

Definition at line 52 of file FileObjectPropertyProviders.php.

References getImageFromIRSS(), and ILIAS\Repository\settings().

     : ?Image {
        if (!$this->settings->hasTilePreviews()) {
            return null;
        }

        $rid = (new ilObjFileInfoRepository())->getByObjectId($obj_id)->getRID();

        if ($rid === null) {
            return null;
        }
        if ($irss->flavours()->possible($rid, $this->crop_definition)) {
            $flavour = $irss->flavours()->get($rid, $this->crop_definition);
            return $this->getImageFromIRSS($irss, $factory, $flavour);
        }
        if ($irss->flavours()->possible($rid, $this->extract_definition)) {
            $flavour = $irss->flavours()->get($rid, $this->extract_definition);
            return $this->getImageFromIRSS($irss, $factory, $flavour);
        }

        return null;
    }

Here is the call graph for this function:

Field Documentation

$crop_definition

FlavourDefinition FileObjectPropertyProviders::$crop_definition

private

Definition at line 37 of file FileObjectPropertyProviders.php.

$extract_definition

FlavourDefinition FileObjectPropertyProviders::$extract_definition

private

Definition at line 38 of file FileObjectPropertyProviders.php.

$icons

IconDatabaseRepository FileObjectPropertyProviders::$icons

private

Definition at line 40 of file FileObjectPropertyProviders.php.

$info

ilObjFileInfoRepository FileObjectPropertyProviders::$info

private

Definition at line 41 of file FileObjectPropertyProviders.php.

$settings

Settings FileObjectPropertyProviders::$settings

private

Definition at line 39 of file FileObjectPropertyProviders.php.

---

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

• components/ILIAS/File/classes/ObjectProperties/FileObjectPropertyProviders.php