ilMediaPoolPage Class Reference

Class ilMediaPoolPage. More...

Inheritance diagram for ilMediaPoolPage:

Collaboration diagram for ilMediaPoolPage:

Public Member Functions
	__construct ($a_id=0, $a_old_nr=0)
	Constructor public.
	create ()
	Create new media pool page.
	update ($a_validate=true, $a_no_history=false)
	update object data
	read ()
	Read media_pool data.
	delete ()
	delete media_pool page and al related data
	getUsages ()
	get all usages of current media object
	lookupUsages ($a_id)
	Lookup usages of media object.
Public Member Functions inherited from ilPageObject
	ilPageObject ($a_parent_type, $a_id=0, $a_old_nr=0, $a_halt=true)
	Constructor public.
	haltOnError ($a_halt)
	setRenderMd5 ($a_rendermd5)
	Set Render MD5.
	getRenderMd5 ()
	Get Render MD5.
	setRenderedContent ($a_renderedcontent)
	Set Rendered Content.
	getRenderedContent ()
	Get Rendered Content.
	setRenderedTime ($a_renderedtime)
	Set Rendered Time.
	getRenderedTime ()
	Get Rendered Time.
	setLastChange ($a_lastchange)
	Set Last Change.
	getLastChange ()
	Get Last Change.
	setLayoutMode ($a_layout_mode)
	Set Layout Mode.
	getLayoutMode ()
	Get Layout Mode enabled/disabled.
	_existsAndNotEmpty ($a_parent_type, $a_id)
	checks whether page exists and is not empty (may return true on some empty pages)
	buildDom ($a_force=false)
	freeDom ()
&	getDom ()
	setId ($a_id)
	set id
	getId ()
	setParentId ($a_id)
	getParentId ()
	setParentType ($a_type)
	getParentType ()
	addUpdateListener (&$a_object, $a_method, $a_parameters="")
	callUpdateListeners ()
	setActive ($a_active)
	set activation
	getActive ($a_check_scheduled_activation=false)
	get activation
	_lookupActive ($a_id, $a_parent_type, $a_check_scheduled_activation=false)
	lookup activation status
	_writeActive ($a_id, $a_parent_type, $a_active, $a_reset_scheduled_activation=true)
	write activation status
	setActivationStart ($a_activationstart)
	Set Activation Start.
	getActivationStart ()
	Get Activation Start.
	setActivationEnd ($a_activationend)
	Set Activation End.
	getActivationEnd ()
	Get Activation End.
&	getContentObject ($a_hier_id, $a_pc_id="")
&	getContentNode ($a_hier_id, $a_pc_id="")
	lookforhier ($a_hier_id)
&	getNode ()
	setXMLContent ($a_xml, $a_encoding="UTF-8")
	set xml content of page, start with <PageObject...>, end with </PageObject>, comply with ILIAS DTD, omit MetaData, use utf-8!
	appendXMLContent ($a_xml)
	append xml content to page setXMLContent must be called before and the same encoding must be used
	getXMLContent ($a_incl_head=false)
	get xml content of page
	copyXmlContent ($a_new_question_copies=true)
	Copy content of page; replace page components with copies where necessary (e.g.
	newQuestionCopies (&$temp_dom)
	Replaces existing question content elements with new copies.
	getXMLFromDom ($a_incl_head=false, $a_append_mobs=false, $a_append_bib=false, $a_append_str="", $a_omit_pageobject_tag=false)
	get xml content of page from dom (use this, if any changes are made to the document)
	getLanguageVariablesXML ()
	get language variables as XML
	appendLangVarXML (&$xml, $var)
	getFirstParagraphText ()
	setParagraphContent ($a_hier_id, $a_content)
	Set content of paragraph.
	setContainsIntLink ($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)
	containsIntLink ()
	returns true, if page was marked as containing an intern link (via setContainsIntLink) (this method should only be called by the import parser)
	needsImportParsing ($a_parse="")
	getBibliographyXML ()
	get a xml string that contains all Bibliography elements, that are referenced by any bibitem alias in the page
	collectMediaObjects ($a_inline_only=true)
	get all media objects, that are referenced and used within the page
	getInternalLinks ()
	get all internal links that are used within the page
	collectFileItems ($a_xml="")
	get all file items that are used within the page
	getMultimediaXML ()
	get a xml string that contains all media object elements, that are referenced by any media alias in the page
	getMediaAliasElement ($a_mob_id, $a_nr=1)
	get complete media object (alias) element
	validateDom ()
	Validate the page content agains page DTD.
	addHierIDs ()
	Add hierarchical ID (e.g.
	getHierIds ()
	get all hierarchical ids
	getFirstRowIds ()
	get ids of all first table rows
	getFirstColumnIds ()
	get ids of all first table columns
	getListItemIds ()
	get ids of all list items
	getFileItemIds ()
	get ids of all file items
	stripHierIDs ()
	strip all hierarchical id attributes out of the dom tree
	addFileSizes ()
	add file sizes
	resolveIntLinks ()
	Resolves all internal link targets of the page, if targets are available (after import)
	moveIntLinks ($a_from_to)
	Move internal links from one destination to another.
	handleImportRepositoryLink ($a_rep_import_id, $a_rep_type, $a_rep_ref_id)
	createFromXML ()
	create new page object with current xml content
	updateFromXML ()
	updates page object with current xml content
	update ($a_validate=true, $a_no_history=false, $skip_handle_usages=false)
	update complete page content in db (dom xml content is used)
	saveMetaKeywords ($a_xml)
	save all keywords
	saveMobUsage ($a_xml, $a_old_nr=0)
	save all usages of media objects (media aliases, media objects, internal links)
	saveFileUsage ($a_xml="", $a_old_nr=0)
	save file usages
	saveContentIncludeUsage ($a_xml="", $a_old_nr=0)
	save content include usages
	collectContentIncludes ($a_xml="")
	get all content includes that are used within the page
	saveStyleUsage ($a_xml, $a_old_nr=0)
	Save all style class/template usages.
	getLastUpdateOfIncludedElements ()
	Get last update of included elements (media objects and files).
	saveInternalLinks ($a_xml)
	save internal links of page
	saveAnchors ($a_xml)
	save anchors
	deleteContent ($a_hid, $a_update=true, $a_pcid="")
	delete content object with hierarchical id $a_hid
	deleteContents ($a_hids, $a_update=true)
	delete multiple content objects
	cutContents ($a_hids)
	Copy contents to clipboard and cut them from the page.
	copyContents ($a_hids)
	Copy contents to clipboard.
	pasteContents ($a_hier_id)
	Paste contents from pc clipboard.
	switchEnableMultiple ($a_hids, $a_update=true)
	gui function set enabled if is not enabled and vice versa
	deleteContentFromHierId ($a_hid, $a_update=true)
	delete content object with hierarchical id >= $a_hid
	deleteContentBeforeHierId ($a_hid, $a_update=true)
	delete content object with hierarchical id < $a_hid
	_moveContentAfterHierId (&$a_source_page, &$a_target_page, $a_hid)
	move content of hierarchical id >= $a_hid to other page
	insertContent (&$a_cont_obj, $a_pos, $a_mode=IL_INSERT_AFTER, $a_pcid="")
	insert a content node before/after a sibling or as first child of a parent
	insertContentNode (&$a_cont_node, $a_pos, $a_mode=IL_INSERT_AFTER, $a_pcid="")
	insert a content node before/after a sibling or as first child of a parent
	moveContentBefore ($a_source, $a_target, $a_spcid="", $a_tpcid="")
	move content object from position $a_source before position $a_target (both hierarchical content ids)
	moveContentAfter ($a_source, $a_target, $a_spcid="", $a_tpcid="")
	move content object from position $a_source before position $a_target (both hierarchical content ids)
	bbCode2XML (&$a_content)
	transforms bbCode to corresponding xml
	insertInstIntoIDs ($a_inst, $a_res_ref_to_obj_id=true)
	inserts installation id into ids (e.g.
	highlightText ($a_text, $proglang, $autoindent)
	Highligths Text with given ProgLang.
	hasHighlighter ($hfile_ext)
	insertSourceCodeParagraphs ($a_output, $outputmode="presentation")
	depending on the SubCharacteristic and ShowLineNumbers attribute the line numbers and html tags for the syntax highlighting will be inserted using the dom xml functions
	checkPCIds ()
	Check, whether (all) page content hashes are set.
	insertPCIds ()
	Insert Page Content IDs.
	getPageContentsHashes ()
	Get page contents hashes.
	getQuestionIds ()
	Get page contents hashes.
	send_paragraph ($par_id, $filename)
	getFO ()
	get fo page content
	registerOfflineHandler ($handler)
	_lookupContainsDeactivatedElements ($a_id, $a_parent_type)
	lookup whether page contains deactivated elements
	containsDeactivatedElements ($a_content)
	Check whether content contains deactivated elements.
	getHistoryEntries ()
	Get History Entries.
	getHistoryEntry ($a_old_nr)
	Get History Entry.
	getHistoryInfo ($a_nr)
	Get information about a history entry, its predecessor and its successor.
	addChangeDivClasses ($a_hashes)
	compareVersion ($a_left, $a_right)
	Compares to revisions of the page.
	increaseViewCnt ()
	increase view cnt
	writeRenderedContent ($a_content, $a_md5)
	Write rendered content.
	containsIntLinks ($a_content)
	Check whether content contains internal links.

Static Public Member Functions
static	deleteAllPagesOfMediaPool ($a_media_pool_id)
	delete media pool page and al related data
static	exists ($a_media_pool_id, $a_title)
	Checks whether a page with given title exists.
static	lookupTitle ($a_page_id)
	Lookup title.
static	getAllPages ($a_media_pool_id)
	Get all pages of media pool.
static	_mediaPoolPageExists ($a_media_pool_id, $a_title)
	Check whether page exists in media pool or not.
static	_exists ($a_id)
	Check whether meida pool page exists.
Static Public Member Functions inherited from ilPageObject
static	_exists ($a_parent_type, $a_id)
	checks whether page exists
static	_isScheduledActivation ($a_id, $a_parent_type)
	Check whether page is activated by time schedule.
static	lookupParentId ($a_id, $a_type)
	Lookup parent id.
static	_handleImportRepositoryLinks ($a_rep_import_id, $a_rep_type, $a_rep_ref_id)
	Change targest of repository links.
static	_deleteAnchors ($a_parent_type, $a_page_id)
	Delete anchors of a page.
static	_saveAnchor ($a_parent_type, $a_page_id, $a_anchor_name)
	Save an anchor.
static	_readAnchors ($a_parent_type, $a_page_id)
	Read anchors of a page.
static	getRecentChanges ($a_parent_type, $a_parent_id, $a_period=30)
	Get recent pages changes for parent object.
static	getAllPages ($a_parent_type, $a_parent_id)
	Get all pages for parent object.
static	getNewPages ($a_parent_type, $a_parent_id)
	Get new pages.
static	getParentObjectContributors ($a_parent_type, $a_parent_id)
	Get all contributors for parent object.
static	getPageContributors ($a_parent_type, $a_page_id)
	Get all contributors for parent object.
static	getPagesWithLinks ($a_parent_type, $a_parent_id)
	Get all pages for parent object that contain internal links.

Additional Inherited Members
Data Fields inherited from ilPageObject
	$id
	$ilias
	$dom
	$xml
	$encoding
	$node
	$cur_dtd = "ilias_pg_3_11.dtd"
	$contains_int_link
	$needs_parsing
	$parent_type
	$parent_id
	$update_listeners
	$update_listener_cnt
	$offline_handler
	$dom_builded
	$history_saved
	$layout_mode
Static Public Attributes inherited from ilPageObject
static	$exists = array()

Detailed Description

Class ilMediaPoolPage.

Author

Alex Killing alex..nosp@m.kill.nosp@m.ing@g.nosp@m.mx.d.nosp@m.e

Version

$Id$

Definition at line 14 of file class.ilMediaPoolPage.php.

Constructor & Destructor Documentation

ilMediaPoolPage::__construct	(		$a_id = 0,
			$a_old_nr = 0
	)

Constructor public.

Parameters

media_pool

page id

Definition at line 21 of file class.ilMediaPoolPage.php.

        {
                parent::__construct("mep", $a_id, $a_old_nr);
        }

Member Function Documentation

static ilMediaPoolPage::_exists (   $a_id )

static

Check whether meida pool page exists.

Parameters

int

page id

Returns

boolean true/false

Definition at line 202 of file class.ilMediaPoolPage.php.

Referenced by ilObjMediaPool\deleteChild(), and ilPageObjectGUI\insertContentIncludes().

        {
                return ilPageObject::_exists("mep", $a_id);
        }

Here is the caller graph for this function:

static ilMediaPoolPage::_mediaPoolPageExists (   $a_media_pool_id,   $a_title  )

static

Check whether page exists in media pool or not.

Parameters

int	media pool id
string	page name

Returns

boolean page exists true/false

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

References $ilDB.

        {
                global $ilDB;
// todo
/*              
                $query = "SELECT id FROM il_media_pool_page".
                        " WHERE media_pool_id = ".$ilDB->quote($a_media_pool_id, "integer").
                        " AND title = ".$ilDB->quote($a_title, "text");
                $set = $ilDB->query($query);
                
                $pages = array();
                if ($rec = $ilDB->fetchAssoc($set))
                {
                        return true;
                }
*/              
                return false;
        }

ilMediaPoolPage::create

(

)

Create new media pool page.

Reimplemented from ilPageObject.

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

References $ilDB, ilPageObject\getXMLContent(), and ilPageObject\saveInternalLinks().

        {
                global $ilDB;
                
                // create page object
                parent::create();
                
                $this->saveInternalLinks($this->getXMLContent());
        }

Here is the call graph for this function:

ilMediaPoolPage::delete

(

)

delete media_pool page and al related data

public

Reimplemented from ilPageObject.

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

References $ilDB.

        {
                global $ilDB;
                

                // delete internal links information to this page
//              include_once("./Services/COPage/classes/class.ilInternalLink.php");
//              ilInternalLink::_deleteAllLinksToTarget("mep", $this->getId());
                                
                
                // delete co page
                parent::delete();

                return true;
        }

static ilMediaPoolPage::deleteAllPagesOfMediaPool (   $a_media_pool_id )

static

delete media pool page and al related data

public

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

References $ilDB.

        {
                global $ilDB;
                
// todo
/*
                $query = "SELECT * FROM il_media_pool_page".
                        " WHERE media_pool_id = ".$ilDB->quote($a_media_pool_id, "integer");
                $set = $ilDB->query($query);
                
                while($rec = $ilDB->fetchAssoc($set))
                {
                        $mp_page = new ilMediaPoolPage($rec["id"]);
                        $mp_page->delete();
                }
*/
        }

static ilMediaPoolPage::exists (   $a_media_pool_id,   $a_title  )

static

Checks whether a page with given title exists.

Definition at line 112 of file class.ilMediaPoolPage.php.

References $ilDB.

        {
                global $ilDB;

// todo
/*
                
                $query = "SELECT * FROM il_media_pool_page".
                        " WHERE media_pool_id = ".$ilDB->quote($a_media_pool_id, "integer").
                        " AND title = ".$ilDB->quote($a_title, "text");
                $set = $ilDB->query($query);
                if($rec = $ilDB->fetchAssoc($set))
                {
                        return true;
                }
*/              
                return false;
        }

static ilMediaPoolPage::getAllPages (   $a_media_pool_id )

static

Get all pages of media pool.

public

Definition at line 147 of file class.ilMediaPoolPage.php.

References $ilDB.

        {
                global $ilDB;
// todo
/*
                $pages = parent::getAllPages("mep", $a_media_pool_id);
                
                $query = "SELECT * FROM il_media_pool_page".
                        " WHERE media_pool_id = ".$ilDB->quote($a_media_pool_id, "integer").
                        " ORDER BY title";
                $set = $ilDB->query($query);
                
                while($rec = $ilDB->fetchAssoc($set))
                {
                        if (isset($pages[$rec["id"]]))
                        {
                                $pages[$rec["id"]]["title"] = $rec["title"];
                        }
                }
*/              
                return $pages;
        }

ilMediaPoolPage::getUsages

(

)

get all usages of current media object

Definition at line 210 of file class.ilMediaPoolPage.php.

References ilPageObject\getId(), and lookupUsages().

        {
                return $this->lookupUsages($this->getId());
        }

Here is the call graph for this function:

static ilMediaPoolPage::lookupTitle (   $a_page_id )

static

Lookup title.

Definition at line 134 of file class.ilMediaPoolPage.php.

References $ilDB.

Referenced by ilObjUser\getClipboardObjects(), ilObjMediaPoolGUI\insertFromClipboard(), ilPageObjectGUI\showPage(), and ilPageEditorGUI\showSnippetInfo().

        {
                global $ilDB;
        
                include_once("./Modules/MediaPool/classes/class.ilMediaPoolItem.php");
                return ilMediaPoolItem::lookupTitle($a_page_id);
        }

Here is the caller graph for this function:

ilMediaPoolPage::lookupUsages

(

$a_id

)

Lookup usages of media object.

Todo:

: This should be all in one context -> mob id table

Definition at line 220 of file class.ilMediaPoolPage.php.

References $ilDB, $q, $ret, $skip, $ut, and ilPageObject\_exists().

Referenced by getUsages().

        {
                global $ilDB;

                // get usages in pages
                $q = "SELECT * FROM page_pc_usage WHERE pc_id = ".
                        $ilDB->quote($a_id, "integer").
                        " AND pc_type = ".$ilDB->quote("incl", "text");
                $us_set = $ilDB->query($q);
                $ret = array();
                while($us_rec = $ilDB->fetchAssoc($us_set))
                {
                        $ut = "";
                        if(is_int(strpos($us_rec["usage_type"], ":")))
                        {
                                $us_arr = explode(":", $us_rec["usage_type"]);
                                $ut = $us_arr[1];
                                $ct = $us_arr[0];
                        }

                        // check whether page exists
                        $skip = false;
                        if ($ut == "pg")
                        {
                                include_once("./Services/COPage/classes/class.ilPageObject.php");
                                if (!ilPageObject::_exists($ct, $us_rec["usage_id"]))
                                {
                                        $skip = true;
                                }
                        }
                                
                        if (!$skip)
                        {
                                $ret[] = array("type" => $us_rec["usage_type"],
                                        "id" => $us_rec["usage_id"],
                                        "hist_nr" => $us_rec["usage_hist_nr"]);
                        }
                }

                // get usages in media pools
                $q = "SELECT DISTINCT mep_id FROM mep_tree JOIN mep_item ON (child = obj_id) WHERE mep_item.obj_id = ".
                        $ilDB->quote($a_id, "integer")." AND mep_item.type = ".$ilDB->quote("pg", "text");
                $us_set = $ilDB->query($q);
                while($us_rec = $ilDB->fetchAssoc($us_set))
                {
                        $ret[] = array("type" => "mep",
                                "id" => $us_rec["mep_id"]);
                }
                
                return $ret;
        }

Here is the call graph for this function:

Here is the caller graph for this function:

ilMediaPoolPage::read

(

)

Read media_pool data.

Reimplemented from ilPageObject.

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

References $ilDB.

        {
                global $ilDB;
                
                // get co page
                parent::read();
        }

ilMediaPoolPage::update	(		$a_validate = true,
			$a_no_history = false
	)

update object data

public

Returns

boolean

Definition at line 45 of file class.ilMediaPoolPage.php.

References $ilDB.

        {
                global $ilDB;
                                parent::update($a_validate, $a_no_history);

                return true;
        }

---

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

• Modules/MediaPool/classes/class.ilMediaPoolPage.php