Class ilPCSourcecodeGUI. 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 ()
	cancel update More...

	create ()

	cancelCreate ()
	cancel creating page content More...

	upload_source ()

	getProgLangOptions ()
	Get selectable programming languages. More...

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

	getImportFormAdapter ()

	getManualFormAdapter (?string $download_title=null, ?string $subchar=null, ?bool $line_numbers=null)

	getEditingFormAdapter ()

	handleUploadResult (FileUpload $upload, UploadResult $result)

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
ilTabsGUI	$tabs

string	$requested_par_downloadtitle

string	$requested_par_content

ilObjUser	$user

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

array bool null	$updated = null

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

Class ilPCSourcecodeGUI.

User Interface for Paragraph Editing @ilCtrl_Calls ilPCSourceCodeGUI: ilRepoStandardUploadHandlerGUI

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

Definition at line 32 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 = `""`
	)

Reimplemented from ilPageContentGUI.

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

      {
        global $DIC;
 
        $this->user = $DIC->user();
        parent::__construct($a_pg_obj, $a_content_obj, $a_hier_id, $a_pc_id);
        $this->tabs = $DIC->tabs();
    }

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

Here is the call graph for this function:

Member Function Documentation

◆ cancelCreate()

ilPCSourceCodeGUI::cancelCreate ( )

cancel creating page content

Reimplemented from ilPageContentGUI.

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

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

References ILIAS\Repository\ctrl().

Here is the call graph for this function:

◆ cancelUpdate()

ilPCSourceCodeGUI::cancelUpdate ( )

cancel update

Reimplemented from ilPageContentGUI.

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

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

References ILIAS\Repository\ctrl().

Here is the call graph for this function:

◆ create()

ilPCSourceCodeGUI::create ( )

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

                            : 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();
        }
    }

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

Here is the call graph for this function:

◆ edit()

ilPCSourceCodeGUI::edit ( )

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

                          : void
    {
        $form = $this->initPropertyForm($this->lng->txt("cont_edit_src"), "update", "cancelCreate");
 
        $this->displayValidationError();
        $this->tpl->addCss(ilObjStyleSheet::getBaseContentStylePath());
 
        $this->initEditor();
        $this->tabs->setBackTarget("", "");
 
        $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());
 
            $par_content = str_replace("&#123;", "[curlybegin ", $par_content);
            $par_content = str_replace("&#125;", " curlyend]", $par_content);
 
            $form->getItemByPostVar("par_content")->setValue($par_content);
        }
 
        $f = $this->gui
            ->ui()
            ->factory()->input()->field()
                                ->textarea(
                                    $this->lng->txt("cont_pc_code")
                                )->withValue($par_content);
        $t = $this->gui->ui()->renderer()->render($f);
        $t = str_replace("<textarea", "<textarea name='code' rows='20' form='copg-src-form' ", $t);
        $t = str_replace("[curlybegin ", "&#123;", $t);
        $t = str_replace(" curlyend]", "&#125;", $t);
        $t = "<div class='c-form copg-src-form'>$t</div>";
        $this->tpl->setContent($t . $this->getEditorScriptTag($this->pc_id, "SourceCode"));
    }

References Vendor\Package\$f, ILIAS\Repository\ctrl(), ilPageContentGUI\displayValidationError(), ilObjStyleSheet\getBaseContentStylePath(), ilPageContentGUI\getEditorScriptTag(), ilPageContentGUI\initEditor(), initPropertyForm(), ILIAS\Repository\lng(), and ILIAS\Repository\tabs().

Referenced by update().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ executeCommand()

ilPCSourceCodeGUI::executeCommand ( )

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

                                    : 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) {
 
            case strtolower(ilRepoStandardUploadHandlerGUI::class):
                $form = $this->getImportFormAdapter();
                $gui = $form->getRepoStandardUploadHandlerGUI("input_file");
                $this->ctrl->forwardCommand($gui);
                break;
 
            default:
                $this->$cmd();
                break;
        }
    }

References ilPageContentGUI\$gui, ILIAS\Repository\ctrl(), and getImportFormAdapter().

Here is the call graph for this function:

◆ getEditingFormAdapter()

ilPCSourceCodeGUI::getEditingFormAdapter ( )

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

                                           : \ILIAS\Repository\Form\FormAdapterGUI
    {
        return $this->getManualFormAdapter(
            $this->content_obj->getDownloadTitle(),
            $this->content_obj->getSubCharacteristic(),
            ($this->content_obj->getShowLineNumbers() == "y")
        );
    }

◆ getImportFormAdapter()

ilPCSourceCodeGUI::getImportFormAdapter ( )

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

                                          : \ILIAS\Repository\Form\FormAdapterGUI
    {
        $this->ctrl->setParameter($this, "cname", "SourceCode");
        $form = $this->gui->form([self::class], "#")
                          ->async()
                          ->hidden("mode", "import")
                          ->file(
                              "input_file",
                              $this->lng->txt("import_file"),
                              \Closure::fromCallable([$this, 'handleUploadResult']),
                              "filename",
                              "",
                              1,
                              [],
                              [self::class],
                              "copg"
                          )
                          ->text(
                              "title",
                              $this->lng->txt("cont_download_title")
                          )
            ->select(
                "subchar",
                $this->lng->txt("cont_src"),
                $this->getProgLangOptions()
            )
            ->checkbox(
                "linenumbers",
                $this->lng->txt("cont_show_line_numbers")
            );
        return $form;
    }

References ILIAS\Repository\ctrl(), and ILIAS\Repository\lng().

Referenced by executeCommand().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getManualFormAdapter()

ilPCSourceCodeGUI::getManualFormAdapter	(	?string	$download_title = `null`,
		?string	$subchar = `null`,
		?bool	$line_numbers = `null`
	)

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

     : \ILIAS\Repository\Form\FormAdapterGUI {
        $this->ctrl->setParameter($this, "cname", "SourceCode");
        $form = $this->gui->form([self::class], "#")
                          ->async()
                          ->hidden("mode", "manual")
                          ->text(
                              "title",
                              $this->lng->txt("cont_download_title"),
                              "",
                              $download_title
                          )
                          ->select(
                              "subchar",
                              $this->lng->txt("cont_src"),
                              $this->getProgLangOptions(),
                              "",
                              $subchar
                          )
                          ->checkbox(
                              "linenumbers",
                              $this->lng->txt("cont_show_line_numbers"),
                              "",
                              $line_numbers
                          );
        return $form;
    }

◆ getProgLangOptions()

ilPCSourceCodeGUI::getProgLangOptions ( )

Get selectable programming languages.

Returns: string[]

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

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

References ilPCSourceCode\getSupportedLanguages().

Here is the call graph for this function:

◆ handleUploadResult()

ilPCSourceCodeGUI::handleUploadResult	(	FileUpload	$upload,
		UploadResult	$result
	)

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

     : BasicHandlerResult {
        $fac = new ILIAS\Data\UUID\Factory();
        $uuid = $fac->uuid4AsString();
        $name = $uuid . ".txt";
        $upload->moveOneFileTo(
            $result,
            "",
            Location::TEMPORARY,
            $name,
            true
        );
 
        return new BasicHandlerResult(
            "filename",
            HandlerResult::STATUS_OK,
            $name,
            ''
        );
    }

◆ initPropertyForm()

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

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

     : 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"));
 
        $code = new ilTextAreaInputGUI("", "par_content");
        $code->setRows(12);
        $form->addItem($code);
 
        return $form;
    }

Referenced by edit(), and insert().

Here is the caller graph for this function:

◆ insert()

ilPCSourceCodeGUI::insert ( )

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

                            : void
    {
        $ilUser = $this->user;
 
        $form = $this->initPropertyForm($this->lng->txt("cont_insert_src"), "create", "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());
    }

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

Referenced by create().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ update()

ilPCSourceCodeGUI::update ( )

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

                            : void
    {
        $this->requested_par_content = $this->request->getRaw("par_content");
        $this->requested_par_downloadtitle = str_replace('"', '', $this->request->getString("par_downloadtitle"));
 
        $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();
        }
    }

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

Here is the call graph for this function:

◆ upload_source()

ilPCSourceCodeGUI::upload_source ( )

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

                                   : bool
    {
        if (isset($_FILES['userfile']['name'])) {
            $userfile = $_FILES['userfile']['tmp_name'];
 
            if ($userfile == "" || !is_uploaded_file($userfile)) {
                $error_str = "<strong>Error(s):</strong><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;
    }

Referenced by create().

Here is the caller graph for this function:

Field Documentation

◆ $requested_par_content

string ilPCSourceCodeGUI::$requested_par_content

protected

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

◆ $requested_par_downloadtitle

string ilPCSourceCodeGUI::$requested_par_downloadtitle

protected

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

◆ $tabs

ilTabsGUI ilPCSourceCodeGUI::$tabs

protected

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

◆ $user

ilObjUser ilPCSourceCodeGUI::$user

protected

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

Referenced by insert().

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

components/ILIAS/COPage/PC/SourceCode/class.ilPCSourceCodeGUI.php

Public Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ cancelCreate()

◆ cancelUpdate()

◆ create()

◆ edit()

◆ executeCommand()

◆ getEditingFormAdapter()

◆ getImportFormAdapter()

◆ getManualFormAdapter()

◆ getProgLangOptions()

◆ handleUploadResult()

◆ initPropertyForm()

◆ insert()

◆ update()

◆ upload_source()

Field Documentation

◆ $requested_par_content

◆ $requested_par_downloadtitle

◆ $tabs

◆ $user