Placement.php

Go to the documentation of this file.

<?php

namespace ILIAS\LTI\ToolProvider\Content;

class Placement
{
    public const TYPE_EMBED = 'embed';

    public const TYPE_IFRAME = 'iframe';

    public const TYPE_FRAME = 'frame';

    public const TYPE_WINDOW = 'window';

    public const TYPE_POPUP = 'popup';

    public const TYPE_OVERLAY = 'overlay';

    public ?string $documentTarget = null;

    private ?string $windowTarget = null;

    private ?string $windowFeatures = null;

    private ?string $url = null;

    private ?int $displayWidth = null;

    private ?int $displayHeight = null;

    private ?string $html = null;

    public function __construct(
        string $documentTarget,
        ?int $displayWidth = null,
        ?int $displayHeight = null,
        ?string $windowTarget = null,
        ?string $windowFeatures = null,
        string $url = null,
        ?string $html = null
    ) {
        $this->documentTarget = $documentTarget;
        $this->displayWidth = $displayWidth;
        $this->displayHeight = $displayHeight;
        $this->windowTarget = $windowTarget;
        $this->windowFeatures = $windowFeatures;
        $this->url = $url;
        $this->html = $html;
    }

    public function toJsonldObject(): object
    {
        if (!empty($this->documentTarget)) {
            $placement = new \stdClass();
            $placement->presentationDocumentTarget = $this->documentTarget;
            if (!is_null($this->displayHeight)) {
                $placement->displayHeight = $this->displayHeight;
            }
            if (!is_null($this->displayWidth)) {
                $placement->displayWidth = $this->displayWidth;
            }
            if (!empty($this->windowTarget)) {
                $placement->windowTarget = $this->windowTarget;
            }
        } else {
            $placement = null;
        }

        return $placement;
    }

    public function toJsonObject(): object
    {
        if (!empty($this->documentTarget)) {
            $placement = new \stdClass();
            switch ($this->documentTarget) {
                case self::TYPE_IFRAME:
                    if (!empty($this->url)) {
                        $placement->src = $this->url;
                    }
                    if (!is_null($this->displayWidth)) {
                        $placement->width = $this->displayWidth;
                    }
                    if (!is_null($this->displayHeight)) {
                        $placement->height = $this->displayHeight;
                    }
                    break;
                case self::TYPE_WINDOW:
                    if (!is_null($this->displayWidth)) {
                        $placement->width = $this->displayWidth;
                    }
                    if (!is_null($this->displayHeight)) {
                        $placement->height = $this->displayHeight;
                    }
                    if (!is_null($this->windowTarget)) {
                        $placement->targetName = $this->windowTarget;
                    }
                    if (!is_null($this->windowFeatures)) {
                        $placement->windowFeatures = $this->windowFeatures;
                    }
                    break;
                case self::TYPE_EMBED:
                    if (!empty($this->html)) {
                        $placement->html = $this->html;
                    }
                    break;
            }
        } else {
            $placement = null;
        }

        return $placement;
    }

    public static function fromJsonObject(object $item, string $documentTarget = null): ?Placement
    {
        $obj = null;
        $displayWidth = null;
        $displayHeight = null;
        $windowTarget = null;
        $windowFeatures = null;
        $url = null;
        $html = null;
        if (isset($item->{'@type'})) {  // Version 1
            if (empty($documentTarget) && isset($item->placementAdvice)) {
                if (isset($item->placementAdvice->presentationDocumentTarget)) {
                    $documentTarget = $item->placementAdvice->presentationDocumentTarget;
                }
            }
            if (!empty($documentTarget) && isset($item->placementAdvice)) {
                if (isset($item->placementAdvice->displayWidth)) {
                    $displayWidth = $item->placementAdvice->displayWidth;
                }
                if (isset($item->placementAdvice->displayHeight)) {
                    $displayHeight = $item->placementAdvice->displayHeight;
                }
                if (isset($item->placementAdvice->windowTarget)) {
                    $windowTarget = $item->placementAdvice->windowTarget;
                }
            }
            if (isset($item->url)) {
                $url = $item->url;
            }
        } else {  // Version 2
            if (empty($documentTarget)) {
                if (isset($item->embed)) {
                    $documentTarget = 'embed';
                } elseif (isset($item->iframe)) {
                    $documentTarget = 'iframe';
                } elseif (isset($item->window)) {
                    $documentTarget = 'window';
                }
            } elseif (!isset($item->{$documentTarget})) {
                $documentTarget = null;
            }
            if (!empty($documentTarget)) {
                if (isset($item->{$documentTarget}->width)) {
                    $displayWidth = $item->{$documentTarget}->width;
                }
                if (isset($item->{$documentTarget}->height)) {
                    $displayHeight = $item->{$documentTarget}->height;
                }
                if (isset($item->{$documentTarget}->targetName)) {
                    $windowTarget = $item->{$documentTarget}->targetName;
                }
                if (isset($item->{$documentTarget}->windowFeatures)) {
                    $windowFeatures = $item->{$documentTarget}->windowFeatures;
                }
                if (isset($item->{$documentTarget}->src)) {
                    $url = $item->{$documentTarget}->src;
                }
                if (isset($item->{$documentTarget}->html)) {
                    $html = $item->{$documentTarget}->html;
                }
            }
        }
        if (!empty($documentTarget)) {
            $obj = new Placement($documentTarget, $displayWidth, $displayHeight, $windowTarget, $windowFeatures, $url, $html);
        }

        return $obj;
    }
}