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

Inheritance diagram for ilPCMap:

Collaboration diagram for ilPCMap:

Public Member Functions
	init ()
	Init object. More...

	create (ilPageObject $a_pg_obj, string $a_hier_id, string $a_pc_id="")

	setLatitude (?float $a_lat=null)

	getLatitude ()

	setLongitude (?float $a_long=null)

	getLongitude ()

	setZoom (?int $a_zoom)

	getZoom ()

	setLayout (?int $a_width, ?int $a_height, string $a_horizontal_align)

	getWidth ()

	getHeight ()

	getHorizontalAlign ()

	setCaption (string $a_caption)

	getCaption ()

	modifyPageContentPostXsl (string $a_output, string $a_mode, bool $a_abstract_only=false)
	Modify page content after xsl. More...

Public Member Functions inherited from ilPageContent
	__construct (ilPageObject $a_pg_obj, ?PageManagerInterface $page_manager=null, ?ObjectAdapterInterface $object_adapter=null)

	setPage (ilPageObject $a_val)

	getPage ()

	init ()
	Init object. More...

	getType ()

	getDomNode ()

	getDomDoc ()

	setDomNode (DOMNode $node)

	getChildNode ()

	getJavascriptFiles (string $a_mode)

	getCssFiles (string $a_mode)

	getOnloadCode (string $a_mode)

	setHierId (string $a_hier_id)

	getHierId ()

	lookupHierId ()

	readHierId ()

	setPcId (string $a_pcid)

	getPCId ()

	setFileDownloadLink (string $a_download_link)

	getFileDownloadLink ()

	setProfileBackUrl (string $url)

	getProfileBackUrl ()

	setFullscreenLink (string $a_fullscreen_link)

	getFullscreenLink ()

	setSourcecodeDownloadScript (string $script_name)

	getSourcecodeDownloadScript ()

	readPCId ()

	writePCId (string $a_pc_id)

	setEnabled (string $value)
	Set Enabled value for page content component. More...

	enable ()

	disable ()

	isEnabled ()

	createPageContentNode (bool $a_set_this_node=true)
	Create page content node (always use this method first when adding a new element) More...

	getNewPageContentNode ()

	modifyPageContentPostXsl (string $a_output, string $a_mode, bool $a_abstract_only=false)
	Modify page content after xsl. More...

	getModel ()
	Get model as needed for the front-end editor. More...

Static Public Member Functions
static	handleCaptionInput (string $a_text)

static	handleCaptionFormOutput (string $a_text)

Static Public Member Functions inherited from ilPageContent
static	sortHierIds (array $a_array)
	Sort an array of Hier IDS in ascending order. More...

static	isGreaterHierId (string $a, string $b)
	Check whether Hier ID $a is greater than Hier ID $b. More...

static	getLangVars ()
	Get lang vars needed for editing. More...

static	handleCopiedContent (DOMDocument $a_domdoc, bool $a_self_ass=true, bool $a_clone_mobs=false, int $new_parent_id=0, int $obj_copy_id=0)
	Handle copied content. More...

static	afterPageUpdate (ilPageObject $a_page, DOMDocument $a_domdoc, string $a_xml, bool $a_creation)
	After page has been updated (or created) More...

static	beforePageDelete (ilPageObject $a_page)
	Before page is being deleted. More...

static	afterRepositoryCopy (ilPageObject $page, array $mapping, int $source_ref_id)
	After repository (container) copy action. More...

static	afterPageHistoryEntry (ilPageObject $a_page, DOMDocument $a_old_domdoc, string $a_old_xml, int $a_old_nr)
	After page history entry has been created. More...

static	deleteHistoryLowerEqualThan (string $parent_type, int $page_id, string $lang, int $delete_lower_than_nr)
	Overwrite in derived classes, if old history entries are being deleted. More...

Additional Inherited Members
Data Fields inherited from ilPageContent
string	$hier_id = ""

DOMNode	$dom_node = null

string	$page_lang = ""

Protected Member Functions inherited from ilPageContent
	getPageManager ()

	setType (string $a_type)
	Set Type. More...

	hasNode ()

	createInitialChildNode (string $hier_id, string $pc_id, string $child, array $child_attributes=[])

Protected Attributes inherited from ilPageContent
DOMDocument	$dom_doc

ILIAS COPage InternalDomainService	$domain

string	$pcid

string	$type = ""

ilPageObject	$pg_obj

string	$file_download_link = ''

string	$fullscreen_link = ''

string	$sourcecode_download_script = ''

ilLogger	$log

string	$profile_back_url = ""

ILIAS COPage Dom DomUtil	$dom_util

PageManagerInterface	$page_manager = null

ObjectAdapterInterface	$object = null

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 Class ilPCMap Map content object (see ILIAS DTD)

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

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

Member Function Documentation

◆ create()

ilPCMap::create	(	ilPageObject	$a_pg_obj,
		string	$a_hier_id,
		string	$a_pc_id = `""`
	)

Definition at line 31 of file class.ilPCMap.php.

     : void {
        $this->createInitialChildNode(
            $a_hier_id,
            $a_pc_id,
            "Map",
            ["Latitude" => "0","Longitude" => "0","Zoom" => "3"]
        );
    }

◆ getCaption()

ilPCMap::getCaption ( )

Definition at line 174 of file class.ilPCMap.php.

                                : string
    {
        if (is_object($this->getChildNode())) {
            foreach ($this->getChildNode()->childNodes as $child) {
                if ($child->nodeName == "MapCaption") {
                    return $this->dom_util->getContent($child);
                }
            }
        }
        return "";
    }

◆ getHeight()

ilPCMap::getHeight ( )

Definition at line 134 of file class.ilPCMap.php.

                               : ?int
    {
        if (is_object($this->getChildNode())) {
            foreach ($this->getChildNode()->childNodes as $child) {
                if ($child->nodeName == "Layout") {
                    $h = $child->getAttribute("Height")
                        ? (int) $child->getAttribute("Height")
                        : null;
                    return $h;
                }
            }
        }
        return null;
    }

References ILIAS\Repository\int().

Here is the call graph for this function:

◆ getHorizontalAlign()

ilPCMap::getHorizontalAlign ( )

Definition at line 149 of file class.ilPCMap.php.

                                        : string
    {
        if (is_object($this->getChildNode())) {
            foreach ($this->getChildNode()->childNodes as $child) {
                if ($child->nodeName == "Layout") {
                    return $child->getAttribute("HorizontalAlign");
                }
            }
        }
        return "";
    }

◆ getLatitude()

ilPCMap::getLatitude ( )

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

                                 : ?float
    {
        if (is_object($this->getChildNode())) {
            return (float) $this->getChildNode()->getAttribute("Latitude");
        }
        return null;
    }

◆ getLongitude()

ilPCMap::getLongitude ( )

Definition at line 74 of file class.ilPCMap.php.

                                  : ?float
    {
        if (is_object($this->getChildNode())) {
            return (float) $this->getChildNode()->getAttribute("Longitude");
        }
        return null;
    }

◆ getWidth()

ilPCMap::getWidth ( )

Definition at line 119 of file class.ilPCMap.php.

                              : ?int
    {
        if (is_object($this->getChildNode())) {
            foreach ($this->getChildNode()->childNodes as $child) {
                if ($child->nodeName == "Layout") {
                    $w = $child->getAttribute("Width")
                        ? (int) $child->getAttribute("Width")
                        : null;
                    return $w;
                }
            }
        }
        return null;
    }

References ILIAS\Repository\int().

Here is the call graph for this function:

◆ getZoom()

ilPCMap::getZoom ( )

Definition at line 93 of file class.ilPCMap.php.

                             : ?int
    {
        if (is_object($this->getChildNode())) {
            return (int) $this->getChildNode()->getAttribute("Zoom");
        }
        return null;
    }

◆ handleCaptionFormOutput()

static ilPCMap::handleCaptionFormOutput ( string $a_text )

static

Definition at line 196 of file class.ilPCMap.php.

     : string {
        $a_text = str_replace("<br />", "\n", $a_text);
        $a_text = str_replace("<br/>", "\n", $a_text);
 
        return $a_text;
    }

Referenced by ilPCMapGUI\getValues().

Here is the caller graph for this function:

◆ handleCaptionInput()

static ilPCMap::handleCaptionInput ( string $a_text )

static

Definition at line 186 of file class.ilPCMap.php.

     : string {
        $a_text = str_replace(chr(13) . chr(10), "<br />", $a_text);
        $a_text = str_replace(chr(13), "<br />", $a_text);
        $a_text = str_replace(chr(10), "<br />", $a_text);
 
        return $a_text;
    }

◆ init()

ilPCMap::init ( )

Init object.

This function must be overwritten and at least set the content type.

Reimplemented from ilPageContent.

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

                          : void
    {
        $this->setType("map");
    }

References ilPageContent\setType().

Here is the call graph for this function:

◆ modifyPageContentPostXsl()

ilPCMap::modifyPageContentPostXsl	(	string	$a_output,
		string	$a_mode,
		bool	$a_abstract_only = `false`
	)

Modify page content after xsl.

Reimplemented from ilPageContent.

Definition at line 205 of file class.ilPCMap.php.

     : string {
        $end = 0;
        $start = strpos($a_output, "[[[[[Map;");
        if (is_int($start)) {
            $end = strpos($a_output, "]]]]]", $start);
        }
        $i = 1;
        while ($end > 0) {
            $param = substr($a_output, $start + 9, $end - $start - 9);
 
            $param = explode(";", $param);
            if (is_numeric($param[0]) && is_numeric($param[1]) && is_numeric($param[2])) {
                $width = is_numeric($param[3] ?? null) ? $param[3] . "px" : "100%";
                $height = is_numeric($param[4] ?? null) ? $param[4] . "px" : "100%";
                $map_gui = ilMapUtil::getMapGUI();
                $map_gui->setMapId("map_" . $i)
                        ->setLatitude($param[0])
                        ->setLongitude($param[1])
                        ->setZoom($param[2])
                        ->setWidth($width)
                        ->setHeight($height)
                        ->setEnableTypeControl(true)
                        ->setEnableNavigationControl(true)
                        ->setEnableCentralMarker(true);
                $h2 = substr($a_output, 0, $start) .
                    $map_gui->getHtml() .
                    substr($a_output, $end + 5);
                $a_output = $h2;
                $i++;
            }
            $start = strpos($a_output, "[[[[[Map;", $start + 5);
            $end = 0;
            if (is_int($start)) {
                $end = strpos($a_output, "]]]]]", $start);
            }
        }
 
        return $a_output;
    }

◆ setCaption()

ilPCMap::setCaption ( string $a_caption )

Definition at line 161 of file class.ilPCMap.php.

                                                 : void
    {
        if (is_object($this->getChildNode())) {
            $this->dom_util->setFirstOptionalElement(
                $this->getChildNode(),
                "MapCaption",
                array(),
                $a_caption,
                array()
            );
        }
    }

◆ setLatitude()

ilPCMap::setLatitude ( ?float $a_lat = null )

Definition at line 44 of file class.ilPCMap.php.

                                                     : void
    {
        if (!is_null($a_lat)) {
            $this->getChildNode()->setAttribute("Latitude", (string) $a_lat);
        } else {
            if ($this->getChildNode()->hasAttribute("Latitude")) {
                $this->getChildNode()->removeAttribute("Latitude");
            }
        }
    }

◆ setLayout()

ilPCMap::setLayout	(	?int	$a_width,
		?int	$a_height,
		string	$a_horizontal_align
	)

Definition at line 101 of file class.ilPCMap.php.

     : void {
        if (is_object($this->getChildNode())) {
            $this->dom_util->setFirstOptionalElement(
                $this->getChildNode(),
                "Layout",
                array("MapCaption"),
                "",
                array("Width" => $a_width !== null ? (string) $a_width : null,
                    "Height" => $a_height !== null ? (string) $a_height : null,
                    "HorizontalAlign" => $a_horizontal_align)
            );
        }
    }

◆ setLongitude()

ilPCMap::setLongitude ( ?float $a_long = null )

Definition at line 63 of file class.ilPCMap.php.

                                                       : void
    {
        if (!is_null($a_long)) {
            $this->getChildNode()->setAttribute("Longitude", $a_long);
        } else {
            if ($this->getChildNode()->hasAttribute("Longitude")) {
                $this->getChildNode()->removeAttribute("Longitude");
            }
        }
    }

◆ setZoom()

ilPCMap::setZoom ( ?int $a_zoom )

Definition at line 82 of file class.ilPCMap.php.

                                         : void
    {
        //if (!empty($a_zoom)) {
        $this->getChildNode()->setAttribute("Zoom", (int) $a_zoom);
        /*} else {
            if ($this->map_node->has_attribute("Zoom")) {
                $this->map_node->remove_attribute("Zoom");
            }
        }*/
    }

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

components/ILIAS/COPage/PC/Map/class.ilPCMap.php

Public Member Functions

Static Public Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ create()

◆ getCaption()

◆ getHeight()

◆ getHorizontalAlign()

◆ getLatitude()

◆ getLongitude()

◆ getWidth()

◆ getZoom()

◆ handleCaptionFormOutput()

◆ handleCaptionInput()

◆ init()

◆ modifyPageContentPostXsl()

◆ setCaption()

◆ setLatitude()

◆ setLayout()

◆ setLongitude()

◆ setZoom()