Inheritance diagram for ilPCMap:

Collaboration diagram for ilPCMap:

Public Member Functions
	init ()
	Init page content component. More...

	setNode ($a_node)
	Set node. More...

	create (&$a_pg_obj, $a_hier_id, $a_pc_id="")
	Create map node in xml. More...

	setLatitude ($a_lat)
	Set latitude of map. More...

	getLatitude ()
	Get latitude of map. More...

	setLongitude ($a_long)
	Set longitude of map. More...

	getLongitude ()
	Get longitude of map. More...

	setZoom ($a_zoom)
	Set zoom of map. More...

	getZoom ()
	Get zoom of map. More...

	setLayout ($a_width, $a_height, $a_horizontal_align)
	Set Layout. More...

	getWidth ()
	Get Width. More...

	getHeight ()
	Get Height. More...

	getHorizontalAlign ()
	Get Horizontal Alignment. More...

	setCaption ($a_caption)
	Set Caption. More...

	getCaption ()
	Get Caption. More...

	modifyPageContentPostXsl ($a_html, $a_mode)
	Modify page content after xsl. More...

Public Member Functions inherited from ilPageContent
	__construct ($a_pg_obj)
	Constructor. More...

	setPage ($a_val)
	Set page. More...

	getPage ()
	Get page. More...

	init ()
	Init object. More...

	getType ()
	Get type of page content. More...

	setNode ($a_node)
	Set xml node of page content. More...

&	getNode ()
	Get xml node of page content. More...

	getJavascriptFiles ($a_mode)
	Get Javascript files. More...

	getCssFiles ($a_mode)
	Get css files. More...

	getOnloadCode ($a_mode)
	Get on load code. More...

	setHierId ($a_hier_id)
	Set hierarchical ID in xml structure. More...

	getHierId ()
	Get hierarchical id. More...

	lookupHierId ()
	Get hierarchical id from dom. More...

	readHierId ()
	Read PC Id. More...

	setPcId ($a_pcid)
	Set PC Id. More...

	getPCId ()
	Get PC Id. More...

	setFileDownloadLink ($a_download_link)
	Set file download link. More...

	getFileDownloadLink ()
	Get file download link. More...

	setFullscreenLink ($a_fullscreen_link)
	Set fullscreen link. More...

	getFullscreenLink ()
	Get fullscreen link. More...

	setSourcecodeDownloadScript ($script_name)
	Set sourcecode download script. More...

	getSourcecodeDownloadScript ()
	Get sourcecode download script. More...

	readPCId ()
	Read PC Id. More...

	writePCId ($a_pc_id)
	Write pc id. More...

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

	enable ()
	Enable page content. More...

	disable ()
	Disable page content. More...

	isEnabled ()
	Check whether page content is enabled. More...

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

	modifyPageContentPostXsl ($a_output, $a_mode)
	Modify page content after xsl. More...

Static Public Member Functions
static	handleCaptionInput ($a_text)

static	handleCaptionFormOutput ($a_text)

Static Public Member Functions inherited from ilPageContent
static	incEdId ($ed_id)
	Increases an hierarchical editing id at lowest level (last number) More...

static	decEdId ($ed_id)
	Decreases an hierarchical editing id at lowest level (last number) More...

static	haveSameContainer ($ed_id1, $ed_id2)
	Check, if two ids are in same container. More...

static	sortHierIds ($a_array)
	Sort an array of Hier IDS in ascending order. More...

static	isGreaterHierId ($a, $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, $a_self_ass=true, $a_clone_mobs=false)
	Handle copied content. More...

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

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

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

Data Fields
	$map_node

Data Fields inherited from ilPageContent
	$hier_id

	$node

	$dom

	$page_lang

Additional Inherited Members
Protected Member Functions inherited from ilPageContent
	setType ($a_type)
	Set Type. More...

Protected Attributes inherited from ilPageContent
	$file_download_link

	$fullscreen_link

	$sourcecode_download_script

	$log

Detailed Description

Class ilPCMap.

Map content object (see ILIAS DTD)

Author: Alex Killing alex..nosp@m.kill.nosp@m.ing@g.nosp@m.mx.d.nosp@m.e

Version: $Id$

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

Member Function Documentation

◆ create()

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

Create map node in xml.

Parameters

object	$a_pg_obj	Page Object
string	$a_hier_id	Hierarchical ID

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

    {
        $this->node = $this->createPageContentNode();
 
        $a_pg_obj->insertContent($this, $a_hier_id, IL_INSERT_AFTER, $a_pc_id);
        $this->map_node = $this->dom->create_element("Map");
        $this->map_node = $this->node->append_child($this->map_node);
        $this->map_node->set_attribute("Latitude", "0");
        $this->map_node->set_attribute("Longitude", "0");
        $this->map_node->set_attribute("Zoom", "3");
    }

References ilPageContent\createPageContentNode(), and IL_INSERT_AFTER.

Here is the call graph for this function:

◆ getCaption()

ilPCMap::getCaption ( )

Get Caption.

Returns: string Caption

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

    {
        if (is_object($this->map_node)) {
            $childs = $this->map_node->child_nodes();
            foreach ($childs as $child) {
                if ($child->node_name() == "MapCaption") {
                    return $child->get_content();
                }
            }
        }
    }

◆ getHeight()

ilPCMap::getHeight ( )

Get Height.

Returns: integer Height

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

    {
        if (is_object($this->map_node)) {
            $childs = $this->map_node->child_nodes();
            foreach ($childs as $child) {
                if ($child->node_name() == "Layout") {
                    return $child->get_attribute("Height");
                }
            }
        }
    }

◆ getHorizontalAlign()

ilPCMap::getHorizontalAlign ( )

Get Horizontal Alignment.

Returns: string Horizontal Alignment

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

    {
        if (is_object($this->map_node)) {
            $childs = $this->map_node->child_nodes();
            foreach ($childs as $child) {
                if ($child->node_name() == "Layout") {
                    return $child->get_attribute("HorizontalAlign");
                }
            }
        }
    }

◆ getLatitude()

ilPCMap::getLatitude ( )

Get latitude of map.

Returns: string latitude

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

    {
        if (is_object($this->map_node)) {
            return $this->map_node->get_attribute("Latitude");
        }
    }

◆ getLongitude()

ilPCMap::getLongitude ( )

Get longitude of map.

Returns: string longitude

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

    {
        if (is_object($this->map_node)) {
            return $this->map_node->get_attribute("Longitude");
        }
    }

◆ getWidth()

ilPCMap::getWidth ( )

Get Width.

Returns: integer Width

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

    {
        if (is_object($this->map_node)) {
            $childs = $this->map_node->child_nodes();
            foreach ($childs as $child) {
                if ($child->node_name() == "Layout") {
                    return $child->get_attribute("Width");
                }
            }
        }
    }

◆ getZoom()

ilPCMap::getZoom ( )

Get zoom of map.

Returns: string zoom

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

    {
        if (is_object($this->map_node)) {
            return $this->map_node->get_attribute("Zoom");
        }
    }

◆ handleCaptionFormOutput()

static ilPCMap::handleCaptionFormOutput ( $a_text )

static

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

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

◆ handleCaptionInput()

static ilPCMap::handleCaptionInput ( $a_text )

static

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

    {
        $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 page content component.

Reimplemented from ilPageContent.

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

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

References ilPageContent\setType().

Here is the call graph for this function:

◆ modifyPageContentPostXsl()

ilPCMap::modifyPageContentPostXsl	(	$a_html,
		$a_mode
	)

Modify page content after xsl.

Parameters

string $a_output

Returns: string

Reimplemented from ilPageContent.

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

    {
        $c_pos = 0;
        $start = strpos($a_html, "[[[[[Map;");
        if (is_int($start)) {
            $end = strpos($a_html, "]]]]]", $start);
        }
        $i = 1;
        while ($end > 0) {
            $param = substr($a_html, $start + 9, $end - $start - 9);
            
            $param = explode(";", $param);
            if (is_numeric($param[0]) && is_numeric($param[1]) && is_numeric($param[2])) {
                include_once("./Services/Maps/classes/class.ilMapUtil.php");
                $map_gui = ilMapUtil::getMapGUI();
                $map_gui->setMapId("map_" . $i)
                        ->setLatitude($param[0])
                        ->setLongitude($param[1])
                        ->setZoom($param[2])
                        ->setWidth($param[3] . "px")
                        ->setHeight($param[4] . "px")
                        ->setEnableTypeControl(true)
                        ->setEnableNavigationControl(true)
                        ->setEnableCentralMarker(true);
                $h2 = substr($a_html, 0, $start) .
                    $map_gui->getHtml() .
                    substr($a_html, $end + 5);
                $a_html = $h2;
                $i++;
            }
            $start = strpos($a_html, "[[[[[Map;", $start + 5);
            $end = 0;
            if (is_int($start)) {
                $end = strpos($a_html, "]]]]]", $start);
            }
        }
                
        return $a_html;
    }

References $end, $i, $start, and ilMapUtil\getMapGUI().

Here is the call graph for this function:

◆ setCaption()

ilPCMap::setCaption ( $a_caption )

Set Caption.

Parameters

string $a_caption Caption

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

    {
        if (is_object($this->map_node)) {
            ilDomUtil::setFirstOptionalElement(
                $this->dom,
                $this->map_node,
                "MapCaption",
                array(),
                $a_caption,
                array()
            );
        }
    }

◆ setLatitude()

ilPCMap::setLatitude ( $a_lat )

Set latitude of map.

Parameters

string $a_lat latitude

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

    {
        if (!empty($a_lat)) {
            $this->map_node->set_attribute("Latitude", $a_lat);
        } else {
            if ($this->map_node->has_attribute("Latitude")) {
                $this->map_node->remove_attribute("Latitude");
            }
        }
    }

◆ setLayout()

ilPCMap::setLayout	(	$a_width,
		$a_height,
		$a_horizontal_align
	)

Set Layout.

Parameters

integer	$a_width	Width
integer	$a_height	Height
integer	$a_horizonal_align	Horizontal Alignment

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

    {
        if (is_object($this->map_node)) {
            ilDomUtil::setFirstOptionalElement(
                $this->dom,
                $this->map_node,
                "Layout",
                array("MapCaption"),
                "",
                array("Width" => $a_width,
                    "Height" => $a_height, "HorizontalAlign" => $a_horizontal_align)
            );
        }
    }

◆ setLongitude()

ilPCMap::setLongitude ( $a_long )

Set longitude of map.

Parameters

string $a_long longitude

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

    {
        if (!empty($a_long)) {
            $this->map_node->set_attribute("Longitude", $a_long);
        } else {
            if ($this->map_node->has_attribute("Longitude")) {
                $this->map_node->remove_attribute("Longitude");
            }
        }
    }

◆ setNode()

ilPCMap::setNode ( $a_node )

Set node.

Reimplemented from ilPageContent.

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

    {
        parent::setNode($a_node);               // this is the PageContent node
        $this->map_node = $a_node->first_child();               // this is the Map node
    }

◆ setZoom()

ilPCMap::setZoom ( $a_zoom )

Set zoom of map.

Parameters

string $a_zoom zoom

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

    {
        if (!empty($a_zoom)) {
            $this->map_node->set_attribute("Zoom", $a_zoom);
        } else {
            if ($this->map_node->has_attribute("Zoom")) {
                $this->map_node->remove_attribute("Zoom");
            }
        }
    }

Field Documentation

◆ $map_node

ilPCMap::$map_node

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

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

Services/COPage/classes/class.ilPCMap.php

Public Member Functions

Static Public Member Functions

Data Fields

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ create()

◆ getCaption()

◆ getHeight()

◆ getHorizontalAlign()

◆ getLatitude()

◆ getLongitude()

◆ getWidth()

◆ getZoom()

◆ handleCaptionFormOutput()

◆ handleCaptionInput()

◆ init()

◆ modifyPageContentPostXsl()

◆ setCaption()

◆ setLatitude()

◆ setLayout()

◆ setLongitude()

◆ setNode()

◆ setZoom()

Field Documentation

◆ $map_node