ilPCPlaceHolder Class Reference

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

Inheritance diagram for ilPCPlaceHolder:

Collaboration diagram for ilPCPlaceHolder:

Public Member Functions
	init ()
	setNode (php4DOMElement $a_node)
	create (ilPageObject $a_pg_obj, string $a_hier_id, string $a_pc_id="")
	setContentClass (string $a_class)
	getContentClass ()
	setHeight (string $a_height)
	getHeight ()
	getClass ()
	modifyPageContentPostXsl (string $a_output, string $a_mode, bool $a_abstract_only=false)
	getModel ()
	getCssFiles (string $a_mode)
Public Member Functions inherited from ilPageContent
	__construct (ilPageObject $a_pg_obj)
	setPage (ilPageObject $a_val)
	getPage ()
	init ()
	Init object. More...
	getType ()
	setNode (php4DOMElement $a_node)
	Set xml node of page content. More...
	getNode ()
	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...
	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	handleCopiedContent (DOMDocument $a_domdoc, bool $a_self_ass=true, bool $a_clone_mobs=false, int $new_parent_id=0, int $obj_copy_id=0)
Static Public Member Functions inherited from ilPageContent
static	incEdId (string $ed_id)
	Increases an hierarchical editing id at lowest level (last number) More...
static	decEdId (string $ed_id)
	Decreases an hierarchical editing id at lowest level (last number) More...
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...

Data Fields
php4DOMElement	$q_node
string	$content_class
string	$height
Data Fields inherited from ilPageContent
string	$hier_id = ""
php4DOMElement	$node = null
php4DOMDocument	$dom = null
string	$page_lang = ""

Protected Attributes
ilCtrl	$ctrl
ilLanguage	$lng
Protected Attributes inherited from ilPageContent
string	$pcid
string	$type = ""
ilPageObject	$pg_obj
string	$file_download_link
string	$fullscreen_link
string	$sourcecode_download_script
ilLogger	$log
string	$profile_back_url = ""

Additional Inherited Members
Protected Member Functions inherited from ilPageContent
	setType (string $a_type)
	Set Type. More...

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 ilPlaceHolder

List content object (see ILIAS DTD)

Definition at line 24 of file class.ilPCPlaceHolder.php.

Member Function Documentation

create()

ilPCPlaceHolder::create	(	ilPageObject	$a_pg_obj,
		string	$a_hier_id,
		string	$a_pc_id = ""
	)

Definition at line 47 of file class.ilPCPlaceHolder.php.

References ilPageContent\createPageContentNode(), IL_INSERT_AFTER, and ilPageObject\insertContent().

     : void {
        $this->createPageContentNode();
        $a_pg_obj->insertContent($this, $a_hier_id, IL_INSERT_AFTER, $a_pc_id);
        $this->q_node = $this->dom->create_element("PlaceHolder");
        $this->q_node = $this->node->append_child($this->q_node);
    }

Here is the call graph for this function:

getClass()

ilPCPlaceHolder::getClass

(

)

Definition at line 88 of file class.ilPCPlaceHolder.php.

                              : string
    {
        return "";
    }

getContentClass()

ilPCPlaceHolder::getContentClass

(

)

Definition at line 65 of file class.ilPCPlaceHolder.php.

Referenced by getModel().

                                     : string
    {
        if (is_object($this->q_node)) {
            return $this->q_node->get_attribute("ContentClass");
        }
        return "";
    }

Here is the caller graph for this function:

getCssFiles()

ilPCPlaceHolder::getCssFiles

(

string

$a_mode

)

Definition at line 165 of file class.ilPCPlaceHolder.php.

References ilObjStyleSheet\getPlaceHolderStylePath().

                                               : array
    {
        return [ilObjStyleSheet::getPlaceHolderStylePath()];
    }

Here is the call graph for this function:

getHeight()

ilPCPlaceHolder::getHeight

(

)

Definition at line 80 of file class.ilPCPlaceHolder.php.

                               : string
    {
        if (is_object($this->q_node)) {
            return $this->q_node->get_attribute("Height");
        }
        return "";
    }

getLangVars()

static ilPCPlaceHolder::getLangVars ( )

static

Definition at line 93 of file class.ilPCPlaceHolder.php.

                                        : array
    {
        return array("question_placeh","media_placeh","text_placeh",
            "ed_insert_plach","question_placehl","media_placehl","text_placehl",
            "verification_placeh", "verification_placehl");
    }

getModel()

ilPCPlaceHolder::getModel

(

)

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

References getContentClass().

                              : ?stdClass
    {
        $model = new \stdClass();
        $model->contentClass = $this->getContentClass();
        return $model;
    }

Here is the call graph for this function:

handleCopiedContent()

static ilPCPlaceHolder::handleCopiedContent ( DOMDocument  $a_domdoc, bool  $a_self_ass = true, bool  $a_clone_mobs = false, int  $new_parent_id = 0, int  $obj_copy_id = 0  )

static

Definition at line 170 of file class.ilPCPlaceHolder.php.

References ilPageContent\$node, and $path.

     : void {
        // remove question placholders
        if (!$a_self_ass) {
            // Get question IDs
            $path = "//PlaceHolder[@ContentClass = 'Question']";
            $xpath = new DOMXPath($a_domdoc);
            $nodes = $xpath->query($path);

            foreach ($nodes as $node) {
                $parent = $node->parentNode;
                $parent->parentNode->removeChild($parent);
            }
        }
    }

init()

ilPCPlaceHolder::init

(

)

Definition at line 32 of file class.ilPCPlaceHolder.php.

References $DIC, ILIAS\Repository\ctrl(), ILIAS\Repository\lng(), and ilPageContent\setType().

                          : void
    {
        global $DIC;

        $this->ctrl = $DIC->ctrl();
        $this->lng = $DIC->language();
        $this->setType("plach");
    }

Here is the call graph for this function:

modifyPageContentPostXsl()

ilPCPlaceHolder::modifyPageContentPostXsl	(	string	$a_output,
		string	$a_mode,
		bool	$a_abstract_only = false
	)

Definition at line 100 of file class.ilPCPlaceHolder.php.

References $i, $lng, $param, and ilLanguage\txt().

     : string {
        $lng = $this->lng;

        //
        // Note: this standard output is "overwritten", e.g. by ilPortfolioPageGUI::postOutputProcessing
        //

        $end = 0;
        $start = strpos($a_output, "{{{{{PlaceHolder#");
        if (is_int($start)) {
            $end = strpos($a_output, "}}}}}", $start);
        }
        $i = 1;
        while ($end > 0) {
            $param = substr($a_output, $start + 17, $end - $start - 17);
            $param = explode("#", $param);

            $html = $param[2];
            switch ($param[2]) {
                case "Text":
                    $html = $lng->txt("cont_text_placeh");
                    break;

                case "Media":
                    $html = $lng->txt("cont_media_placeh");
                    break;

                case "Question":
                    $html = $lng->txt("cont_question_placeh");
                    break;

                case "Verification":
                    $html = $lng->txt("cont_verification_placeh");
                    break;
            }

            $h2 = substr($a_output, 0, $start) .
                $html .
                substr($a_output, $end + 5);
            $a_output = $h2;
            $i++;

            $start = strpos($a_output, "{{{{{PlaceHolder#", $start + 5);
            $end = 0;
            if (is_int($start)) {
                $end = strpos($a_output, "}}}}}", $start);
            }
        }
        return $a_output;
    }

Here is the call graph for this function:

setContentClass()

ilPCPlaceHolder::setContentClass

(

string

$a_class

)

Definition at line 58 of file class.ilPCPlaceHolder.php.

                                                    : void
    {
        if (is_object($this->q_node)) {
            $this->q_node->set_attribute("ContentClass", $a_class);
        }
    }

setHeight()

ilPCPlaceHolder::setHeight

(

string

$a_height

)

Definition at line 73 of file class.ilPCPlaceHolder.php.

                                               : void
    {
        if (is_object($this->q_node)) {
            $this->q_node->set_attribute("Height", $a_height);
        }
    }

setNode()

ilPCPlaceHolder::setNode

(

php4DOMElement

$a_node

)

Definition at line 41 of file class.ilPCPlaceHolder.php.

References php4DOMNode\first_child().

                                                   : void
    {
        parent::setNode($a_node);               // this is the PageContent node
        $this->q_node = $a_node->first_child();         //... and this the PlaceHolder
    }

Here is the call graph for this function:

Field Documentation

$content_class

string ilPCPlaceHolder::$content_class

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

$ctrl

ilCtrl ilPCPlaceHolder::$ctrl

protected

Definition at line 26 of file class.ilPCPlaceHolder.php.

$height

string ilPCPlaceHolder::$height

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

$lng

ilLanguage ilPCPlaceHolder::$lng

protected

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

Referenced by modifyPageContentPostXsl().

$q_node

php4DOMElement ilPCPlaceHolder::$q_node

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

---

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

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