ilPCMediaObjectQuickEdit Class Reference

This file is part of ILIAS, a powerful learning management system published by ILIAS open source e-Learning e.V. More...

Collaboration diagram for ilPCMediaObjectQuickEdit:

Public Member Functions
	__construct (ilPCMediaObject $pcmedia)
	getTitle ()
	Get title (always from mob) More...
	isTitleReadOnly ()
	Is title read only? (If more than one usage exists) More...
	setTitle (string $title)
	Set title. More...
	getClass ()
	Get style class. More...
	setClass (string $class)
	Set style class. More...
	getHorizontalAlign ()
	Get horizontal alignment. More...
	setHorizontalAlign (string $align)
	Set horizontal alignment. More...
	getUseFullscreen ()
	Using fullscreen? Yes, if mob has fullscreen item and fullscreen alias exists. More...
	setUseFullscreen (bool $use_fullscreen)
	getCaption ()
	Get caption from pc, if set, from mob otherwise. More...
	setCaption (string $caption)
	Set caption (pc if more usages, otherwise mob) More...
	getTextRepresentation ()
	Get text representation from pc, if set, from mob otherwise. More...
	setTextRepresentation (string $alt_text)
	Set text representation (pc if more usages, otherwise mob) More...

Protected Attributes
ilPCMediaObject	$pcmedia
ilObjMediaObject	$mob
int	$usage_cnt

Detailed Description

This file is part of ILIAS, a powerful learning management system published by ILIAS open source e-Learning e.V.

ILIAS is licensed with the GPL-3.0, see https://www.gnu.org/licenses/gpl-3.0.en.html You should have received a copy of said license along with the source code, too.

If this is not the case or you just want to try ILIAS, you'll find us at: https://www.ilias.de https://github.com/ILIAS-eLearning Manages business logic in media slate editing

Author

Alexander Killing killi.nosp@m.ng@l.nosp@m.eifos.nosp@m..de

Definition at line 24 of file class.ilPCMediaObjectQuickEdit.php.

Constructor & Destructor Documentation

__construct()

ilPCMediaObjectQuickEdit::__construct

(

ilPCMediaObject

$pcmedia

)

Definition at line 30 of file class.ilPCMediaObjectQuickEdit.php.

References $pcmedia, and ilPCMediaObject\getMediaObject().

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

Here is the call graph for this function:

Member Function Documentation

getCaption()

ilPCMediaObjectQuickEdit::getCaption

(

)

Get caption from pc, if set, from mob otherwise.

Definition at line 159 of file class.ilPCMediaObjectQuickEdit.php.

                                : 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());
    }

getClass()

ilPCMediaObjectQuickEdit::getClass

(

)

Get style class.

Definition at line 71 of file class.ilPCMediaObjectQuickEdit.php.

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

getHorizontalAlign()

ilPCMediaObjectQuickEdit::getHorizontalAlign

(

)

Get horizontal alignment.

Definition at line 94 of file class.ilPCMediaObjectQuickEdit.php.

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

getTextRepresentation()

ilPCMediaObjectQuickEdit::getTextRepresentation

(

)

Get text representation from pc, if set, from mob otherwise.

Definition at line 194 of file class.ilPCMediaObjectQuickEdit.php.

                                           : 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());
    }

getTitle()

ilPCMediaObjectQuickEdit::getTitle

(

)

Get title (always from mob)

Definition at line 43 of file class.ilPCMediaObjectQuickEdit.php.

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

getUseFullscreen()

ilPCMediaObjectQuickEdit::getUseFullscreen

(

)

Using fullscreen? Yes, if mob has fullscreen item and fullscreen alias exists.

Definition at line 112 of file class.ilPCMediaObjectQuickEdit.php.

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

isTitleReadOnly()

ilPCMediaObjectQuickEdit::isTitleReadOnly

(

)

Is title read only? (If more than one usage exists)

Definition at line 51 of file class.ilPCMediaObjectQuickEdit.php.

Referenced by setTitle().

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

Here is the caller graph for this function:

setCaption()

ilPCMediaObjectQuickEdit::setCaption

(

string

$caption

)

Set caption (pc if more usages, otherwise mob)

Definition at line 173 of file class.ilPCMediaObjectQuickEdit.php.

                                               : 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);
        }
    }

setClass()

ilPCMediaObjectQuickEdit::setClass

(

string

$class

)

Set style class.

Definition at line 83 of file class.ilPCMediaObjectQuickEdit.php.

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

setHorizontalAlign()

ilPCMediaObjectQuickEdit::setHorizontalAlign

(

string

$align

)

Set horizontal alignment.

Definition at line 102 of file class.ilPCMediaObjectQuickEdit.php.

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

setTextRepresentation()

ilPCMediaObjectQuickEdit::setTextRepresentation

(

string

$alt_text

)

Set text representation (pc if more usages, otherwise mob)

Definition at line 208 of file class.ilPCMediaObjectQuickEdit.php.

                                                           : 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);
        }
    }

setTitle()

ilPCMediaObjectQuickEdit::setTitle

(

string

$title

)

Set title.

Definition at line 59 of file class.ilPCMediaObjectQuickEdit.php.

References isTitleReadOnly().

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

Here is the call graph for this function:

setUseFullscreen()

ilPCMediaObjectQuickEdit::setUseFullscreen

(

bool

$use_fullscreen

)

Definition at line 117 of file class.ilPCMediaObjectQuickEdit.php.

                                                          : 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");
                }
            }
        }
    }

Field Documentation

$mob

ilObjMediaObject ilPCMediaObjectQuickEdit::$mob

protected

Definition at line 27 of file class.ilPCMediaObjectQuickEdit.php.

$pcmedia

ilPCMediaObject ilPCMediaObjectQuickEdit::$pcmedia

protected

Definition at line 26 of file class.ilPCMediaObjectQuickEdit.php.

Referenced by __construct().

$usage_cnt

int ilPCMediaObjectQuickEdit::$usage_cnt

protected

Definition at line 28 of file class.ilPCMediaObjectQuickEdit.php.

---

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

• components/ILIAS/COPage/PC/MediaObject/class.ilPCMediaObjectQuickEdit.php