This file is part of ILIAS, a powerful learning management system published by ILIAS open source e-Learning e.V. More...

Inheritance diagram for ilPCSourceCode:

Collaboration diagram for ilPCSourceCode:

Public Member Functions
	init ()

	modifyPageContentPostXsl (string $a_output, string $a_mode="presentation", bool $a_abstract_only=false)

	highlightText (string $a_text, string $proglang)
	Highlights Text with given ProgLang. More...

	importFile (string $tmpname)

Public Member Functions inherited from ilPCParagraph
	init ()

	create (ilPageObject $a_pg_obj, string $a_hier_id, string $a_pc_id="", bool $from_placeholder=false)
	Create paragraph node (incl. More...

	setText (string $a_text, bool $a_auto_split=false)
	Set (xml) content of text paragraph. More...

	getText (bool $a_short_mode=false)
	Get (xml) content of paragraph. More...

	setCharacteristic (string $a_char)

	getCharacteristic ()

	setSubCharacteristic (string $a_char)

	getAutoIndent ()

	setAutoIndent (string $ind)

	getSubCharacteristic ()

	setDownloadTitle (string $title)

	getDownloadTitle ()

	setShowLineNumbers (string $a_char)

	getShowLineNumbers ()

	setLanguage (string $a_lang)

	getLanguage ()

	input2xml (string $a_text, bool $a_wysiwyg=false, bool $a_handle_lists=true)

	autoSplit (string $a_text)
	This function splits a paragraph text that has been already processed with input2xml at each header position =header1=, ==header2== or ===header3=== and returns an array that contains the single chunks. More...

	handleNextBr (string $a_str)
	Remove preceding More...

	removeTrailingBr (string $a_str)
	Remove trailing More...

	getType ()
	Need to override getType from ilPageContent to distinguish between Pararagraph and Source. More...

	saveJS (ilPageObject $a_pg_obj, string $a_content, string $a_char, string $a_pc_id, string $a_insert_at="", bool $from_placeholder=false)
	Save input coming from ajax. More...

	getLastSavedPCId (ilPageObject $a_pg_obj, bool $a_as_ajax_str=false)
	Get last inserted pc ids. More...

	updatePage (ilPageObject $a_page)
	Update page object (it would be better to have this centralized and to change the constructors and pass the page object instead the dom object) More...

	autoLinkGlossaries (array $a_glos)

	getJavascriptFiles (string $a_mode)

	getOnloadCode (string $a_mode)

	getModel ()

	insert (\ilPageObject $page, string $a_content, string $a_char, string $a_pc_id, string $a_insert_at="", string $a_new_pc_id="")
	Save input coming from ajax. More...

Public Member Functions inherited from ilPageContent
	__construct (ilPageObject $a_pg_obj, ?PageManagerInterface $page_manager=null, ?ObjectAdapterInterface $object_adapter=null)

	setPage (ilPageObject $a_val)

	getPage ()

	init ()
	Init object. More...

	getType ()

	getDomNode ()

	getDomDoc ()

	setDomNode (DOMNode $node)

	getChildNode ()

	getJavascriptFiles (string $a_mode)

	getCssFiles (string $a_mode)

	getOnloadCode (string $a_mode)

	setHierId (string $a_hier_id)

	getHierId ()

	lookupHierId ()

	readHierId ()

	setPcId (string $a_pcid)

	getPCId ()

	setFileDownloadLink (string $a_download_link)

	getFileDownloadLink ()

	setProfileBackUrl (string $url)

	getProfileBackUrl ()

	setFullscreenLink (string $a_fullscreen_link)

	getFullscreenLink ()

	setSourcecodeDownloadScript (string $script_name)

	getSourcecodeDownloadScript ()

	readPCId ()

	writePCId (string $a_pc_id)

	setEnabled (string $value)
	Set Enabled value for page content component. More...

	enable ()

	disable ()

	isEnabled ()

	createPageContentNode (bool $a_set_this_node=true)
	Create page content node (always use this method first when adding a new element) More...

	getNewPageContentNode ()

	modifyPageContentPostXsl (string $a_output, string $a_mode, bool $a_abstract_only=false)
	Modify page content after xsl. More...

	getModel ()
	Get model as needed for the front-end editor. More...

Static Public Member Functions
static	getLangVars ()

Static Public Member Functions inherited from ilPCParagraph
static	attribsToArray (string $a_str)
	converts a string of format var1 = "val1" var2 = "val2" ... More...

static	_input2xml (string $a_text, string $a_lang, bool $a_wysiwyg=false, bool $a_handle_lists=true)
	Converts user input to xml User input comes as bb code information, e.g. More...

static	intLinks2xml (string $a_text)
	internal links to xml More...

static	input2xmlReplaceLists (string $a_text)
	Converts xml from DB to output in edit textarea. More...

static	xml2outputReplaceLists (string $a_text)
	Replaces with *. More...

static	segmentString (string $a_haystack, array $a_needles)
	Segments a string into an array at each position of a substring. More...

static	xml2output (string $a_text, bool $a_wysiwyg=false, bool $a_replace_lists=true, bool $unmask=true)
	Converts xml from DB to output in edit textarea. More...

static	handleAjaxContent (string $a_content)
	Handle ajax content. More...

static	handleAjaxContentPost (string $text)
	Post input2xml handling of ajax content. More...

static	autoLinkGlossariesPage (ilPageObject $a_page, array $a_terms)
	Auto link glossary of whole page. More...

static	afterPageUpdate (ilPageObject $a_page, DOMDocument $a_domdoc, string $a_xml, bool $a_creation)
	After page has been updated (or created) More...

static	beforePageDelete (ilPageObject $a_page)
	Before page is being deleted. More...

static	afterPageHistoryEntry (ilPageObject $a_page, DOMDocument $a_old_domdoc, string $a_old_xml, int $a_old_nr)
	After page history entry has been created. More...

static	saveAnchors (ilPageObject $a_page, DOMDocument $a_domdoc)
	Save anchors. More...

static	_deleteAnchors (string $a_parent_type, int $a_page_id, string $a_page_lang)
	Delete anchors of a page. More...

static	_saveAnchor (string $a_parent_type, int $a_page_id, string $a_page_lang, string $a_anchor_name)
	Save an anchor. More...

static	_readAnchors (string $a_parent_type, int $a_page_id, string $a_page_lang="-")
	Read anchors of a page. More...

static	saveMetaKeywords (ilPageObject $a_page, DOMDocument $a_domdoc)
	save all keywords More...

Static Public Member Functions inherited from ilPageContent
static	sortHierIds (array $a_array)
	Sort an array of Hier IDS in ascending order. More...

static	isGreaterHierId (string $a, string $b)
	Check whether Hier ID $a is greater than Hier ID $b. More...

static	getLangVars ()
	Get lang vars needed for editing. More...

static	handleCopiedContent (DOMDocument $a_domdoc, bool $a_self_ass=true, bool $a_clone_mobs=false, int $new_parent_id=0, int $obj_copy_id=0)
	Handle copied content. More...

static	afterPageUpdate (ilPageObject $a_page, DOMDocument $a_domdoc, string $a_xml, bool $a_creation)
	After page has been updated (or created) More...

static	beforePageDelete (ilPageObject $a_page)
	Before page is being deleted. More...

static	afterRepositoryCopy (ilPageObject $page, array $mapping, int $source_ref_id)
	After repository (container) copy action. More...

static	afterPageHistoryEntry (ilPageObject $a_page, DOMDocument $a_old_domdoc, string $a_old_xml, int $a_old_nr)
	After page history entry has been created. More...

static	deleteHistoryLowerEqualThan (string $parent_type, int $page_id, string $lang, int $delete_lower_than_nr)
	Overwrite in derived classes, if old history entries are being deleted. More...

Additional Inherited Members
Data Fields inherited from ilPageContent
string	$hier_id = ""

DOMNode	$dom_node = null

string	$page_lang = ""

Protected Member Functions inherited from ilPCParagraph
	createAfter (DomNode $node)
	Create paragraph node (incl. More...

	checkTextArray (array $text)
	Check text array. More...

Protected Member Functions inherited from ilPageContent
	getPageManager ()

	setType (string $a_type)
	Set Type. More...

	hasNode ()

	createInitialChildNode (string $hier_id, string $pc_id, string $child, array $child_attributes=[])

Static Protected Member Functions inherited from ilPCParagraph
static	getBBMap ()
	Get bb to xml tag map. More...

static	getXMLTagMap ()
	Get tag to bb map. More...

static	replaceBBCode (string $a_text, string $a_bb, string $a_tag)

static	isValidTagContent (string $content)

static	replaceBBTagByMatching (string $start_tag, string $end_tag, string $xml_tag_name, string $text, array $attribs)
	Transforms [iln...]...[] to <IntLink...>...</IntLink>, if content is valid, otherwise it removes the bb tags. More...

static	linkTermsInDom (DOMDocument $a_dom, array $a_terms, DOMNode $a_par_node=null)
	Link terms in a dom page object in bb style. More...

Protected Attributes inherited from ilPCParagraph
string	$inserted_pc_id

ilObjUser	$user

ilLanguage	$lng

Protected Attributes inherited from ilPageContent
DOMDocument	$dom_doc

ILIAS COPage InternalDomainService	$domain

string	$pcid

string	$type = ""

ilPageObject	$pg_obj

string	$file_download_link = ''

string	$fullscreen_link = ''

string	$sourcecode_download_script = ''

ilLogger	$log

string	$profile_back_url = ""

ILIAS COPage Dom DomUtil	$dom_util

PageManagerInterface	$page_manager = null

ObjectAdapterInterface	$object = null

Static Protected Attributes inherited from ilPCParagraph
static array	$bb_tags

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 ilPCSourceCode

Paragraph of ilPageObject

Author: Roland Küstermann; Alex Killing alex..nosp@m.kill.nosp@m.ing@g.nosp@m.mx.d.nosp@m.e

Definition at line 27 of file class.ilPCSourceCode.php.

Member Function Documentation

◆ getLangVars()

static ilPCSourceCode::getLangVars ( )

static

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

                                         : array
     {
         return array("ed_insert_code", "pc_code");
     }

◆ highlightText()

ilPCSourceCode::highlightText	(	string	$a_text,
		string	$proglang
	)

Highlights Text with given ProgLang.

Definition at line 156 of file class.ilPCSourceCode.php.

References ilSyntaxHighlighter\getInstance(), ilSyntaxHighlighter\getNewLanguageId(), and ilSyntaxHighlighter\isSupported().

Referenced by modifyPageContentPostXsl().

      : string {
         $proglang = ilSyntaxHighlighter::getNewLanguageId($proglang);
         if (ilSyntaxHighlighter::isSupported($proglang)) {
             $highl = ilSyntaxHighlighter::getInstance($proglang);
             $a_text = $highl->highlight($a_text);
         }
         return $a_text;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ importFile()

ilPCSourceCode::importFile ( string $tmpname )

Definition at line 168 of file class.ilPCSourceCode.php.

References ilPCParagraph\input2xml(), and ilPCParagraph\setText().

                                                : void
     {
         if ($tmpname !== "") {
             $tmpfs = $this->domain->filesystem()->temp();
             $this->setText(
                 $this->input2xml($tmpfs->read($tmpname), 0, false)
             );
             $tmpfs->delete($tmpname);
         }
     }

Here is the call graph for this function:

◆ init()

ilPCSourceCode::init ( )

Definition at line 29 of file class.ilPCSourceCode.php.

References ilPageContent\setType().

                           : void
     {
         $this->setType("src");
     }

Here is the call graph for this function:

◆ modifyPageContentPostXsl()

ilPCSourceCode::modifyPageContentPostXsl	(	string	$a_output,
		string	$a_mode = `"presentation"`,
		bool	$a_abstract_only = `false`
	)

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

References ILIAS\Survey\Mode\getId(), ilPageContent\getPage(), and highlightText().

      : string {
         $nodes = $this->dom_util->path($this->dom_doc, "//Paragraph");
         $i = 0;
         foreach ($nodes as $context_node) {
             $char = $context_node->getAttribute('Characteristic');
 
             if ($char !== "Code") {
                 $i++;
                 continue;
             }
 
             $n = $context_node->parentNode;
             $char = $context_node->getAttribute('Characteristic');
             $subchar = $context_node->getAttribute('SubCharacteristic');
             $showlinenumbers = $context_node->getAttribute('ShowLineNumbers');
             $downloadtitle = $context_node->getAttribute('DownloadTitle');
             $autoindent = $context_node->getAttribute('AutoIndent');
 
             // get XML Content
             $content = "";
             foreach ($context_node->childNodes as $child) {
                 $content .= $this->dom_util->dump($child);
             }
 
             while ($context_node->firstChild) {
                 $node_del = $context_node->firstChild;
                 $node_del->parentNode->removeChild($node_del);
             }
 
             //$content = str_replace("<br />", "<br/>", utf8_decode($content));
             $content = str_replace("<br />", "<br/>", $content);
             $content = str_replace("<br/>", "\n", $content);
             $rownums = count(explode("\n", $content));
 
             // see #23028
             //$plain_content = html_entity_decode($content);
             $plain_content = $content;
 
             $plain_content = preg_replace_callback(
                 "/\&#x([1-9a-f]{2});?/is",
                 function ($hit) {
                     return chr(base_convert($hit[1], 16, 10));
                 },
                 $plain_content
             );
             $plain_content = preg_replace_callback(
                 "/\&#(\d+);?/is",
                 function ($hit) {
                     return chr($hit[1]);
                 },
                 $plain_content
             );
             //$content = utf8_encode($this->highlightText($plain_content, $subchar));
             $content = $this->highlightText($plain_content, $subchar);
 
             $content = str_replace("&amp;lt;", "&lt;", $content);
             $content = str_replace("&amp;gt;", "&gt;", $content);
             //                  $content = str_replace("&", "&amp;", $content);
             //var_dump($content);
             $rows = "<tr valign=\"top\">";
             $rownumbers = "";
             $linenumbers = "";
 
             //if we have to show line numbers
             if (strcmp($showlinenumbers, "y") == 0) {
                 $linenumbers = "<td nowrap=\"nowrap\" class=\"ilc_LineNumbers\" >";
                 $linenumbers .= "<pre class=\"ilc_Code ilc_code_block_Code\">";
 
                 for ($j = 0; $j < $rownums; $j++) {
                     $indentno = strlen($rownums) - strlen($j + 1) + 2;
                     $rownumeration = ($j + 1);
                     $linenumbers .= "<span class=\"ilc_LineNumber\">$rownumeration</span>";
                     if ($j < $rownums - 1) {
                         $linenumbers .= "\n";
                     }
                 }
                 $linenumbers .= "</pre>";
                 $linenumbers .= "</td>";
             }
 
             $rows .= $linenumbers . "<td class=\"ilc_Sourcecode\"><pre class=\"ilc_Code ilc_code_block_Code\">" . $content . "</pre></td>";
             $rows .= "</tr>";
 
             // fix for ie explorer which is not able to produce empty line feeds with <br /><br />;
             // workaround: add a space after each br.
             $newcontent = str_replace("\n", "<br/>", $rows);
             // fix for IE
             $newcontent = str_replace("<br/><br/>", "<br/> <br/>", $newcontent);
             // falls drei hintereinander...
             $newcontent = str_replace("<br/><br/>", "<br/> <br/>", $newcontent);
 
             // workaround for preventing template engine
             // from hiding paragraph text that is enclosed
             // in curly brackets (e.g. "{a}", see ilLMEditorGUI::executeCommand())
             $newcontent = str_replace("{", "&#123;", $newcontent);
             $newcontent = str_replace("}", "&#125;", $newcontent);
 
             $a_output = str_replace("[[[[[Code;" . ($i + 1) . "]]]]]", $newcontent, $a_output);
 
             if ($a_mode != "presentation" && is_object($this->getPage()->getOfflineHandler())
                 && trim($downloadtitle) != "") {
                 // call code handler for offline versions
                 $this->getPage()->getOfflineHandler()->handleCodeParagraph($this->getPage()->getId(), $i + 1, $downloadtitle, $plain_content);
             }
             $i++;
         }
 
         return $a_output;
     }

Here is the call graph for this function:

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

Services/COPage/PC/SourceCode/class.ilPCSourceCode.php

Public Member Functions

Static Public Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ getLangVars()

◆ highlightText()

◆ importFile()

◆ init()

◆ modifyPageContentPostXsl()