ILIAS\COPage\PC\MediaObject\ImageMapRetrieval Class Reference

Inheritance diagram for ILIAS\COPage\PC\MediaObject\ImageMapRetrieval:

Collaboration diagram for ILIAS\COPage\PC\MediaObject\ImageMapRetrieval:

Public Member Functions
	__construct (protected \ilPCInteractiveImage|\ilPCMediaObject $content_obj, protected string $parent_node_name)
	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\COPage\PC\MediaObject\ImageMapRetrieval::__construct	(	protected \ilPCInteractiveImage|\ilPCMediaObject	$content_obj,
		protected string	$parent_node_name
	)

Definition at line 29 of file ImageMapRetrieval.php.

      {
    }

Member Function Documentation

collectData()

ILIAS\COPage\PC\MediaObject\ImageMapRetrieval::collectData ( )

protected

Definition at line 60 of file ImageMapRetrieval.php.

                                    : array
    {
        if ($this->data !== null) {
            return $this->data;
        }
 
        $alias_item = new \ilMediaAliasItem(
            $this->content_obj->getDomDoc(),
            $this->content_obj->hier_id,
            "Standard",
            $this->content_obj->getPCId(),
            $this->parent_node_name
        );
        $data = [];
        foreach ($alias_item->getMapAreas() as $area) {
            $link = $area["Link"] ?? [];
            $link_type = strtolower($link["LinkType"] ?? "");
            $link_type = match ($link_type) {
                "extlink" => "ext",
                "intlink" => "int",
                default => $link_type
            };
            $data[] = [
                "id" => (int) $area["Nr"],
                "title" => $link["Title"] ?? "",
                "shape" => $area["Shape"],
                "coords" => implode(", ", explode(",", $area["Coords"])),
                "highlight_mode" => $area["HighlightMode"],
                "highlight_class" => $area["HighlightClass"],
                "link_type" => $link_type,
                "href" => $link["Href"] ?? "",
                "target" => $link["Target"] ?? "",
                "type" => $link["Type"] ?? "",
                "target_frame" => $link["TargetFrame"] ?? ""
            ];
        }
 
        usort(
            $data,
            static fn(array $left, array $right): int => strcasecmp($left["title"], $right["title"])
        );
 
        return $this->data = $data;
    }

References $data, and ILIAS\Repository\int().

Here is the call graph for this function:

count()

ILIAS\COPage\PC\MediaObject\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\COPage\PC\MediaObject\ImageMapRetrieval::getData	(	array	$fields,
		?Range	$range = null,
		?Order	$order = null,
		array	$filter = [],
		array	$parameters = []
	)

Implements ILIAS\Repository\RetrievalInterface.

Definition at line 35 of file ImageMapRetrieval.php.

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

isFieldNumeric()

ILIAS\COPage\PC\MediaObject\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\COPage\PC\MediaObject\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/COPage/PC/MediaObject/ImageMapRetrieval.php