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

Collaboration diagram for ilPCSourceCodeGUI:

Public Member Functions
	__construct (ilPageObject $a_pg_obj, ?ilPageContent $a_content_obj, string $a_hier_id, string $a_pc_id="")
	executeCommand ()
	edit ()
	insert ()
	update ()
	cancelUpdate ()
	create ()
	cancelCreate ()
	upload_source ()
	getProgLangOptions ()
	Get selectable programming languages. More...
	initPropertyForm (string $a_title, string $a_cmd, string $a_cmd_cancel)
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 ()
	moveAfter ()
	move content element after another element More...
	moveBefore ()
	move content element before another element More...
	splitPage ()
	split page to new page at specified position More...
	splitPageNext ()
	split page to next page at specified position More...
	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
string	$requested_par_downloadtitle
string	$requested_par_content
ilObjUser	$user
Protected Attributes inherited from ilPageContentGUI
EditSessionRepository	$edit_repo
string	$pc_id = ""
array	$chars
ilObjStyleSheet	$style = null
ilLogger	$log
int	$styleid = 0
EditGUIRequest	$request
string	$sub_command = ""
int	$requested_ref_id = 0
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 = ""
php4DOMDocument	$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 ()
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 ilPCSourcecodeGUI

User Interface for Paragraph Editing

Author

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

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

Constructor & Destructor Documentation

__construct()

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

Definition at line 35 of file class.ilPCSourceCodeGUI.php.

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

      {
        global $DIC;

        $this->user = $DIC->user();
        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

cancelCreate()

ilPCSourceCodeGUI::cancelCreate

(

)

Definition at line 235 of file class.ilPCSourceCodeGUI.php.

References ILIAS\Repository\ctrl().

                                  : void
    {
        $this->ctrl->returnToParent($this, "jump" . $this->hier_id);
    }

Here is the call graph for this function:

cancelUpdate()

ilPCSourceCodeGUI::cancelUpdate

(

)

Definition at line 182 of file class.ilPCSourceCodeGUI.php.

References ILIAS\Repository\ctrl().

                                  : void
    {
        $this->ctrl->returnToParent($this, "jump" . $this->hier_id);
    }

Here is the call graph for this function:

create()

ilPCSourceCodeGUI::create

(

)

Definition at line 187 of file class.ilPCSourceCodeGUI.php.

References ILIAS\Repository\ctrl(), ilPageContentGUI\getPage(), insert(), ilPageContentGUI\setCurrentTextLang(), and upload_source().

                            : void
    {
        $this->content_obj = new ilPCSourceCode($this->getPage());
        $this->content_obj->create($this->pg_obj, $this->hier_id, $this->pc_id);
        $this->content_obj->setLanguage($this->request->getString("par_language"));

        $this->setCurrentTextLang($this->request->getString("par_language"));

        $this->requested_par_content = $this->request->getRaw("par_content");
        $this->requested_par_downloadtitle = str_replace('"', '', $this->request->getString("par_downloadtitle"));

        $uploaded = $this->upload_source();

        $this->content_obj->setCharacteristic(
            $this->request->getString("par_characteristic")
        );
        $this->content_obj->setSubCharacteristic(
            $this->request->getString("par_subcharacteristic")
        );
        $this->content_obj->setDownloadTitle(str_replace('"', '', $this->requested_par_downloadtitle));
        $this->content_obj->setShowLineNumbers(
            $this->request->getString("par_showlinenumbers") ? 'y' : 'n'
        );
        $this->content_obj->setCharacteristic('Code');

        if ($uploaded) {
            $this->insert();
            return;
        }

        $this->updated = $this->content_obj->setText(
            $this->content_obj->input2xml($this->requested_par_content, 0, false)
        );

        if ($this->updated !== true) {
            $this->insert();
            return;
        }

        $this->updated = $this->pg_obj->update();

        if ($this->updated === true) {
            $this->ctrl->returnToParent($this, "jump" . $this->hier_id);
        } else {
            $this->insert();
        }
    }

Here is the call graph for this function:

edit()

ilPCSourceCodeGUI::edit

(

)

Definition at line 62 of file class.ilPCSourceCodeGUI.php.

References ILIAS\Repository\ctrl(), ilPageContentGUI\displayValidationError(), initPropertyForm(), and ILIAS\Repository\lng().

Referenced by update().

                          : void
    {
        $form = $this->initPropertyForm($this->lng->txt("cont_edit_src"), "update", "cancelCreate");

        if ($this->pg_obj->getParentType() == "lm") {
            $this->tpl->setVariable(
                "LINK_ILINK",
                $this->ctrl->getLinkTargetByClass("ilInternalLinkGUI", "showLinkHelp")
            );
            $this->tpl->setVariable("TXT_ILINK", "[" . $this->lng->txt("cont_internal_link") . "]");
        }

        $this->displayValidationError();

        $cmd = $this->ctrl->getCmd();
        if ($cmd == "update") {
            $form->setValuesByPost();
        } else {
            $form->getItemByPostVar("par_language")->setValue($this->content_obj->getLanguage());
            $form->getItemByPostVar("par_subcharacteristic")->setValue($this->content_obj->getSubCharacteristic());
            $form->getItemByPostVar("par_downloadtitle")->setValue($this->content_obj->getDownloadTitle());
            $form->getItemByPostVar("par_showlinenumbers")->setChecked(
                $this->content_obj->getShowLineNumbers() == "y"
            );
            //                  $form->getItemByPostVar("par_autoindent")->setChecked(
            //                          $this->content_obj->getAutoIndent()=="y"?true:false);

            $par_content = $this->content_obj->xml2output($this->content_obj->getText());

            //TODO: Find a better way to convert back curly brackets
            $par_content = str_replace("{", "{", $par_content);
            $par_content = str_replace("}", "}", $par_content);

            $form->getItemByPostVar("par_content")->setValue($par_content);
        }


        $this->tpl->setContent($form->getHTML());
    }

Here is the call graph for this function:

Here is the caller graph for this function:

executeCommand()

ilPCSourceCodeGUI::executeCommand

(

)

Definition at line 47 of file class.ilPCSourceCodeGUI.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:

getProgLangOptions()

ilPCSourceCodeGUI::getProgLangOptions

(

)

Get selectable programming languages.

Returns

string[]

Definition at line 271 of file class.ilPCSourceCodeGUI.php.

References ilSyntaxHighlighter\getSupportedLanguagesV51().

Referenced by initPropertyForm().

                                        : array
    {
        $prog_langs = array(
            "" => "other");
        foreach (ilSyntaxHighlighter::getSupportedLanguagesV51() as $k => $v) {
            $prog_langs[$k] = $v;
        }
        return $prog_langs;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

initPropertyForm()

ilPCSourceCodeGUI::initPropertyForm	(	string	$a_title,
		string	$a_cmd,
		string	$a_cmd_cancel
	)

Definition at line 281 of file class.ilPCSourceCodeGUI.php.

References $lang, ilMDLanguageItem\_getLanguages(), ILIAS\Repository\ctrl(), getProgLangOptions(), and ILIAS\Repository\lng().

Referenced by edit(), and insert().

     : ilPropertyFormGUI {
        $form = new ilPropertyFormGUI();
        $form->setTitle($a_title);
        $form->setFormAction($this->ctrl->getFormAction($this, $a_cmd));
        $form->addCommandButton($a_cmd, $this->lng->txt("save"));
        $form->addCommandButton($a_cmd_cancel, $this->lng->txt("cancel"));

        $lang_var = ilMDLanguageItem::_getLanguages();
        $lang = new ilSelectInputGUI($this->lng->txt("language"), "par_language");
        $lang->setOptions($lang_var);
        $form->addItem($lang);

        $prog_langs = $this->getProgLangOptions();
        $code_style = new ilSelectInputGUI($this->lng->txt("cont_src"), "par_subcharacteristic");
        $code_style->setOptions($prog_langs);
        $form->addItem($code_style);
        $line_number = new ilCheckboxInputGUI($this->lng->txt("cont_show_line_numbers"), "par_showlinenumbers");
        $form->addItem($line_number);

        $code = new ilTextAreaInputGUI("", "par_content");
        $code->setRows(12);
        $form->addItem($code);

        $downlaod_title = new ilTextInputGUI($this->lng->txt("cont_download_title"), "par_downloadtitle");
        $downlaod_title->setSize(40);
        $form->addItem($downlaod_title);

        $file = new ilFileInputGUI($this->lng->txt("import_file"), "userfile");
        $form->addItem($file);

        return $form;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

insert()

ilPCSourceCodeGUI::insert

(

)

Definition at line 102 of file class.ilPCSourceCodeGUI.php.

References $ilUser, $user, ILIAS\Repository\ctrl(), ilPageContentGUI\displayValidationError(), ilPageContentGUI\getCurrentTextLang(), initPropertyForm(), and ILIAS\Repository\lng().

Referenced by create().

                            : void
    {
        $ilUser = $this->user;

        $form = $this->initPropertyForm($this->lng->txt("cont_insert_src"), "create_src", "cancelCreate");

        if ($this->pg_obj->getParentType() == "lm") {
            $this->tpl->setVariable(
                "LINK_ILINK",
                $this->ctrl->getLinkTargetByClass("ilInternalLinkGUI", "showLinkHelp")
            );
            $this->tpl->setVariable("TXT_ILINK", "[" . $this->lng->txt("cont_internal_link") . "]");
        }

        $this->displayValidationError();

        $cmd = $this->ctrl->getCmd();
        if ($cmd == "create_src") {
            $form->setValuesByPost();
        } else {
            if ($this->getCurrentTextLang() != "") {
                $form->getItemByPostVar("par_language")->setValue($this->getCurrentTextLang());
            } else {
                $form->getItemByPostVar("par_language")->setValue($ilUser->getLanguage());
            }

            $form->getItemByPostVar("par_showlinenumbers")->setChecked(true);
            //                  $form->getItemByPostVar("par_autoindent")->setChecked(true);
            $form->getItemByPostVar("par_subcharacteristic")->setValue("");
            $form->getItemByPostVar("par_content")->setValue("");
        }

        $this->tpl->setContent($form->getHTML());
    }

Here is the call graph for this function:

Here is the caller graph for this function:

update()

ilPCSourceCodeGUI::update

(

)

Definition at line 137 of file class.ilPCSourceCodeGUI.php.

References ILIAS\Repository\ctrl(), edit(), and upload_source().

                            : void
    {
        $this->requested_par_content = $this->request->getRaw("par_content");
        $this->requested_par_downloadtitle = str_replace('"', '', $this->request->getString("par_downloadtitle"));

        $this->upload_source();

        // set language and characteristic

        $this->content_obj->setLanguage(
            $this->request->getString("par_language")
        );
        $this->content_obj->setCharacteristic($this->request->getString("par_characteristic"));

        // set language and characteristic
        $this->content_obj->setLanguage($this->request->getString("par_language"));
        $this->content_obj->setSubCharacteristic($this->request->getString("par_subcharacteristic"));
        $this->content_obj->setDownloadTitle(
            str_replace('"', '', $this->requested_par_downloadtitle)
        );
        $this->content_obj->setShowLineNumbers(
            $this->request->getString("par_showlinenumbers") ? "y" : "n"
        );
        $this->content_obj->setSubCharacteristic($this->request->getString("par_subcharacteristic"));
        $this->content_obj->setCharacteristic("Code");

        $this->updated = $this->content_obj->setText(
            $this->content_obj->input2xml($this->requested_par_content, 0, false)
        );

        if ($this->updated !== true) {
            //echo "Did not update!";
            $this->edit();
            return;
        }

        $this->updated = $this->pg_obj->update();

        if ($this->updated === true && $this->ctrl->getCmd() != "upload") {
            $this->ctrl->returnToParent($this, "jump" . $this->hier_id);
        } else {
            $this->edit();
        }
    }

Here is the call graph for this function:

upload_source()

ilPCSourceCodeGUI::upload_source

(

)

Definition at line 240 of file class.ilPCSourceCodeGUI.php.

Referenced by create(), and update().

                                   : bool
    {
        if (isset($_FILES['userfile']['name'])) {
            $userfile = $_FILES['userfile']['tmp_name'];

            if ($userfile == "" || !is_uploaded_file($userfile)) {
                $error_str = "<b>Error(s):</b><br>Upload error: file name must not be empty!";
                $this->tpl->setVariable("MESSAGE", $error_str);
                $this->content_obj->setText(
                    $this->content_obj->input2xml(
                        $this->request->getRaw("par_content"),
                        0,
                        false
                    )
                );
                return false;
            }

            $this->requested_par_content = file_get_contents($userfile);
            $this->requested_par_downloadtitle = $_FILES['userfile']['name'];
            return true;
        }

        return false;
    }

Here is the caller graph for this function:

Field Documentation

$requested_par_content

string ilPCSourceCodeGUI::$requested_par_content

protected

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

$requested_par_downloadtitle

string ilPCSourceCodeGUI::$requested_par_downloadtitle

protected

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

$user

ilObjUser ilPCSourceCodeGUI::$user

protected

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

Referenced by insert().

---

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

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