ILIAS\COPage\PC\InteractiveImage\IIMManager Class Reference

Collaboration diagram for ILIAS\COPage\PC\InteractiveImage\IIMManager:

Public Member Functions
	__construct (InternalDomainService $domain)
	handleUploadResult (FileUpload $upload, UploadResult $result, ?\ilObjMediaObject $mob=null)
	handleOverlayUpload (\ilObjMediaObject $mob, FileUpload $upload, UploadResult $result)
	getOverlayWebPath (\ilObjMediaObject $mob, string $file)
	getOverlayThumbnailPath (\ilObjMediaObject $mob, string $file)
	getOverlays (\ilObjMediaObject $mob)
	resolveIIMMediaAliases (\DOMDocument $dom, array $a_mapping)
	Resolve iim media aliases (in ilContObjParse) More...

Protected Member Functions
	getOverlayThumbnailName (string $file)

Protected Attributes
ILIAS MediaObjects MediaObjectManager	$media_manager
ilLogger	$log
InternalDomainService	$domain
ILIAS COPage Dom DomUtil	$dom_util

Detailed Description

Definition at line 30 of file IIMManager.php.

Constructor & Destructor Documentation

__construct()

ILIAS\COPage\PC\InteractiveImage\IIMManager::__construct

(

InternalDomainService

$domain

)

Definition at line 37 of file IIMManager.php.

References $DIC, ILIAS\COPage\PC\InteractiveImage\IIMManager\$domain, ILIAS\COPage\InternalDomainService\domUtil(), and ILIAS\COPage\InternalDomainService\log().

      {
        global $DIC;
        $this->domain = $domain;
        $this->dom_util = $DIC->copage()->internal()->domain()->domUtil();
        if (isset($DIC['ilLoggerFactory'])) {
            $this->log = $domain->log();
        }
        $this->media_manager = $DIC->mediaObjects()->internal()->domain()->mediaObject();
    }

Here is the call graph for this function:

Member Function Documentation

getOverlays()

ILIAS\COPage\PC\InteractiveImage\IIMManager::getOverlays

(

\ilObjMediaObject

$mob

)

Definition at line 123 of file IIMManager.php.

References ilObjMediaObject\getFilesOfDirectory(), ILIAS\COPage\PC\InteractiveImage\IIMManager\getOverlayThumbnailPath(), and ILIAS\COPage\PC\InteractiveImage\IIMManager\getOverlayWebPath().

                                                       : array
    {
        $overlays = [];
        foreach ($mob->getFilesOfDirectory("/overlays") as $file) {
            $file = $file["basename"];
            $overlays[] = [
                "name" => $file,
                "thumbpath" => $this->getOverlayThumbnailPath($mob, $file),
                "webpath" => $this->getOverlayWebPath($mob, $file)
            ];
        }
        return $overlays;
    }

Here is the call graph for this function:

getOverlayThumbnailName()

ILIAS\COPage\PC\InteractiveImage\IIMManager::getOverlayThumbnailName ( string  $file )

protected

Definition at line 117 of file IIMManager.php.

Referenced by ILIAS\COPage\PC\InteractiveImage\IIMManager\handleOverlayUpload().

                                                            : string
    {
        $piname = pathinfo($file);
        return basename($file, "." . $piname['extension']) . ".png";
    }

Here is the caller graph for this function:

getOverlayThumbnailPath()

ILIAS\COPage\PC\InteractiveImage\IIMManager::getOverlayThumbnailPath	(	\ilObjMediaObject	$mob,
		string	$file
	)

Definition at line 112 of file IIMManager.php.

References ilObject\getId().

Referenced by ILIAS\COPage\PC\InteractiveImage\IIMManager\getOverlays().

                                                                                 : string
    {
        return $this->media_manager->getLocalSrc($mob->getId(), "/thumb/" . $file);
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getOverlayWebPath()

ILIAS\COPage\PC\InteractiveImage\IIMManager::getOverlayWebPath	(	\ilObjMediaObject	$mob,
		string	$file
	)

Definition at line 107 of file IIMManager.php.

References ilObject\getId().

Referenced by ILIAS\COPage\PC\InteractiveImage\IIMManager\getOverlays().

                                                                           : string
    {
        return $this->media_manager->getLocalSrc($mob->getId(), "/overlays/" . $file);
    }

Here is the call graph for this function:

Here is the caller graph for this function:

handleOverlayUpload()

ILIAS\COPage\PC\InteractiveImage\IIMManager::handleOverlayUpload	(	\ilObjMediaObject	$mob,
		FileUpload	$upload,
		UploadResult	$result
	)

Definition at line 86 of file IIMManager.php.

References ilObjMediaObject\addAdditionalFileFromUpload(), ilObject\getId(), ILIAS\FileUpload\DTO\UploadResult\getName(), ILIAS\COPage\PC\InteractiveImage\IIMManager\getOverlayThumbnailName(), ilObjMediaObject\makeThumbnail(), and ILIAS\MetaData\OERExposer\OAIPMH\Handler\HandlerResult\STATUS_OK.

     : BasicHandlerResult {
        $mob->addAdditionalFileFromUpload(
            $result,
            "overlays"
        );
        $mob->makeThumbnail(
            "overlays/" . $result->getName(),
            "thumb/" . $this->getOverlayThumbnailName($result->getName())
        );
        return new BasicHandlerResult(
            "mob_id",
            HandlerResult::STATUS_OK,
            (string) $mob->getId(),
            ''
        );
    }

Here is the call graph for this function:

handleUploadResult()

ILIAS\COPage\PC\InteractiveImage\IIMManager::handleUploadResult	(	FileUpload	$upload,
		UploadResult	$result,
		?\ilObjMediaObject	$mob = null
	)

Definition at line 49 of file IIMManager.php.

References ILIAS\FileUpload\DTO\UploadResult\getName(), and ILIAS\MetaData\OERExposer\OAIPMH\Handler\HandlerResult\STATUS_OK.

     : BasicHandlerResult {
        $this->log->debug("Handle mob upload");
        $title = $result->getName();
        $this->log->debug($title);

        if (is_null($mob)) {
            $this->log->debug("New...");
            $mob = new \ilObjMediaObject();
            $mob->setTitle($title);
            $mob->setDescription("");
            $mob->create();

            $media_item = $mob->addMediaItemFromUpload(
                "Standard",
                $result
            );
        } else {
            $this->log->debug("Update...");
            $media_item = $mob->replaceMediaItemFromUpload(
                "Standard",
                $result
            );
        }
        $mob->update();

        return new BasicHandlerResult(
            "mob_id",
            HandlerResult::STATUS_OK,
            (string) $mob->getId(),
            ''
        );
    }

Here is the call graph for this function:

resolveIIMMediaAliases()

ILIAS\COPage\PC\InteractiveImage\IIMManager::resolveIIMMediaAliases	(	\DOMDocument	$dom,
		array	$a_mapping
	)

Resolve iim media aliases (in ilContObjParse)

Definition at line 141 of file IIMManager.php.

References $path.

     : bool {
        // resolve normal internal links
        $path = "//InteractiveImage/MediaAlias";
        $changed = false;
        $nodes = $this->dom_util->path($dom, $path);
        foreach ($nodes as $node) {
            $old_id = $node->getAttribute("OriginId");
            if (($a_mapping[$old_id] ?? 0) > 0) {
                $node->setAttribute("OriginId", "il__mob_" . $a_mapping[$old_id]);
                $changed = true;
            }
        }
        return $changed;
    }

Field Documentation

$dom_util

ILIAS COPage Dom DomUtil ILIAS\COPage\PC\InteractiveImage\IIMManager::$dom_util

protected

Definition at line 35 of file IIMManager.php.

$domain

InternalDomainService ILIAS\COPage\PC\InteractiveImage\IIMManager::$domain

protected

Definition at line 34 of file IIMManager.php.

Referenced by ILIAS\COPage\PC\InteractiveImage\IIMManager\__construct().

$log

ilLogger ILIAS\COPage\PC\InteractiveImage\IIMManager::$log

protected

Definition at line 33 of file IIMManager.php.

$media_manager

ILIAS MediaObjects MediaObjectManager ILIAS\COPage\PC\InteractiveImage\IIMManager::$media_manager

protected

Definition at line 32 of file IIMManager.php.

---

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

• components/ILIAS/COPage/PC/InteractiveImage/IIMManager.php