ilPCSection 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 ilPCSection:

Collaboration diagram for ilPCSection:

Public Member Functions
	init ()
	Init object. More...
	setNode (php4DOMElement $a_node)
	Set xml node of page content. More...
	create (ilPageObject $a_pg_obj, string $a_hier_id, string $a_pc_id="")
	setCharacteristic (string $a_char)
	getCharacteristic ()
	modifyPageContentPostXsl (string $a_output, string $a_mode, bool $a_abstract_only=false)
	setActiveFrom (int $a_unix_ts)
	getActiveFrom ()
	Get activation from. More...
	setActiveTo (int $a_unix_ts)
	Set activation to. More...
	getActiveTo ()
	getAttribute (string $a_attr)
	setPermission (string $a_val)
	Set permission. More...
	getPermission ()
	setPermissionRefId (int $a_ref_id)
	getPermissionRefId ()
	setNoLink ()
	Set no link. More...
	setExtLink (string $a_href)
	Set link of area to an external one. More...
	setIntLink (string $a_type, string $a_target, string $a_target_frame)
	Set link of area to an internal one. More...
	getLink ()
	handleAccess (string $a_html, string $a_mode)
	insertTimings (string $a_html)
	Insert timings (in edit mode) More...
	getProtected ()
	setProtected (bool $val)
	getModel ()
	Get model as needed for the front-end editor. More...
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 ()
	Get lang vars needed for editing. More...
static	afterPageUpdate (ilPageObject $a_page, DOMDocument $a_domdoc, string $a_xml, bool $a_creation)
	After page has been updated (or created) More...
static	saveTimings (ilPageObject $a_page)
static	getCacheTriggerString (ilPageObject $a_page)
	Get page cache update trigger string. More...
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	$sec_node
Data Fields inherited from ilPageContent
string	$hier_id = ""
php4DOMElement	$node = null
php4DOMDocument	$dom = null
string	$page_lang = ""

Protected Member Functions
	setAttribute (string $a_attr, string $a_val)
Protected Member Functions inherited from ilPageContent
	setType (string $a_type)
	Set Type. More...

Protected Attributes
ilAccessHandler	$access
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 = ""

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 ilPCSection Section content object (see ILIAS DTD)

Author

Alexander Killing killi.nosp@m.ng@l.nosp@m.eifos.nosp@m..de

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

Member Function Documentation

afterPageUpdate()

static ilPCSection::afterPageUpdate ( ilPageObject  $a_page, DOMDocument  $a_domdoc, string  $a_xml, bool  $a_creation  )

static

After page has been updated (or created)

Reimplemented from ilPageContent.

Definition at line 90 of file class.ilPCSection.php.

     : void {
        self::saveTimings($a_page);
    }

create()

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

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

     : void {
        $this->node = $this->createPageContentNode();
        $a_pg_obj->insertContent($this, $a_hier_id, IL_INSERT_AFTER, $a_pc_id);
        $this->sec_node = $this->dom->create_element("Section");
        $this->sec_node = $this->node->append_child($this->sec_node);
        $this->sec_node->set_attribute("Characteristic", "Block");
    }

getActiveFrom()

ilPCSection::getActiveFrom

(

)

Get activation from.

Definition at line 127 of file class.ilPCSection.php.

                                   : int
    {
        if (is_object($this->sec_node)) {
            return (int) $this->sec_node->get_attribute("ActiveFrom");
        }
        return 0;
    }

getActiveTo()

ilPCSection::getActiveTo

(

)

Definition at line 149 of file class.ilPCSection.php.

                                 : int
    {
        if (is_object($this->sec_node)) {
            return (int) $this->sec_node->get_attribute("ActiveTo");
        }
        return 0;
    }

getAttribute()

ilPCSection::getAttribute

(

string

$a_attr

)

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

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

getCacheTriggerString()

static ilPCSection::getCacheTriggerString ( ilPageObject  $a_page )

static

Get page cache update trigger string.

Returns

string trigger string

Exceptions

ilDateTimeException

Definition at line 363 of file class.ilPCSection.php.

     : string {
        global $DIC;
 
        $ilDB = $DIC->database();
 
        $set = $ilDB->query(
            "SELECT * FROM copg_section_timings " .
            " WHERE page_id = " . $ilDB->quote($a_page->getId(), "integer") .
            " AND parent_type = " . $ilDB->quote($a_page->getParentType(), "text")
        );
        $str = "1";     // changed to 1 to force cache miss for #24277
        $current_ts = new ilDateTime(time(), IL_CAL_UNIX);
        $current_ts = $current_ts->get(IL_CAL_UNIX);
        while ($rec = $ilDB->fetchAssoc($set)) {
            $unix_ts = $rec["unix_ts"];
            if ($unix_ts < $current_ts) {
                $unix_ts .= "a";
            }
            $str .= "-" . $unix_ts;
        }
 
        return $str;
    }

Referenced by ilPageObjectGUI\showPage().

Here is the caller graph for this function:

getCharacteristic()

ilPCSection::getCharacteristic

(

)

Definition at line 70 of file class.ilPCSection.php.

                                       : string
    {
        if (is_object($this->sec_node)) {
            $char = $this->sec_node->get_attribute("Characteristic");
            if (substr($char, 0, 4) == "ilc_") {
                $char = substr($char, 4);
            }
            return $char;
        }
        return "";
    }

getLangVars()

static ilPCSection::getLangVars ( )

static

Get lang vars needed for editing.

Returns

string[] array of lang var keys

Reimplemented from ilPageContent.

Definition at line 82 of file class.ilPCSection.php.

                                        : array
    {
        return array("ed_insert_section");
    }

getLink()

ilPCSection::getLink

(

)

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

                             : array
    {
        $childs = $this->sec_node->child_nodes();
        foreach ($childs as $child) {
            if ($child->node_name() == "ExtLink") {
                return array("LinkType" => "ExtLink",
                    "Href" => $child->get_attribute("Href"));
            }
            if ($child->node_name() == "IntLink") {
                return array("LinkType" => "IntLink",
                    "Target" => $child->get_attribute("Target"),
                    "Type" => $child->get_attribute("Type"),
                    "TargetFrame" => $child->get_attribute("TargetFrame"));
            }
        }
        return array("LinkType" => "NoLink");
    }

getModel()

ilPCSection::getModel

(

)

Get model as needed for the front-end editor.

Reimplemented from ilPageContent.

Definition at line 453 of file class.ilPCSection.php.

                              : ?stdClass
    {
        if ($this->sec_node->node_name() != "Section") {
            return null;
        }
        $model = new stdClass();
        $model->protected = $this->getProtected();
 
        return $model;
    }

getPermission()

ilPCSection::getPermission

(

)

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

                                   : string
    {
        return $this->getAttribute("Permission");
    }

getPermissionRefId()

ilPCSection::getPermissionRefId

(

)

Definition at line 197 of file class.ilPCSection.php.

                                        : int
    {
        $id = explode("_", $this->getAttribute("PermissionRefId"));
        if (isset($id[3]) && in_array($id[1], array("", 0, IL_INST_ID))) {
            return (int) $id[3];
        }
        return 0;
    }

References $id, and IL_INST_ID.

getProtected()

ilPCSection::getProtected

(

)

Definition at line 435 of file class.ilPCSection.php.

                                  : bool
    {
        if (is_object($this->sec_node)) {
            return ($this->sec_node->get_attribute("Protected") == "1");
        }
 
        return false;
    }

handleAccess()

ilPCSection::handleAccess	(	string	$a_html,
		string	$a_mode
	)

Definition at line 273 of file class.ilPCSection.php.

     : string {
        $ilAccess = $this->access;
 
        while (($start = strpos($a_html, "{{{{{Section;Access;")) > 0) {
            $end = strpos($a_html, "}}}}}", $start);
            $access_attr = explode(";", substr($a_html, $start, $end - $start));
            $id = explode("_", $access_attr[3]);
            $section_nr = $access_attr[6];
            $access = true;
            if (in_array($id[1], array("", 0, IL_INST_ID)) && $id[3] > 0) {
                if ($access_attr[5] == "no_read") {
                    $access = !$ilAccess->checkAccess("read", "", $id[3]);
                } else {
                    $access = $ilAccess->checkAccess($access_attr[5], "", $id[3]);
                }
            }
            if ($a_mode == ilPageObjectGUI::EDIT) {
                $access = true;
            }
            $end_limiter = "{{{{{Section;AccessEnd;" . $section_nr . "}}}}}";
            if ($access) {
                $a_html = substr($a_html, 0, $start) . substr($a_html, $end + 5);
                $a_html = str_replace($end_limiter, "", $a_html);
            } else {
                $end = strpos($a_html, $end_limiter, $start);
                $a_html = substr($a_html, 0, $start) . substr($a_html, $end + strlen($end_limiter));
            }
        }
 
        $a_html = str_replace("{{{{{Section;Access}}}}}", "", $a_html);
        return $a_html;
    }

References $id, ilRBACAccessHandler\checkAccess(), ilPageObjectGUI\EDIT, and IL_INST_ID.

Here is the call graph for this function:

init()

ilPCSection::init

(

)

Init object.

This function must be overwritten and at least set the content type.

Reimplemented from ilPageContent.

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

                          : void
    {
        global $DIC;
 
        $this->access = $DIC->access();
        $this->ctrl = $DIC->ctrl();
        $this->lng = $DIC->language();
        $this->setType("sec");
    }

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

Here is the call graph for this function:

insertTimings()

ilPCSection::insertTimings

(

string

$a_html

)

Insert timings (in edit mode)

Exceptions

ilDateTimeException

Definition at line 393 of file class.ilPCSection.php.

     : string {
        $lng = $this->lng;
 
        $end = 0;
        $start = strpos($a_html, "{{{{{Section;ActiveFrom");
        if (is_int($start)) {
            $end = strpos($a_html, "}}}}}", $start);
        }
        $i = 1;
        while ($end > 0) {
            $param = substr($a_html, $start + 13, $end - $start - 13);
            $param = explode(";", $param);
            $from = $param[1];
            $to = $param[3];
            $html = "";
            if ($from != "") {
                ilDatePresentation::setUseRelativeDates(false);
                $from = new ilDateTime($from, IL_CAL_UNIX);
                $html .= $lng->txt("cont_active_from") . ": " . ilDatePresentation::formatDate($from);
            }
            if ($to != "") {
                $to = new ilDateTime($to, IL_CAL_UNIX);
                $html .= " " . $lng->txt("cont_active_to") . ": " . ilDatePresentation::formatDate($to);
            }
 
            $h2 = substr($a_html, 0, $start) .
                $html .
                substr($a_html, $end + 5);
            $a_html = $h2;
            $i++;
 
            $start = strpos($a_html, "{{{{{Section;ActiveFrom;", $start + 5);
            $end = 0;
            if (is_int($start)) {
                $end = strpos($a_html, "}}}}}", $start);
            }
        }
        return $a_html;
    }

modifyPageContentPostXsl()

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

Exceptions

ilDateTimeException

Reimplemented from ilPageContent.

Definition at line 102 of file class.ilPCSection.php.

     : string {
        $a_output = self::insertTimings($a_output);
        $a_output = $this->handleAccess($a_output, $a_mode);
 
        return $a_output;
    }

saveTimings()

static ilPCSection::saveTimings ( ilPageObject  $a_page )

static

Definition at line 309 of file class.ilPCSection.php.

     : void {
        global $DIC;
 
        $ilDB = $DIC->database();
 
        $ilDB->manipulate(
            "DELETE FROM copg_section_timings WHERE " .
            " page_id = " . $ilDB->quote($a_page->getId(), "integer") .
            " AND parent_type = " . $ilDB->quote($a_page->getParentType(), "text")
        );
 
        $xml = $a_page->getXMLFromDom();
 
        $doc = domxml_open_mem($xml);
 
        // media aliases
        $xpc = xpath_new_context($doc);
        $path = "//Section";
        $res = xpath_eval($xpc, $path);
        for ($i = 0; $i < count($res->nodeset); $i++) {
            $from = $res->nodeset[$i]->get_attribute("ActiveFrom");
            if ($from != "") {
                $ilDB->replace(
                    "copg_section_timings",
                    array(
                        "page_id" => array("integer", $a_page->getId()),
                        "parent_type" => array("text", $a_page->getParentType()),
                        "unix_ts" => array("integer", $from)
                        ),
                    array()
                );
            }
            $to = $res->nodeset[$i]->get_attribute("ActiveTo");
            if ($to != "") {
                $ilDB->replace(
                    "copg_section_timings",
                    array(
                        "page_id" => array("integer", $a_page->getId()),
                        "parent_type" => array("text", $a_page->getParentType()),
                        "unix_ts" => array("integer", $to)
                    ),
                    array()
                );
            }
        }
    }

setActiveFrom()

ilPCSection::setActiveFrom

(

int

$a_unix_ts

)

Definition at line 113 of file class.ilPCSection.php.

                                                 : void
    {
        if ($a_unix_ts > 0) {
            $this->sec_node->set_attribute("ActiveFrom", $a_unix_ts);
        } else {
            if ($this->sec_node->has_attribute("ActiveFrom")) {
                $this->sec_node->remove_attribute("ActiveFrom");
            }
        }
    }

setActiveTo()

ilPCSection::setActiveTo

(

int

$a_unix_ts

)

Set activation to.

Definition at line 138 of file class.ilPCSection.php.

                                               : void
    {
        if ($a_unix_ts > 0) {
            $this->sec_node->set_attribute("ActiveTo", $a_unix_ts);
        } else {
            if ($this->sec_node->has_attribute("ActiveTo")) {
                $this->sec_node->remove_attribute("ActiveTo");
            }
        }
    }

setAttribute()

ilPCSection::setAttribute ( string  $a_attr, string  $a_val  )

protected

Definition at line 157 of file class.ilPCSection.php.

     : void {
        if (!empty($a_val)) {
            $this->sec_node->set_attribute($a_attr, $a_val);
        } else {
            if ($this->sec_node->has_attribute($a_attr)) {
                $this->sec_node->remove_attribute($a_attr);
            }
        }
    }

setCharacteristic()

ilPCSection::setCharacteristic

(

string

$a_char

)

Definition at line 59 of file class.ilPCSection.php.

                                                     : void
    {
        if (!empty($a_char)) {
            $this->sec_node->set_attribute("Characteristic", $a_char);
        } else {
            if ($this->sec_node->has_attribute("Characteristic")) {
                $this->sec_node->remove_attribute("Characteristic");
            }
        }
    }

setExtLink()

ilPCSection::setExtLink

(

string

$a_href

)

Set link of area to an external one.

Definition at line 217 of file class.ilPCSection.php.

                                              : void
    {
        $this->setNoLink();
        if (trim($a_href) != "") {
            $attributes = array("Href" => trim($a_href));
            ilDOMUtil::setFirstOptionalElement(
                $this->dom,
                $this->sec_node,
                "ExtLink",
                array(""),
                "",
                $attributes
            );
        }
    }

References $attributes, and ilDOMUtil\setFirstOptionalElement().

Here is the call graph for this function:

setIntLink()

ilPCSection::setIntLink	(	string	$a_type,
		string	$a_target,
		string	$a_target_frame
	)

Set link of area to an internal one.

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

     : void {
        $this->setNoLink();
        $attributes = array("Type" => $a_type, "Target" => $a_target,
            "TargetFrame" => $a_target_frame);
        ilDOMUtil::setFirstOptionalElement(
            $this->dom,
            $this->sec_node,
            "IntLink",
            array(""),
            "",
            $attributes
        );
    }

setNode()

ilPCSection::setNode

(

php4DOMElement

$a_node

)

Set xml node of page content.

Parameters

php4DOMElement

$a_node

node object

Reimplemented from ilPageContent.

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

                                                   : void
    {
        parent::setNode($a_node);               // this is the PageContent node
        $this->sec_node = $a_node->first_child();               // this is the Section node
    }

References php4DOMNode\first_child().

Here is the call graph for this function:

setNoLink()

ilPCSection::setNoLink

(

)

Set no link.

Definition at line 209 of file class.ilPCSection.php.

                               : void
    {
        ilDOMUtil::deleteAllChildsByName($this->sec_node, array("IntLink", "ExtLink"));
    }

References ilDOMUtil\deleteAllChildsByName().

Here is the call graph for this function:

setPermission()

ilPCSection::setPermission

(

string

$a_val

)

Set permission.

Parameters

string

$a_val

"read"|"write"|"visible"|"no_read"

Definition at line 182 of file class.ilPCSection.php.

                                                : void
    {
        $this->setAttribute("Permission", $a_val);
    }

setPermissionRefId()

ilPCSection::setPermissionRefId

(

int

$a_ref_id

)

Definition at line 192 of file class.ilPCSection.php.

                                                     : void
    {
        $this->setAttribute("PermissionRefId", "il__ref_" . $a_ref_id);
    }

setProtected()

ilPCSection::setProtected

(

bool

$val

)

Definition at line 444 of file class.ilPCSection.php.

                                           : void
    {
        if ($val) {
            $this->sec_node->set_attribute("Protected", "1");
        } else {
            $this->sec_node->set_attribute("Protected", "0");
        }
    }

Field Documentation

$access

ilAccessHandler ilPCSection::$access

protected

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

$ctrl

ilCtrl ilPCSection::$ctrl

protected

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

$lng

ilLanguage ilPCSection::$lng

protected

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

$sec_node

php4DOMElement ilPCSection::$sec_node

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

---

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

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