ilPCSourceCodeGUI Class Reference

Class ilPCSourcecodeGUI. More...

Inheritance diagram for ilPCSourceCodeGUI:

Collaboration diagram for ilPCSourceCodeGUI:

Public Member Functions
	__construct ($a_pg_obj, $a_content_obj, $a_hier_id, $a_pc_id="")
	Constructor public. More...
	executeCommand ()
	execute command More...
	edit ()
	edit paragraph form More...
	insert ()
	insert paragraph form More...
	update ()
	update paragraph in dom and update page in db More...
	cancelUpdate ()
	cancel update More...
	create ()
	create new paragraph in dom and update page in db More...
	cancelCreate ()
	cancel creating paragraph More...
	upload_source ()
	getProgLangOptions ()
	Get selectable programming languages. More...
	initPropertyForm ($a_title, $a_cmd, $a_cmd_cancel)
	initiates property form GUI class More...
Public Member Functions inherited from ilPageContentGUI
	__construct ($a_pg_obj, $a_content_obj, $a_hier_id=0, $a_pc_id="")
	Constructor public. More...
	setContentObject ($a_val)
	Set content object. More...
	getContentObject ()
	Get content object. More...
	setPage ($a_val)
	Set page. More...
	getPage ()
	Get page. More...
	setPageConfig ($a_val)
	Set Page Config. More...
	getPageConfig ()
	Get Page Config. More...
	setStyleId ($a_styleid)
	Set Style Id. More...
	getStyleId ()
	Get Style Id. More...
	getStyle ()
	Get style object. More...
	setCharacteristics ($a_chars)
	Set Characteristics. More...
	getCharacteristics ()
	Get characteristics. More...
	getHierId ()
	get hierarchical id in dom object More...
	setHierId ($a_hier_id)
	get hierarchical id in dom object More...
	getBBMenu ($a_ta_name="par_content")
	Get the bb menu incl. More...
	delete ()
	delete content element More...
	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 ()
	display validation errors More...
	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 ($a_type)
	Get table templates. More...

Protected Attributes
	$user
Protected Attributes inherited from ilPageContentGUI
	$error
	$log

Additional Inherited Members
Static Public Member Functions inherited from ilPageContentGUI
static	_getCommonBBButtons ()
	Get common bb buttons. More...
Data Fields inherited from ilPageContentGUI
	$content_obj
	$tpl
	$lng
	$ctrl
	$pg_obj
	$hier_id
	$dom
	$updated
	$target_script
	$return_location
	$page_config = null
Static Public Attributes inherited from ilPageContentGUI
static	$style_selector_reset = "margin-top:2px; margin-bottom:2px; text-indent:0px; position:static; float:none; width: auto;"
Protected Member Functions inherited from ilPageContentGUI
	getCharacteristicsOfCurrentStyle ($a_type)
	Get characteristics of current style. More...
Static Protected Attributes inherited from ilPageContentGUI
static	$common_bb_buttons

Detailed Description

Class ilPCSourcecodeGUI.

User Interface for Paragraph Editing

Author

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

Version

$Id$

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

Constructor & Destructor Documentation

__construct()

ilPCSourceCodeGUI::__construct	(		$a_pg_obj,
			$a_content_obj,
			$a_hier_id,
			$a_pc_id = ""
	)

Constructor public.

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

References $DIC, and 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

(

)

cancel creating paragraph

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

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

cancelUpdate()

ilPCSourceCodeGUI::cancelUpdate

(

)

cancel update

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

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

create()

ilPCSourceCodeGUI::create

(

)

create new paragraph in dom and update page in db

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

References $_GET, $_POST, $_SESSION, ilPageContentGUI\getPage(), insert(), ilUtil\stripSlashes(), and upload_source().

    {
        $this->content_obj = new ilPCSourceCode($this->getPage());
        $this->content_obj->create($this->pg_obj, $this->hier_id, $this->pc_id);
        $this->content_obj->setLanguage($_POST["par_language"]);

        $_SESSION["il_text_lang_" . $_GET["ref_id"]] = $_POST["par_language"];

        $uploaded = $this->upload_source();
                
        $this->content_obj->setCharacteristic($_POST["par_characteristic"]);
        $this->content_obj->setSubCharacteristic($_POST["par_subcharacteristic"]);
        $this->content_obj->setDownloadTitle(str_replace('"', '', ilUtil::stripSlashes($_POST["par_downloadtitle"])));
        $this->content_obj->setShowLineNumbers($_POST["par_showlinenumbers"]?'y':'n');
        $this->content_obj->setCharacteristic('Code');
        //$this->content_obj->setAutoIndent     ($_POST["par_autoindent"]?'y':'n');

        if ($uploaded) {
            $this->insert();
            return;
        }
        
        $this->updated = $this->content_obj->setText(
            $this->content_obj->input2xml($_POST["par_content"], 0, false)
        );
        
        if ($this->updated !== true) {
            $this->insert();
            return;
        }
        
        $this->updated = $this->pg_obj->update();

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

Here is the call graph for this function:

edit()

ilPCSourceCodeGUI::edit

(

)

edit paragraph form

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

References $_POST, $form, ilPageContentGUI\displayValidationError(), and initPropertyForm().

Referenced by update().

    {
        $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();

        if (key($_POST["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"?true:false
            );
            //                  $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

(

)

execute command

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

References $ret.

    {
        // 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:
                $ret = $this->$cmd();
                break;
        }

        return $ret;
    }

getProgLangOptions()

ilPCSourceCodeGUI::getProgLangOptions

(

)

Get selectable programming languages.

Returns

string[]

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

References array, and ilSyntaxHighlighter\getSupportedLanguagesV51().

Referenced by initPropertyForm().

    {
        $prog_langs = array(
            "" => "other");
        include_once("./Services/UIComponent/SyntaxHighlighter/classes/class.ilSyntaxHighlighter.php");
        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	(		$a_title,
			$a_cmd,
			$a_cmd_cancel
	)

initiates property form GUI class

Parameters

string	$a_title
string	$a_cmd
string	$a_cmd_cancel

Returns

ilPropertyFormGUI form class

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

References $code, $file, $form, $lang, ilMDLanguageItem\_getLanguages(), getProgLangOptions(), ilSelectInputGUI\setOptions(), and ilTextInputGUI\setSize().

Referenced by edit(), and insert().

    {
        include_once("./Services/Form/classes/class.ilPropertyFormGUI.php");
        $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"));


        require_once("Services/MetaData/classes/class.ilMDLanguageItem.php");
        $lang_var = ilMDLanguageItem::_getLanguages();
        include_once("./Services/Form/classes/class.ilSelectInputGUI.php");
        $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);
        include_once("./Services/Form/classes/class.ilSelectInputGUI.php");
        $line_number = new ilCheckboxInputGUI($this->lng->txt("cont_show_line_numbers"), "par_showlinenumbers");
        $form->addItem($line_number);
        //$indent = new ilCheckboxInputGUI($this->lng->txt("cont_autoindent"), "par_autoindent");
        //$form->addItem($indent);


        include_once("./Services/Form/classes/class.ilSelectInputGUI.php");
        $code = new ilTextAreaInputGUI("", "par_content");
        $code->setRows(12);
        $form->addItem($code);

        include_once("./Services/Form/classes/class.ilTextInputGUI.php");
        $downlaod_title = new ilTextInputGUI($this->lng->txt("cont_download_title"), "par_downloadtitle");
        $downlaod_title->setSize(40);
        $form->addItem($downlaod_title);

        include_once("./Services/Form/classes/class.ilFileInputGUI.php");
        $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

(

)

insert paragraph form

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

References $_GET, $_POST, $_SESSION, $form, $ilUser, $user, ilPageContentGUI\displayValidationError(), and initPropertyForm().

Referenced by create().

    {
        $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();

        if (key($_POST["cmd"]) == "create_src") {
            $form->setValuesByPost();
        } else {
            if ($_SESSION["il_text_lang_" . $_GET["ref_id"]] != "") {
                $form->getItemByPostVar("par_language")->setValue($_SESSION["il_text_lang_" . $_GET["ref_id"]]);
            } 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

(

)

update paragraph in dom and update page in db

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

References $_POST, edit(), ilUtil\stripSlashes(), and upload_source().

    {
        $this->upload_source();

        // set language and characteristic
        
        $this->content_obj->setLanguage($_POST["par_language"]);
        $this->content_obj->setCharacteristic($_POST["par_characteristic"]);

        //echo "PARupdate:".htmlentities($this->content_obj->input2xml($_POST["par_content"])).":<br>"; exit;

         
        // set language and characteristic
        $this->content_obj->setLanguage($_POST["par_language"]);
        $this->content_obj->setSubCharacteristic($_POST["par_subcharacteristic"]);
        $this->content_obj->setDownloadTitle(str_replace('"', '', ilUtil::stripSlashes($_POST["par_downloadtitle"])));
        $this->content_obj->setShowLineNumbers($_POST["par_showlinenumbers"]?"y":"n");
        //$this->content_obj->setAutoIndent($_POST["par_autoindent"]?"y":"n");
        $this->content_obj->setSubCharacteristic($_POST["par_subcharacteristic"]);
        $this->content_obj->setCharacteristic("Code");

        $this->updated = $this->content_obj->setText(
            $this->content_obj->input2xml($_POST["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 241 of file class.ilPCSourceCodeGUI.php.

References $_POST.

Referenced by create(), and update().

    {
        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(stripslashes($_POST["par_content"]), 0, false));
                return false;
            }

            $_POST["par_content"] = file_get_contents($userfile);
            $_POST["par_downloadtitle"] = $_FILES['userfile']['name'];
            return true;
        }
        
        return false;
    }

Here is the caller graph for this function:

Field Documentation

$user

ilPCSourceCodeGUI::$user

protected

Definition at line 23 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