Class ilPCParagraphGUI User Interface for Paragraph Editing. More...

Inheritance diagram for ilPCParagraphGUI:

Collaboration diagram for ilPCParagraphGUI:

Public Member Functions
	__construct (ilPageObject $a_pg_obj, ?ilPageContent $a_content_obj, string $a_hier_id, string $a_pc_id="")

	executeCommand ()
	execute command More...

	determineCharacteristic (bool $a_insert=false)
	Determine current characteristic. More...

	editJS ()
	Edit paragraph (Ajax mode, sends the content of the paragraph) More...

	outputError (array $a_err)
	Output error. More...

	cancel ()
	Cancel. More...

	insertCharacteristicTable (ilTemplate $a_tpl, string $a_seleted_value)
	Insert characteristic table. More...

	insertHelp (ilTemplate $a_tpl)
	Insert Help. More...

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...

Static Public Member Functions
static	_getStandardCharacteristics ()
	Get standard characteristics. More...

static	_getStandardTextCharacteristics ()
	Get standard characteristics. More...

static	_getCharacteristics (int $a_style_id)
	Get characteristics. More...

static	xml2outputJS (string $s_text)
	Prepare content for js output. More...

Static Public Member Functions inherited from ilPageContentGUI
static	_getCommonBBButtons ()

Protected Attributes
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

Private Member Functions
	setStyle ()

Additional Inherited Members
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 ilPCParagraphGUI 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.ilPCParagraphGUI.php.

Constructor & Destructor Documentation

◆ __construct()

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

Reimplemented from ilPageContentGUI.

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

      {
        global $DIC;
 
        $this->user = $DIC->user();
        $this->ctrl = $DIC->ctrl();
        $this->lng = $DIC->language();
        parent::__construct($a_pg_obj, $a_content_obj, $a_hier_id, $a_pc_id);
 
        // characteristics (should be flexible in the future)
        $this->setCharacteristics(ilPCParagraphGUI::_getStandardCharacteristics());
    }

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

Here is the call graph for this function:

Member Function Documentation

◆ _getCharacteristics()

static ilPCParagraphGUI::_getCharacteristics ( int $a_style_id )

static

Get characteristics.

Definition at line 79 of file class.ilPCParagraphGUI.php.

                                                               : array
    {
        global $DIC;
        $request = $DIC->copage()->internal()
            ->gui()
            ->pc()
            ->editRequest();
        $requested_ref_id = $request->getRefId();
 
        $service = $DIC->contentStyle()->internal();
 
        $st_chars = ilPCParagraphGUI::_getStandardCharacteristics();
        $chars = ilPCParagraphGUI::_getStandardCharacteristics();
        if ($a_style_id > 0 &&
            ilObject::_lookupType($a_style_id) == "sty") {
            $access_manager = $service->domain()->access(
                $requested_ref_id,
                $DIC->user()->getId()
            );
            $char_manager = $service->domain()->characteristic(
                $a_style_id,
                $access_manager
            );
 
            $chars = $char_manager->getByTypes(
                ["text_block", "heading1", "heading2", "heading3"],
                false,
                false
            );
            $new_chars = array();
            foreach ($chars as $char) {
                if (($st_chars[$char->getCharacteristic()] ?? "") != "") {      // keep lang vars for standard chars
                    $title = $char_manager->getPresentationTitle(
                        $char->getType(),
                        $char->getCharacteristic()
                    );
                    if ($title == "") {
                        $title = $st_chars[$char->getCharacteristic()];
                    }
                    $new_chars[$char->getCharacteristic()] = $title;
                } else {
                    $new_chars[$char->getCharacteristic()] = $char_manager->getPresentationTitle(
                        $char->getType(),
                        $char->getCharacteristic()
                    );
                }
            }
            $chars = $new_chars;
        }
 
        return $chars;
    }

References ilPageContentGUI\$char_manager, ilPageContentGUI\$chars, $DIC, ilPageContentGUI\$request, ilPageContentGUI\$requested_ref_id, $service, _getStandardCharacteristics(), and ilObject\_lookupType().

Here is the call graph for this function:

◆ _getStandardCharacteristics()

static ilPCParagraphGUI::_getStandardCharacteristics ( )

static

Get standard characteristics.

Definition at line 50 of file class.ilPCParagraphGUI.php.

                                                        : array
    {
        global $DIC;
 
        $lng = $DIC->language();
 
        return array("Standard" => $lng->txt("cont_standard"),
            "Headline1" => $lng->txt("cont_Headline1"),
            "Headline2" => $lng->txt("cont_Headline2"),
            "Headline3" => $lng->txt("cont_Headline3"),
            "Book" => $lng->txt("cont_Book"),
            "Numbers" => $lng->txt("cont_Numbers"),
            "Verse" => $lng->txt("cont_Verse"),
            "List" => $lng->txt("cont_List"),
            "TableContent" => $lng->txt("cont_TableContent")
        );
    }

References $DIC, ilPageContentGUI\$lng, and ilLanguage\txt().

Referenced by __construct(), and _getCharacteristics().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ _getStandardTextCharacteristics()

static ilPCParagraphGUI::_getStandardTextCharacteristics ( )

static

Get standard characteristics.

Definition at line 71 of file class.ilPCParagraphGUI.php.

                                                            : array
    {
        return ["Mnemonic", "Attention"];
    }

◆ cancel()

ilPCParagraphGUI::cancel ( )

Cancel.

Reimplemented from ilPageContentGUI.

Definition at line 382 of file class.ilPCParagraphGUI.php.

                            : void
    {
        $this->log->debug("ilPCParagraphGUI, cancel(): return to parent: jump" . $this->hier_id);
        $this->ctrl->returnToParent($this, "jump" . $this->hier_id);
    }

References ILIAS\Repository\ctrl().

Here is the call graph for this function:

◆ determineCharacteristic()

ilPCParagraphGUI::determineCharacteristic ( bool $a_insert = false )

Determine current characteristic.

Definition at line 214 of file class.ilPCParagraphGUI.php.

                                                                   : string
    {
        $cmd = $this->ctrl->getCmd();
        // language and characteristic selection
        if (!$a_insert) {
            if ($cmd == "update") {
                $s_char = $this->request->getString("par_characteristic");
            } else {
                $s_char = $this->content_obj->getCharacteristic();
                if ($s_char == "") {
                    $s_char = "Standard";
                }
            }
        } else {
            if ($cmd == "create") {
                $s_char = $this->request->getString("par_characteristic");
            } else {
                $s_char = "Standard";
 
                // set characteristic of new paragraphs in list items to "List"
                $cont_obj = $this->pg_obj->getContentObject($this->getHierId());
                if (is_object($cont_obj)) {
                    if ($cont_obj->getType() == "li" ||
                        ($cont_obj->getType() == "par" && $cont_obj->getCharacteristic() == "List")) {
                        $s_char = "List";
                    }
 
                    if ($cont_obj->getType() == "td" ||
                        ($cont_obj->getType() == "par" && $cont_obj->getCharacteristic() == "TableContent")) {
                        $s_char = "TableContent";
                    }
                }
            }
        }
        return $s_char;
    }

References ILIAS\Repository\ctrl().

Here is the call graph for this function:

◆ editJS()

ilPCParagraphGUI::editJS ( )

Edit paragraph (Ajax mode, sends the content of the paragraph)

Definition at line 254 of file class.ilPCParagraphGUI.php.

                            : void
    {
        $s_text = $this->content_obj->getText();
        $this->log->debug("step 1: " . substr($s_text, 0, 1000));
 
        //echo "\n<br><br>".htmlentities($s_text);
        $s_text = $this->content_obj->xml2output($s_text, true, false);
        $this->log->debug("step 2: " . substr($s_text, 0, 1000));
 
        //echo "\n<br><br>".htmlentities($s_text);
        $char = $this->determineCharacteristic(false);
        $s_text = ilPCParagraphGUI::xml2outputJS($s_text);
        $this->log->debug("step 3: " . substr($s_text, 0, 1000));
 
        //echo "\n<br><br>".htmlentities($s_text);
        $ids = "###" . $this->content_obj->readHierId() . ":" . $this->content_obj->readPCId() . "###" .
            $char . "###";
        echo $ids . $s_text;
        $this->log->debug("step 4: " . substr($ids . $s_text, 0, 1000));
        exit;
    }

References exit, and xml2outputJS().

Here is the call graph for this function:

◆ executeCommand()

ilPCParagraphGUI::executeCommand ( )

execute command

Returns: mixed

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

                                    : mixed
    {
        // get next class that processes or forwards current command
        $next_class = $this->ctrl->getNextClass($this);
 
        $this->getCharacteristicsOfCurrentStyle(
            array("text_block", "heading1", "heading2", "heading3")
        );      // scorm-2004
 
        // get current command
        $cmd = $this->ctrl->getCmd();
 
        $this->log->debug("ilPCParagraphGUI: executeCommand " . $cmd);
 
        switch ($next_class) {
            default:
                $ret = $this->$cmd();
                break;
        }
 
        return $ret;
    }

References ILIAS\Repository\ctrl().

Here is the call graph for this function:

◆ insertCharacteristicTable()

ilPCParagraphGUI::insertCharacteristicTable	(	ilTemplate	$a_tpl,
		string	$a_seleted_value
	)

Insert characteristic table.

Definition at line 391 of file class.ilPCParagraphGUI.php.

     : void {
        $i = 0;
 
        $chars = $this->getCharacteristics();
 
        if ($chars[$a_seleted_value] == "" && ($a_seleted_value != "")) {
            $chars = array_merge(
                array($a_seleted_value => $a_seleted_value),
                $chars
            );
        }
 
        foreach ($chars as $char => $char_lang) {
            $a_tpl->setCurrentBlock("characteristic_cell");
            $a_tpl->setVariable(
                "CHAR_HTML",
                '<div class="ilc_text_block_' . $char . '" style="margin-top:2px; margin-bottom:2px; position:static;">' . $char_lang . "</div>"
            );
            $a_tpl->setVariable("CHAR_VALUE", $char);
            if ($char == $a_seleted_value) {
                $a_tpl->setVariable(
                    "SELECTED",
                    ' checked="checked" '
                );
            }
            $a_tpl->parseCurrentBlock();
            if ((($i + 1) % 3) == 0) {  //
                $a_tpl->touchBlock("characteristic_row");
            }
            $i++;
        }
        $a_tpl->touchBlock("characteristic_table");
    }

◆ insertHelp()

ilPCParagraphGUI::insertHelp ( ilTemplate $a_tpl )

Insert Help.

Definition at line 445 of file class.ilPCParagraphGUI.php.

                                                 : void
    {
        $lng = $this->lng;
 
        $a_tpl->setCurrentBlock("help_item");
        $a_tpl->setVariable("TXT_HELP", "<strong>" . $lng->txt("cont_syntax_help") . "</strong>");
        $a_tpl->parseCurrentBlock();
        $a_tpl->setCurrentBlock("help_item");
        $a_tpl->setVariable("TXT_HELP", "* " . $lng->txt("cont_bullet_list"));
        $a_tpl->parseCurrentBlock();
        $a_tpl->setCurrentBlock("help_item");
        $a_tpl->setVariable("TXT_HELP", "# " . $lng->txt("cont_numbered_list"));
        $a_tpl->parseCurrentBlock();
        $a_tpl->setCurrentBlock("help_item");
        $a_tpl->setVariable("TXT_HELP", "=" . $lng->txt("cont_Headline1") . "=<br />" .
            "==" . $lng->txt("cont_Headline2") . "==<br />" .
            "===" . $lng->txt("cont_Headline3") . "===");
        $a_tpl->parseCurrentBlock();
 
        if ($this->getPageConfig()->getEnableWikiLinks()) {
            $a_tpl->setCurrentBlock("help_item");
            $a_tpl->setVariable("TXT_HELP", "[[" . $lng->txt("cont_wiki_page_link") . "]]");
            $a_tpl->parseCurrentBlock();
        }
 
        $a_tpl->setCurrentBlock("help");
        $a_tpl->parseCurrentBlock();
    }

References $lng, ilTemplate\parseCurrentBlock(), ilTemplate\setCurrentBlock(), and HTML_Template_IT\setVariable().

Here is the call graph for this function:

◆ outputError()

ilPCParagraphGUI::outputError ( array $a_err )

Output error.

Definition at line 371 of file class.ilPCParagraphGUI.php.

                                             : void
    {
        $err_str = "";
        foreach ($a_err as $err) {
            $err_str .= $err[1] . "<br />";
        }
        echo $err_str;
        $this->log->debug("ilPCParagraphGUI, outputError() and exit: " . substr($err_str, 0, 100));
        exit;
    }

References exit.

◆ setStyle()

ilPCParagraphGUI::setStyle ( )

private

Definition at line 428 of file class.ilPCParagraphGUI.php.

                               : void
    {
        if ($this->pg_obj->getParentType() == "term" ||
            $this->pg_obj->getParentType() == "lm") {
            if ($this->pg_obj->getParentType() != "term") {
                $this->tpl->addCss(ilObjStyleSheet::getContentStylePath(
                    ilObjContentObject::_lookupStyleSheetId($this->pg_obj->getParentId())
                ));
            } else {
                $this->tpl->addCss(ilObjStyleSheet::getContentStylePath(0));
            }
        }
    }

References ilObjContentObject\_lookupStyleSheetId(), and ilObjStyleSheet\getContentStylePath().

Here is the call graph for this function:

◆ xml2outputJS()

static ilPCParagraphGUI::xml2outputJS ( string $s_text )

static

Prepare content for js output.

Definition at line 279 of file class.ilPCParagraphGUI.php.

                                                       : string
    {
        // lists
        $s_text = str_replace(
            array("<SimpleBulletList>", "</SimpleBulletList>"),
            array('<ul class="ilc_list_u_BulletedList">', "</ul>"),
            $s_text
        );
        while (preg_match('~<SimpleBulletList Class=\"([^\"]*)\">~i', $s_text, $found)) {
            $class = $found[1];
            $s_text = str_replace('<SimpleBulletList Class="' . $class . '">', '<ul class="ilc_list_u_' . $class . '">', $s_text);
        }
        $s_text = str_replace(
            array("<SimpleNumberedList>", "</SimpleNumberedList>"),
            array('<ol class="ilc_list_o_NumberedList">', "</ol>"),
            $s_text
        );
        while (preg_match('~<SimpleNumberedList Class=\"([^\"]*)\">~i', $s_text, $found)) {
            $class = $found[1];
            $s_text = str_replace('<SimpleNumberedList Class="' . $class . '">', '<ol class="ilc_list_o_' . $class . '">', $s_text);
        }
        $s_text = str_replace(
            array("<SimpleListItem>", "</SimpleListItem>"),
            array('<li class="ilc_list_item_StandardListItem">', "</li>"),
            $s_text
        );
        $s_text = str_replace(
            array("<SimpleListItem/>"),
            array('<li class="ilc_list_item_StandardListItem"></li>'),
            $s_text
        );
        while (preg_match('~<SimpleListItem Class=\"([^\"]*)\">~i', $s_text, $found)) {
            $class = $found[1];
            $s_text = str_replace('<SimpleListItem Class="' . $class . '">', '<li class="ilc_list_item_' . $class . '">', $s_text);
        }
 
        // spans
        foreach (ilPageContentGUI::_getCommonBBButtons() as $bb => $cl) {
            if (!in_array($bb, array("code", "tex", "fn", "xln", "sub", "sup"))) {
                $s_text = str_replace(
                    "[" . $bb . "]",
                    '<span class="ilc_text_inline_' . $cl . '">',
                    $s_text
                );
                $s_text = str_replace(
                    "[/" . $bb . "]",
                    '</span>',
                    $s_text
                );
            }
        }
 
        // marked text spans
        $ws = "[ \t\r\f\v\n]*";
        while (preg_match("~\[(marked$ws(class$ws=$ws\"([^\"])*\")$ws)\]~i", $s_text, $found)) {
            $attribs = ilPCParagraph::attribsToArray($found[2]);
            if (isset($attribs["class"])) {
                $s_text = str_replace("[" . $found[1] . "]", "<span class=\"ilc_text_inline_" . $attribs["class"] . "\">", $s_text);
            } else {
                $s_text = str_replace("[" . $found[1] . "]", "[error:marked" . $found[1] . "]", $s_text);
            }
        }
        $s_text = preg_replace('~\[\/marked\]~i', "</span>", $s_text);
 
 
        // code
        $s_text = str_replace(
            array("[code]", "[/code]"),
            array("<code>", "</code>"),
            $s_text
        );
 
        // sup
        $s_text = str_replace(
            array("[sup]", "[/sup]"),
            array('<sup class="ilc_sup_Sup">', "</sup>"),
            $s_text
        );
 
        // sub
        $s_text = str_replace(
            array("[sub]", "[/sub]"),
            array('<sub class="ilc_sub_Sub">', "</sub>"),
            $s_text
        );
 
        return $s_text;
    }

References ilPageContentGUI\_getCommonBBButtons(), and ilPCParagraph\attribsToArray().

Referenced by editJS(), ilPCDataTableGUI\getCellContent(), ilPCParagraph\getModel(), ilPCTable\getModel(), and ilPCParagraphModelProvider\getModels().

Here is the call graph for this function:

Here is the caller graph for this function:

Field Documentation

◆ $user

ilObjUser ilPCParagraphGUI::$user

protected

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

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

components/ILIAS/COPage/PC/Paragraph/class.ilPCParagraphGUI.php

Public Member Functions

Static Public Member Functions

Protected Attributes

Private Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ _getCharacteristics()

◆ _getStandardCharacteristics()

◆ _getStandardTextCharacteristics()

◆ cancel()

◆ determineCharacteristic()

◆ editJS()

◆ executeCommand()

◆ insertCharacteristicTable()

◆ insertHelp()

◆ outputError()

◆ setStyle()

◆ xml2outputJS()

Field Documentation

◆ $user