ilPCSourceCode Class Reference

Class ilPCSourceCode. More...

Inheritance diagram for ilPCSourceCode:

Collaboration diagram for ilPCSourceCode:

Public Member Functions
	init ()
	Init page content component. More...
	modifyPageContentPostXsl ($a_output, $outputmode="presentation")
	Modify page content after xsl. More...
	highlightText ($a_text, $proglang, $autoindent="")
	Highligths Text with given ProgLang. More...
	hasHighlighter ($hfile_ext)
Public Member Functions inherited from ilPCParagraph
	init ()
	Init page content component. More...
	setNode ($a_node)
	Set Page Content Node. More...
	createAtNode (&$node)
	Create new page content (incl. More...
	createBeforeNode (&$node)
	Create new page content (incl. More...
	createAfter ($node)
	Create paragraph node (incl. More...
	create (&$a_pg_obj, $a_hier_id, $a_pc_id="")
	Create paragraph node (incl. More...
	setText ($a_text, $a_auto_split=false)
	Set (xml) content of text paragraph. More...
	getText ($a_short_mode=false)
	Get (xml) content of paragraph. More...
	getParagraphSequenceContent ($a_pg_obj)
	Get paragraph sequenc of current paragraph. More...
	setCharacteristic ($a_char)
	Set Characteristic of paragraph. More...
	getCharacteristic ()
	Get characteristic of paragraph. More...
	setSubCharacteristic ($a_char)
	set attribute subcharacteristic More...
	getAutoIndent ()
	Get AutoIndent (Code Paragraphs) More...
	setAutoIndent ($a_char)
	getSubCharacteristic ()
	get attribute subcharacteristic More...
	setDownloadTitle ($a_char)
	set attribute download title More...
	getDownloadTitle ()
	get attribute download title More...
	setShowLineNumbers ($a_char)
	set attribute showlinenumbers More...
	getShowLineNumbers ()
	get attribute showlinenumbers More...
	setLanguage ($a_lang)
	set language More...
	getLanguage ()
	get language More...
	input2xml ($a_text, $a_wysiwyg=0, $a_handle_lists=true)
	autoSplit ($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 ($a_str)
	Remove preceding More...
	removeTrailingBr ($a_str)
	Remove trailing More...
	getType ()
	Need to override getType from ilPageContent to distinguish between Pararagraph and Source. More...
	saveJS ($a_pg_obj, $a_content, $a_char, $a_pc_id, $a_insert_at="")
	Save input coming from ajax. More...
	getLastSavedPCId ($a_pg_obj, $a_as_ajax_str=false)
	Get last inserted pc ids. More...
	updatePage ($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 ($a_glos)
	Auto link glossaries. More...
	getJavascriptFiles ($a_mode)
	Get Javascript files. More...
	getOnloadCode ($a_mode)
	Get onload code. More...
Public Member Functions inherited from ilPageContent
	__construct ($a_pg_obj)
	Constructor. More...
	setPage ($a_val)
	Set page. More...
	getPage ()
	Get page. More...
	init ()
	Init object. More...
	getType ()
	Get type of page content. More...
	setNode ($a_node)
	Set xml node of page content. More...
&	getNode ()
	Get xml node of page content. More...
	getJavascriptFiles ($a_mode)
	Get Javascript files. More...
	getCssFiles ($a_mode)
	Get css files. More...
	getOnloadCode ($a_mode)
	Get on load code. More...
	setHierId ($a_hier_id)
	Set hierarchical ID in xml structure. More...
	getHierId ()
	Get hierarchical id. More...
	lookupHierId ()
	Get hierarchical id from dom. More...
	readHierId ()
	Read PC Id. More...
	setPcId ($a_pcid)
	Set PC Id. More...
	getPCId ()
	Get PC Id. More...
	setFileDownloadLink ($a_download_link)
	Set file download link. More...
	getFileDownloadLink ()
	Get file download link. More...
	setFullscreenLink ($a_fullscreen_link)
	Set fullscreen link. More...
	getFullscreenLink ()
	Get fullscreen link. More...
	setSourcecodeDownloadScript ($script_name)
	Set sourcecode download script. More...
	getSourcecodeDownloadScript ()
	Get sourcecode download script. More...
	readPCId ()
	Read PC Id. More...
	writePCId ($a_pc_id)
	Write pc id. More...
	setEnabled ($value)
	Set Enabled value for page content component. More...
	enable ()
	Enable page content. More...
	disable ()
	Disable page content. More...
	isEnabled ()
	Check whether page content is enabled. More...
	createPageContentNode ($a_set_this_node=true)
	Create page content node (always use this method first when adding a new element) More...
	modifyPageContentPostXsl ($a_output, $a_mode)
	Modify page content after xsl. More...

Static Public Member Functions
static	getLangVars ()
	Get lang vars needed for editing. More...
Static Public Member Functions inherited from ilPCParagraph
static	_input2xml ($a_text, $a_lang, $a_wysiwyg=0, $a_handle_lists=true)
	converts user input to xml More...
static	intLinks2xml ($a_text)
	internal links to xml More...
static	input2xmlReplaceLists ($a_text)
	Converts xml from DB to output in edit textarea. More...
static	xml2outputReplaceLists ($a_text)
	Replaces with *. More...
static	segmentString ($a_haystack, $a_needles)
	Segments a string into an array at each position of a substring. More...
static	xml2output ($a_text, $a_wysiwyg=false, $a_replace_lists=true, $unmask=true)
	Converts xml from DB to output in edit textarea. More...
static	handleAjaxContent ($a_content)
	Handle ajax content. More...
static	handleAjaxContentPost ($text)
	Post input2xml handling of ajax content. More...
static	autoLinkGlossariesPage ($a_page, $a_terms)
	Auto link glossary of whole page. More...
static	afterPageUpdate ($a_page, DOMDocument $a_domdoc, $a_xml, $a_creation)
	After page has been updated (or created) More...
static	beforePageDelete ($a_page)
	Before page is being deleted. More...
static	afterPageHistoryEntry ($a_page, DOMDocument $a_old_domdoc, $a_old_xml, $a_old_nr)
	After page history entry has been created. More...
static	saveAnchors ($a_page, $a_domdoc)
	Save anchors. More...
static	_deleteAnchors ($a_parent_type, $a_page_id, $a_page_lang)
	Delete anchors of a page. More...
static	_saveAnchor ($a_parent_type, $a_page_id, $a_page_lang, $a_anchor_name)
	Save an anchor. More...
static	_readAnchors ($a_parent_type, $a_page_id, $a_page_lang="-")
	Read anchors of a page. More...
static	saveMetaKeywords ($a_page, $a_domdoc)
	save all keywords More...
Static Public Member Functions inherited from ilPageContent
static	incEdId ($ed_id)
	Increases an hierarchical editing id at lowest level (last number) More...
static	decEdId ($ed_id)
	Decreases an hierarchical editing id at lowest level (last number) More...
static	haveSameContainer ($ed_id1, $ed_id2)
	Check, if two ids are in same container. More...
static	sortHierIds ($a_array)
	Sort an array of Hier IDS in ascending order. More...
static	isGreaterHierId ($a, $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, $a_self_ass=true, $a_clone_mobs=false)
	Handle copied content. More...
static	afterPageUpdate ($a_page, DOMDocument $a_domdoc, $a_xml, $a_creation)
	After page has been updated (or created) More...
static	beforePageDelete ($a_page)
	Before page is being deleted. More...
static	afterPageHistoryEntry ($a_page, DOMDocument $a_old_domdoc, $a_old_xml, $a_old_nr)
	After page history entry has been created. More...

Additional Inherited Members
Data Fields inherited from ilPCParagraph
	$dom
	$par_node
Data Fields inherited from ilPageContent
	$hier_id
	$node
	$dom
	$page_lang
Protected Member Functions inherited from ilPageContent
	setType ($a_type)
	Set Type. More...
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 ($a_text, $a_bb, $a_tag)
	Replace bb code. More...
static	linkTermsInDom ($a_dom, $a_terms, $a_par_node=null)
	Link terms in a dom page object in bb style. More...
Protected Attributes inherited from ilPCParagraph
	$user
Protected Attributes inherited from ilPageContent
	$file_download_link
	$fullscreen_link
	$sourcecode_download_script
	$log
Static Protected Attributes inherited from ilPCParagraph
static	$bb_tags

Detailed Description

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

Version

$Id$

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

Member Function Documentation

getLangVars()

static ilPCSourceCode::getLangVars ( )

static

Get lang vars needed for editing.

Returns

array array of lang var keys

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

References array.

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

hasHighlighter()

ilPCSourceCode::hasHighlighter

(

$hfile_ext

)

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

    {
        return file_exists("Services/COPage/syntax_highlight/php/HFile/HFile_" . $hfile_ext . ".php");
    }

highlightText()

ilPCSourceCode::highlightText	(		$a_text,
			$proglang,
			$autoindent = ""
	)

Highligths Text with given ProgLang.

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

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

Referenced by modifyPageContentPostXsl().

    {
        include_once("./Services/UIComponent/SyntaxHighlighter/classes/class.ilSyntaxHighlighter.php");
        $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:

init()

ilPCSourceCode::init

(

)

Init page content component.

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

References ilPageContent\setType().

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

Here is the call graph for this function:

modifyPageContentPostXsl()

ilPCSourceCode::modifyPageContentPostXsl	(		$a_output,
			$outputmode = "presentation"
	)

Modify page content after xsl.

Parameters

string

$a_output

Returns

string

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

References ilPCParagraph\$dom, $i, $n, $path, $res, $rows, ilPageContent\getPage(), highlightText(), xpath_eval(), and xpath_new_context().

    {
        $dom = $this->getPage()->getDom();

        $xpc = xpath_new_context($dom);
        $path = "//Paragraph"; //"[@Characteristic = 'Code']";
        $res = &xpath_eval($xpc, $path);
        for ($i = 0; $i < count($res->nodeset); $i++) {
            $context_node = $res->nodeset[$i];
            $char = $context_node->get_attribute('Characteristic');

            if ($char != "Code") {
                continue;
            }

            $n = $context_node->parent_node();
            $char = $context_node->get_attribute('Characteristic');
            $subchar = $context_node->get_attribute('SubCharacteristic');
            $showlinenumbers = $context_node->get_attribute('ShowLineNumbers');
            $downloadtitle = $context_node->get_attribute('DownloadTitle');
            $autoindent = $context_node->get_attribute('AutoIndent');

            $content = "";

            // get XML Content
            $childs = $context_node->child_nodes();

            for ($j=0; $j<count($childs); $j++) {
                $content .= $dom->dump_node($childs[$j]);
            }

            while ($context_node->has_child_nodes()) {
                $node_del = $context_node->first_child();
                $context_node->remove_child($node_del);
            }

            $content = str_replace("<br />", "<br/>", utf8_decode($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, $autoindent));

            $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\">";

                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\">" . $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);

            //echo htmlentities($newcontent);
            $a_output = str_replace("[[[[[Code;" . ($i + 1) . "]]]]]", $newcontent, $a_output);

            if ($outputmode != "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);
            }
        }

        return $a_output;
    }

Here is the call graph for this function:

---

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

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