ILIAS  Release_5_0_x_branch Revision 61816
 All Data Structures Namespaces Files Functions Variables Groups Pages
ilMediaPoolPage Class Reference

Class ilMediaPoolPage. More...

+ Inheritance diagram for ilMediaPoolPage:
+ Collaboration diagram for ilMediaPoolPage:

Public Member Functions

 getParentType ()
 Get parent type.
 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 ($a_incl_hist=true)
 get all usages of current media object
 lookupUsages ($a_id, $a_incl_hist=true)
 Lookup usages of media object.
- Public Member Functions inherited from ilPageObject
 ilPageObject ($a_id=0, $a_old_nr=0, $a_lang="-")
 Constructor public.
 afterConstructor ()
 After constructor.
 initPageConfig ()
 Init page config.
 setLanguage ($a_val)
 Set language.
 getLanguage ()
 Get language.
 setPageConfig ($a_val)
 Set page config object.
 getPageConfig ()
 Get page config object.
 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.
 setLastChangeUser ($a_val)
 Set last change user.
 getLastChangeUser ()
 Get last change user.
 setShowActivationInfo ($a_val)
 Set show page activation info.
 getShowActivationInfo ()
 Get show page activation info.
 buildDom ($a_force=false)
 freeDom ()
 getDom ()
 Deprecated php4DomDocument.
 getDomDoc ()
 Get dom doc (php5 dom document)
 setId ($a_id)
 set id
 getId ()
 setParentId ($a_id)
 getParentId ()
 addUpdateListener (&$a_object, $a_method, $a_parameters="")
 callUpdateListeners ()
 setActive ($a_active)
 set activation
 getActive ($a_check_scheduled_activation=false)
 get activation
 _writeActive ($a_id, $a_parent_type, $a_active, $a_reset_scheduled_activation=true, $a_lang="-")
 write activation status
 _lookupActivationData ($a_id, $a_parent_type, $a_lang="-")
 Lookup activation data.
 _writeParentId ($a_parent_type, $a_pg_id, $a_par_id)
 Write parent id.
 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="")
 Get a content object of the page.
getContentNode ($a_hier_id, $a_pc_id="")
 Get content node from dom.
 checkForTag ($a_content_tag, $a_hier_id, $a_pc_id="")
 Get content node from dom.
 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_clone_mobs=false)
 Copy content of page; replace page components with copies where necessary (e.g.
 handleCopiedContent ($a_dom, $a_self_ass=true, $a_clone_mobs=false)
 Handle copied content.
 newIIMCopies ($temp_dom)
 Replaces media objects in interactive images with copies of the interactive images.
 newMobCopies ($temp_dom)
 Replaces media objects with copies.
 newQuestionCopies (&$temp_dom)
 Replaces existing question content elements with new copies.
 removeQuestions (&$temp_dom)
 Remove questions from document.
 countPageContents ()
 Remove questions from document.
 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)
 setImportMode ($a_val)
 Set import mode.
 getImportMode ()
 Get import mode.
 needsImportParsing ($a_parse="")
 setContainsQuestion ($a_val)
 Set contains question.
 getContainsQuestion ()
 Get contains question.
 collectMediaObjects ($a_inline_only=true)
 get all media objects, that are referenced and used within the page
 getInternalLinks ($a_cnt_multiple=false)
 get all internal links 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
 getHierIdsForPCIds ($a_pc_ids)
 Get hier ids for a set of pc ids.
 addFileSizes ()
 add file sizes
 resolveIntLinks ()
 Resolves all internal link targets of the page, if targets are available (after import)
 resolveMediaAliases ($a_mapping)
 Resolve media aliases (after import)
 resolveIIMMediaAliases ($a_mapping)
 Resolve iim media aliases (in ilContObjParse)
 resolveFileItems ($a_mapping)
 Resolve file items (after import)
 resolveQuestionReferences ($a_mapping)
 Resolve all quesion references (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.
 afterUpdate ()
 After update.
 saveStyleUsage ($a_domdoc, $a_old_nr=0)
 Save all style class/template usages.
 deleteStyleUsages ($a_old_nr=0)
 Delete style usages.
 getLastUpdateOfIncludedElements ()
 Get last update of included elements (media objects and files).
 deleteInternalLinks ()
 Delete internal links.
 saveInternalLinks ($a_domdoc)
 save internal links of page
 create ()
 create new page (with current xml data)
 deleteContent ($a_hid, $a_update=true, $a_pcid="")
 delete content object with hierarchical id $a_hid
 deleteContents ($a_hids, $a_update=true, $a_self_ass=false)
 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, $a_self_ass=false)
 Paste contents from pc clipboard.
 switchEnableMultiple ($a_hids, $a_update=true, $a_self_ass=false)
 (De-)activate elements
 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.
 checkPCIds ()
 Check, whether (all) page content hashes are set.
 getAllPCIds ()
 Get all pc ids.
 existsPCId ($a_pc_id)
 existsPCId
 generatePcId ($a_pc_ids=false)
 Generate new pc id.
 insertPCIds ()
 Insert Page Content IDs.
 getPageContentsHashes ()
 Get page contents hashes.
 getQuestionIds ()
 Get question ids.
 send_paragraph ($par_id, $filename)
 getFO ()
 get fo page content
 registerOfflineHandler ($handler)
 getOfflineHandler ()
 Get offline handler.
 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.
 performAutomaticModifications ()
 Perform automatic modifications (may be overwritten by sub classes)
 saveInitialOpenedContent ($a_type, $a_id, $a_target)
 Save initial opened content.
 getInitialOpenedContent ()
 Get initial opened content.
 beforePageContentUpdate ($a_page_content)
 Before page content update.
 copy ($a_id, $a_parent_type="", $a_parent_id=0, $a_clone_mobs=false)
 Copy page.
 copyPageToTranslation ($a_target_lang)
 Copy page to translation.
 getEditLock ()
 Get page lock.
 releasePageLock ()
 Release page lock.
 getEditLockInfo ()
 Get edit lock info.
 getContentTemplates ()
 Get content templates.

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 _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, $a_lang="")
 Checks whether page exists.
static _existsAndNotEmpty ($a_parent_type, $a_id, $a_lang="-")
 Checks whether page exists and is not empty (may return true on some empty pages)
static preloadActivationDataByParentId ($a_parent_id)
 Preload activation data by Parent Id.
static _lookupActive ($a_id, $a_parent_type, $a_check_scheduled_activation=false, $a_lang="-")
 lookup activation status
static _isScheduledActivation ($a_id, $a_parent_type, $a_lang="-")
 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 _lookupContainsDeactivatedElements ($a_id, $a_parent_type, $a_lang="-")
 lookup whether page contains deactivated elements
static getRecentChanges ($a_parent_type, $a_parent_id, $a_period=30, $a_lang="")
 Get recent pages changes for parent object.
static getAllPages ($a_parent_type, $a_parent_id, $a_lang="-")
 Get all pages for parent object.
static getNewPages ($a_parent_type, $a_parent_id, $a_lang="-")
 Get new pages.
static getParentObjectContributors ($a_parent_type, $a_parent_id, $a_lang="-")
 Get all contributors for parent object.
static getPageContributors ($a_parent_type, $a_page_id, $a_lang="-")
 Get all contributors for parent object.
static getPagesWithLinks ($a_parent_type, $a_parent_id, $a_lang="-")
 Get all pages for parent object that contain internal links.
static lookupTranslations ($a_parent_type, $a_id)
 Lookup translations.
static truncateHTML ($a_text, $a_length=100, $a_ending= '...', $a_exact=false, $a_consider_html=true)
 Truncate (html) string.

Additional Inherited Members

- Data Fields inherited from ilPageObject
 $id
 $ilias
 $dom
 $xml
 $encoding
 $node
 $cur_dtd = "ilias_pg_4_5.dtd"
 $contains_int_link
 $needs_parsing
 $parent_type
 $parent_id
 $update_listeners
 $update_listener_cnt
 $offline_handler
 $dom_builded
 $history_saved
 $language = "-"
- Static Public Attributes inherited from ilPageObject
static $exists = array()
- Protected Member Functions inherited from ilPageObject
 __afterUpdate ($a_domdoc, $a_xml, $a_creation=false, $a_empty=false)
 After update event handler (internal).
 __beforeDelete ()
 Before deletion handler (internal).
 __afterHistoryEntry ($a_old_domdoc, $a_old_content, $a_old_nr)
 Before deletion handler (internal).
- Protected Attributes inherited from ilPageObject
 $import_mode = false
- Static Protected Attributes inherited from ilPageObject
static $activation_data = 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.

Member Function Documentation

static ilMediaPoolPage::_exists (   $a_id)
static

Check whether meida pool page exists.

Parameters
intpage id
Returns
boolean true/false

Definition at line 162 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
intmedia pool id
stringpage name
Returns
boolean page exists true/false

Definition at line 137 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::delete ( )

delete media_pool page and al related data

public

Reimplemented from ilPageObject.

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

References $ilDB.

{
global $ilDB;
// delete internal links information to this page
// include_once("./Services/Link/classes/class.ilInternalLink.php");
// ilInternalLink::_deleteAllLinksToTarget("mep", $this->getId());
// delete co page
return true;
}
static ilMediaPoolPage::deleteAllPagesOfMediaPool (   $a_media_pool_id)
static

delete media pool page and al related data

public

Definition at line 78 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 99 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;
}
ilMediaPoolPage::getParentType ( )

Get parent type.

Returns
string parent type

Reimplemented from ilPageObject.

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

{
return "mep";
}
ilMediaPoolPage::getUsages (   $a_incl_hist = true)

get all usages of current media object

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

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

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

+ Here is the call graph for this function:

static ilMediaPoolPage::lookupTitle (   $a_page_id)
static

Lookup title.

Definition at line 121 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,
  $a_incl_hist = true 
)

Lookup usages of media object.

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

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

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

Referenced by ilWebAccessChecker\checkAccessMob(), and 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");
if (!$a_incl_hist)
{
$q.= " AND usage_hist_nr = ".$ilDB->quote(0, "integer");
}
$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 43 of file class.ilMediaPoolPage.php.

References $ilDB.

{
global $ilDB;
// get co page
}
ilMediaPoolPage::update (   $a_validate = true,
  $a_no_history = false 
)

update object data

public

Returns
boolean

Reimplemented from ilPageObject.

Definition at line 32 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: