ilPCMapGUI 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 ilPCMapGUI:

Collaboration diagram for ilPCMapGUI:

Public Member Functions
	__construct (ilPageObject $a_pg_obj, ?ilPageContent $a_content_obj, string $a_hier_id, string $a_pc_id="")
	executeCommand ()
	insert ()
	edit ()
	getValues ()
	initForm (string $a_mode)
	create ()
	update ()
Public Member Functions inherited from ilPageContentGUI
	__construct (ilPageObject $a_pg_obj, ?ilPageContent $a_content_obj, string $a_hier_id="", string $a_pc_id="0")
	setContentObject (ilPageContent $a_val)
	getContentObject ()
	setPage (ilPageObject $a_val)
	getPage ()
	setPageConfig (ilPageConfig $a_val)
	getPageConfig ()
	setStyleId (int $a_styleid)
	getStyleId ()
	getStyle ()
	getCharacteristicsOfCurrentStyle (array $a_type)
	Get characteristics of current style and call setCharacteristics, if style is given. More...
	setCharacteristics (array $a_chars)
	getCharacteristics ()
	getHierId ()
	setHierId (string $a_hier_id)
	set hierarchical id in dom object More...
	delete ()
	displayValidationError ()
	cancelCreate ()
	cancel creating page content More...
	cancelUpdate ()
	cancel update More...
	cancel ()
	Cancel. More...
	deactivate ()
	gui function set enabled if is not enabled and vice versa More...
	cut ()
	Cut single element. More...
	copy ()
	Copy single element. More...
	getTemplateOptions (string $a_type="")
	Get table templates. More...

Protected Attributes
ilPropertyFormGUI	$form
Protected Attributes inherited from ilPageContentGUI
ILIAS COPage Editor GUIService	$editor_gui
ILIAS COPage InternalGUIService	$gui
EditSessionRepository	$edit_repo
string	$pc_id = ""
array	$chars
ilObjStyleSheet	$style = null
LOMServices	$lom_services
ilLogger	$log
int	$styleid = 0
EditGUIRequest	$request
string	$sub_command = ""
int	$requested_ref_id = 0
ILIAS GlobalScreen ScreenContext ContextServices	$tool_context
Style Content CharacteristicManager	$char_manager

Additional Inherited Members
Static Public Member Functions inherited from ilPageContentGUI
static	_getCommonBBButtons ()
Data Fields inherited from ilPageContentGUI
ilPageContent	$content_obj
ilGlobalTemplateInterface	$tpl
ilLanguage	$lng
ilCtrl	$ctrl
ilPageObject	$pg_obj
string	$hier_id = ""
DOMDocument	$dom
	$updated
string	$target_script = ""
string	$return_location = ""
ilPageConfig	$page_config = null
Static Public Attributes inherited from ilPageContentGUI
static string	$style_selector_reset = "margin-top:2px; margin-bottom:2px; text-indent:0px; position:static; float:none; width: auto;"
Protected Member Functions inherited from ilPageContentGUI
	redirectToParent (string $hier_id="")
	getParentReturn (string $hier_id="")
	updateAndReturn ()
	setCurrentTextLang (string $lang_key)
	getCurrentTextLang ()
	setEditorToolContext ()
	initEditor ()
	getEditorScriptTag (string $form_pc_id="", string $form_cname="")
Static Protected Attributes inherited from ilPageContentGUI
static array	$common_bb_buttons

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 ilPCMapGUI User Interface for Map Editing

Author

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

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

Constructor & Destructor Documentation

__construct()

ilPCMapGUI::__construct	(	ilPageObject	$a_pg_obj,
		?ilPageContent	$a_content_obj,
		string	$a_hier_id,
		string	$a_pc_id = ""
	)

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

References $DIC, ILIAS\GlobalScreen\Provider\__construct(), ILIAS\Repository\ctrl(), and ILIAS\Repository\lng().

      {
        global $DIC;

        $this->tpl = $DIC["tpl"];
        $this->ctrl = $DIC->ctrl();
        $this->lng = $DIC->language();
        parent::__construct($a_pg_obj, $a_content_obj, $a_hier_id, $a_pc_id);
    }

Here is the call graph for this function:

Member Function Documentation

create()

ilPCMapGUI::create

(

)

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

References $location, ilPageContentGUI\$tpl, ILIAS\Repository\ctrl(), ilPageContentGUI\displayValidationError(), ILIAS\Repository\form(), ilPageContentGUI\getPage(), initForm(), and ILIAS\UICore\GlobalTemplate\setContent().

                            : void
    {
        $tpl = $this->tpl;

        $this->initForm("create");
        if ($this->form->checkInput()) {
            $this->content_obj = new ilPCMap($this->getPage());
            $location = $this->form->getInput("location");
            $this->content_obj->create($this->pg_obj, $this->hier_id, $this->pc_id);
            $this->content_obj->setLatitude($location["latitude"]);
            $this->content_obj->setLongitude($location["longitude"]);
            $this->content_obj->setZoom((int) $location["zoom"]);
            $this->content_obj->setLayout(
                $this->form->getInput("width"),
                $this->form->getInput("height"),
                $this->form->getInput("horizontal_align")
            );
            $this->content_obj->setCaption(
                $this->content_obj->handleCaptionInput($this->form->getInput("caption"))
            );
            $this->updated = $this->pg_obj->update();
            if ($this->updated === true) {
                $this->ctrl->returnToParent($this, "jump" . $this->hier_id);
                return;
            }
        }
        $this->displayValidationError();
        $this->form->setValuesByPost();
        $tpl->setContent($this->form->getHTML());
    }

Here is the call graph for this function:

edit()

ilPCMapGUI::edit

(

)

Definition at line 66 of file class.ilPCMapGUI.php.

References ilPageContentGUI\$tpl, ilPageContentGUI\displayValidationError(), ILIAS\Repository\form(), getValues(), initForm(), and ILIAS\UICore\GlobalTemplate\setContent().

                          : void
    {
        $tpl = $this->tpl;
        $this->displayValidationError();
        $this->initForm("update");
        $this->getValues();
        $tpl->setContent($this->form->getHTML());
    }

Here is the call graph for this function:

executeCommand()

ilPCMapGUI::executeCommand

(

)

Definition at line 42 of file class.ilPCMapGUI.php.

References ILIAS\Repository\ctrl().

                                    : void
    {
        // get next class that processes or forwards current command
        $next_class = $this->ctrl->getNextClass($this);

        // get current command
        $cmd = $this->ctrl->getCmd();

        switch ($next_class) {
            default:
                $this->$cmd();
                break;
        }
    }

Here is the call graph for this function:

getValues()

ilPCMapGUI::getValues

(

)

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

References ILIAS\Repository\form(), and ilPCMap\handleCaptionFormOutput().

Referenced by edit().

                               : void
    {
        $values = array();

        $values["location"]["latitude"] = $this->content_obj->getLatitude();
        $values["location"]["longitude"] = $this->content_obj->getLongitude();
        $values["location"]["zoom"] = $this->content_obj->getZoom();
        $values["width"] = $this->content_obj->getWidth();
        $values["height"] = $this->content_obj->getHeight();
        $values["caption"] = ilPCMap::handleCaptionFormOutput($this->content_obj->getCaption());
        $values["horizontal_align"] = $this->content_obj->getHorizontalAlign();

        $this->form->setValuesByArray($values);
    }

Here is the call graph for this function:

Here is the caller graph for this function:

initForm()

ilPCMapGUI::initForm

(

string

$a_mode

)

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

References ilPageContentGUI\$ctrl, ilPageContentGUI\$lng, ILIAS\Repository\form(), ILIAS\Repository\lng(), ilSelectInputGUI\setOptions(), ilFormPropertyGUI\setRequired(), ilNumberInputGUI\setSize(), and ilLanguage\txt().

Referenced by create(), edit(), insert(), and update().

                                            : void
    {
        $ilCtrl = $this->ctrl;
        $lng = $this->lng;

        // edit form
        $this->form = new ilPropertyFormGUI();
        $this->form->setFormAction($ilCtrl->getFormAction($this));
        if ($a_mode == "create") {
            $this->form->setTitle($this->lng->txt("cont_insert_map"));
        } else {
            $this->form->setTitle($this->lng->txt("cont_update_map"));
        }

        // location
        $loc_prop = new ilLocationInputGUI(
            $this->lng->txt("cont_location"),
            "location"
        );
        $loc_prop->setRequired(true);
        $this->form->addItem($loc_prop);

        // width
        $width_prop = new ilNumberInputGUI(
            $this->lng->txt("cont_width"),
            "width"
        );
        $width_prop->setSize(4);
        $width_prop->setMaxLength(4);
        $width_prop->setRequired(true);
        $width_prop->setMinValue(250);
        $this->form->addItem($width_prop);

        // height
        $height_prop = new ilNumberInputGUI(
            $this->lng->txt("cont_height"),
            "height"
        );
        $height_prop->setSize(4);
        $height_prop->setMaxLength(4);
        $height_prop->setRequired(true);
        $height_prop->setMinValue(200);
        $this->form->addItem($height_prop);

        // horizonal align
        $align_prop = new ilSelectInputGUI(
            $this->lng->txt("cont_align"),
            "horizontal_align"
        );
        $options = array(
            "Left" => $lng->txt("cont_left"),
            "Center" => $lng->txt("cont_center"),
            "Right" => $lng->txt("cont_right"),
            "LeftFloat" => $lng->txt("cont_left_float"),
            "RightFloat" => $lng->txt("cont_right_float"));
        $align_prop->setOptions($options);
        $this->form->addItem($align_prop);

        // caption
        $caption_prop = new ilTextAreaInputGUI(
            $this->lng->txt("cont_caption"),
            "caption"
        );
        $this->form->addItem($caption_prop);

        // save/cancel buttons
        if ($a_mode == "create") {
            $this->form->addCommandButton("create", $lng->txt("save"));
            $this->form->addCommandButton("cancelCreate", $lng->txt("cancel"));
        } else {
            $this->form->addCommandButton("update", $lng->txt("save"));
            $this->form->addCommandButton("cancelUpdate", $lng->txt("cancel"));
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

insert()

ilPCMapGUI::insert

(

)

Definition at line 57 of file class.ilPCMapGUI.php.

References ilPageContentGUI\$tpl, ilPageContentGUI\displayValidationError(), ILIAS\Repository\form(), initForm(), and ILIAS\UICore\GlobalTemplate\setContent().

                            : void
    {
        $tpl = $this->tpl;

        $this->displayValidationError();
        $this->initForm("create");
        $tpl->setContent($this->form->getHTML());
    }

Here is the call graph for this function:

update()

ilPCMapGUI::update

(

)

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

References $location, ilPageContentGUI\$tpl, ILIAS\Repository\ctrl(), ilPageContentGUI\displayValidationError(), ILIAS\Repository\form(), initForm(), and ILIAS\UICore\GlobalTemplate\setContent().

                            : void
    {
        $tpl = $this->tpl;

        $this->initForm("update");
        if ($this->form->checkInput()) {
            $location = $this->form->getInput("location");
            $this->content_obj->setLatitude($location["latitude"]);
            $this->content_obj->setLongitude($location["longitude"]);
            $this->content_obj->setZoom((int) $location["zoom"]);
            $this->content_obj->setLayout(
                $this->form->getInput("width"),
                $this->form->getInput("height"),
                $this->form->getInput("horizontal_align")
            );
            $this->content_obj->setCaption(
                $this->content_obj->handleCaptionInput($this->form->getInput("caption"))
            );
            $this->updated = $this->pg_obj->update();
            if ($this->updated === true) {
                $this->ctrl->returnToParent($this, "jump" . $this->hier_id);
                return;
            }
        }
        $this->displayValidationError();
        $this->form->setValuesByPost();
        $tpl->setContent($this->form->getHTML());
    }

Here is the call graph for this function:

Field Documentation

$form

ilPropertyFormGUI ilPCMapGUI::$form

protected

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

---

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

• components/ILIAS/COPage/PC/Map/class.ilPCMapGUI.php