Stores repository clipboard data. More...

Collaboration diagram for ILIAS\MediaObjects\ImageMap\ImageMapEditSessionRepository:

Public Member Functions
	__construct ()

	setTargetScript (string $script)

	getTargetScript ()

	setRefId (int $ref_id)

	getRefId ()

	setObjId (int $obj_id)

	getObjId ()

	setHierId (string $hier_id)

	getHierId ()

	setPCId (string $pc_id)

	getPCId ()

	setAreaType (string $type)

	getAreaType ()

	setAreaNr (int $nr)

	getAreaNr ()

	setCoords (string $coords)

	getCoords ()

	setMode (string $mode)

	getMode ()

	setLinkType (string $type)

	getLinkType ()

	setExternalLink (string $href)

	getExternalLink ()

	setInternalLink (string $type, string $target, string $target_frame, string $anchor)

	getInternalLink ()

	clear ()

Data Fields
const	KEY_BASE = "il_map_"

Protected Member Functions
	get (string $key)

	set (string $key, $val)

Detailed Description

Stores repository clipboard data.

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

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

Constructor & Destructor Documentation

◆ __construct()

ILIAS\MediaObjects\ImageMap\ImageMapEditSessionRepository::__construct ( )

Definition at line 32 of file class.ImageMapEditSessionRepository.php.

33 {

34 }

Member Function Documentation

◆ clear()

ILIAS\MediaObjects\ImageMap\ImageMapEditSessionRepository::clear ( )

Definition at line 190 of file class.ImageMapEditSessionRepository.php.

                           : void
    {
        \ilSession::clear(self::KEY_BASE . "area_nr");
        \ilSession::clear(self::KEY_BASE . "edit_coords");
        \ilSession::clear(self::KEY_BASE . "edit_mode");
        \ilSession::clear(self::KEY_BASE . "el_href");
        \ilSession::clear(self::KEY_BASE . "il_type");
        \ilSession::clear(self::KEY_BASE . "il_ltype");
        \ilSession::clear(self::KEY_BASE . "il_target");
        \ilSession::clear(self::KEY_BASE . "il_targetframe");
        \ilSession::clear(self::KEY_BASE . "il_anchor");
        \ilSession::clear(self::KEY_BASE . "edit_area_type");
    }

References ilSession\clear().

Here is the call graph for this function:

◆ get()

ILIAS\MediaObjects\ImageMap\ImageMapEditSessionRepository::get ( string $key )

protected

Returns: mixed|null

Definition at line 39 of file class.ImageMapEditSessionRepository.php.

    {
        if (\ilSession::has(self::KEY_BASE . $key)) {
            return \ilSession::get(self::KEY_BASE . $key);
        }
        return null;
    }

References ILIAS\LTI\ToolProvider\$key, ILIAS\Repository\get(), and ilSession\has().

Here is the call graph for this function:

◆ getAreaNr()

ILIAS\MediaObjects\ImageMap\ImageMapEditSessionRepository::getAreaNr ( )

Definition at line 120 of file class.ImageMapEditSessionRepository.php.

                               : int
    {
        return (int) $this->get("area_nr");
    }

◆ getAreaType()

ILIAS\MediaObjects\ImageMap\ImageMapEditSessionRepository::getAreaType ( )

Definition at line 110 of file class.ImageMapEditSessionRepository.php.

                                 : string
    {
        return (string) $this->get("edit_area_type");
    }

◆ getCoords()

ILIAS\MediaObjects\ImageMap\ImageMapEditSessionRepository::getCoords ( )

Definition at line 130 of file class.ImageMapEditSessionRepository.php.

                               : string
    {
        return (string) $this->get("edit_coords");
    }

◆ getExternalLink()

ILIAS\MediaObjects\ImageMap\ImageMapEditSessionRepository::getExternalLink ( )

Definition at line 160 of file class.ImageMapEditSessionRepository.php.

                                     : string
    {
        return (string) $this->get("el_href");
    }

◆ getHierId()

ILIAS\MediaObjects\ImageMap\ImageMapEditSessionRepository::getHierId ( )

Definition at line 90 of file class.ImageMapEditSessionRepository.php.

                               : string
    {
        return (string) $this->get("edit_hier_id");
    }

◆ getInternalLink()

ILIAS\MediaObjects\ImageMap\ImageMapEditSessionRepository::getInternalLink ( )

Returns: string[]

Definition at line 180 of file class.ImageMapEditSessionRepository.php.

                                     : array
    {
        return [
            "type" => (string) $this->get("il_type"),
            "target" => (string) $this->get("il_target"),
            "target_frame" => (string) $this->get("il_targetframe"),
            "anchor" => (string) $this->get("il_anchor")
        ];
    }

◆ getLinkType()

ILIAS\MediaObjects\ImageMap\ImageMapEditSessionRepository::getLinkType ( )

Definition at line 150 of file class.ImageMapEditSessionRepository.php.

                                 : string
    {
        return (string) $this->get("il_ltype");
    }

◆ getMode()

ILIAS\MediaObjects\ImageMap\ImageMapEditSessionRepository::getMode ( )

Definition at line 140 of file class.ImageMapEditSessionRepository.php.

                             : string
    {
        return (string) $this->get("edit_mode");
    }

◆ getObjId()

ILIAS\MediaObjects\ImageMap\ImageMapEditSessionRepository::getObjId ( )

Definition at line 80 of file class.ImageMapEditSessionRepository.php.

                              : int
    {
        return (int) $this->get("edit_obj_id");
    }

◆ getPCId()

ILIAS\MediaObjects\ImageMap\ImageMapEditSessionRepository::getPCId ( )

Definition at line 100 of file class.ImageMapEditSessionRepository.php.

                             : string
    {
        return (string) $this->get("edit_pc_id");
    }

◆ getRefId()

ILIAS\MediaObjects\ImageMap\ImageMapEditSessionRepository::getRefId ( )

Definition at line 70 of file class.ImageMapEditSessionRepository.php.

                              : int
    {
        return (int) $this->get("edit_ref_id");
    }

◆ getTargetScript()

ILIAS\MediaObjects\ImageMap\ImageMapEditSessionRepository::getTargetScript ( )

Definition at line 60 of file class.ImageMapEditSessionRepository.php.

                                     : string
    {
        return (string) $this->get("edit_target_script");
    }

◆ set()

ILIAS\MediaObjects\ImageMap\ImageMapEditSessionRepository::set	(	string	$key,
			$val
	)

protected

Parameters

mixed $val

Definition at line 50 of file class.ImageMapEditSessionRepository.php.

                                             : void
    {
        \ilSession::set(self::KEY_BASE . $key, $val);
    }

References ILIAS\LTI\ToolProvider\$key, and ilSession\set().

Here is the call graph for this function:

◆ setAreaNr()

ILIAS\MediaObjects\ImageMap\ImageMapEditSessionRepository::setAreaNr ( int $nr )

Definition at line 115 of file class.ImageMapEditSessionRepository.php.

                                      : void
    {
        $this->set("area_nr", $nr);
    }

◆ setAreaType()

ILIAS\MediaObjects\ImageMap\ImageMapEditSessionRepository::setAreaType ( string $type )

Definition at line 105 of file class.ImageMapEditSessionRepository.php.

                                             : void
    {
        $this->set("edit_area_type", $type);
    }

References $type.

◆ setCoords()

ILIAS\MediaObjects\ImageMap\ImageMapEditSessionRepository::setCoords ( string $coords )

Definition at line 125 of file class.ImageMapEditSessionRepository.php.

                                             : void
    {
        $this->set("edit_coords", $coords);
    }

◆ setExternalLink()

ILIAS\MediaObjects\ImageMap\ImageMapEditSessionRepository::setExternalLink ( string $href )

Definition at line 155 of file class.ImageMapEditSessionRepository.php.

                                                 : void
    {
        $this->set("el_href", $href);
    }

◆ setHierId()

ILIAS\MediaObjects\ImageMap\ImageMapEditSessionRepository::setHierId ( string $hier_id )

Definition at line 85 of file class.ImageMapEditSessionRepository.php.

                                              : void
    {
        $this->set("edit_hier_id", $hier_id);
    }

◆ setInternalLink()

ILIAS\MediaObjects\ImageMap\ImageMapEditSessionRepository::setInternalLink	(	string	$type,
		string	$target,
		string	$target_frame,
		string	$anchor
	)

Definition at line 165 of file class.ImageMapEditSessionRepository.php.

     : void {
        $this->set("il_type", $type);
        $this->set("il_target", $target);
        $this->set("il_targetframe", $target_frame);
        $this->set("il_anchor", $anchor);
    }

◆ setLinkType()

ILIAS\MediaObjects\ImageMap\ImageMapEditSessionRepository::setLinkType ( string $type )

Definition at line 145 of file class.ImageMapEditSessionRepository.php.

                                             : void
    {
        $this->set("il_ltype", $type);
    }

References $type.

◆ setMode()

ILIAS\MediaObjects\ImageMap\ImageMapEditSessionRepository::setMode ( string $mode )

Definition at line 135 of file class.ImageMapEditSessionRepository.php.

                                         : void
    {
        $this->set("edit_mode", $mode);
    }

◆ setObjId()

ILIAS\MediaObjects\ImageMap\ImageMapEditSessionRepository::setObjId ( int $obj_id )

Definition at line 75 of file class.ImageMapEditSessionRepository.php.

                                         : void
    {
        $this->set("edit_obj_id", $obj_id);
    }

◆ setPCId()

ILIAS\MediaObjects\ImageMap\ImageMapEditSessionRepository::setPCId ( string $pc_id )

Definition at line 95 of file class.ImageMapEditSessionRepository.php.

                                          : void
    {
        $this->set("edit_pc_id", $pc_id);
    }

◆ setRefId()

ILIAS\MediaObjects\ImageMap\ImageMapEditSessionRepository::setRefId ( int $ref_id )

Definition at line 65 of file class.ImageMapEditSessionRepository.php.

                                         : void
    {
        $this->set("edit_ref_id", $ref_id);
    }

References $ref_id.

◆ setTargetScript()

ILIAS\MediaObjects\ImageMap\ImageMapEditSessionRepository::setTargetScript ( string $script )

Definition at line 55 of file class.ImageMapEditSessionRepository.php.

                                                   : void
    {
        $this->set("edit_target_script", $script);
    }

Field Documentation

◆ KEY_BASE

const ILIAS\MediaObjects\ImageMap\ImageMapEditSessionRepository::KEY_BASE = "il_map_"

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

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

Services/MediaObjects/ImageMap/class.ImageMapEditSessionRepository.php

Public Member Functions

Data Fields

Protected Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ clear()

◆ get()

◆ getAreaNr()

◆ getAreaType()

◆ getCoords()

◆ getExternalLink()

◆ getHierId()

◆ getInternalLink()

◆ getLinkType()

◆ getMode()

◆ getObjId()

◆ getPCId()

◆ getRefId()

◆ getTargetScript()

◆ set()

◆ setAreaNr()

◆ setAreaType()

◆ setCoords()

◆ setExternalLink()

◆ setHierId()

◆ setInternalLink()

◆ setLinkType()

◆ setMode()

◆ setObjId()

◆ setPCId()

◆ setRefId()

◆ setTargetScript()

Field Documentation

◆ KEY_BASE