class.ilPCMediaObjectQuickEdit.php

Go to the documentation of this file.

<?php

class ilPCMediaObjectQuickEdit
{
    protected ilPCMediaObject $pcmedia;
    protected ilObjMediaObject $mob;
    protected int $usage_cnt;

    public function __construct(
        ilPCMediaObject $pcmedia
    ) {
        $this->pcmedia = $pcmedia;
        $this->mob = $pcmedia->getMediaObject();
        $this->usage_cnt = count($this->mob->getUsages());
    }

    // TITLE

    public function getTitle(): string
    {
        return $this->mob->getTitle();
    }

    public function isTitleReadOnly(): bool
    {
        return ($this->usage_cnt > 1);
    }

    public function setTitle(string $title): void
    {
        if (!$this->isTitleReadOnly()) {
            $this->mob->setTitle($title);
        }
    }

    // STYLE CLASS (always from pc)

    public function getClass(): string
    {
        $selected = $this->pcmedia->getClass();
        if ($selected == "") {
            $selected = "MediaContainer";
        }
        return $selected;
    }

    public function setClass(string $class): void
    {
        $this->pcmedia->setClass($class);
    }


    // HORIZONTAL ALIGNMENT (from pc standard alias)

    public function getHorizontalAlign(): string
    {
        return $this->pcmedia->getStandardMediaAliasItem()->getHorizontalAlign();
    }

    public function setHorizontalAlign(string $align): void
    {
        $this->pcmedia->getStandardMediaAliasItem()->setHorizontalAlign($align);
    }

    // USE FULLSCREEN

    public function getUseFullscreen(): bool
    {
        return ($this->mob->hasFullscreenItem() && $this->pcmedia->getFullscreenMediaAliasItem()->exists());
    }

    public function setUseFullscreen(bool $use_fullscreen): void
    {
        $full_alias = $this->pcmedia->getFullscreenMediaAliasItem();
        // if fullscreen should be used...
        if ($use_fullscreen) {
            //... ensure mob has fullscreen
            if (!$this->mob->hasFullscreenItem()) {
                $std_item = $this->mob->getMediaItem("Standard");
                $full_item = new ilMediaItem();
                $this->mob->addMediaItem($full_item);
                $full_item->setPurpose("Fullscreen");
                $full_item->setLocationType($std_item->getLocationType());
                $full_item->setFormat($std_item->getFormat());
                $full_item->setLocation($std_item->getLocation());
            }

            //... ensure fullscreen alias exists
            if (!$full_alias->exists()) {
                $full_alias->insert();
                $full_alias->deriveSize();
                $full_alias->deriveCaption();
                $full_alias->deriveTextRepresentation();
                $full_alias->deriveParameters();
            }
        } else {
            if ($this->pcmedia->checkInstanceEditing()) {
                if ($full_alias->exists()) {
                    $full_alias->delete();
                }
            } else {
                if ($this->mob->hasFullscreenItem()) {
                    $this->mob->removeMediaItem("Fullscreen");
                }
            }
        }
    }

    // CAPTION

    public function getCaption(): string
    {
        $std_alias = $this->pcmedia->getStandardMediaAliasItem();
        $std_item = $this->mob->getMediaItem("Standard");

        if (trim($std_alias->getCaption()) == "") {
            return trim($std_item->getCaption());
        }
        return trim($std_alias->getCaption());
    }

    public function setCaption(string $caption): void
    {
        $std_alias = $this->pcmedia->getStandardMediaAliasItem();
        $std_item = $this->mob->getMediaItem("Standard");
        if ($this->pcmedia->checkInstanceEditing()) {
            if ($caption !== $std_item->getCaption()) {     // in quick edit we derive if the value is equal to the item caption
                $std_alias->setCaption($caption);
            } else {
                $std_alias->deriveCaption();
            }
        } else {
            $std_alias->deriveCaption();
            $std_item->setCaption($caption);
        }
    }

    // ALT TEXT

    public function getTextRepresentation(): string
    {
        $std_alias = $this->pcmedia->getStandardMediaAliasItem();
        $std_item = $this->mob->getMediaItem("Standard");

        if (trim($std_alias->getTextRepresentation()) == "") {
            return trim($std_item->getTextRepresentation());
        }
        return trim($std_alias->getTextRepresentation());
    }

    public function setTextRepresentation(string $alt_text): void
    {
        $std_alias = $this->pcmedia->getStandardMediaAliasItem();
        $std_item = $this->mob->getMediaItem("Standard");
        if ($this->pcmedia->checkInstanceEditing()) {
            if ($alt_text !== $std_item->getTextRepresentation()) {     // in quick edit we derive if the value is equal to the item caption
                $std_alias->setTextRepresentation($alt_text);
            } else {
                $std_alias->deriveTextRepresentation();
            }
        } else {
            $std_alias->deriveTextRepresentation();
            $std_item->setTextRepresentation($alt_text);
        }
    }
}