ilPageObject Class Reference

Class ilPageObject Handles PageObjects of ILIAS Learning Modules (see ILIAS DTD) More...

Inheritance diagram for ilPageObject:

Collaboration diagram for ilPageObject:

Public Member Functions
	__construct (int $a_id=0, int $a_old_nr=0, string $a_lang="-")
	setContentIdManager (\ILIAS\COPage\ID\ContentIdManager $content_id_manager)
	afterConstructor ()
	getParentType ()
	initPageConfig ()
	setLanguage (string $a_val)
	Set language. More...
	getLanguage ()
	setPageConfig (ilPageConfig $a_val)
	setConcreteLang (string $a_val)
	getConcreteLang ()
	getPageConfig ()
	setRenderMd5 (string $a_rendermd5)
	getRenderMd5 ()
	setRenderedContent (string $a_renderedcontent)
	getRenderedContent ()
	setRenderedTime (string $a_renderedtime)
	getRenderedTime ()
	setLastChange (string $a_lastchange)
	getLastChange ()
	setLastChangeUser (int $a_val)
	getLastChangeUser ()
	setShowActivationInfo (bool $a_val)
	getShowActivationInfo ()
	getCreationUserId ()
	read ()
	Read page data. More...
	buildDom (bool $a_force=false)
	freeDom ()
	getDomDoc ()
	Get dom doc (DOMDocument) More...
	setId (int $a_id)
	getId ()
	setParentId (int $a_id)
	getParentId ()
	addUpdateListener (object $a_object, string $a_method, $a_parameters="")
	callUpdateListeners ()
	setActive (bool $a_active)
	getActive (bool $a_check_scheduled_activation=false)
	setActivationStart (?string $a_activationstart)
	getActivationStart ()
	setActivationEnd (?string $a_activationend)
	Set Activation End. More...
	getActivationEnd ()
	getContentObject (string $a_hier_id, string $a_pc_id="")
	Get a content object of the page. More...
	getContentObjectForPcId (string $pcid)
	Get content object for pc id. More...
	getParentContentObjectForPcId (string $pcid)
	Get parent content object for pc id. More...
	getContentDomNode (string $a_hier_id, string $a_pc_id="")
	getDomNodeForPCId (string $pc_id)
	setXMLContent (string $a_xml, string $a_encoding="UTF-8")
	set xml content of page, start with <PageObject...>, end with </PageObject>, comply with ILIAS DTD, omit MetaData, use utf-8! More...
	appendXMLContent (string $a_xml)
	getXMLContent (bool $a_incl_head=false)
	get xml content of page More...
	copyXmlContent (bool $a_clone_mobs=false, int $a_new_parent_id=0, int $obj_copy_id=0, bool $self_ass=true)
	Copy content of page; replace page components with copies where necessary (e.g. More...
	handleDeleteContent (?DOMNode $a_node=null, $move_operation=false)
	Handle content before deletion This currently treats only plugged content If no node is given, then the whole dom will be scanned. More...
	getXMLFromDom (bool $a_incl_head=false, bool $a_append_mobs=false, bool $a_append_bib=false, string $a_append_str="", bool $a_omit_pageobject_tag=false, int $style_id=0, bool $offline=false)
	get xml content of page from dom (use this, if any changes are made to the document) More...
	getLanguageVariablesXML (int $style_id=0)
	Get language variables as XML. More...
	getFirstParagraphText ()
	getParagraphForPCID (string $pcid)
	setContainsIntLink (bool $a_contains_link)
	lm parser set this flag to true, if the page contains intern links (this method should only be called by the import parser) todo: move to ilLMPageObject !? More...
	containsIntLink ()
	returns true, if page was marked as containing an intern link (via setContainsIntLink) (this method should only be called by the import parser) More...
	setImportMode (bool $a_val)
	getImportMode ()
	needsImportParsing (?bool $a_parse=null)
	setContainsQuestion (bool $a_val)
	getContainsQuestion ()
	collectMediaObjects (bool $a_inline_only=true)
	get all media objects, that are referenced and used within the page More...
	getInternalLinks ()
	get all internal links that are used within the page More...
	getMultimediaXML (bool $offline=false)
	get a xml string that contains all media object elements, that are referenced by any media alias in the page More...
	getMediaAliasElement (int $a_mob_id, int $a_nr=1)
	get complete media object (alias) element More...
	validateDom (bool $throw=false)
	Validate the page content agains page DTD. More...
	addHierIDs ()
	Add hierarchical ID (e.g. More...
	getHierIds ()
	stripHierIDs ()
	stripPCIDs ()
	getHierIdsForPCIds (array $a_pc_ids)
	Get hier ids for a set of pc ids. More...
	getHierIdForPcId (string $pcid)
	getPCIdsForHierIds (array $hier_ids)
	Get hier ids for a set of pc ids. More...
	getPCIdForHierId (string $hier_id)
	addFileSizes ()
	add file sizes More...
	resolveIntLinks (?array $a_link_map=null)
	Resolves all internal link targets of the page, if targets are available (after import) More...
	resolveMediaAliases (array $a_mapping, bool $a_reuse_existing_by_import=false)
	Resolve media aliases (after import) More...
	resolveIIMMediaAliases (array $a_mapping)
	Resolve iim media aliases (in ilContObjParse) More...
	resolveFileItems (array $a_mapping)
	Resolve file items (after import) More...
	resolveQuestionReferences (array $a_mapping)
	Resolve all quesiont references (after import) More...
	moveIntLinks (array $a_from_to)
	Move internal links from one destination to another. More...
	handleRepositoryLinksOnCopy (array $a_mapping, int $a_source_ref_id)
	Handle repository links on copy process. More...
	setEmptyPageXml ()
	createFromXML ()
	Create new page object with current xml content. More...
	updateFromXML ()
	Updates page object with current xml content This function is currently (8 beta) called by: More...
	afterUpdate (DOMDocument $domdoc, string $xml)
	After update. More...
	update (bool $a_validate=true, bool $a_no_history=false)
	update complete page content in db (dom xml content is used) More...
	delete ()
	saveStyleUsage (DOMDocument $a_domdoc, int $a_old_nr=0)
	Save all style class/template usages. More...
	deleteStyleUsages (int $a_old_nr=0)
	Delete style usages. More...
	getLastUpdateOfIncludedElements ()
	Get last update of included elements (media objects and files). More...
	deleteInternalLinks ()
	Delete internal links. More...
	saveInternalLinks (DOMDocument $a_domdoc)
	save internal links of page More...
	create (bool $a_import=false)
	create new page (with current xml data) More...
	deleteContent (string $a_hid, bool $a_update=true, string $a_pcid="", bool $move_operation=false)
	delete content object with hierarchical id $a_hid More...
	deleteContents (array $a_hids, bool $a_update=true, bool $a_self_ass=false, bool $move_operation=false)
	Delete multiple content objects. More...
	cutContents (array $a_hids)
	Copy contents to clipboard and cut them from the page. More...
	copyContents (array $a_hids)
	Copy contents to clipboard. More...
	pasteContents (string $a_hier_id, bool $a_self_ass=false)
	Paste contents from pc clipboard. More...
	switchEnableMultiple (array $a_hids, bool $a_update=true, bool $a_self_ass=false)
	(De-)activate elements More...
	insertContent (ilPageContent $a_cont_obj, string $a_pos, int $a_mode=IL_INSERT_AFTER, string $a_pcid="", bool $remove_placeholder=true)
	insert a content node before/after a sibling or as first child of a parent More...
	insertContentNode (DOMNode $a_cont_node, string $a_pos, int $a_mode=IL_INSERT_AFTER, string $a_pcid="")
	insert a content node before/after a sibling or as first child of a parent More...
	moveContentAfter (string $a_source, string $a_target, string $a_spcid="", string $a_tpcid="")
	move content object from position $a_source before position $a_target (both hierarchical content ids) More...
	insertInstIntoIDs (string $a_inst, bool $a_res_ref_to_obj_id=true)
	inserts installation id into ids (e.g. More...
	checkPCIds ()
	Check, whether (all) page content hashes are set. More...
	getAllPCIds ()
	Get all pc ids. More...
	hasDuplicatePCIds ()
	getDuplicatePCIds ()
	Get all duplicate PC Ids. More...
	generatePCId ()
	insertPCIds ()
	Insert Page Content IDs. More...
	sendParagraph (string $par_id, string $filename)
	registerOfflineHandler (object $handler)
	getOfflineHandler ()
	containsDeactivatedElements (string $a_content)
	Check whether content contains deactivated elements. More...
	getHistoryEntries ()
	Get History Entries. More...
	getHistoryEntry (int $a_old_nr)
	Get History Entry. More...
	getHistoryInfo (int $a_nr)
	Get information about a history entry, its predecessor and its successor. More...
	preparePageForCompare (ilPageObject $page)
	increaseViewCnt ()
	Increase view cnt. More...
	writeRenderedContent (string $a_content, string $a_md5)
	Write rendered content. More...
	containsIntLinks (string $a_content)
	Check whether content contains internal links. More...
	performAutomaticModifications ()
	Perform automatic modifications (may be overwritten by sub classes) More...
	saveInitialOpenedContent (string $a_type, int $a_id, string $a_target)
	Save initial opened content. More...
	getInitialOpenedContent ()
	Get initial opened content. More...
	beforePageContentUpdate (ilPageContent $a_page_content)
	Before page content update Note: This one is "work in progress", currently only text paragraphs call this hook It is called before the page content object invokes the update procedure of ilPageObject. More...
	copy (int $a_id, string $a_parent_type="", int $a_new_parent_id=0, bool $a_clone_mobs=false, int $obj_copy_id=0, bool $overwrite_existing=true)
	Copy page. More...
	copyPageToTranslation (string $a_target_lang)
	Copy page to translation. More...
	getEditLock ()
	Get page lock. More...
	releasePageLock ()
	Release page lock. More...
	getEditLockInfo ()
	Get edit lock info. More...
	getContentTemplates ()
	Get content templates. More...
	getEffectiveEditLockTime ()
	resolveResources (array $ref_mapping)
	Resolve resources. More...
	getRepoObjId ()
	Get object id of repository object that contains this page, return 0 if page does not belong to a repo object. More...
	getPCModel ()
	Get page component model. More...
	assignCharacteristic (array $targets, string $char_par, string $char_sec, string $char_med)
	Assign characteristic. More...

Static Public Member Functions
static	_exists (string $a_parent_type, int $a_id, string $a_lang="", bool $a_no_cache=false)
	Checks whether page exists. More...
static	_existsAndNotEmpty (string $a_parent_type, int $a_id, string $a_lang="-")
	Checks whether page exists and is not empty (may return true on some empty pages) More...
static	preloadActivationDataByParentId (int $a_parent_id)
	Preload activation data by Parent Id. More...
static	_lookupActive (int $a_id, string $a_parent_type, bool $a_check_scheduled_activation=false, string $a_lang="-")
	lookup activation status More...
static	_isScheduledActivation (int $a_id, string $a_parent_type, string $a_lang="-")
	Check whether page is activated by time schedule. More...
static	_writeActive (int $a_id, string $a_parent_type, bool $a_active)
	write activation status More...
static	_lookupActivationData (int $a_id, string $a_parent_type, string $a_lang="-")
	Lookup activation data. More...
static	lookupParentId (int $a_id, string $a_type)
static	_writeParentId (string $a_parent_type, int $a_pg_id, int $a_par_id)
static	_lookupContainsDeactivatedElements (int $a_id, string $a_parent_type, string $a_lang="-")
	lookup whether page contains deactivated elements More...
static	getRecentChanges (string $a_parent_type, int $a_parent_id, int $a_period=30, string $a_lang="")
	Get recent pages changes for parent object. More...
static	getAllPages (string $a_parent_type, int $a_parent_id, string $a_lang="-")
	Get all pages for parent object. More...
static	getNewPages (string $a_parent_type, int $a_parent_id, string $a_lang="-")
	Get new pages. More...
static	getParentObjectContributors (string $a_parent_type, int $a_parent_id, string $a_lang="-")
	Get all contributors for parent object. More...
static	getPageContributors (string $a_parent_type, int $a_page_id, string $a_lang="-")
	Get all contributors for parent object. More...
static	getPagesWithLinks (string $a_parent_type, int $a_parent_id, string $a_lang="-")
	Get all pages for parent object that contain internal links. More...
static	lookupTranslations (string $a_parent_type, int $a_id)
	Lookup translations. More...
static	truncateHTML (string $a_text, int $a_length=100, string $a_ending='...', bool $a_exact=false, bool $a_consider_html=true)
	Truncate (html) string. More...
static	getLastChangeByParent (string $a_parent_type, int $a_parent_id, string $a_lang="")
	Get all pages for parent object. More...

Data Fields
int	$old_nr
DOMDocument	$dom = null
string	$xml = ""
string	$encoding = ""
DomNode	$node
string	$cur_dtd = "ilias_pg_9.dtd"
bool	$contains_int_link = false
bool	$needs_parsing = false
string	$parent_type = ""
int	$parent_id = 0
array	$update_listeners = []
int	$update_listener_cnt = 0
object	$offline_handler = null
bool	$dom_builded = false
bool	$history_saved = false
int	$last_change_user = 0

Static Public Attributes
static array	$exists = array()

Protected Member Functions
	getIliasAbsolutePath ()
	getLangVarXML (string $var)
	getLangVarXMLForValue (string $var, string $val)
	__afterUpdate (DOMDocument $a_domdoc, string $a_xml, bool $a_creation=false, bool $a_empty=false)
	After update event handler (internal). More...
	isTranslationPage ()
	__beforeDelete ()
	Before deletion handler (internal). More...
	__afterDelete ()
	afterDelete ()
	__afterHistoryEntry (DOMDocument $a_old_domdoc, string $a_old_content, int $a_old_nr)
	getContentManager ()
	setCopyProperties (ilPageObject $new_page)
	setTranslationProperties (self $transl_page)

Protected Attributes
ILIAS COPage Dom DomUtil	$dom_util
ILIAS COPage Link LinkManager	$link
ILIAS COPage PC PCDefinition	$pc_definition
int	$create_user = 0
array	$id_elements
bool	$page_not_found = false
bool	$show_page_act_info = false
ilObjectDefinition	$obj_definition
ilDBInterface	$db
ilObjUser	$user
ilLanguage	$lng
ilTree	$tree
LOMServices	$lom_services
int	$id
string	$language = "-"
bool	$import_mode = false
ilLogger	$log
array	$page_record = array()
bool	$active = false
ilPageConfig	$page_config
string	$rendermd5 = ""
string	$renderedcontent = ""
string	$renderedtime = ""
string	$lastchange = ""
bool	$contains_question = false
array	$hier_ids = []
string	$activationstart = null
string	$activationend = null
ILIAS COPage ReadingTime ReadingTimeManager	$reading_time_manager
	$concrete_lang = ""
ILIAS COPage ID ContentIdManager	$content_id_manager
ILIAS COPage Page PageManager	$page_manager
ILIAS COPage Style StyleManager	$style_manager
ILIAS COPage PC DomainService	$pc_service

Static Protected Attributes
static array	$activation_data = array()

Detailed Description

Class ilPageObject Handles PageObjects of ILIAS Learning Modules (see ILIAS DTD)

Author

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

Definition at line 52 of file class.ilPageObject.php.

Constructor & Destructor Documentation

__construct()

ilPageObject::__construct ( int  $a_id = 0, int  $a_old_nr = 0, string  $a_lang = "-"  )

final

Definition at line 110 of file class.ilPageObject.php.

      {
        global $DIC;
        $this->obj_definition = $DIC["objDefinition"];
        $this->db = $DIC->database();
        $this->user = $DIC->user();
        $this->lng = $DIC->language();
        $this->tree = $DIC->repositoryTree();
        $this->log = ilLoggerFactory::getLogger('copg');
        $this->lom_services = $DIC->learningObjectMetadata();
 
        $this->reading_time_manager = new ILIAS\COPage\ReadingTime\ReadingTimeManager();
 
        $this->parent_type = $this->getParentType();
        $this->id = $a_id;
        $this->setLanguage($a_lang);
 
        $this->contains_int_link = false;
        $this->needs_parsing = false;
        $this->update_listeners = array();
        $this->update_listener_cnt = 0;
        $this->dom_builded = false;
        $this->page_not_found = false;
        $this->old_nr = $a_old_nr;
        $this->encoding = "UTF-8";
        $this->id_elements =
            array("PageContent",
                  "TableRow",
                  "TableData",
                  "ListItem",
                  "FileItem",
                  "Section",
                  "Tab",
                  "ContentPopup",
                  "GridCell"
            );
        $this->setActive(true);
        $this->show_page_act_info = false;
 
        if ($a_id != 0) {
            $this->read();
        }
 
        $this->initPageConfig();
        $this->afterConstructor();
        $domain = $DIC->copage()
                      ->internal()
                      ->domain();
        $this->content_id_manager = $domain
            ->contentIds($this);
        $this->page_manager = $domain->page();
        $this->pc_service = $domain->pc();
        $this->pc_definition = $domain->pc()->definition();
        $this->link = $domain->link();
        $this->style_manager = $domain->style();
        $this->dom_util = $domain->domUtil();
    }

References $DIC, afterConstructor(), ilLoggerFactory\getLogger(), getParentType(), initPageConfig(), ILIAS\Repository\link(), ILIAS\Repository\lng(), read(), setActive(), setLanguage(), and ILIAS\Repository\user().

Here is the call graph for this function:

Member Function Documentation

__afterDelete()

ilPageObject::__afterDelete ( )

finalprotected

Definition at line 1690 of file class.ilPageObject.php.

                                            : void
    {
        $this->afterDelete();
    }

__afterHistoryEntry()

ilPageObject::__afterHistoryEntry ( DOMDocument  $a_old_domdoc, string  $a_old_content, int  $a_old_nr  )

finalprotected

Definition at line 1699 of file class.ilPageObject.php.

     : void {
        // save style usage
        $this->saveStyleUsage($a_old_domdoc, $a_old_nr);
 
        // pc classes hook
        $defs = $this->pc_definition->getPCDefinitions();
        foreach ($defs as $def) {
            $cl = $def["pc_class"];
            call_user_func(
                $def["pc_class"] . '::afterPageHistoryEntry',
                $this,
                $a_old_domdoc,
                $a_old_content,
                $a_old_nr
            );
        }
    }

__afterUpdate()

ilPageObject::__afterUpdate ( DOMDocument  $a_domdoc, string  $a_xml, bool  $a_creation = false, bool  $a_empty = false  )

finalprotected

After update event handler (internal).

The hooks are e.g. for storing any dependent relations/references in the database.

Definition at line 1379 of file class.ilPageObject.php.

     : void {
        // we do not need this if we are creating an empty page
        if (!$a_creation || !$a_empty) {
            // save internal link information
            // the page object is responsible to do this, since it "offers" the
            // internal link feature pc and page classes
            $this->saveInternalLinks($a_domdoc);
 
            // save style usage
            $this->saveStyleUsage($a_domdoc);
 
            // save estimated reading time
            $this->reading_time_manager->saveTime($this);
 
            // pc classes hook
            $defs = $this->pc_definition->getPCDefinitions();
            foreach ($defs as $def) {
                $cl = $def["pc_class"];
                call_user_func($def["pc_class"] . '::afterPageUpdate', $this, $a_domdoc, $a_xml, $a_creation);
            }
        }
 
        // call page hook
        $this->afterUpdate($a_domdoc, $a_xml);
 
        // call update listeners
        $this->callUpdateListeners();
    }

__beforeDelete()

ilPageObject::__beforeDelete ( )

finalprotected

Before deletion handler (internal).

Definition at line 1680 of file class.ilPageObject.php.

                                             : void
    {
        // pc classes hook
        $defs = $this->pc_definition->getPCDefinitions();
        foreach ($defs as $def) {
            $cl = $def["pc_class"];
            call_user_func($def["pc_class"] . '::beforePageDelete', $this);
        }
    }

_exists()

static ilPageObject::_exists ( string  $a_parent_type, int  $a_id, string  $a_lang = "", bool  $a_no_cache = false  )

static

Checks whether page exists.

Parameters

string

$a_lang

language code, if empty language independent existence is checked

Definition at line 335 of file class.ilPageObject.php.

     : bool {
        global $DIC;
 
        $db = $DIC->database();
 
        if (!$a_no_cache && isset(self::$exists[$a_parent_type . ":" . $a_id . ":" . $a_lang])) {
            return self::$exists[$a_parent_type . ":" . $a_id . ":" . $a_lang];
        }
 
        $and_lang = "";
        if ($a_lang != "") {
            $and_lang = " AND lang = " . $db->quote($a_lang, "text");
        }
 
        $query = "SELECT page_id FROM page_object WHERE page_id = " . $db->quote($a_id, "integer") . " " .
            "AND parent_type = " . $db->quote($a_parent_type, "text") . $and_lang;
        $set = $db->query($query);
        if ($row = $db->fetchAssoc($set)) {
            self::$exists[$a_parent_type . ":" . $a_id . ":" . $a_lang] = true;
            return true;
        } else {
            self::$exists[$a_parent_type . ":" . $a_id . ":" . $a_lang] = false;
            return false;
        }
    }

Referenced by ilImprintGUI\__construct(), ilDclDetailedViewDefinitionGUI\__construct(), ilDashboardPageGUI\__construct(), ilInternalLink\_exists(), ilPageObjectGUI\checkLangPageAvailable(), ilObjContentObject\checkStructure(), ILIAS\Blog\Export\BlogHtmlExport\collectAllPagesPageElements(), ilObjectCopyGUI\copyParentPage(), ilObjForum\delete(), ilObjMediaPool\deleteChild(), assQuestion\deletePageOfQuestion(), ilObjContentPage\doCloneObject(), ilObjContentPage\doDelete(), ILIAS\ContentPage\PageMetrics\PageMetricsService\doesPageExistsForLanguage(), ilContentPagePageCommandForwarder\doesPageExistsForLanguage(), ilForumPageCommandForwarder\doesPageExistsForLanguage(), ilAssQuestionFeedback\ensurePageObjectDeleted(), ilAssQuestionFeedbackPageObjectCommandForwarder\ensurePageObjectExists(), ilAssQuestionFeedback\ensurePageObjectExists(), ilContainerStartObjectsGUI\executeCommand(), ilLOEditorGUI\executeCommand(), ilLMPageObjectGUI\executeCommand(), ilObjectCopyGUI\executeNextStepAfterSourceSelection(), ILIAS\LearningModule\Export\LMHtmlExport\exportHTMLPages(), ILIAS\Portfolio\Export\PortfolioHtmlExport\exportHTMLPages(), ILIAS\Wiki\Export\WikiHtmlExport\exportHTMLPages(), ILIAS\Portfolio\Export\PortfolioHtmlExport\exportHTMLPagesPrint(), ILIAS\Wiki\Export\WikiHtmlExport\exportHTMLPagesPrint(), ilObjContentObject\exportXMLPageObjects(), ilLearningModuleImporter\finalProcessing(), ilObjContentObject\fixTree(), ilContainerGUI\forwardToPageObject(), ilPageMultiLang\getEffectiveLang(), ilLMPresentationGUI\getLMPage(), ilLMContentRendererGUI\getLMPageGUI(), ilLMPresentationGUI\getLMPageGUI(), ilContainerExporter\getXmlExportTailDependencies(), ilLearningSequenceExporter\getXmlExportTailDependencies(), ilPCQuestion\handleCopiedContent(), ilObjLearningSequence\hasContentPage(), ilQuestionPageParser\processPagesToParse(), ilObjContentObject\validatePages(), and ilContainerXmlWriter\writeSubitems().

Here is the caller graph for this function:

_existsAndNotEmpty()

static ilPageObject::_existsAndNotEmpty ( string  $a_parent_type, int  $a_id, string  $a_lang = "-"  )

static

Checks whether page exists and is not empty (may return true on some empty pages)

Definition at line 369 of file class.ilPageObject.php.

     : bool {
        return ilPageUtil::_existsAndNotEmpty($a_parent_type, $a_id, $a_lang);
    }

Referenced by ilDashboardPageGUI\isLanguageAvailable().

Here is the caller graph for this function:

_isScheduledActivation()

static ilPageObject::_isScheduledActivation ( int  $a_id, string  $a_parent_type, string  $a_lang = "-"  )

static

Check whether page is activated by time schedule.

Definition at line 552 of file class.ilPageObject.php.

     : bool {
        global $DIC;
 
        $db = $DIC->database();
 
        // language must be set at least to "-"
        if ($a_lang == "") {
            $a_lang = "-";
        }
 
        //echo "<br>";
        //var_dump(self::$activation_data); exit;
        if (isset(self::$activation_data[$a_id . ":" . $a_parent_type . ":" . $a_lang])) {
            $rec = self::$activation_data[$a_id . ":" . $a_parent_type . ":" . $a_lang];
        } else {
            $set = $db->queryF(
                "SELECT active, activation_start, activation_end FROM page_object WHERE page_id = %s" .
                " AND parent_type = %s AND lang = %s",
                array("integer", "text", "text"),
                array($a_id, $a_parent_type, $a_lang)
            );
            $rec = $db->fetchAssoc($set);
        }
 
        if (!$rec["active"] && $rec["activation_start"] != "") {
            return true;
        }
 
        return false;
    }

Referenced by ilLMPagesTableGUI\fillRow(), ILIAS\LearningModule\Editing\SubObjectRetrieval\getData(), ilLMEditorExplorerGUI\getNodeIcon(), and ilLMTOCExplorerGUI\getNodeIcon().

Here is the caller graph for this function:

_lookupActivationData()

static ilPageObject::_lookupActivationData ( int  $a_id, string  $a_parent_type, string  $a_lang = "-"  )

static

Lookup activation data.

Definition at line 614 of file class.ilPageObject.php.

     : array {
        global $DIC;
 
        $db = $DIC->database();
 
        // language must be set at least to "-"
        if ($a_lang == "") {
            $a_lang = "-";
        }
 
        if (isset(self::$activation_data[$a_id . ":" . $a_parent_type . ":" . $a_lang])) {
            $rec = self::$activation_data[$a_id . ":" . $a_parent_type . ":" . $a_lang];
        } else {
            $set = $db->queryF(
                "SELECT active, activation_start, activation_end, show_activation_info FROM page_object WHERE page_id = %s" .
                " AND parent_type = %s AND lang = %s",
                array("integer", "text", "text"),
                array($a_id, $a_parent_type, $a_lang)
            );
            $rec = $db->fetchAssoc($set);
            if (!$rec) {
                return [
                    "active" => 1,
                    "activation_start" => null,
                    "activation_end" => null,
                    "show_activation_info" => 0
                ];
            }
        }
 
        return $rec;
    }

Referenced by ilLMNavigationStatus\determineStatus(), ilLMNavigationStatus\getPredecessorPageId(), ilLMNavigationStatus\getSuccessorPageId(), and ilLMContentRendererGUI\renderDeactivatedPageMessage().

Here is the caller graph for this function:

_lookupActive()

static ilPageObject::_lookupActive ( int  $a_id, string  $a_parent_type, bool  $a_check_scheduled_activation = false, string  $a_lang = "-"  )

static

lookup activation status

Definition at line 508 of file class.ilPageObject.php.

     : bool {
        global $DIC;
 
        $db = $DIC->database();
 
        // language must be set at least to "-"
        if ($a_lang == "") {
            $a_lang = "-";
        }
 
        if (isset(self::$activation_data[$a_id . ":" . $a_parent_type . ":" . $a_lang])) {
            $rec = self::$activation_data[$a_id . ":" . $a_parent_type . ":" . $a_lang];
        } else {
            $set = $db->queryF(
                "SELECT active, activation_start, activation_end FROM page_object WHERE page_id = %s" .
                " AND parent_type = %s AND lang = %s",
                array("integer", "text", "text"),
                array($a_id, $a_parent_type, $a_lang)
            );
            $rec = $db->fetchAssoc($set);
            if (!$rec) {
                return true;
            }
        }
 
        $rec["n"] = ilUtil::now();
        if (!$rec["active"] && $a_check_scheduled_activation) {
            if ($rec["n"] >= $rec["activation_start"] &&
                $rec["n"] <= $rec["activation_end"]) {
                return true;
            }
        }
 
        return (bool) $rec["active"];
    }

Referenced by ilDclDetailedViewDefinitionGUI\__construct(), ilObjContentObjectGUI\activatePages(), ILIAS\LearningModule\Editing\EditSubObjectsGUI\activatePages(), ilLMNavigationRendererGUI\addDropdown(), ILIAS\Blog\Permission\PermissionManager\canReadPosting(), ilObjBlog\deliverRSS(), ilLMNavigationStatus\determineStatus(), ilLMPagesTableGUI\fillRow(), ilObjBlogGUI\filterInactivePostings(), ILIAS\LearningModule\Editing\SubObjectRetrieval\getData(), ilDclTextRecordRepresentation\getHTML(), ilLPStatusVisitedPages\getLMPages(), ilLMTOCExplorerGUI\getNodeHref(), ilLMEditorExplorerGUI\getNodeIcon(), ilLMTOCExplorerGUI\getNodeIcon(), ilLMEditorExplorerGUI\getNodeIconAlt(), ilLMNavigationStatus\getPredecessorPageId(), ilLMNavigationStatus\getSuccessorPageId(), ilBlogDraftsDerivedTaskProvider\getTasks(), ilImprint\isActive(), ILIAS\Blog\Permission\PermissionManager\isActive(), ilLMTOCExplorerGUI\isNodeClickable(), ilObjBlogGUI\renderNavigationByDate(), ilLMPresentationGUI\showPrintView(), and ilLMPresentationGUI\showPrintViewSelection().

Here is the caller graph for this function:

_lookupContainsDeactivatedElements()

static ilPageObject::_lookupContainsDeactivatedElements ( int  $a_id, string  $a_parent_type, string  $a_lang = "-"  )

static

lookup whether page contains deactivated elements

Definition at line 2047 of file class.ilPageObject.php.

     : bool {
        global $DIC;
 
        $db = $DIC->database();
 
        if ($a_lang == "") {
            $a_lang = "-";
        }
 
        $query = "SELECT * FROM page_object WHERE page_id = " .
            $db->quote($a_id, "integer") . " AND " .
            " parent_type = " . $db->quote($a_parent_type, "text") . " AND " .
            " lang = " . $db->quote($a_lang, "text") . " AND " .
            " inactive_elements = " . $db->quote(1, "integer");
        $obj_set = $db->query($query);
 
        if ($obj_rec = $obj_set->fetchRow(ilDBConstants::FETCHMODE_ASSOC)) {
            return true;
        }
 
        return false;
    }

Referenced by ilLMPagesTableGUI\fillRow(), ILIAS\LearningModule\Editing\SubObjectRetrieval\getData(), ilLMEditorExplorerGUI\getNodeIcon(), and ilLMEditorExplorerGUI\getNodeIconAlt().

Here is the caller graph for this function:

_writeActive()

static ilPageObject::_writeActive ( int  $a_id, string  $a_parent_type, bool  $a_active  )

static

write activation status

Definition at line 590 of file class.ilPageObject.php.

     : void {
        global $DIC;
 
        $db = $DIC->database();
 
        // language must be set at least to "-"
        $a_lang = "-";
 
        $db->manipulateF(
            "UPDATE page_object SET active = %s, activation_start = %s, " .
            " activation_end = %s WHERE page_id = %s" .
            " AND parent_type = %s AND lang = %s",
            array("int", "timestamp", "timestamp", "integer", "text", "text"),
            array((int) $a_active, null, null, $a_id, $a_parent_type, $a_lang)
        );
    }

Referenced by ilObjContentObjectGUI\activatePages(), and ILIAS\LearningModule\Editing\EditSubObjectsGUI\activatePages().

Here is the caller graph for this function:

_writeParentId()

static ilPageObject::_writeParentId ( string  $a_parent_type, int  $a_pg_id, int  $a_par_id  )

static

Definition at line 663 of file class.ilPageObject.php.

                                                                                             : void
    {
        global $DIC;
 
        $db = $DIC->database();
        $db->manipulateF(
            "UPDATE page_object SET parent_id = %s WHERE page_id = %s" .
            " AND parent_type = %s",
            array("integer", "integer", "text"),
            array($a_par_id, $a_pg_id, $a_parent_type)
        );
    }

References $DIC, and ilDBInterface\manipulateF().

Referenced by ilBlogImporter\finalProcessing(), ilContainerImporter\finalProcessing(), ilContentPageImporter\finalProcessing(), ilForumImporter\finalProcessing(), ilLearningModuleImporter\finalProcessing(), ilLearningSequenceImporter\finalProcessing(), ilMediaPoolImporter\finalProcessing(), ilPortfolioImporter\finalProcessing(), and ilWikiImporter\finalProcessing().

Here is the call graph for this function:

Here is the caller graph for this function:

addFileSizes()

ilPageObject::addFileSizes

(

)

add file sizes

Definition at line 1178 of file class.ilPageObject.php.

                                  : void
    {
        $this->pc_service->fileList()->addFileSizes($this->getDomDoc());
    }

addHierIDs()

ilPageObject::addHierIDs

(

)

Add hierarchical ID (e.g.

for editing) attributes "HierId" to current dom tree.

Definition at line 1129 of file class.ilPageObject.php.

                                : void
    {
        $this->content_id_manager->addHierIDsToDom();
    }

Referenced by ilContainerPage\addRepositoryBlockToPage(), ILIAS\COPage\PC\Paragraph\ParagraphCommandActionHandler\cancelCommand(), PCInteractiveImageTest\getInteractiveImageInPage(), ilPCParagraph\getLastSavedPCId(), PCMediaObjectTest\getMediaObjectInPage(), ILIAS\COPage\Compare\PageCompare\getPageContentsHashes(), ILIAS\COPage\ID\ContentIdManager\getPCIdsForHierIds(), PCTabsTest\getTabsWithTabs(), COPageTestBase\insertParagraphAt(), and ILIAS\COPage\PC\Paragraph\ParagraphCommandActionHandler\mergePrevious().

Here is the caller graph for this function:

addUpdateListener()

ilPageObject::addUpdateListener	(	object	$a_object,
		string	$a_method,
			$a_parameters = ""
	)

Parameters

mixed

$a_parameters

Definition at line 447 of file class.ilPageObject.php.

     : void {
        $cnt = $this->update_listener_cnt;
        $this->update_listeners[$cnt]["object"] = $a_object;
        $this->update_listeners[$cnt]["method"] = $a_method;
        $this->update_listeners[$cnt]["parameters"] = $a_parameters;
        $this->update_listener_cnt++;
    }

afterConstructor()

ilPageObject::afterConstructor

(

)

Reimplemented in ilBlogPosting, ilDashboardPage, ilLMPage, ilPortfolioPage, and ilWikiPage.

Definition at line 177 of file class.ilPageObject.php.

                                      : void
    {
    }

Referenced by __construct().

Here is the caller graph for this function:

afterDelete()

ilPageObject::afterDelete ( )

protected

Reimplemented in ilLMPage.

Definition at line 1695 of file class.ilPageObject.php.

                                    : void
    {
    }

afterUpdate()

ilPageObject::afterUpdate	(	DOMDocument	$domdoc,
		string	$xml
	)

After update.

Reimplemented in ilLMPage, and ilWikiPage.

Definition at line 1416 of file class.ilPageObject.php.

                                                                 : void
    {
    }

appendXMLContent()

ilPageObject::appendXMLContent

(

string

$a_xml

)

   append xml content to page
   setXMLContent must be called before and the same encoding must be used

s

Definition at line 780 of file class.ilPageObject.php.

                                                   : void
    {
        $this->xml .= $a_xml;
    }

assignCharacteristic()

ilPageObject::assignCharacteristic	(	array	$targets,
		string	$char_par,
		string	$char_sec,
		string	$char_med
	)

Assign characteristic.

Returns

array|bool

Exceptions

ilCOPagePCEditException
ilCOPageUnknownPCTypeException
ilDateTimeException

Definition at line 3049 of file class.ilPageObject.php.

      {
        if (is_array($targets)) {
            foreach ($targets as $t) {
                $tarr = explode(":", $t);
                $cont_obj = $this->getContentObject($tarr[0], $tarr[1]);
                if (is_object($cont_obj) && $cont_obj->getType() == "par") {
                    $cont_obj->setCharacteristic($char_par);
                }
                if (is_object($cont_obj) && $cont_obj->getType() == "sec") {
                    $cont_obj->setCharacteristic($char_sec);
                }
                if (is_object($cont_obj) && $cont_obj->getType() == "media") {
                    $cont_obj->setClass($char_med);
                }
            }
            return $this->update();
        }
        return true;
    }

beforePageContentUpdate()

ilPageObject::beforePageContentUpdate

(

ilPageContent

$a_page_content

)

Before page content update Note: This one is "work in progress", currently only text paragraphs call this hook It is called before the page content object invokes the update procedure of ilPageObject.

Reimplemented in ilGlossaryDefPage, and ilLMPage.

Definition at line 2601 of file class.ilPageObject.php.

                                                                          : void
    {
    }

Referenced by ilPCParagraph\updatePage().

Here is the caller graph for this function:

buildDom()

ilPageObject::buildDom

(

bool

$a_force = false

)

Returns

bool|array

Definition at line 380 of file class.ilPageObject.php.

    {
        if ($this->dom_builded && !$a_force) {
            return true;
        }
        $error = null;
        if ($this->getXMLContent() === "") {
            $this->setXMLContent("<PageObject></PageObject>");
        }
        $this->dom = $this->dom_util->docFromString($this->getXMLContent(true), $error);
        $path = "//PageObject";
        if (is_null($this->dom)) {
            throw new ilCOPageException("Invalid page xml (" .
                $this->getId() . "," . $this->getLanguage() . "): " . $this->getXMLContent(true));
        }
        $nodes = $this->dom_util->path($this->dom, $path);
        if (count($nodes) == 1) {
            $this->node = $nodes->item(0);
        } else {
            throw new ilCOPageException("Invalid page xml (" .
                $this->getId() . "," . $this->getLanguage() . "): " . $this->getXMLContent(true));
        }
 
        if (empty($error)) {
            $this->dom_builded = true;
            return true;
        } else {
            return $error;
        }
    }

References $path, ILIAS\Survey\Mode\getId(), and getLanguage().

Referenced by ilContainerPage\addMissingContainerBlocks(), ILIAS\COPage\ID\ContentIdManager\checkPCIds(), ILIAS\COPage\ID\ContentIdManager\getAllPCIds(), ILIAS\COPage\Compare\PageCompare\getPageContentsHashes(), ilQuestionPageParser\processPagesToParse(), ilContainerPage\removeUnsupportedBlockIds(), and ILIAS\COPage\ReadingTime\ReadingTimeManager\saveTime().

Here is the call graph for this function:

Here is the caller graph for this function:

callUpdateListeners()

ilPageObject::callUpdateListeners

(

)

Definition at line 459 of file class.ilPageObject.php.

                                         : void
    {
        for ($i = 0; $i < $this->update_listener_cnt; $i++) {
            $object = $this->update_listeners[$i]["object"];
            $method = $this->update_listeners[$i]["method"];
            $parameters = $this->update_listeners[$i]["parameters"];
            $object->$method($parameters);
        }
    }

checkPCIds()

ilPageObject::checkPCIds

(

)

Check, whether (all) page content hashes are set.

Definition at line 1983 of file class.ilPageObject.php.

                                : bool
    {
        return $this->content_id_manager->checkPCIds();
    }

collectMediaObjects()

ilPageObject::collectMediaObjects

(

bool

$a_inline_only = true

)

get all media objects, that are referenced and used within the page

Definition at line 1073 of file class.ilPageObject.php.

                                                                   : array
    {
        $mob_manager = $this->pc_service->mediaObject();
        return $mob_manager->collectMediaObjects($this->getDomDoc(), $a_inline_only);
    }

containsDeactivatedElements()

ilPageObject::containsDeactivatedElements

(

string

$a_content

)

Check whether content contains deactivated elements.

Definition at line 2077 of file class.ilPageObject.php.

                                                                  : bool
    {
        if (strpos($a_content, " Enabled=\"False\"")) {
            return true;
        }
        return false;
    }

containsIntLink()

ilPageObject::containsIntLink

(

)

returns true, if page was marked as containing an intern link (via setContainsIntLink) (this method should only be called by the import parser)

Definition at line 1031 of file class.ilPageObject.php.

                                     : bool
    {
        return $this->contains_int_link;
    }

containsIntLinks()

ilPageObject::containsIntLinks

(

string

$a_content

)

Check whether content contains internal links.

Definition at line 2552 of file class.ilPageObject.php.

                                                       : bool
    {
        if (strpos($a_content, "IntLink")) {
            return true;
        }
        return false;
    }

copy()

ilPageObject::copy	(	int	$a_id,
		string	$a_parent_type = "",
		int	$a_new_parent_id = 0,
		bool	$a_clone_mobs = false,
		int	$obj_copy_id = 0,
		bool	$overwrite_existing = true
	)

Copy page.

Parameters

int	$a_id	target page id (new page)
string	$a_parent_type
int	$a_new_parent_id
false	$a_clone_mobs
int	$obj_copy_id	copy wizard id

Definition at line 2613 of file class.ilPageObject.php.

     : void {
        if ($a_parent_type == "") {
            $a_parent_type = $this->getParentType();
            if ($a_new_parent_id == 0) {
                $a_new_parent_id = $this->getParentId();
            }
        }
 
        foreach (self::lookupTranslations($this->getParentType(), $this->getId()) as $l) {
            $existed = false;
            $orig_page = ilPageObjectFactory::getInstance($this->getParentType(), $this->getId(), 0, $l);
            if (ilPageObject::_exists($a_parent_type, $a_id, $l)) {
                if (!$overwrite_existing) {
                    continue;
                }
                $new_page_object = ilPageObjectFactory::getInstance($a_parent_type, $a_id, 0, $l);
                $existed = true;
            } else {
                $new_page_object = ilPageObjectFactory::getInstance($a_parent_type, 0, 0, $l);
                $new_page_object->setParentId($a_new_parent_id);
                $new_page_object->setId($a_id);
            }
            $new_page_object->setXMLContent($orig_page->copyXMLContent($a_clone_mobs, $a_new_parent_id, $obj_copy_id));
            $new_page_object->setActive($orig_page->getActive());
            $new_page_object->setActivationStart($orig_page->getActivationStart());
            $new_page_object->setActivationEnd($orig_page->getActivationEnd());
            $this->setCopyProperties($new_page_object);
            if ($existed) {
                $new_page_object->buildDom();
                $new_page_object->update();
            } else {
                $new_page_object->create(false);
            }
        }
    }

copyContents()

ilPageObject::copyContents

(

array

$a_hids

)

Copy contents to clipboard.

Definition at line 1851 of file class.ilPageObject.php.

                                               : void
    {
        $cm = $this->page_manager->content($this->getDomDoc());
        $cm->copyContents($a_hids, $this->user);
    }

References ILIAS\Repository\user().

Here is the call graph for this function:

copyPageToTranslation()

ilPageObject::copyPageToTranslation

(

string

$a_target_lang

)

Copy page to translation.

Definition at line 2687 of file class.ilPageObject.php.

     : void {
        $transl_page = ilPageObjectFactory::getInstance(
            $this->getParentType(),
            0,
            0,
            $a_target_lang
        );
        $this->setTranslationProperties($transl_page);
        $transl_page->create(false);
    }

copyXmlContent()

ilPageObject::copyXmlContent	(	bool	$a_clone_mobs = false,
		int	$a_new_parent_id = 0,
		int	$obj_copy_id = 0,
		bool	$self_ass = true
	)

Copy content of page; replace page components with copies where necessary (e.g.

questions)

Returns

string|string[]|null

Definition at line 815 of file class.ilPageObject.php.

     : string {
        $cm = $this->page_manager->contentFromXml($this->getXMLContent());
        return $cm->copyXmlContent(
            $this,
            $a_clone_mobs,
            $a_new_parent_id,
            $obj_copy_id,
            $self_ass
        );
    }

create()

ilPageObject::create

(

bool

$a_import = false

)

create new page (with current xml data)

Reimplemented in ilBlogPosting, ilPortfolioPage, and ilWikiPage.

Definition at line 1786 of file class.ilPageObject.php.

                                                  : void
    {
        $this->createFromXML();
    }

createFromXML()

ilPageObject::createFromXML

(

)

Create new page object with current xml content.

Reimplemented in ilWikiPage.

Definition at line 1290 of file class.ilPageObject.php.

                                   : void
    {
        $empty = false;
        if ($this->getXMLContent() === "") {
            $this->setEmptyPageXml();
            $empty = true;
        }
        $content = $this->getXMLContent();
        $this->buildDom(true);
        $dom_doc = $this->getDomDoc();
 
        $errors = $this->validateDom(true);
 
        $iel = $this->containsDeactivatedElements($content);
        $inl = $this->containsIntLinks($content);
        // create object
        $this->db->insert("page_object", array(
            "page_id" => array("integer", $this->getId()),
            "parent_id" => array("integer", $this->getParentId()),
            "lang" => array("text", $this->getLanguage()),
            "content" => array("clob", $content),
            "parent_type" => array("text", $this->getParentType()),
            "create_user" => array("integer", $this->user->getId()),
            "last_change_user" => array("integer", $this->user->getId()),
            "active" => array("integer", (int) $this->getActive()),
            "activation_start" => array("timestamp", $this->getActivationStart()),
            "activation_end" => array("timestamp", $this->getActivationEnd()),
            "show_activation_info" => array("integer", (int) $this->getShowActivationInfo()),
            "inactive_elements" => array("integer", $iel),
            "int_links" => array("integer", $inl),
            "created" => array("timestamp", ilUtil::now()),
            "last_change" => array("timestamp", ilUtil::now()),
            "is_empty" => array("integer", $empty)
        ));
        // after update event
        $this->__afterUpdate($dom_doc, $content, true, $empty);
    }

References ILIAS\Survey\Mode\getId(), getLanguage(), ilUtil\now(), and ILIAS\Repository\user().

Referenced by ilTestPage\createPageWithNextId().

Here is the call graph for this function:

Here is the caller graph for this function:

cutContents()

ilPageObject::cutContents

(

array

$a_hids

)

Copy contents to clipboard and cut them from the page.

Returns

array|bool

Exceptions

ilDateTimeException

Definition at line 1837 of file class.ilPageObject.php.

    {
        $this->copyContents($a_hids);
        return $this->deleteContents(
            $a_hids,
            true,
            $this->getPageConfig()->getEnableSelfAssessment(),
            true
        );
    }

delete()

ilPageObject::delete

(

)

Reimplemented in ilBlogPosting, ilPortfolioPage, and ilWikiPage.

Definition at line 1588 of file class.ilPageObject.php.

                            : void
    {
        $copg_logger = ilLoggerFactory::getLogger('copg');
        $copg_logger->debug(
            "ilPageObject: Delete called for ID '" . $this->getId() . "'," .
            " parent type: '" . $this->getParentType() . "', " .
            " hist nr: '" . $this->old_nr . "', " .
            " lang: '" . $this->getLanguage() . "', "
        );
 
        $mobs = array();
        if (!$this->page_not_found) {
            $this->buildDom();
            $mobs = $this->collectMediaObjects(false);
        }
        $mobs2 = ilObjMediaObject::_getMobsOfObject(
            $this->getParentType() . ":pg",
            $this->getId(),
            false,
            $this->getLanguage()
        );
 
        foreach ($mobs2 as $m) {
            if (!in_array($m, $mobs)) {
                $mobs[] = $m;
            }
        }
 
        $copg_logger->debug("ilPageObject: ... found " . count($mobs) . " media objects.");
 
        $this->__beforeDelete();
 
        // treat plugged content
        $this->handleDeleteContent();
 
        // delete style usages
        $this->deleteStyleUsages(false);
 
        // delete internal links
        $this->deleteInternalLinks();
 
        // delete all mob usages
        ilObjMediaObject::_deleteAllUsages($this->getParentType() . ":pg", $this->getId());
 
        // delete news
        if (!$this->isTranslationPage()) {
            ilNewsItem::deleteNewsOfContext(
                $this->getParentId(),
                $this->getParentType(),
                $this->getId(),
                "pg"
            );
        }
 
        // delete page_object entry
        $and = $this->isTranslationPage()
            ? " AND lang = " . $this->db->quote($this->getLanguage(), "text")
            : "";
        $this->db->manipulate("DELETE FROM page_object " .
            "WHERE page_id = " . $this->db->quote($this->getId(), "integer") .
            " AND parent_type= " . $this->db->quote($this->getParentType(), "text") . $and);
 
        // delete media objects
        foreach ($mobs as $mob_id) {
            $copg_logger->debug("ilPageObject: ... processing mob " . $mob_id . ".");
 
            if (ilObject::_lookupType($mob_id) != 'mob') {
                $copg_logger->debug("ilPageObject: ... type mismatch. Ignoring mob " . $mob_id . ".");
                continue;
            }
 
            if (ilObject::_exists($mob_id)) {
                $copg_logger->debug("ilPageObject: ... delete mob " . $mob_id . ".");
 
                $mob_obj = new ilObjMediaObject($mob_id);
                $mob_obj->delete();
            } else {
                $copg_logger->debug("ilPageObject: ... missing mob " . $mob_id . ".");
            }
        }
 
        $this->__afterDelete();
    }

References ilObjMediaObject\_deleteAllUsages(), ilObject\_exists(), ilObjMediaObject\_getMobsOfObject(), ilObject\_lookupType(), ilNewsItem\deleteNewsOfContext(), ILIAS\Survey\Mode\getId(), getLanguage(), and ilLoggerFactory\getLogger().

Here is the call graph for this function:

deleteContent()

ilPageObject::deleteContent	(	string	$a_hid,
		bool	$a_update = true,
		string	$a_pcid = "",
		bool	$move_operation = false
	)

delete content object with hierarchical id $a_hid

Returns

array|bool

Exceptions

ilDateTimeException
ilWACException

Definition at line 1797 of file class.ilPageObject.php.

      {
        $pm = $this->page_manager->content($this->getDomDoc());
        $pm->deleteContent($this, $a_hid, $a_pcid, $move_operation);
        if ($a_update) {
            return $this->update();
        }
        return true;
    }

deleteContents()

ilPageObject::deleteContents	(	array	$a_hids,
		bool	$a_update = true,
		bool	$a_self_ass = false,
		bool	$move_operation = false
	)

Delete multiple content objects.

Parameters

bool

$a_update

update page in db (note: update deletes all hierarchical ids in DOM!)

Returns

array|bool

Exceptions

ilDateTimeException

Definition at line 1818 of file class.ilPageObject.php.

      {
        $pm = $this->page_manager->content($this->getDomDoc());
        $pm->deleteContents($this, $a_hids, $a_self_ass, $move_operation);
        if ($a_update) {
            return $this->update();
        }
        return true;
    }

Referenced by ILIAS\COPage\PC\Paragraph\ParagraphCommandActionHandler\cancelCommand(), ILIAS\COPage\PC\Paragraph\ParagraphCommandActionHandler\deleteCommand(), and ILIAS\COPage\PC\Paragraph\ParagraphCommandActionHandler\mergePrevious().

Here is the caller graph for this function:

deleteInternalLinks()

ilPageObject::deleteInternalLinks

(

)

Delete internal links.

Definition at line 1765 of file class.ilPageObject.php.

                                         : void
    {
        $this->link->deleteInternalLinks($this);
    }

References ILIAS\Repository\link().

Here is the call graph for this function:

deleteStyleUsages()

ilPageObject::deleteStyleUsages

(

int

$a_old_nr = 0

)

Delete style usages.

Definition at line 1738 of file class.ilPageObject.php.

                                                        : void
    {
        $this->style_manager->deleteStyleUsages($this, $a_old_nr);
    }

freeDom()

ilPageObject::freeDom

(

)

Definition at line 411 of file class.ilPageObject.php.

                             : void
    {
        unset($this->dom);
    }

generatePCId()

ilPageObject::generatePCId

(

)

Definition at line 2010 of file class.ilPageObject.php.

                                  : string
    {
        return $this->content_id_manager->generatePCId();
    }

getActivationEnd()

ilPageObject::getActivationEnd

(

)

Definition at line 704 of file class.ilPageObject.php.

                                      : ?string
    {
        return $this->activationend;
    }

getActivationStart()

ilPageObject::getActivationStart

(

)

Definition at line 687 of file class.ilPageObject.php.

                                        : ?string
    {
        return $this->activationstart;
    }

getActive()

ilPageObject::getActive

(

bool

$a_check_scheduled_activation = false

)

Definition at line 474 of file class.ilPageObject.php.

     : bool {
        if ($a_check_scheduled_activation && !$this->active) {
            $start = new ilDateTime($this->getActivationStart(), IL_CAL_DATETIME);
            $end = new ilDateTime($this->getActivationEnd(), IL_CAL_DATETIME);
            $now = new ilDateTime(time(), IL_CAL_UNIX);
            if (!ilDateTime::_before($now, $start) && !ilDateTime::_after($now, $end)) {
                return true;
            }
        }
        return $this->active;
    }

References ilDateTime\_after(), ilDateTime\_before(), IL_CAL_DATETIME, and IL_CAL_UNIX.

Referenced by ILIAS\Blog\News\NewsManager\handle().

Here is the call graph for this function:

Here is the caller graph for this function:

getAllPages()

static ilPageObject::getAllPages ( string  $a_parent_type, int  $a_parent_id, string  $a_lang = "-"  )

static

Get all pages for parent object.

Definition at line 2285 of file class.ilPageObject.php.

     : array {
        global $DIC;
 
        $db = $DIC->database();
 
        $and_lang = "";
        if ($a_lang != "") {
            $and_lang = " AND lang = " . $db->quote($a_lang, "text");
        }
 
        $q = "SELECT * FROM page_object " .
            " WHERE parent_id = " . $db->quote($a_parent_id, "integer") .
            " AND parent_type = " . $db->quote($a_parent_type, "text") . $and_lang;
        $set = $db->query($q);
        $pages = array();
        while ($page = $db->fetchAssoc($set)) {
            $key_add = ($a_lang == "")
                ? ":" . $page["lang"]
                : "";
            $pages[$page["page_id"] . $key_add] = array(
                "date" => $page["last_change"],
                "id" => $page["page_id"],
                "lang" => $page["lang"],
                "user" => $page["last_change_user"]
            );
        }
 
        return $pages;
    }

References ilDBInterface\quote().

Referenced by ilForumPageCollector\getAllPageIds(), ilContentPagePageCollector\getAllPageIds(), ilLearningModulePageCollector\getAllPageIds(), and ilCourseExporter\getXmlExportTailDependencies().

Here is the call graph for this function:

Here is the caller graph for this function:

getAllPCIds()

ilPageObject::getAllPCIds

(

)

Get all pc ids.

Definition at line 1991 of file class.ilPageObject.php.

                                 : array
    {
        return $this->content_id_manager->getAllPCIds();
    }

Referenced by ilDclDetailedViewDefinition\isActive().

Here is the caller graph for this function:

getConcreteLang()

ilPageObject::getConcreteLang

(

)

Definition at line 213 of file class.ilPageObject.php.

                                     : string
    {
        return $this->concrete_lang;
    }

getContainsQuestion()

ilPageObject::getContainsQuestion

(

)

Definition at line 1063 of file class.ilPageObject.php.

                                         : bool
    {
        return $this->contains_question;
    }

getContentDomNode()

ilPageObject::getContentDomNode	(	string	$a_hier_id,
		string	$a_pc_id = ""
	)

Definition at line 753 of file class.ilPageObject.php.

                                                                              : ?DOMNode
    {
        $cm = $this->page_manager->content($this->getDomDoc());
        return $cm->getContentDomNode($a_hier_id, $a_pc_id);
    }

Referenced by PCGridTest\getCellForHierId(), PCFileListTest\getItemForHierId(), PCListTest\getItemForHierId(), PCTabsTest\getTabForHierId(), and PCTableDataTest\getTDForHierId().

Here is the caller graph for this function:

getContentManager()

ilPageObject::getContentManager ( )

protected

Definition at line 2567 of file class.ilPageObject.php.

                                          : \ILIAS\COPage\Page\PageContentManager
    {
        $this->buildDom();
        return $this->page_manager->content($this->getDomDoc());
    }

getContentObject()

ilPageObject::getContentObject	(	string	$a_hier_id,
		string	$a_pc_id = ""
	)

Get a content object of the page.

Definition at line 712 of file class.ilPageObject.php.

     : ?ilPageContent {
        $node = $this->page_manager->content($this->getDomDoc())->getContentDomNode(
            $a_hier_id,
            $a_pc_id
        );
        $this->log->debug("getContentObject: " . " $a_hier_id, $a_pc_id, " . $node->nodeName);
        return $this->pc_service->getByNode($node, $this);
    }

Referenced by ilPCParagraph\insert(), and ilPCParagraph\saveJS().

Here is the caller graph for this function:

getContentObjectForPcId()

ilPageObject::getContentObjectForPcId

(

string

$pcid

)

Get content object for pc id.

Definition at line 727 of file class.ilPageObject.php.

                                                         : ?ilPageContent
    {
        $hier_ids = $this->getHierIdsForPCIds([$pcid]);
        return $this->getContentObject($hier_ids[$pcid], $pcid);
    }

Referenced by ILIAS\COPage\PC\Paragraph\ParagraphCommandActionHandler\cancelCommand(), ilPCTableModelProvider\getModels(), and ilDclDetailedViewDefinition\isActive().

Here is the caller graph for this function:

getContentTemplates()

ilPageObject::getContentTemplates

(

)

Get content templates.

Returns

array array of arrays with "id" => page id (int), "parent_type" => parent type (string), "title" => title (string)

Reimplemented in ilWikiPage.

Definition at line 2940 of file class.ilPageObject.php.

                                         : array
    {
        return array();
    }

getCreationUserId()

ilPageObject::getCreationUserId

(

)

Definition at line 283 of file class.ilPageObject.php.

                                       : int
    {
        return $this->create_user;
    }

getDomDoc()

ilPageObject::getDomDoc

(

)

Get dom doc (DOMDocument)

Definition at line 419 of file class.ilPageObject.php.

                               : DOMDocument
    {
        return $this->dom;
    }

Referenced by ilPageContentGUI\__construct(), ilPageContent\__construct(), ilContainerPage\addRepositoryBlockToPage(), ILIAS\COPage\ID\ContentIdManager\checkPCIds(), ILIAS\COPage\ID\ContentIdManager\getAllPCIds(), ILIAS\COPage\PC\Paragraph\ParagraphManager\getFirstParagraphText(), ILIAS\COPage\Compare\PageCompare\getPageContentsHashes(), ILIAS\COPage\PC\Paragraph\ParagraphManager\getParagraphForPCID(), ILIAS\COPage\ID\ContentIdManager\getPCIdsForHierIds(), and ilContainerPage\removeUnsupportedBlockIds().

Here is the caller graph for this function:

getDomNodeForPCId()

ilPageObject::getDomNodeForPCId

(

string

$pc_id

)

Definition at line 759 of file class.ilPageObject.php.

                                                    : ?DOMNode
    {
        return $this->getContentDomNode("", $pc_id);
    }

getDuplicatePCIds()

ilPageObject::getDuplicatePCIds

(

)

Get all duplicate PC Ids.

Returns

int[]

Definition at line 2005 of file class.ilPageObject.php.

                                       : array
    {
        return $this->content_id_manager->getDuplicatePCIds();
    }

getEditLock()

ilPageObject::getEditLock

(

)

Get page lock.

Definition at line 2718 of file class.ilPageObject.php.

                                 : bool
    {
        $db = $this->db;
        $user = $this->user;
 
        $min = $this->getEffectiveEditLockTime();
        if ($min > 0) {
            // try to set the lock for the user
            $ts = time();
            $db->manipulate(
                "UPDATE page_object SET " .
                " edit_lock_user = " . $db->quote($user->getId(), "integer") . "," .
                " edit_lock_ts = " . $db->quote($ts, "integer") .
                " WHERE (edit_lock_user = " . $db->quote($user->getId(), "integer") . " OR " .
                " edit_lock_ts < " . $db->quote(time() - ($min * 60), "integer") . ") " .
                " AND page_id = " . $db->quote($this->getId(), "integer") .
                " AND parent_type = " . $db->quote($this->getParentType(), "text")
            );
 
            $set = $db->query(
                "SELECT edit_lock_user FROM page_object " .
                " WHERE page_id = " . $db->quote($this->getId(), "integer") .
                " AND parent_type = " . $db->quote($this->getParentType(), "text")
            );
            $rec = $db->fetchAssoc($set);
            if ($rec["edit_lock_user"] != $user->getId()) {
                return false;
            }
        }
 
        return true;
    }

References ilDBInterface\fetchAssoc(), ilObject\getId(), ilDBInterface\manipulate(), ilDBInterface\query(), and ilDBInterface\quote().

Here is the call graph for this function:

getEditLockInfo()

ilPageObject::getEditLockInfo

(

)

Get edit lock info.

Definition at line 2790 of file class.ilPageObject.php.

                                     : array
    {
        $db = $this->db;
 
        $aset = new ilSetting("adve");
        $min = (int) $aset->get("block_mode_minutes");
 
        $set = $db->query(
            "SELECT edit_lock_user, edit_lock_ts FROM page_object " .
            " WHERE page_id = " . $db->quote($this->getId(), "integer") .
            " AND parent_type = " . $db->quote($this->getParentType(), "text")
        );
        $rec = $db->fetchAssoc($set);
        $rec["edit_lock_until"] = $rec["edit_lock_ts"] + $min * 60;
 
        return $rec;
    }

References ilDBInterface\fetchAssoc(), ILIAS\Repository\int(), ilDBInterface\query(), and ilDBInterface\quote().

Here is the call graph for this function:

getEffectiveEditLockTime()

ilPageObject::getEffectiveEditLockTime

(

)

Definition at line 2974 of file class.ilPageObject.php.

                                              : int
    {
        if ($this->getPageConfig()->getEditLockSupport() == false) {
            return 0;
        }
 
        $aset = new ilSetting("adve");
        $min = (int) $aset->get("block_mode_minutes");
 
        return $min;
    }

References ILIAS\Repository\int().

Here is the call graph for this function:

getFirstParagraphText()

ilPageObject::getFirstParagraphText

(

)

Definition at line 1003 of file class.ilPageObject.php.

                                           : string
    {
        return $this->pc_service->paragraph()->getFirstParagraphText($this);
    }

getHierIdForPcId()

ilPageObject::getHierIdForPcId

(

string

$pcid

)

Definition at line 1157 of file class.ilPageObject.php.

                                                  : string
    {
        return $this->content_id_manager->getHierIdForPcId($pcid);
    }

Referenced by ILIAS\COPage\PC\Paragraph\ParagraphCommandActionHandler\cancelCommand(), and ILIAS\COPage\PC\Paragraph\ParagraphCommandActionHandler\mergePrevious().

Here is the caller graph for this function:

getHierIds()

ilPageObject::getHierIds

(

)

Definition at line 1134 of file class.ilPageObject.php.

                                : array
    {
        return $this->content_id_manager->getHierIds();
    }

getHierIdsForPCIds()

ilPageObject::getHierIdsForPCIds

(

array

$a_pc_ids

)

Get hier ids for a set of pc ids.

Definition at line 1152 of file class.ilPageObject.php.

                                                       : array
    {
        return $this->content_id_manager->getHierIdsForPCIds($a_pc_ids);
    }

Referenced by ilPCMediaObjectGUI\__construct(), ILIAS\COPage\PC\Paragraph\ParagraphCommandActionHandler\getFullIdForPCId(), ILIAS\COPage\PC\Paragraph\ParagraphCommandActionHandler\getIdForPCId(), and ilPCParagraph\getLastSavedPCId().

Here is the caller graph for this function:

getHistoryEntries()

ilPageObject::getHistoryEntries

(

)

Get History Entries.

Definition at line 2088 of file class.ilPageObject.php.

                                       : array
    {
        $db = $this->db;
 
        $h_query = "SELECT * FROM page_history " .
            " WHERE page_id = " . $db->quote($this->getId(), "integer") .
            " AND parent_type = " . $db->quote($this->getParentType(), "text") .
            " AND lang = " . $db->quote($this->getLanguage(), "text") .
            " ORDER BY hdate DESC";
 
        $hset = $db->query($h_query);
        $hentries = array();
 
        while ($hrec = $db->fetchAssoc($hset)) {
            $hrec["sortkey"] = (int) $hrec["nr"];
            $hrec["user"] = (int) $hrec["user_id"];
            $hentries[] = $hrec;
        }
        //var_dump($hentries);
        return $hentries;
    }

References ilDBInterface\fetchAssoc(), ILIAS\Survey\Mode\getId(), getLanguage(), ILIAS\Repository\int(), ilDBInterface\query(), and ilDBInterface\quote().

Here is the call graph for this function:

getHistoryEntry()

ilPageObject::getHistoryEntry

(

int

$a_old_nr

)

Get History Entry.

Definition at line 2113 of file class.ilPageObject.php.

                                                  : ?array
    {
        $db = $this->db;
 
        $res = $db->queryF(
            "SELECT * FROM page_history " .
            " WHERE page_id = %s " .
            " AND parent_type = %s " .
            " AND nr = %s" .
            " AND lang = %s",
            array("integer", "text", "integer", "text"),
            array($this->getId(), $this->getParentType(), $a_old_nr, $this->getLanguage())
        );
        if ($hrec = $db->fetchAssoc($res)) {
            return $hrec;
        }
 
        return null;
    }

References $res, ilDBInterface\fetchAssoc(), ILIAS\Survey\Mode\getId(), getLanguage(), and ilDBInterface\queryF().

Here is the call graph for this function:

getHistoryInfo()

ilPageObject::getHistoryInfo

(

int

$a_nr

)

Get information about a history entry, its predecessor and its successor.

Parameters

int

$a_nr

Nr of history entry

Definition at line 2138 of file class.ilPageObject.php.

                                             : array
    {
        $db = $this->db;
 
        // determine previous entry
        $and_nr = ($a_nr > 0)
            ? " AND nr < " . $db->quote($a_nr, "integer")
            : "";
        $res = $db->query("SELECT MAX(nr) mnr FROM page_history " .
            " WHERE page_id = " . $db->quote($this->getId(), "integer") .
            " AND parent_type = " . $db->quote($this->getParentType(), "text") .
            " AND lang = " . $db->quote($this->getLanguage(), "text") .
            $and_nr);
        $row = $db->fetchAssoc($res);
        if ($row["mnr"] > 0) {
            $res = $db->query("SELECT * FROM page_history " .
                " WHERE page_id = " . $db->quote($this->getId(), "integer") .
                " AND parent_type = " . $db->quote($this->getParentType(), "text") .
                " AND lang = " . $db->quote($this->getLanguage(), "text") .
                " AND nr = " . $db->quote((int) $row["mnr"], "integer"));
            $row = $db->fetchAssoc($res);
            $ret["previous"] = $row;
        }
 
        // determine next entry
        $res = $db->query("SELECT MIN(nr) mnr FROM page_history " .
            " WHERE page_id = " . $db->quote($this->getId(), "integer") .
            " AND parent_type = " . $db->quote($this->getParentType(), "text") .
            " AND lang = " . $db->quote($this->getLanguage(), "text") .
            " AND nr > " . $db->quote($a_nr, "integer"));
        $row = $db->fetchAssoc($res);
        if ($row["mnr"] > 0) {
            $res = $db->query("SELECT * FROM page_history " .
                " WHERE page_id = " . $db->quote($this->getId(), "integer") .
                " AND parent_type = " . $db->quote($this->getParentType(), "text") .
                " AND lang = " . $db->quote($this->getLanguage(), "text") .
                " AND nr = " . $db->quote((int) $row["mnr"], "integer"));
            $row = $db->fetchAssoc($res);
            $ret["next"] = $row;
        }
 
        // current
        if ($a_nr > 0) {
            $res = $db->query("SELECT * FROM page_history " .
                " WHERE page_id = " . $db->quote($this->getId(), "integer") .
                " AND parent_type = " . $db->quote($this->getParentType(), "text") .
                " AND lang = " . $db->quote($this->getLanguage(), "text") .
                " AND nr = " . $db->quote($a_nr, "integer"));
        } else {
            $res = $db->query("SELECT page_id, last_change hdate, parent_type, parent_id, last_change_user user_id, content, lang FROM page_object " .
                " WHERE page_id = " . $db->quote($this->getId(), "integer") .
                " AND parent_type = " . $db->quote($this->getParentType(), "text") .
                " AND lang = " . $db->quote($this->getLanguage(), "text"));
        }
        $row = $db->fetchAssoc($res);
        $ret["current"] = $row;
 
        return $ret;
    }

References $res, ilDBInterface\fetchAssoc(), getLanguage(), ilDBInterface\query(), and ilDBInterface\quote().

Here is the call graph for this function:

getId()

ilPageObject::getId

(

)

Definition at line 429 of file class.ilPageObject.php.

                           : int
    {
        return $this->id;
    }

References $id.

Referenced by ilPCFileList\afterPageUpdate(), ilPCMediaObject\afterPageUpdate(), ilLMPage\afterUpdate(), ilPCContentInclude\beforePageDelete(), ilTestPage\createPageWithNextId(), ilDclDetailedViewDefinition\getAvailablePlaceholders(), ILIAS\COPage\ReadingTime\ReadingTimeManager\getTime(), ilMediaPoolPage\getUsages(), ILIAS\Blog\News\NewsManager\handle(), ilWikiStat\handlePageDeletion(), ilDclDetailedViewDefinition\isActive(), ILIAS\COPage\PC\MediaObject\MediaObjectManager\resolveMediaAliases(), ilPCParagraph\saveMetaKeywords(), ILIAS\COPage\ReadingTime\ReadingTimeManager\saveTime(), and ilPCSection\saveTimings().

Here is the caller graph for this function:

getIliasAbsolutePath()

ilPageObject::getIliasAbsolutePath ( )

protected

Reimplemented in ilUnitTestPageObject.

Definition at line 805 of file class.ilPageObject.php.

                                             : string
    {
        return ILIAS_ABSOLUTE_PATH;
    }

getImportMode()

ilPageObject::getImportMode

(

)

Definition at line 1041 of file class.ilPageObject.php.

                                   : bool
    {
        return $this->import_mode;
    }

getInitialOpenedContent()

ilPageObject::getInitialOpenedContent

(

)

Get initial opened content.

Definition at line 2589 of file class.ilPageObject.php.

                                             : array
    {
        $cm = $this->getContentManager();
        return $cm->getInitialOpenedContent();
    }

getInternalLinks()

ilPageObject::getInternalLinks

(

)

get all internal links that are used within the page

Definition at line 1082 of file class.ilPageObject.php.

                                      : array
    {
        return $this->link->getInternalLinks($this->getDomDoc());
    }

References ILIAS\Repository\link().

Here is the call graph for this function:

getLanguage()

ilPageObject::getLanguage

(

)

Definition at line 198 of file class.ilPageObject.php.

                                 : string
    {
        return $this->language;
    }

Referenced by ilPCFileList\afterPageUpdate(), ilPCMediaObject\afterPageUpdate(), ilPCContentInclude\beforePageDelete(), ILIAS\COPage\ReadingTime\ReadingTimeManager\getTime(), and ILIAS\COPage\ReadingTime\ReadingTimeManager\saveTime().

Here is the caller graph for this function:

getLanguageVariablesXML()

ilPageObject::getLanguageVariablesXML

(

int

$style_id = 0

)

Get language variables as XML.

Definition at line 903 of file class.ilPageObject.php.

                                                              : string
    {
        $xml = "<LVs>";
        $lang_vars = array(
            "ed_paste_clip",
            "ed_edit",
            "ed_edit_prop",
            "ed_delete",
            "ed_moveafter",
            "ed_movebefore",
            "ed_go",
            "ed_class",
            "ed_width",
            "ed_align_left",
            "ed_align_right",
            "ed_align_center",
            "ed_align_left_float",
            "ed_align_right_float",
            "ed_delete_item",
            "ed_new_item_before",
            "ed_new_item_after",
            "ed_copy_clip",
            "please_select",
            "ed_split_page",
            "ed_item_up",
            "ed_item_down",
            "ed_split_page_next",
            "ed_enable",
            "de_activate",
            "ed_paste",
            "ed_edit_multiple",
            "ed_cut",
            "ed_copy",
            "ed_insert_templ",
            "ed_click_to_add_pg",
            "download"
        );
 
        // collect lang vars from pc elements
        $defs = $this->pc_definition->getPCDefinitions();
        foreach ($defs as $def) {
            $lang_vars[] = "pc_" . $def["pc_type"];
            $lang_vars[] = "ed_insert_" . $def["pc_type"];
 
            $cl = $def["pc_class"];
            $lvs = call_user_func($def["pc_class"] . '::getLangVars');
            foreach ($lvs as $lv) {
                $lang_vars[] = $lv;
            }
        }
 
        // workaround for #30561, should go to characteristic manager
        $dummy_pc = new ilPCSectionGUI($this, null, "");
        $dummy_pc->setStyleId($style_id);
        foreach (["section", "table", "flist_li", "list_u", "list_o",
                  "table", "table_cell"] as $type) {
            $dummy_pc->getCharacteristicsOfCurrentStyle([$type]);
            foreach ($dummy_pc->getCharacteristics() as $char => $txt) {
                $xml .= "<LV name=\"char_" . $type . "_" . $char . "\" value=\"" . $txt . "\"/>";
            }
        }
        $type = "media_cont";
        $dummy_pc = new ilPCMediaObjectGUI($this, null, "");
        $dummy_pc->setStyleId($style_id);
        $dummy_pc->getCharacteristicsOfCurrentStyle([$type]);
        foreach ($dummy_pc->getCharacteristics() as $char => $txt) {
            $xml .= "<LV name=\"char_" . $type . "_" . $char . "\" value=\"" . $txt . "\"/>";
        }
        foreach (["text_block", "heading1", "heading2", "heading3"] as $type) {
            $dummy_pc = new ilPCParagraphGUI($this, null, "");
            $dummy_pc->setStyleId($style_id);
            $dummy_pc->getCharacteristicsOfCurrentStyle([$type]);
            foreach ($dummy_pc->getCharacteristics() as $char => $txt) {
                $xml .= "<LV name=\"char_" . $type . "_" . $char . "\" value=\"" . $txt . "\"/>";
            }
        }
        foreach ($lang_vars as $lang_var) {
            $xml .= $this->getLangVarXML($lang_var);
        }
        foreach ($this->pc_service->plugged()->getPluginLangVars() as $k => $v) {
            $xml .= $this->getLangVarXMLForValue($k, $v);
        }
        $xml .= "</LVs>";
        return $xml;
    }

References $txt.

getLangVarXML()

ilPageObject::getLangVarXML ( string  $var )

protected

Definition at line 989 of file class.ilPageObject.php.

                                                 : string
    {
        return $this->getLangVarXMLForValue(
            $var,
            $this->lng->txt("cont_" . $var)
        );
    }

References ILIAS\Repository\lng().

Here is the call graph for this function:

getLangVarXMLForValue()

ilPageObject::getLangVarXMLForValue ( string  $var, string  $val  )

protected

Definition at line 997 of file class.ilPageObject.php.

                                                                      : string
    {
        $val = str_replace('"', """, $val);
        return "<LV name=\"$var\" value=\"" . $val . "\"/>";
    }

getLastChange()

ilPageObject::getLastChange

(

)

Definition at line 258 of file class.ilPageObject.php.

                                   : string
    {
        return $this->lastchange;
    }

getLastChangeByParent()

static ilPageObject::getLastChangeByParent ( string  $a_parent_type, int  $a_parent_id, string  $a_lang = ""  )

static

Get all pages for parent object.

Definition at line 2948 of file class.ilPageObject.php.

     : string {
        global $DIC;
 
        $db = $DIC->database();
 
        $and_lang = "";
        if ($a_lang != "") {
            $and_lang = " AND lang = " . $db->quote($a_lang, "text");
        }
 
        $db->setLimit(1, 0);
        $q = "SELECT last_change FROM page_object " .
            " WHERE parent_id = " . $db->quote($a_parent_id, "integer") .
            " AND parent_type = " . $db->quote($a_parent_type, "text") . $and_lang .
            " ORDER BY last_change DESC";
 
        $set = $db->query($q);
        $rec = $db->fetchAssoc($set);
 
        return $rec["last_change"];
    }

References ilDBInterface\quote().

Referenced by ilWikiUserHTMLExport\getProcess().

Here is the call graph for this function:

Here is the caller graph for this function:

getLastChangeUser()

ilPageObject::getLastChangeUser

(

)

Definition at line 268 of file class.ilPageObject.php.

                                       : int
    {
        return $this->last_change_user;
    }

getLastUpdateOfIncludedElements()

ilPageObject::getLastUpdateOfIncludedElements

(

)

Get last update of included elements (media objects and files).

This is needed for cache logic, cache must be reloaded if anything has changed.

Todo:

: move to content include class

Definition at line 1748 of file class.ilPageObject.php.

                                                     : string
    {
        $mobs = ilObjMediaObject::_getMobsOfObject(
            $this->getParentType() . ":pg",
            $this->getId()
        );
        $files = ilObjFile::_getFilesOfObject(
            $this->getParentType() . ":pg",
            $this->getId()
        );
        $objs = array_merge($mobs, $files);
        return ilObject::_getLastUpdateOfObjects($objs);
    }

References ilObject\_getLastUpdateOfObjects(), ilObjMediaObject\_getMobsOfObject(), and ILIAS\Survey\Mode\getId().

Here is the call graph for this function:

getMediaAliasElement()

ilPageObject::getMediaAliasElement	(	int	$a_mob_id,
		int	$a_nr = 1
	)

get complete media object (alias) element

Definition at line 1101 of file class.ilPageObject.php.

                                                                      : string
    {
        $mob_manager = $this->pc_service->mediaObject();
        return $mob_manager->getMediaAliasElement(
            $this->getDomDoc(),
            $a_mob_id,
            $a_nr
        );
    }

getMultimediaXML()

ilPageObject::getMultimediaXML

(

bool

$offline = false

)

get a xml string that contains all media object elements, that are referenced by any media alias in the page

Definition at line 1091 of file class.ilPageObject.php.

     : string {
        $mob_manager = $this->pc_service->mediaObject();
        return $mob_manager->getMultimediaXML($this->getDomDoc(), $offline);
    }

getNewPages()

static ilPageObject::getNewPages ( string  $a_parent_type, int  $a_parent_id, string  $a_lang = "-"  )

static

Get new pages.

Definition at line 2322 of file class.ilPageObject.php.

     : array {
        global $DIC;
 
        $db = $DIC->database();
 
        $and_lang = "";
        if ($a_lang != "") {
            $and_lang = " AND lang = " . $db->quote($a_lang, "text");
        }
 
        $pages = array();
 
        $q = "SELECT * FROM page_object " .
            " WHERE parent_id = " . $db->quote($a_parent_id, "integer") .
            " AND parent_type = " . $db->quote($a_parent_type, "text") . $and_lang .
            " ORDER BY created DESC";
        $set = $db->query($q);
        while ($page = $db->fetchAssoc($set)) {
            if ($page["created"] != "") {
                $pages[] = array(
                    "created" => $page["created"],
                    "id" => $page["page_id"],
                    "lang" => $page["lang"],
                    "user" => $page["create_user"],
                );
            }
        }
 
        return $pages;
    }

References ilDBInterface\quote().

Here is the call graph for this function:

getOfflineHandler()

ilPageObject::getOfflineHandler

(

)

Definition at line 2039 of file class.ilPageObject.php.

                                       : ?object
    {
        return $this->offline_handler;
    }

getPageConfig()

ilPageObject::getPageConfig

(

)

Definition at line 218 of file class.ilPageObject.php.

                                   : ilPageConfig
    {
        return $this->page_config;
    }

Referenced by ilLMPage\afterConstructor(), and ilWikiPage\afterConstructor().

Here is the caller graph for this function:

getPageContributors()

static ilPageObject::getPageContributors ( string  $a_parent_type, int  $a_page_id, string  $a_lang = "-"  )

static

Get all contributors for parent object.

Definition at line 2428 of file class.ilPageObject.php.

     : array {
        global $DIC;
 
        $db = $DIC->database();
 
        $and_lang = "";
        if ($a_lang != "") {
            $and_lang = " AND lang = " . $db->quote($a_lang, "text");
        }
 
        $contributors = array();
        $set = $db->queryF(
            "SELECT last_change_user, lang FROM page_object " .
            " WHERE page_id = %s AND parent_type = %s " .
            " AND last_change_user != %s" . $and_lang,
            array("integer", "text", "integer"),
            array($a_page_id, $a_parent_type, 0)
        );
 
        while ($page = $db->fetchAssoc($set)) {
            if ($a_lang == "") {
                $contributors[$page["last_change_user"]][$page["lang"]] = 1;
            } else {
                $contributors[$page["last_change_user"]] = 1;
            }
        }
 
        $set = $db->queryF(
            "SELECT count(*) as cnt, lang, page_id, user_id FROM page_history " .
            " WHERE page_id = %s AND parent_type = %s AND user_id != %s " . $and_lang .
            " GROUP BY user_id, page_id, lang ",
            array("integer", "text", "integer"),
            array($a_page_id, $a_parent_type, 0)
        );
        while ($hpage = $db->fetchAssoc($set)) {
            if ($a_lang === "") {
                $contributors[$hpage["user_id"]][$page["lang"]] =
                    ($contributors[$hpage["user_id"]][$page["lang"]] ?? 0) + $hpage["cnt"];
            } else {
                $contributors[$hpage["user_id"]] =
                    ($contributors[$hpage["user_id"]] ?? 0) + $hpage["cnt"];
            }
        }
 
        $c = array();
        foreach ($contributors as $k => $co) {
            $name = ilObjUser::_lookupName($k);
            $c[] = array("user_id" => $k,
                         "pages" => $co,
                         "lastname" => $name["lastname"],
                         "firstname" => $name["firstname"]
            );
        }
 
        return $c;
    }

References ilDBInterface\quote().

Referenced by ilBlogPostingGUI\getPageHeading(), and ILIAS\Blog\News\NewsManager\handle().

Here is the call graph for this function:

Here is the caller graph for this function:

getPagesWithLinks()

static ilPageObject::getPagesWithLinks ( string  $a_parent_type, int  $a_parent_id, string  $a_lang = "-"  )

static

Get all pages for parent object that contain internal links.

Definition at line 2514 of file class.ilPageObject.php.

     : array {
        global $DIC;
 
        $db = $DIC->database();
 
        $and_lang = "";
        if ($a_lang != "") {
            $and_lang = " AND lang = " . $db->quote($a_lang, "text");
        }
 
        $q = "SELECT * FROM page_object " .
            " WHERE parent_id = " . $db->quote($a_parent_id, "integer") .
            " AND parent_type = " . $db->quote($a_parent_type, "text") .
            " AND int_links = " . $db->quote(1, "integer") . $and_lang;
        $set = $db->query($q);
        $pages = array();
        while ($page = $db->fetchAssoc($set)) {
            $key_add = ($a_lang == "")
                ? ":" . $page["lang"]
                : "";
            $pages[$page["page_id"] . $key_add] = array(
                "date" => $page["last_change"],
                "id" => $page["page_id"],
                "lang" => $page["lang"],
                "user" => $page["last_change_user"]
            );
        }
 
        return $pages;
    }

References ilDBInterface\quote().

Here is the call graph for this function:

getParagraphForPCID()

ilPageObject::getParagraphForPCID

(

string

$pcid

)

Definition at line 1008 of file class.ilPageObject.php.

                                                     : ?ilPCParagraph
    {
        return $this->pc_service->paragraph()->getParagraphForPCID($this, $pcid);
    }

getParentContentObjectForPcId()

ilPageObject::getParentContentObjectForPcId

(

string

$pcid

)

Get parent content object for pc id.

Definition at line 736 of file class.ilPageObject.php.

                                                               : ?ilPageContent
    {
        $content_object = $this->getContentObjectForPcId($pcid);
        $node = $content_object->getDomNode();
        $node = $node->parentNode;
        while ($node) {
            if ($node->nodeName == "PageContent") {
                $pcid = $node->getAttribute("PCID");
                if ($pcid != "") {
                    return $this->getContentObjectForPcId($pcid);
                }
            }
            $node = $node->parentNode;
        }
        return null;
    }

Referenced by ILIAS\COPage\PC\Paragraph\ParagraphCommandActionHandler\cancelCommand().

Here is the caller graph for this function:

getParentId()

ilPageObject::getParentId

(

)

Definition at line 439 of file class.ilPageObject.php.

                                 : int
    {
        return $this->parent_id;
    }

Referenced by ilLMPage\afterConstructor(), ilWikiPage\afterConstructor(), ilLMPage\afterDelete(), ilLMPage\afterUpdate(), ilGlossaryDefPage\beforePageContentUpdate(), ilLMPage\beforePageContentUpdate(), ilBlogPosting\getBlogId(), ilWikiPage\getWikiId(), and ilPCParagraph\saveMetaKeywords().

Here is the caller graph for this function:

getParentObjectContributors()

static ilPageObject::getParentObjectContributors ( string  $a_parent_type, int  $a_parent_id, string  $a_lang = "-"  )

static

Get all contributors for parent object.

Parameters

string	$a_parent_type	Parent Type
int	$a_parent_id	Parent ID

Definition at line 2362 of file class.ilPageObject.php.

     : array {
        global $DIC;
 
        $db = $DIC->database();
 
        $and_lang = "";
        if ($a_lang != "") {
            $and_lang = " AND lang = " . $db->quote($a_lang, "text");
        }
 
        $contributors = array();
        $set = $db->queryF(
            "SELECT last_change_user, lang, page_id FROM page_object " .
            " WHERE parent_id = %s AND parent_type = %s " .
            " AND last_change_user != %s" . $and_lang,
            array("integer", "text", "integer"),
            array($a_parent_id, $a_parent_type, 0)
        );
 
        while ($page = $db->fetchAssoc($set)) {
            if ($a_lang == "") {
                $contributors[$page["last_change_user"]][$page["page_id"]][$page["lang"]] = 1;
            } else {
                $contributors[$page["last_change_user"]][$page["page_id"]] = 1;
            }
        }
 
        $set = $db->queryF(
            "SELECT count(*) as cnt, lang, page_id, user_id FROM page_history " .
            " WHERE parent_id = %s AND parent_type = %s AND user_id != %s " . $and_lang .
            " GROUP BY page_id, user_id, lang ",
            array("integer", "text", "integer"),
            array($a_parent_id, $a_parent_type, 0)
        );
        while ($hpage = $db->fetchAssoc($set)) {
            if ($a_lang == "") {
                $contributors[$hpage["user_id"]][$hpage["page_id"]][$hpage["lang"]] =
                    ($contributors[$hpage["user_id"]][$hpage["page_id"]][$hpage["lang"]] ?? 0) + $hpage["cnt"];
            } else {
                $contributors[$hpage["user_id"]][$hpage["page_id"]] =
                    ($contributors[$hpage["user_id"]][$hpage["page_id"]] ?? 0) + $hpage["cnt"];
            }
        }
 
        $c = array();
        foreach ($contributors as $k => $co) {
            if (ilObject::_lookupType($k) == "usr") {
                $name = ilObjUser::_lookupName($k);
                $c[] = array("user_id" => $k,
                             "pages" => $co,
                             "lastname" => $name["lastname"],
                             "firstname" => $name["firstname"]
                );
            }
        }
 
        return $c;
    }

References ilDBInterface\quote().

Here is the call graph for this function:

getParentType()

ilPageObject::getParentType ( )

abstract

Reimplemented in ilLoginPage, ilLogoutPage, ilBlogPosting, ilContainerPage, ilContainerStartObjectsPage, ilContentPagePage, ilPageLayoutPage, ilUnitTestPageObject, ilLOPage, ilDashboardPage, ilDclDetailedViewDefinition, ilForumPage, ilGlossaryDefPage, ilImprint, ilLMPage, ilLSOExtroPage, ilLSOIntroPage, ilMediaPoolPage, ilPortfolioPage, ilPortfolioTemplatePage, ilTestPage, ilAssQuestionPage, ilAssGenFeedbackPage, ilAssSpecFeedbackPage, and ilWikiPage.

Referenced by __construct(), ilPCFileList\afterPageUpdate(), ilPCMediaObject\afterPageUpdate(), ilPCContentInclude\beforePageDelete(), ILIAS\COPage\ReadingTime\ReadingTimeManager\getTime(), ILIAS\COPage\PC\MediaObject\MediaObjectManager\resolveMediaAliases(), ilPCParagraph\saveMetaKeywords(), ILIAS\COPage\ReadingTime\ReadingTimeManager\saveTime(), and ilPCSection\saveTimings().

Here is the caller graph for this function:

getPCIdForHierId()

ilPageObject::getPCIdForHierId

(

string

$hier_id

)

Definition at line 1170 of file class.ilPageObject.php.

                                                     : string
    {
        return $this->content_id_manager->getPCIdForHierId($hier_id);
    }

Referenced by PCGridTest\getCellForHierId(), PCInteractiveImageTest\getInteractiveImageInPage(), PCFileListTest\getItemForHierId(), PCListTest\getItemForHierId(), PCMediaObjectTest\getMediaObjectInPage(), PCTabsTest\getTabForHierId(), and PCTableDataTest\getTDForHierId().

Here is the caller graph for this function:

getPCIdsForHierIds()

ilPageObject::getPCIdsForHierIds

(

array

$hier_ids

)

Get hier ids for a set of pc ids.

Definition at line 1165 of file class.ilPageObject.php.

                                                       : array
    {
        return $this->content_id_manager->getPCIdsForHierIds($hier_ids);
    }

getPCModel()

ilPageObject::getPCModel

(

)

Get page component model.

Returns

array

Definition at line 3007 of file class.ilPageObject.php.

                                : array
    {
        $model = [];
        /*
        $this->log->debug("--- Get page model start");
        $model = [];
        foreach ($this->getAllPCIds() as $pc_id) {
            $co = $this->getContentObjectForPcId($pc_id);
            if ($co !== null) {
                $co_model = $co->getModel();
                if ($co_model !== null) {
                    $model[$pc_id] = $co_model;
                }
            }
        }
        $this->log->debug("--- Get page model end");
        */
 
        $config = $this->getPageConfig();
        foreach ($this->pc_definition->getPCDefinitions() as $def) {
            $model_provider = $this->pc_definition->getPCModelProviderByName($def["name"]);
            if ($config->getEnablePCType($def["name"]) || $def["name"] === "PlaceHolder") {
                if (!is_null($model_provider)) {
                    foreach ($model_provider->getModels(
                        $this->dom_util,
                        $this
                    ) as $pc_id => $co_model) {
                        $model[$pc_id] = $co_model;
                    }
                }
            }
        }
        return $model;
    }

getRecentChanges()

static ilPageObject::getRecentChanges ( string  $a_parent_type, int  $a_parent_id, int  $a_period = 30, string  $a_lang = ""  )

static

Get recent pages changes for parent object.

Parameters

string	$a_parent_type	Parent Type
int	$a_parent_id	Parent ID
int	$a_period	Time Period

Definition at line 2222 of file class.ilPageObject.php.

     : array {
        global $DIC;
 
        $db = $DIC->database();
 
        $and_lang = "";
        if ($a_lang != "") {
            $and_lang = " AND lang = " . $db->quote($a_lang, "text");
        }
 
        $page_changes = array();
        $limit_ts = date('Y-m-d H:i:s', time() - ($a_period * 24 * 60 * 60));
        $q = "SELECT * FROM page_object " .
            " WHERE parent_id = " . $db->quote($a_parent_id, "integer") .
            " AND parent_type = " . $db->quote($a_parent_type, "text") .
            " AND last_change >= " . $db->quote($limit_ts, "timestamp") . $and_lang;
        //      " AND (TO_DAYS(now()) - TO_DAYS(last_change)) <= ".((int)$a_period);
        $set = $db->query($q);
        while ($page = $db->fetchAssoc($set)) {
            $page_changes[] = array(
                "date" => $page["last_change"],
                "id" => $page["page_id"],
                "lang" => $page["lang"],
                "type" => "page",
                "user" => $page["last_change_user"]
            );
        }
 
        $and_str = "";
        if ($a_period > 0) {
            $limit_ts = date('Y-m-d H:i:s', time() - ($a_period * 24 * 60 * 60));
            $and_str = " AND hdate >= " . $db->quote($limit_ts, "timestamp") . " ";
        }
 
        $q = "SELECT * FROM page_history " .
            " WHERE parent_id = " . $db->quote($a_parent_id, "integer") .
            " AND parent_type = " . $db->quote($a_parent_type, "text") .
            $and_str . $and_lang;
        $set = $db->query($q);
        while ($page = $db->fetchAssoc($set)) {
            $page_changes[] = array(
                "date" => $page["hdate"],
                "id" => $page["page_id"],
                "lang" => $page["lang"],
                "type" => "hist",
                "nr" => $page["nr"],
                "user" => $page["user_id"]
            );
        }
 
        $page_changes = ilArrayUtil::sortArray($page_changes, "date", "desc");
 
        return $page_changes;
    }

References ilDBInterface\quote().

Here is the call graph for this function:

getRenderedContent()

ilPageObject::getRenderedContent

(

)

Definition at line 238 of file class.ilPageObject.php.

                                        : string
    {
        return $this->renderedcontent;
    }

getRenderedTime()

ilPageObject::getRenderedTime

(

)

Definition at line 248 of file class.ilPageObject.php.

                                     : string
    {
        return $this->renderedtime;
    }

getRenderMd5()

ilPageObject::getRenderMd5

(

)

Definition at line 228 of file class.ilPageObject.php.

                                  : string
    {
        return $this->rendermd5;
    }

getRepoObjId()

ilPageObject::getRepoObjId

(

)

Get object id of repository object that contains this page, return 0 if page does not belong to a repo object.

Definition at line 2998 of file class.ilPageObject.php.

                                  : ?int
    {
        return $this->getParentId();
    }

getShowActivationInfo()

ilPageObject::getShowActivationInfo

(

)

Definition at line 278 of file class.ilPageObject.php.

                                           : bool
    {
        return $this->show_page_act_info;
    }

getXMLContent()

ilPageObject::getXMLContent

(

bool

$a_incl_head = false

)

get xml content of page

Definition at line 788 of file class.ilPageObject.php.

                                                            : string
    {
        // build full http path for XML DOCTYPE header.
        // Under windows a relative path doesn't work :-(
        if ($a_incl_head) {
            //echo "+".$this->encoding."+";
            $enc_str = (!empty($this->encoding))
                ? "encoding=\"" . $this->encoding . "\""
                : "";
            return "<?xml version=\"1.0\" $enc_str ?>" .
                "<!DOCTYPE PageObject SYSTEM \"" . $this->getIliasAbsolutePath() . "/components/ILIAS/Export/xml/" . $this->cur_dtd . "\">" .
                $this->xml;
        } else {
            return $this->xml;
        }
    }

getXMLFromDom()

ilPageObject::getXMLFromDom	(	bool	$a_incl_head = false,
		bool	$a_append_mobs = false,
		bool	$a_append_bib = false,
		string	$a_append_str = "",
		bool	$a_omit_pageobject_tag = false,
		int	$style_id = 0,
		bool	$offline = false
	)

get xml content of page from dom (use this, if any changes are made to the document)

Definition at line 850 of file class.ilPageObject.php.

     : string {
        if ($a_incl_head) {
            //echo "\n<br>#".$this->encoding."#";
            return $this->dom_util->dump($this->node);
        } else {
            // append multimedia object elements
            if ($a_append_mobs || $a_append_bib) {
                $mobs = "";
                $bibs = "";
                if ($a_append_mobs) {
                    $mobs = $this->getMultimediaXML($offline);
                }
                if ($a_append_bib) {
                    // deprecated
                    //                                  $bibs = $this->getBibliographyXML();
                }
                $trans = $this->getLanguageVariablesXML($style_id);
                //echo htmlentities($this->dom->dump_node($this->node)); exit;
                return "<dummy>" . $this->dom_util->dump($this->node) . $mobs . $bibs . $trans . $a_append_str . "</dummy>";
            } else {
                if (is_object($this->dom)) {
                    if ($a_omit_pageobject_tag) {
                        $xml = "";
                        foreach ($this->node->childNodes as $child) {
                            $xml .= $this->dom_util->dump($child);
                        }
                    } else {
                        $xml = $this->dom_util->dump($this->node);
                        $xml = preg_replace('/<\?xml[^>]*>/i', "", $xml);
                        $xml = preg_replace('/<!DOCTYPE[^>]*>/i', "", $xml);
 
                        // don't use dump_node. This gives always entities.
                        //return $this->dom->dump_node($this->node);
                    }
                    return $xml;
                } else {
                    return "";
                }
            }
        }
    }

Referenced by ILIAS\COPage\ReadingTime\ReadingTimeManager\saveTime().

Here is the caller graph for this function:

handleDeleteContent()

ilPageObject::handleDeleteContent	(	?DOMNode	$a_node = null,
			$move_operation = false
	)

Handle content before deletion This currently treats only plugged content If no node is given, then the whole dom will be scanned.

Parameters

DOMNode | null

$a_node

Definition at line 840 of file class.ilPageObject.php.

                                                                                         : void
    {
        $pm = $this->page_manager->content($this->getDomDoc());
        $pm->handleDeleteContent($this, $a_node, $move_operation);
    }

handleRepositoryLinksOnCopy()

ilPageObject::handleRepositoryLinksOnCopy	(	array	$a_mapping,
		int	$a_source_ref_id
	)

Handle repository links on copy process.

Definition at line 1263 of file class.ilPageObject.php.

     : void {
        $this->buildDom();
 
        $tree = $this->tree;
        $this->log->debug("Handle repository links...");
 
        $defs = $this->pc_definition->getPCDefinitions();
        foreach ($defs as $def) {
            if (method_exists($def["pc_class"], 'afterRepositoryCopy')) {
                call_user_func($def["pc_class"] . '::afterRepositoryCopy', $this, $a_mapping, $a_source_ref_id);
            }
        }
 
        $this->link->handleRepositoryLinksOnCopy($this->getDomDoc(), $a_mapping, $a_source_ref_id, $tree);
    }

hasDuplicatePCIds()

ilPageObject::hasDuplicatePCIds

(

)

Definition at line 1996 of file class.ilPageObject.php.

                                       : bool
    {
        return $this->content_id_manager->hasDuplicatePCIds();
    }

increaseViewCnt()

ilPageObject::increaseViewCnt

(

)

Increase view cnt.

Definition at line 2205 of file class.ilPageObject.php.

                                     : void
    {
        $db = $this->db;
 
        $db->manipulate("UPDATE page_object " .
            " SET view_cnt = view_cnt + 1 " .
            " WHERE page_id = " . $db->quote($this->getId(), "integer") .
            " AND parent_type = " . $db->quote($this->getParentType(), "text") .
            " AND lang = " . $db->quote($this->getLanguage(), "text"));
    }

References ilDBInterface\manipulate(), and ilDBInterface\quote().

Here is the call graph for this function:

initPageConfig()

ilPageObject::initPageConfig

(

)

Reimplemented in ilUnitTestPageObject.

Definition at line 183 of file class.ilPageObject.php.

                                    : void
    {
        $cfg = ilPageObjectFactory::getConfigInstance($this->getParentType());
        $this->setPageConfig($cfg);
    }

References ilPageObjectFactory\getConfigInstance().

Referenced by __construct().

Here is the call graph for this function:

Here is the caller graph for this function:

insertContent()

ilPageObject::insertContent	(	ilPageContent	$a_cont_obj,
		string	$a_pos,
		int	$a_mode = IL_INSERT_AFTER,
		string	$a_pcid = "",
		bool	$remove_placeholder = true
	)

insert a content node before/after a sibling or as first child of a parent

Definition at line 1900 of file class.ilPageObject.php.

     : void {
        $cm = $this->page_manager->content($this->getDomDoc());
        $cm->insertContent(
            $a_cont_obj,
            $a_pos,
            $a_mode,
            $a_pcid,
            $remove_placeholder,
            $this->getPageConfig()->getEnablePCType("PlaceHolder")
        );
    }

Referenced by ilPCLearningHistory\create().

Here is the caller graph for this function:

insertContentNode()

ilPageObject::insertContentNode	(	DOMNode	$a_cont_node,
		string	$a_pos,
		int	$a_mode = IL_INSERT_AFTER,
		string	$a_pcid = ""
	)

insert a content node before/after a sibling or as first child of a parent

Definition at line 1921 of file class.ilPageObject.php.

     : void {
        $cm = $this->page_manager->content($this->getDomDoc());
        $cm->insertContentNode(
            $a_cont_node,
            $a_pos,
            $a_mode,
            $a_pcid
        );
    }

insertInstIntoIDs()

ilPageObject::insertInstIntoIDs	(	string	$a_inst,
		bool	$a_res_ref_to_obj_id = true
	)

inserts installation id into ids (e.g.

il__pg_4 -> il_23_pg_4) this is needed for xml export of page

Parameters

string	$a_inst	installation id
bool	$a_res_ref_to_obj_id	convert repository links obj_<ref_id> to <type>_<obj_id>

Definition at line 1972 of file class.ilPageObject.php.

     : void {
        $cm = $this->page_manager->content($this->getDomDoc());
        $cm->insertInstIntoIDs($a_inst, $a_res_ref_to_obj_id);
    }

insertPCIds()

ilPageObject::insertPCIds

(

)

Insert Page Content IDs.

Definition at line 2018 of file class.ilPageObject.php.

                                 : void
    {
        $this->content_id_manager->insertPCIds();
    }

Referenced by PCInteractiveImageTest\getInteractiveImageInPage(), PCMediaObjectTest\getMediaObjectInPage(), and PCTabsTest\getTabForHierId().

Here is the caller graph for this function:

isTranslationPage()

ilPageObject::isTranslationPage ( )

protected

Definition at line 1672 of file class.ilPageObject.php.

                                          : bool
    {
        return !in_array($this->getLanguage(), ["", "-"]);
    }

References getLanguage().

Here is the call graph for this function:

lookupParentId()

static ilPageObject::lookupParentId ( int  $a_id, string  $a_type  )

static

Definition at line 651 of file class.ilPageObject.php.

                                                                    : int
    {
        global $DIC;
 
        $db = $DIC->database();
 
        $res = $db->query("SELECT parent_id FROM page_object WHERE page_id = " . $db->quote($a_id, "integer") . " " .
            "AND parent_type=" . $db->quote($a_type, "text"));
        $rec = $db->fetchAssoc($res);
        return (int) ($rec["parent_id"] ?? 0);
    }

References $DIC, $res, ilDBInterface\fetchAssoc(), ilDBInterface\query(), and ilDBInterface\quote().

Referenced by ilLMContentRendererGUI\determineStatus(), and ilLMPageGUI\processAnswer().

Here is the call graph for this function:

Here is the caller graph for this function:

lookupTranslations()

static ilPageObject::lookupTranslations ( string  $a_parent_type, int  $a_id  )

static

Lookup translations.

Definition at line 2664 of file class.ilPageObject.php.

     : array {
        global $DIC;
 
        $db = $DIC->database();
 
        $set = $db->query(
            "SELECT lang FROM page_object " .
            " WHERE page_id = " . $db->quote($a_id, "integer") .
            " AND parent_type = " . $db->quote($a_parent_type, "text")
        );
        $langs = array();
        while ($rec = $db->fetchAssoc($set)) {
            $langs[] = $rec["lang"];
        }
        return $langs;
    }

Referenced by ilObjContentPage\doCloneObject(), ilContentPageImporter\finalProcessing(), ilCOPageExporter\getXmlRepresentation(), and ilLMObject\updateInternalLinks().

Here is the caller graph for this function:

moveContentAfter()

ilPageObject::moveContentAfter	(	string	$a_source,
		string	$a_target,
		string	$a_spcid = "",
		string	$a_tpcid = ""
	)

move content object from position $a_source before position $a_target (both hierarchical content ids)

Parameters

string	$a_source
string	$a_target
string	$a_spcid
string	$a_tpcid

Returns

array|bool

Exceptions

ilCOPagePCEditException
ilCOPageUnknownPCTypeException
ilDateTimeException

Definition at line 1949 of file class.ilPageObject.php.

      {
        $cm = $this->page_manager->content($this->getDomDoc());
        $cm->moveContentAfter(
            $this,
            $a_source,
            $a_target,
            $a_spcid,
            $a_tpcid
        );
        return $this->update();
    }

Referenced by ILIAS\COPage\PC\Paragraph\ParagraphCommandActionHandler\cancelCommand().

Here is the caller graph for this function:

moveIntLinks()

ilPageObject::moveIntLinks

(

array

$a_from_to

)

Move internal links from one destination to another.

This is used for pages and structure links. Just use IDs in "from" and "to".

Definition at line 1249 of file class.ilPageObject.php.

                                                  : bool
    {
        $this->buildDom();
        $this->addHierIDs();
        return $this->link->moveIntLinks(
            $this->getDomDoc(),
            $a_from_to
        );
    }

References ILIAS\Repository\link().

Here is the call graph for this function:

needsImportParsing()

ilPageObject::needsImportParsing

(

?bool

$a_parse = null

)

Definition at line 1046 of file class.ilPageObject.php.

                                                             : bool
    {
        if ($a_parse === true) {
            $this->needs_parsing = true;
        }
        if ($a_parse === false) {
            $this->needs_parsing = false;
        }
        return $this->needs_parsing;
    }

pasteContents()

ilPageObject::pasteContents	(	string	$a_hier_id,
		bool	$a_self_ass = false
	)

Paste contents from pc clipboard.

Returns

array|bool

Exceptions

ilDateTimeException

Definition at line 1862 of file class.ilPageObject.php.

      {
        $user = $this->user;
        $cm = $this->page_manager->content($this->getDomDoc());
        $cm->pasteContents(
            $user,
            $a_hier_id,
            $this,
            $a_self_ass
        );
        return $this->update();
    }

performAutomaticModifications()

ilPageObject::performAutomaticModifications

(

)

Perform automatic modifications (may be overwritten by sub classes)

Definition at line 2563 of file class.ilPageObject.php.

                                                   : void
    {
    }

preloadActivationDataByParentId()

static ilPageObject::preloadActivationDataByParentId ( int  $a_parent_id )

static

Preload activation data by Parent Id.

Definition at line 491 of file class.ilPageObject.php.

                                                                            : void
    {
        global $DIC;
 
        $db = $DIC->database();
        $set = $db->query(
            "SELECT page_id, parent_type, lang, active, activation_start, activation_end, show_activation_info FROM page_object " .
            " WHERE parent_id = " . $db->quote($a_parent_id, "integer")
        );
        while ($rec = $db->fetchAssoc($set)) {
            self::$activation_data[$rec["page_id"] . ":" . $rec["parent_type"] . ":" . $rec["lang"]] = $rec;
        }
    }

References $DIC, ilDBInterface\fetchAssoc(), ilDBInterface\query(), and ilDBInterface\quote().

Referenced by ilLMExplorerGUI\__construct().

Here is the call graph for this function:

Here is the caller graph for this function:

preparePageForCompare()

ilPageObject::preparePageForCompare

(

ilPageObject

$page

)

Reimplemented in ilWikiPage.

Definition at line 2198 of file class.ilPageObject.php.

                                                             : void
    {
    }

read()

ilPageObject::read

(

)

Read page data.

Reimplemented in ilBlogPosting, and ilPortfolioPage.

Definition at line 291 of file class.ilPageObject.php.

                          : void
    {
        $this->setActive(true);
        if ($this->old_nr == 0) {
            $query = "SELECT * FROM page_object" .
                " WHERE page_id = " . $this->db->quote($this->id, "integer") .
                " AND parent_type=" . $this->db->quote($this->getParentType(), "text") .
                " AND lang = " . $this->db->quote($this->getLanguage(), "text");
            $pg_set = $this->db->query($query);
            if (!$this->page_record = $this->db->fetchAssoc($pg_set)) {
                throw new ilCOPageNotFoundException("Error: Page " . $this->id . " is not in database" .
                    " (parent type " . $this->getParentType() . ", lang: " . $this->getLanguage() . ").");
            }
            $this->setActive($this->page_record["active"]);
            $this->setActivationStart($this->page_record["activation_start"]);
            $this->setActivationEnd($this->page_record["activation_end"]);
            $this->setShowActivationInfo($this->page_record["show_activation_info"]);
        } else {
            $query = "SELECT * FROM page_history" .
                " WHERE page_id = " . $this->db->quote($this->id, "integer") .
                " AND parent_type=" . $this->db->quote($this->getParentType(), "text") .
                " AND nr = " . $this->db->quote($this->old_nr, "integer") .
                " AND lang = " . $this->db->quote($this->getLanguage(), "text");
            $pg_set = $this->db->query($query);
            $this->page_record = $this->db->fetchAssoc($pg_set);
        }
        if (!$this->page_record) {
            throw new ilCOPageNotFoundException("Error: Page " . $this->id . " is not in database" .
                " (parent type " . $this->getParentType() . ", lang: " . $this->getLanguage() . ").");
        }
        $this->xml = $this->page_record["content"];
        $this->setParentId((int) $this->page_record["parent_id"]);
        $this->last_change_user = (int) ($this->page_record["last_change_user"] ?? 0);
        $this->create_user = (int) ($this->page_record["create_user"] ?? 0);
        $this->setRenderedContent((string) ($this->page_record["rendered_content"] ?? ""));
        $this->setRenderMd5((string) ($this->page_record["render_md5"] ?? ""));
        $this->setRenderedTime((string) ($this->page_record["rendered_time"] ?? ""));
        $this->setLastChange((string) ($this->page_record["last_change"] ?? ""));
    }

References getLanguage(), and ILIAS\Repository\int().

Referenced by __construct(), and ilWikiPage\createFromXML().

Here is the call graph for this function:

Here is the caller graph for this function:

registerOfflineHandler()

ilPageObject::registerOfflineHandler

(

object

$handler

)

Definition at line 2034 of file class.ilPageObject.php.

                                                           : void
    {
        $this->offline_handler = $handler;
    }

References $handler.

releasePageLock()

ilPageObject::releasePageLock

(

)

Release page lock.

Definition at line 2754 of file class.ilPageObject.php.

                                     : bool
    {
        $db = $this->db;
        $user = $this->user;
        $aset = new ilSetting("adve");
 
        $min = (int) $aset->get("block_mode_minutes");
        if ($min > 0) {
            // try to set the lock for the user
            $ts = time();
            $db->manipulate(
                "UPDATE page_object SET " .
                " edit_lock_user = " . $db->quote($user->getId(), "integer") . "," .
                " edit_lock_ts = 0" .
                " WHERE edit_lock_user = " . $db->quote($user->getId(), "integer") .
                " AND page_id = " . $db->quote($this->getId(), "integer") .
                " AND parent_type = " . $db->quote($this->getParentType(), "text")
            );
 
            $set = $db->query(
                "SELECT edit_lock_user FROM page_object " .
                " WHERE page_id = " . $db->quote($this->getId(), "integer") .
                " AND parent_type = " . $db->quote($this->getParentType(), "text")
            );
            $rec = $db->fetchAssoc($set);
            if ($rec["edit_lock_user"] != $user->getId()) {
                return false;
            }
        }
 
        return true;
    }

References ilDBInterface\fetchAssoc(), ilObject\getId(), ILIAS\Repository\int(), ilDBInterface\manipulate(), ilDBInterface\query(), and ilDBInterface\quote().

Here is the call graph for this function:

resolveFileItems()

ilPageObject::resolveFileItems

(

array

$a_mapping

)

Resolve file items (after import)

Definition at line 1223 of file class.ilPageObject.php.

                                                      : bool
    {
        return $this->pc_service->fileList()->resolveFileItems(
            $this->getDomDoc(),
            $a_mapping
        );
    }

resolveIIMMediaAliases()

ilPageObject::resolveIIMMediaAliases

(

array

$a_mapping

)

Resolve iim media aliases (in ilContObjParse)

Definition at line 1211 of file class.ilPageObject.php.

                                                            : bool
    {
        return $this->pc_service->interactiveImage()->resolveIIMMediaAliases(
            $this->getDomDoc(),
            $a_mapping
        );
    }

resolveIntLinks()

ilPageObject::resolveIntLinks

(

?array

$a_link_map = null

)

Resolves all internal link targets of the page, if targets are available (after import)

Definition at line 1187 of file class.ilPageObject.php.

                                                              : bool
    {
        return $this->link->resolveIntLinks($this->getDomDoc(), $a_link_map);
    }

References ILIAS\Repository\link().

Referenced by ilQuestionPageParser\processPagesToParse().

Here is the call graph for this function:

Here is the caller graph for this function:

resolveMediaAliases()

ilPageObject::resolveMediaAliases	(	array	$a_mapping,
		bool	$a_reuse_existing_by_import = false
	)

Resolve media aliases (after import)

Definition at line 1196 of file class.ilPageObject.php.

     : bool {
        return $this->pc_service->mediaObject()->resolveMediaAliases(
            $this,
            $a_mapping,
            $a_reuse_existing_by_import
        );
    }

resolveQuestionReferences()

ilPageObject::resolveQuestionReferences

(

array

$a_mapping

)

Resolve all quesiont references (after import)

Definition at line 1235 of file class.ilPageObject.php.

                                                               : bool
    {
        $qm = $this->pc_service->question();
        return $qm->resolveQuestionReferences(
            $this->getDomDoc(),
            $a_mapping
        );
    }

resolveResources()

ilPageObject::resolveResources

(

array

$ref_mapping

)

Resolve resources.

Todo:

: move this into proper "afterImport" routine that calls all PC components

Definition at line 2990 of file class.ilPageObject.php.

                                                        : bool
    {
        return ilPCResources::resolveResources($this, $ref_mapping);
    }

References ilPCResources\resolveResources().

Here is the call graph for this function:

saveInitialOpenedContent()

ilPageObject::saveInitialOpenedContent	(	string	$a_type,
		int	$a_id,
		string	$a_target
	)

Save initial opened content.

Definition at line 2576 of file class.ilPageObject.php.

     : void {
        $cm = $this->getContentManager();
        $cm->setInitialOpenedContent($a_type, $a_id, $a_target);
        $this->update();
    }

saveInternalLinks()

ilPageObject::saveInternalLinks

(

DOMDocument

$a_domdoc

)

save internal links of page

Todo:

: move to specific classes, internal link use info

Reimplemented in ilWikiPage.

Definition at line 1775 of file class.ilPageObject.php.

                                                            : void
    {
        $this->link->saveInternalLinks(
            $this,
            $a_domdoc
        );
    }

References ILIAS\Repository\link().

Here is the call graph for this function:

saveStyleUsage()

ilPageObject::saveStyleUsage	(	DOMDocument	$a_domdoc,
		int	$a_old_nr = 0
	)

Save all style class/template usages.

Definition at line 1724 of file class.ilPageObject.php.

     : void {
        $this->style_manager->saveStyleUsage(
            $this,
            $a_domdoc,
            $a_old_nr
        );
    }

sendParagraph()

ilPageObject::sendParagraph	(	string	$par_id,
		string	$filename
	)

Definition at line 2023 of file class.ilPageObject.php.

     : void {
        $this->pc_service->paragraph()->send(
            $this->getDomDoc(),
            $par_id,
            $filename
        );
    }

setActivationEnd()

ilPageObject::setActivationEnd

(

?string

$a_activationend

)

Set Activation End.

Parameters

string

$a_activationend

IL_CAL_DATETIME format

Definition at line 696 of file class.ilPageObject.php.

                                                              : void
    {
        if ($a_activationend == "") {
            $a_activationend = null;
        }
        $this->activationend = $a_activationend;
    }

setActivationStart()

ilPageObject::setActivationStart

(

?string

$a_activationstart

)

Parameters

string

$a_activationstart

IL_CAL_DATETIME format

Definition at line 679 of file class.ilPageObject.php.

                                                                  : void
    {
        if ($a_activationstart == "") {
            $a_activationstart = null;
        }
        $this->activationstart = $a_activationstart;
    }

setActive()

ilPageObject::setActive

(

bool

$a_active

)

Definition at line 469 of file class.ilPageObject.php.

                                             : void
    {
        $this->active = $a_active;
    }

Referenced by __construct().

Here is the caller graph for this function:

setConcreteLang()

ilPageObject::setConcreteLang

(

string

$a_val

)

Definition at line 208 of file class.ilPageObject.php.

    {
        $this->concrete_lang = $a_val;
    }

setContainsIntLink()

ilPageObject::setContainsIntLink

(

bool

$a_contains_link

)

lm parser set this flag to true, if the page contains intern links (this method should only be called by the import parser) todo: move to ilLMPageObject !?

Parameters

bool

$a_contains_link

true, if page contains intern link tag(s)

Definition at line 1021 of file class.ilPageObject.php.

                                                             : void
    {
        $this->contains_int_link = $a_contains_link;
    }

setContainsQuestion()

ilPageObject::setContainsQuestion

(

bool

$a_val

)

Definition at line 1058 of file class.ilPageObject.php.

                                                    : void
    {
        $this->contains_question = $a_val;
    }

setContentIdManager()

ilPageObject::setContentIdManager

(

\ILIAS\COPage\ID\ContentIdManager

$content_id_manager

)

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

     : void {
        $this->content_id_manager = $content_id_manager;
    }

setCopyProperties()

ilPageObject::setCopyProperties ( ilPageObject  $new_page )

protected

Reimplemented in ilWikiPage.

Definition at line 2656 of file class.ilPageObject.php.

                                                                : void
    {
    }

setEmptyPageXml()

ilPageObject::setEmptyPageXml

(

)

Definition at line 1282 of file class.ilPageObject.php.

                                     : void
    {
        $this->setXMLContent("<PageObject></PageObject>");
    }

setId()

ilPageObject::setId

(

int

$a_id

)

Definition at line 424 of file class.ilPageObject.php.

                                    : void
    {
        $this->id = $a_id;
    }

Referenced by ilWikiPage\create(), and ilTestPage\createPageWithNextId().

Here is the caller graph for this function:

setImportMode()

ilPageObject::setImportMode

(

bool

$a_val

)

Definition at line 1036 of file class.ilPageObject.php.

                                              : void
    {
        $this->import_mode = $a_val;
    }

setLanguage()

ilPageObject::setLanguage

(

string

$a_val

)

Set language.

Parameters

string

$a_val

language code or "-" for unknown / not set

Definition at line 193 of file class.ilPageObject.php.

                                              : void
    {
        $this->language = $a_val;
    }

References ILIAS\UI\examples\Symbol\Glyph\Language\language().

Referenced by __construct(), and ilPCParagraph\insert().

Here is the call graph for this function:

Here is the caller graph for this function:

setLastChange()

ilPageObject::setLastChange

(

string

$a_lastchange

)

Definition at line 253 of file class.ilPageObject.php.

                                                       : void
    {
        $this->lastchange = $a_lastchange;
    }

setLastChangeUser()

ilPageObject::setLastChangeUser

(

int

$a_val

)

Definition at line 263 of file class.ilPageObject.php.

                                                 : void
    {
        $this->last_change_user = $a_val;
    }

setPageConfig()

ilPageObject::setPageConfig

(

ilPageConfig

$a_val

)

Definition at line 203 of file class.ilPageObject.php.

                                                      : void
    {
        $this->page_config = $a_val;
    }

Referenced by ilUnitTestPageObject\initPageConfig().

Here is the caller graph for this function:

setParentId()

ilPageObject::setParentId

(

int

$a_id

)

Definition at line 434 of file class.ilPageObject.php.

                                          : void
    {
        $this->parent_id = $a_id;
    }

Referenced by ilBlogPosting\setBlogId(), and ilWikiPage\setWikiId().

Here is the caller graph for this function:

setRenderedContent()

ilPageObject::setRenderedContent

(

string

$a_renderedcontent

)

Definition at line 233 of file class.ilPageObject.php.

                                                                 : void
    {
        $this->renderedcontent = $a_renderedcontent;
    }

setRenderedTime()

ilPageObject::setRenderedTime

(

string

$a_renderedtime

)

Definition at line 243 of file class.ilPageObject.php.

                                                           : void
    {
        $this->renderedtime = $a_renderedtime;
    }

setRenderMd5()

ilPageObject::setRenderMd5

(

string

$a_rendermd5

)

Definition at line 223 of file class.ilPageObject.php.

                                                     : void
    {
        $this->rendermd5 = $a_rendermd5;
    }

setShowActivationInfo()

ilPageObject::setShowActivationInfo

(

bool

$a_val

)

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

                                                      : void
    {
        $this->show_page_act_info = $a_val;
    }

setTranslationProperties()

ilPageObject::setTranslationProperties ( self  $transl_page )

protected

Definition at line 2700 of file class.ilPageObject.php.

                                                                  : void
    {
        $transl_page->setId($this->getId());
        $transl_page->setParentId($this->getParentId());
        $transl_page->setXMLContent($this->copyXmlContent());
        $transl_page->setActive($this->getActive());
        $transl_page->setActivationStart($this->getActivationStart());
        $transl_page->setActivationEnd($this->getActivationEnd());
    }

References ILIAS\Survey\Mode\getId().

Here is the call graph for this function:

setXMLContent()

ilPageObject::setXMLContent	(	string	$a_xml,
		string	$a_encoding = "UTF-8"
	)

set xml content of page, start with <PageObject...>, end with </PageObject>, comply with ILIAS DTD, omit MetaData, use utf-8!

Parameters

string

$a_encoding

encoding of the content (here is no conversion done! it must be already utf-8 encoded at the time)

Definition at line 770 of file class.ilPageObject.php.

                                                                              : void
    {
        $this->encoding = $a_encoding;
        $this->xml = $a_xml;
    }

stripHierIDs()

ilPageObject::stripHierIDs

(

)

Definition at line 1139 of file class.ilPageObject.php.

                                  : void
    {
        $this->content_id_manager->stripHierIDsFromDom();
    }

Referenced by ilPCParagraph\getLastSavedPCId().

Here is the caller graph for this function:

stripPCIDs()

ilPageObject::stripPCIDs

(

)

Definition at line 1144 of file class.ilPageObject.php.

                                : void
    {
        $this->content_id_manager->stripPCIDs();
    }

switchEnableMultiple()

ilPageObject::switchEnableMultiple	(	array	$a_hids,
		bool	$a_update = true,
		bool	$a_self_ass = false
	)

(De-)activate elements

Returns

array|bool

Exceptions

ilCOPageUnknownPCTypeException
ilDateTimeException
ilWACException

Definition at line 1884 of file class.ilPageObject.php.

      {
        $cm = $this->page_manager->content($this->getDomDoc());
        $cm->switchEnableMultiple($this, $a_hids, $a_self_ass);
        if ($a_update) {
            return $this->update();
        }
        return true;
    }

truncateHTML()

static ilPageObject::truncateHTML ( string  $a_text, int  $a_length = 100, string  $a_ending = '...', bool  $a_exact = false, bool  $a_consider_html = true  )

static

Truncate (html) string.

See also

http://dodona.wordpress.com/2009/04/05/how-do-i-truncate-an-html-string-without-breaking-the-html-code/

Definition at line 2812 of file class.ilPageObject.php.

     : string {
        $open_tags = [];
        if ($a_consider_html) {
            // if the plain text is shorter than the maximum length, return the whole text
            if (strlen(preg_replace('/<.*?>/', '', $a_text)) <= $a_length) {
                return $a_text;
            }
 
            // splits all html-tags to scanable lines
            $total_length = strlen($a_ending);
            $open_tags = array();
            $truncate = '';
            preg_match_all('/(<.+?>)?([^<>]*)/s', $a_text, $lines, PREG_SET_ORDER);
            foreach ($lines as $line_matchings) {
                // if there is any html-tag in this line, handle it and add it (uncounted) to the output
                if (!empty($line_matchings[1])) {
                    // if it's an "empty element" with or without xhtml-conform closing slash
                    if (preg_match(
                        '/^<(\s*.+?\/\s*|\s*(img|br|input|hr|area|base|basefont|col|frame|isindex|link|meta|param)(\s.+?)?)>$/is',
                        $line_matchings[1]
                    )) {
                        // do nothing
                    } // if tag is a closing tag
                    elseif (preg_match('/^<\s*\/([^\s]+?)\s*>$/s', $line_matchings[1], $tag_matchings)) {
                        // delete tag from $open_tags list
                        $pos = array_search($tag_matchings[1], $open_tags);
                        if ($pos !== false) {
                            unset($open_tags[$pos]);
                        }
                    } // if tag is an opening tag
                    elseif (preg_match('/^<\s*([^\s>!]+).*?>$/s', $line_matchings[1], $tag_matchings)) {
                        // add tag to the beginning of $open_tags list
                        array_unshift($open_tags, strtolower($tag_matchings[1]));
                    }
                    // add html-tag to $truncate'd text
                    $truncate .= $line_matchings[1];
                }
 
                // calculate the length of the plain text part of the line; handle entities as one character
                $content_length = strlen(preg_replace(
                    '/&[0-9a-z]{2,8};|&#[0-9]{1,7};|[0-9a-f]{1,6};/i',
                    ' ',
                    $line_matchings[2]
                ));
                if ($total_length + $content_length > $a_length) {
                    // the number of characters which are left
                    $left = $a_length - $total_length;
                    $entities_length = 0;
                    // search for html entities
                    if (preg_match_all(
                        '/&[0-9a-z]{2,8};|&#[0-9]{1,7};|[0-9a-f]{1,6};/i',
                        $line_matchings[2],
                        $entities,
                        PREG_OFFSET_CAPTURE
                    )) {
                        // calculate the real length of all entities in the legal range
                        foreach ($entities[0] as $entity) {
                            if ($entity[1] + 1 - $entities_length <= $left) {
                                $left--;
                                $entities_length += strlen($entity[0]);
                            } else {
                                // no more characters left
                                break;
                            }
                        }
                    }
 
                    // $truncate .= substr($line_matchings[2], 0, $left+$entities_length);
                    $truncate .= ilStr::shortenText($line_matchings[2], 0, $left + $entities_length);
 
                    // maximum lenght is reached, so get off the loop
                    break;
                } else {
                    $truncate .= $line_matchings[2];
                    $total_length += $content_length;
                }
 
                // if the maximum length is reached, get off the loop
                if ($total_length >= $a_length) {
                    break;
                }
            }
        } else {
            if (strlen($a_text) <= $a_length) {
                return $a_text;
            } else {
                // $truncate = substr($a_text, 0, $a_length - strlen($a_ending));
                $truncate = ilStr::shortenText($a_text, 0, $a_length - strlen($a_ending));
            }
        }
 
        // THIS IS BUGGY AS IT MIGHT BREAK AN OPEN TAG AT THE END
        if (!count($open_tags)) {
            // if the words shouldn't be cut in the middle...
            if (!$a_exact) {
                // ...search the last occurance of a space...
                $spacepos = strrpos($truncate, ' ');
                if ($spacepos !== false) {
                    // ...and cut the text in this position
                    // $truncate = substr($truncate, 0, $spacepos);
                    $truncate = ilStr::shortenText($truncate, 0, $spacepos);
                }
            }
        }
 
        // add the defined ending to the text
        $truncate .= $a_ending;
 
        if ($a_consider_html) {
            // close all unclosed html-tags
            foreach ($open_tags as $tag) {
                $truncate .= '</' . $tag . '>';
            }
        }
 
        return $truncate;
    }

References ilStr\shortenText().

Referenced by ilLearningModuleNotification\getPreviewText().

Here is the call graph for this function:

Here is the caller graph for this function:

update()

ilPageObject::update	(	bool	$a_validate = true,
		bool	$a_no_history = false
	)

update complete page content in db (dom xml content is used)

Returns

array|bool

Exceptions

ilDateTimeException
ilWACException

Reimplemented in ilUnitTestPageObject, ilPortfolioPage, and ilWikiPage.

Definition at line 1426 of file class.ilPageObject.php.

    {
        $this->log->debug("start..., id: " . $this->getId());
        $lm_set = new ilSetting("lm");
 
        // add missing pc ids
        if (!$this->checkPCIds()) {
            $this->insertPCIds();
        }
 
        // test validating
        if ($a_validate) {
            $this->log->debug($this->dom_util->dump($this->getDomDoc()->documentElement));
            $errors = $this->validateDom();
        }
        //var_dump($errors); exit;
        if (empty($errors) && !$this->getEditLock()) {
            $lock = $this->getEditLockInfo();
            $errors[0] = array(0 => 0,
                               1 => $this->lng->txt("cont_not_saved_edit_lock_expired") . "<br />" .
                                   $this->lng->txt("obj_usr") . ": " .
                                   ilUserUtil::getNamePresentation($lock["edit_lock_user"]) . "<br />" .
                                   $this->lng->txt("content_until") . ": " .
                                   ilDatePresentation::formatDate(new ilDateTime($lock["edit_lock_until"], IL_CAL_UNIX))
            );
        }
 
        // check for duplicate pc ids
        $this->log->debug("checking duplicate ids");
        if ($this->hasDuplicatePCIds()) {
            $errors[0] = $this->lng->txt("cont_could_not_save_duplicate_pc_ids") .
                " (" . implode(", ", $this->getDuplicatePCIds()) . ")";
        }
 
        if (!empty($errors)) {
            $this->log->debug("ilPageObject, update(): errors: " . print_r($errors, true));
        }
 
        //echo "-".htmlentities($this->getXMLFromDom())."-"; exit;
        if (empty($errors)) {
            // @todo 1: is this page type or pc content type
            // related -> plugins should be able to hook in!?
 
            $this->log->debug("perform automatic modifications");
            $this->performAutomaticModifications();
 
            // get xml content
            $content = $this->getXMLFromDom();
            $dom_doc = $this->getDomDoc();
 
            // this needs to be locked
 
            // write history entry
            $old_set = $this->db->query("SELECT * FROM page_object WHERE " .
                "page_id = " . $this->db->quote($this->getId(), "integer") . " AND " .
                "parent_type = " . $this->db->quote($this->getParentType(), "text") . " AND " .
                "lang = " . $this->db->quote($this->getLanguage(), "text"));
            $last_nr_set = $this->db->query("SELECT max(nr) as mnr FROM page_history WHERE " .
                "page_id = " . $this->db->quote($this->getId(), "integer") . " AND " .
                "parent_type = " . $this->db->quote($this->getParentType(), "text") . " AND " .
                "lang = " . $this->db->quote($this->getLanguage(), "text"));
            $last_nr = $this->db->fetchAssoc($last_nr_set);
            if ($old_rec = $this->db->fetchAssoc($old_set)) {
                // only save, if something has changed
                // added user id to the check for ilias 5.0, 7.10.2014
                if (($content != $old_rec["content"] || $this->user->getId() != $old_rec["last_change_user"]) &&
                    !$a_no_history && !$this->history_saved && $lm_set->get("page_history", 1)) {
                    if ($old_rec["content"] != "<PageObject></PageObject>") {
                        $this->db->manipulateF(
                            "DELETE FROM page_history WHERE " .
                            "page_id = %s AND parent_type = %s AND hdate = %s AND lang = %s",
                            array("integer", "text", "timestamp", "text"),
                            array($old_rec["page_id"],
                                  $old_rec["parent_type"],
                                  $old_rec["last_change"],
                                  $old_rec["lang"]
                            )
                        );
 
                        // the following lines are a workaround for
                        // bug 6741
                        $last_c = $old_rec["last_change"];
                        if ($last_c == "") {
                            $last_c = ilUtil::now();
                        }
 
                        $this->db->insert("page_history", array(
                            "page_id" => array("integer", $old_rec["page_id"]),
                            "parent_type" => array("text", $old_rec["parent_type"]),
                            "lang" => array("text", $old_rec["lang"]),
                            "hdate" => array("timestamp", $last_c),
                            "parent_id" => array("integer", $old_rec["parent_id"]),
                            "content" => array("clob", $old_rec["content"]),
                            "user_id" => array("integer", $old_rec["last_change_user"]),
                            "ilias_version" => array("text", ILIAS_VERSION_NUMERIC),
                            "nr" => array("integer", (int) $last_nr["mnr"] + 1)
                        ));
 
                        $old_content = $old_rec["content"];
                        $old_domdoc = new DOMDocument();
                        $old_nr = $last_nr["mnr"] + 1;
                        $old_domdoc->loadXML('<?xml version="1.0" encoding="UTF-8"?>' . $old_content);
 
                        // after history entry creation event
                        $this->log->debug("calling __afterHistoryEntry");
                        $this->__afterHistoryEntry($old_domdoc, $old_content, $old_nr);
 
                        // only save one time
                    }
                    $this->history_saved = true;
                }
            }
            //echo htmlentities($content);
            $em = (trim($content) == "<PageObject/>")
                ? 1
                : 0;
 
            // @todo: pass dom instead?
            $this->log->debug("checking deactivated elements");
            $iel = $this->containsDeactivatedElements($content);
            $this->log->debug("checking internal links");
            $inl = $this->containsIntLinks($content);
 
            $now = ilUtil::now();
            $this->lastchange = $now;
            $this->db->update("page_object", array(
                "content" => array("clob", $content),
                "parent_id" => array("integer", $this->getParentId()),
                "last_change_user" => array("integer", $this->user->getId()),
                "last_change" => array("timestamp", $now),
                "is_empty" => array("integer", $em),
                "active" => array("integer", $this->getActive()),
                "activation_start" => array("timestamp", $this->getActivationStart()),
                "activation_end" => array("timestamp", $this->getActivationEnd()),
                "show_activation_info" => array("integer", $this->getShowActivationInfo()),
                "inactive_elements" => array("integer", $iel),
                "int_links" => array("integer", $inl),
            ), array(
                "page_id" => array("integer", $this->getId()),
                "parent_type" => array("text", $this->getParentType()),
                "lang" => array("text", $this->getLanguage())
            ));
 
            // after update event
            $this->log->debug("calling __afterUpdate()");
            $this->__afterUpdate($dom_doc, $content);
 
            $this->log->debug(
                "...ending, updated and returning true, content: " . substr(
                    $this->getXMLContent(),
                    0,
                    1000
                )
            );
 
            //echo "<br>PageObject::update:".htmlentities($this->getXMLContent()).":";
            return true;
        } else {
            return $errors;
        }
    }

References $lm_set, ilDatePresentation\formatDate(), ILIAS\Survey\Mode\getId(), getLanguage(), ilUserUtil\getNamePresentation(), IL_CAL_UNIX, ILIAS_VERSION_NUMERIC, ILIAS\Repository\lng(), ilUtil\now(), and ILIAS\Repository\user().

Referenced by ilContainerPage\addRepositoryBlockToPage(), ILIAS\COPage\PC\Paragraph\ParagraphCommandActionHandler\cancelCommand(), ilQuestionPageParser\processPagesToParse(), ilContainerPage\removeUnsupportedBlockIds(), and ilPCParagraph\updatePage().

Here is the call graph for this function:

Here is the caller graph for this function:

updateFromXML()

ilPageObject::updateFromXML

(

)

Updates page object with current xml content This function is currently (8 beta) called by:

• ilQuestionPageParser (Test and TestQuestionPool)
• ilSCORM13Package->dbImportSco (SCORM importer)
• assQuestion->copyPageOfQuestion

Definition at line 1335 of file class.ilPageObject.php.

                                   : bool
    {
        $this->log->debug("ilPageObject, updateFromXML(): start, id: " . $this->getId());
 
        $content = $this->getXMLContent();
 
        $this->log->debug("ilPageObject, updateFromXML(): content: " . substr($content, 0, 100));
 
        $this->buildDom(true);
        $dom_doc = $this->getDomDoc();
 
        $errors = $this->validateDom(true);
 
        $iel = $this->containsDeactivatedElements($content);
        $inl = $this->containsIntLinks($content);
 
        $this->db->update("page_object", array(
            "content" => array("clob", $content),
            "parent_id" => array("integer", $this->getParentId()),
            "last_change_user" => array("integer", $this->user->getId()),
            "last_change" => array("timestamp", ilUtil::now()),
            "active" => array("integer", $this->getActive()),
            "activation_start" => array("timestamp", $this->getActivationStart()),
            "activation_end" => array("timestamp", $this->getActivationEnd()),
            "inactive_elements" => array("integer", $iel),
            "int_links" => array("integer", $inl),
        ), array(
            "page_id" => array("integer", $this->getId()),
            "parent_type" => array("text", $this->getParentType()),
            "lang" => array("text", $this->getLanguage())
        ));
 
        // after update event
        $this->__afterUpdate($dom_doc, $content);
 
        $this->log->debug("ilPageObject, updateFromXML(): end");
 
        return true;
    }

References ILIAS\Survey\Mode\getId(), getLanguage(), ilUtil\now(), and ILIAS\Repository\user().

Here is the call graph for this function:

validateDom()

ilPageObject::validateDom

(

bool

$throw = false

)

Validate the page content agains page DTD.

Definition at line 1114 of file class.ilPageObject.php.

                                                    : ?array
    {
        $this->stripHierIDs();
 
        // possible fix for #14820
        //libxml_disable_entity_loader(false);
 
        $error = null;
        $this->dom_util->validate($this->dom, $error, $throw);
        return $error;
    }

writeRenderedContent()

ilPageObject::writeRenderedContent	(	string	$a_content,
		string	$a_md5
	)

Write rendered content.

Definition at line 2492 of file class.ilPageObject.php.

     : void {
        global $DIC;
 
        $db = $DIC->database();
 
        $db->update("page_object", array(
            "rendered_content" => array("clob", $a_content),
            "render_md5" => array("text", $a_md5),
            "rendered_time" => array("timestamp", ilUtil::now())
        ), array(
            "page_id" => array("integer", $this->getId()),
            "lang" => array("text", $this->getLanguage()),
            "parent_type" => array("text", $this->getParentType())
        ));
    }

Field Documentation

$activation_data

array ilPageObject::$activation_data = array()

staticprotected

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

$activationend

string ilPageObject::$activationend = null

protected

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

$activationstart

string ilPageObject::$activationstart = null

protected

Definition at line 101 of file class.ilPageObject.php.

$active

bool ilPageObject::$active = false

protected

Definition at line 92 of file class.ilPageObject.php.

$concrete_lang

ilPageObject::$concrete_lang = ""

protected

Definition at line 104 of file class.ilPageObject.php.

$contains_int_link

bool ilPageObject::$contains_int_link = false

Definition at line 78 of file class.ilPageObject.php.

$contains_question

bool ilPageObject::$contains_question = false

protected

Definition at line 99 of file class.ilPageObject.php.

$content_id_manager

ILIAS COPage ID ContentIdManager ilPageObject::$content_id_manager

protected

Definition at line 105 of file class.ilPageObject.php.

$create_user

int ilPageObject::$create_user = 0

protected

Definition at line 57 of file class.ilPageObject.php.

$cur_dtd

string ilPageObject::$cur_dtd = "ilias_pg_9.dtd"

Definition at line 77 of file class.ilPageObject.php.

$db

ilDBInterface ilPageObject::$db

protected

Definition at line 67 of file class.ilPageObject.php.

Referenced by ilWikiPage\createFromXML().

$dom

DOMDocument ilPageObject::$dom = null

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

$dom_builded

bool ilPageObject::$dom_builded = false

Definition at line 85 of file class.ilPageObject.php.

$dom_util

ILIAS COPage Dom DomUtil ilPageObject::$dom_util

protected

Definition at line 54 of file class.ilPageObject.php.

$encoding

string ilPageObject::$encoding = ""

Definition at line 75 of file class.ilPageObject.php.

$exists

array ilPageObject::$exists = array()

static

Definition at line 66 of file class.ilPageObject.php.

$hier_ids

array ilPageObject::$hier_ids = []

protected

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

$history_saved

bool ilPageObject::$history_saved = false

Definition at line 86 of file class.ilPageObject.php.

$id

int ilPageObject::$id

protected

Definition at line 72 of file class.ilPageObject.php.

Referenced by ilContainerPage\addRepositoryBlockToPage(), ilWikiPage\create(), ilDclDetailedViewDefinition\exists(), ilDclDetailedViewDefinition\isActive(), and ilContainerPage\removeUnsupportedBlockIds().

$id_elements

array ilPageObject::$id_elements

protected

Definition at line 61 of file class.ilPageObject.php.

$import_mode

bool ilPageObject::$import_mode = false

protected

Definition at line 89 of file class.ilPageObject.php.

$language

string ilPageObject::$language = "-"

protected

Definition at line 87 of file class.ilPageObject.php.

$last_change_user

int ilPageObject::$last_change_user = 0

Definition at line 98 of file class.ilPageObject.php.

$lastchange

string ilPageObject::$lastchange = ""

protected

Definition at line 97 of file class.ilPageObject.php.

$link

ILIAS COPage Link LinkManager ilPageObject::$link

protected

Definition at line 55 of file class.ilPageObject.php.

$lng

ilLanguage ilPageObject::$lng

protected

Definition at line 69 of file class.ilPageObject.php.

Referenced by ilPortfolioPage\getTitle().

$log

ilLogger ilPageObject::$log

protected

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

$lom_services

LOMServices ilPageObject::$lom_services

protected

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

$needs_parsing

bool ilPageObject::$needs_parsing = false

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

$node

DomNode ilPageObject::$node

Definition at line 76 of file class.ilPageObject.php.

Referenced by ilContainerPage\addRepositoryBlockToPage(), and ilContainerPage\removeUnsupportedBlockIds().

$obj_definition

ilObjectDefinition ilPageObject::$obj_definition

protected

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

$offline_handler

object ilPageObject::$offline_handler = null

Definition at line 84 of file class.ilPageObject.php.

$old_nr

int ilPageObject::$old_nr

Definition at line 62 of file class.ilPageObject.php.

$page_config

ilPageConfig ilPageObject::$page_config

protected

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

$page_manager

ILIAS COPage Page PageManager ilPageObject::$page_manager

protected

Definition at line 106 of file class.ilPageObject.php.

$page_not_found

bool ilPageObject::$page_not_found = false

protected

Definition at line 63 of file class.ilPageObject.php.

$page_record

array ilPageObject::$page_record = array()

protected

Definition at line 91 of file class.ilPageObject.php.

$parent_id

int ilPageObject::$parent_id = 0

Definition at line 81 of file class.ilPageObject.php.

$parent_type

string ilPageObject::$parent_type = ""

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

Referenced by ilDashboardPage\getParentType().

$pc_definition

ILIAS COPage PC PCDefinition ilPageObject::$pc_definition

protected

Definition at line 56 of file class.ilPageObject.php.

$pc_service

ILIAS COPage PC DomainService ilPageObject::$pc_service

protected

Definition at line 108 of file class.ilPageObject.php.

$reading_time_manager

ILIAS COPage ReadingTime ReadingTimeManager ilPageObject::$reading_time_manager

protected

Definition at line 103 of file class.ilPageObject.php.

$renderedcontent

string ilPageObject::$renderedcontent = ""

protected

Definition at line 95 of file class.ilPageObject.php.

$renderedtime

string ilPageObject::$renderedtime = ""

protected

Definition at line 96 of file class.ilPageObject.php.

$rendermd5

string ilPageObject::$rendermd5 = ""

protected

Definition at line 94 of file class.ilPageObject.php.

$show_page_act_info

bool ilPageObject::$show_page_act_info = false

protected

Definition at line 64 of file class.ilPageObject.php.

$style_manager

ILIAS COPage Style StyleManager ilPageObject::$style_manager

protected

Definition at line 107 of file class.ilPageObject.php.

$tree

ilTree ilPageObject::$tree

protected

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

$update_listener_cnt

int ilPageObject::$update_listener_cnt = 0

Definition at line 83 of file class.ilPageObject.php.

$update_listeners

array ilPageObject::$update_listeners = []

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

$user

ilObjUser ilPageObject::$user

protected

Definition at line 68 of file class.ilPageObject.php.

$xml

string ilPageObject::$xml = ""

Definition at line 74 of file class.ilPageObject.php.

---

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

• components/ILIAS/COPage/classes/class.ilPageObject.php