ILIAS\MediaObjects\ImageMap\ImageMapRetrieval Class Reference

Inheritance diagram for ILIAS\MediaObjects\ImageMap\ImageMapRetrieval:

Collaboration diagram for ILIAS\MediaObjects\ImageMap\ImageMapRetrieval:

Public Member Functions
	__construct (protected \ilObjMediaObject $media_object)
	getData (array $fields, ?Range $range=null, ?Order $order=null, array $filter=[], array $parameters=[])
	count (array $filter=[], array $parameters=[])
	isFieldNumeric (string $field)
	getData (array $fields, ?Range $range=null, ?Order $order=null, array $filter=[], array $parameters=[])
	count (array $filter, array $parameters)
	isFieldNumeric (string $field)

Protected Member Functions
	collectData ()

Protected Attributes
array	$data = null

Detailed Description

Definition at line 23 of file ImageMapRetrieval.php.

Constructor & Destructor Documentation

__construct()

ILIAS\MediaObjects\ImageMap\ImageMapRetrieval::__construct

(

protected \ilObjMediaObject

$media_object

)

Definition at line 29 of file ImageMapRetrieval.php.

      {
    }

Member Function Documentation

collectData()

ILIAS\MediaObjects\ImageMap\ImageMapRetrieval::collectData ( )

protected

Definition at line 60 of file ImageMapRetrieval.php.

                                    : array
    {
        if ($this->data !== null) {
            return $this->data;
        }
 
        $item = $this->media_object->getMediaItem("Standard");
        $data = [];
        $highlight_modes = \ilMapArea::getAllHighlightModes();
        $highlight_classes = \ilMapArea::getAllHighlightClasses();
 
        for ($id = 1, $max = \ilMapArea::_getMaxNr($item->getId()); $id <= $max; $id++) {
            $area = new \ilMapArea($item->getId(), $id);
            $data[] = [
                "id" => $id,
                "title" => $area->getTitle(),
                "shape" => $area->getShape(),
                "coords" => implode(", ", explode(",", $area->getCoords())),
                "highlight_mode" => $highlight_modes[$area->getHighlightMode()] ?? $area->getHighlightMode(),
                "highlight_class" => $highlight_classes[$area->getHighlightClass()] ?? $area->getHighlightClass(),
                "link_type" => $area->getLinkType(),
                "href" => $area->getHref(),
                "target" => $area->getTarget(),
                "type" => $area->getType(),
                "target_frame" => $area->getTargetFrame()
            ];
        }
 
        return $this->data = $data;
    }

References $data, $id, ilMapArea\_getMaxNr(), ilMapArea\getAllHighlightClasses(), and ilMapArea\getAllHighlightModes().

Here is the call graph for this function:

count()

ILIAS\MediaObjects\ImageMap\ImageMapRetrieval::count	(	array	$filter = [],
		array	$parameters = []
	)

Implements ILIAS\Repository\RetrievalInterface.

Definition at line 50 of file ImageMapRetrieval.php.

                                                                     : int
    {
        return count($this->collectData());
    }

getData()

ILIAS\MediaObjects\ImageMap\ImageMapRetrieval::getData	(	array	$fields,
		?Range	$range = null,
		?Order	$order = null,
		array	$filter = [],
		array	$parameters = []
	)

Implements ILIAS\Repository\RetrievalInterface.

Definition at line 34 of file ImageMapRetrieval.php.

     : \Generator {
        $data = $this->collectData();
        $data = $this->applyOrder($data, $order);
        $data = $this->applyRange($data, $range);
 
        foreach ($data as $row) {
            yield $row;
        }
    }

isFieldNumeric()

ILIAS\MediaObjects\ImageMap\ImageMapRetrieval::isFieldNumeric

(

string

$field

)

Implements ILIAS\Repository\RetrievalInterface.

Definition at line 55 of file ImageMapRetrieval.php.

                                                 : bool
    {
        return $field === "id";
    }

Field Documentation

$data

array ILIAS\MediaObjects\ImageMap\ImageMapRetrieval::$data = null

protected

Definition at line 27 of file ImageMapRetrieval.php.

---

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

• components/ILIAS/MediaObjects/ImageMap/ImageMapRetrieval.php