ilPCMap Class Reference

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...
	setNode (php4DOMElement $a_node)
	Set xml node of page content. 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)
	setPage (ilPageObject $a_val)
	getPage ()
	init ()
	Init object. More...
	getType ()
	setNode (php4DOMElement $a_node)
	Set xml node of page content. More...
	getNode ()
	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...
	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	incEdId (string $ed_id)
	Increases an hierarchical editing id at lowest level (last number) More...
static	decEdId (string $ed_id)
	Decreases an hierarchical editing id at lowest level (last number) More...
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...

Data Fields
php4DOMElement	$map_node
Data Fields inherited from ilPageContent
string	$hier_id = ""
php4DOMElement	$node = null
php4DOMDocument	$dom = null
string	$page_lang = ""

Additional Inherited Members
Protected Member Functions inherited from ilPageContent
	setType (string $a_type)
	Set Type. More...
Protected Attributes inherited from ilPageContent
string	$pcid
string	$type = ""
ilPageObject	$pg_obj
string	$file_download_link
string	$fullscreen_link
string	$sourcecode_download_script
ilLogger	$log
string	$profile_back_url = ""

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 39 of file class.ilPCMap.php.

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

getCaption()

ilPCMap::getCaption

(

)

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

                                : string
    {
        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();
                }
            }
        }
        return "";
    }

getHeight()

ilPCMap::getHeight

(

)

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

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

References ILIAS\Repository\int().

Here is the call graph for this function:

getHorizontalAlign()

ilPCMap::getHorizontalAlign

(

)

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

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

getLatitude()

ilPCMap::getLatitude

(

)

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

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

getLongitude()

ilPCMap::getLongitude

(

)

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

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

getWidth()

ilPCMap::getWidth

(

)

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

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

References ILIAS\Repository\int().

Here is the call graph for this function:

getZoom()

ilPCMap::getZoom

(

)

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

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

handleCaptionFormOutput()

static ilPCMap::handleCaptionFormOutput ( string  $a_text )

static

Definition at line 211 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 201 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 28 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 220 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])) {
                $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_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 174 of file class.ilPCMap.php.

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

References ilDOMUtil\setFirstOptionalElement().

Here is the call graph for this function:

setLatitude()

ilPCMap::setLatitude

(

?float

$a_lat = null

)

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

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

setLayout()

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

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

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

References ilDOMUtil\setFirstOptionalElement().

Here is the call graph for this function:

setLongitude()

ilPCMap::setLongitude

(

?float

$a_long = null

)

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

                                                       : void
    {
        if (!is_null($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

(

php4DOMElement

$a_node

)

Set xml node of page content.

Parameters

php4DOMElement

$a_node

node object

Reimplemented from ilPageContent.

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

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

References php4DOMNode\first_child().

Here is the call graph for this function:

setZoom()

ilPCMap::setZoom

(

?int

$a_zoom

)

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

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

Field Documentation

$map_node

php4DOMElement ilPCMap::$map_node

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

---

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

• Services/COPage/classes/class.ilPCMap.php