ILIAS  release_4-3 Revision
 All Data Structures Namespaces Files Functions Variables Groups Pages
ilPortfolioPage Class Reference

Page for user portfolio. More...

+ Inheritance diagram for ilPortfolioPage:
+ Collaboration diagram for ilPortfolioPage:

Public Member Functions

 __construct ($a_portfolio_id, $a_id=0, $a_old_nr=0)
 Constructor.
 setType ($a_val)
 Set type.
 getType ()
 Get type.
 setTitle ($a_title)
 Set Title.
 getTitle ()
 Get Title.
 setOrderNr ($a_val)
 Set order nr.
 getOrderNr ()
 Get order nr.
 create ()
 Create new portfolio page.
 update ($a_validate=true, $a_no_history=false)
 Update page.
 read ()
 Read page data.
 delete ()
 delete portfolio page and all related data
- 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.
 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.
 _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
 _lookupActivationData ($a_id, $a_parent_type)
 lookup activation status
 _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)
 needsImportParsing ($a_parse="")
 setContainsQuestion ($a_val)
 Set contains question.
 getContainsQuestion ()
 Get contains question.
 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 ($a_cnt_multiple=false)
 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
 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
 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
 saveSkillUsage ($a_xml="", $a_old_nr=0)
 save content include usages
 collectSkills ($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, $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.
 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.
 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)
 _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.
 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.

Static Public Member Functions

static lookupMaxOrderNr ($a_portfolio_id)
 Lookup max order nr for portfolio.
static lookupTitle ($a_page_id)
 Lookup title.
static getAllPages ($a_portfolio_id)
 Get pages of portfolio.
static fixOrdering ($a_portfolio_id)
 Fix ordering.
static findPortfolioForPage ($a_page_id)
 Get portfolio id of page id.
- 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 _getQuestionIdsForPage ($a_parent_type, $a_page_id)
 Get all questions of a page.
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.

Data Fields

const TYPE_PAGE = 1
const TYPE_BLOG = 2
- Data Fields inherited from ilPageObject
 $id
 $ilias
 $dom
 $xml
 $encoding
 $node
 $cur_dtd = "ilias_pg_4_3.dtd"
 $contains_int_link
 $needs_parsing
 $parent_type
 $parent_id
 $update_listeners
 $update_listener_cnt
 $offline_handler
 $dom_builded
 $history_saved
 $layout_mode

Protected Member Functions

 getPropertiesForDB ()
 Get properties for insert/update statements.

Static Protected Member Functions

static lookupProperty ($a_id, $a_prop)
 Lookup portfolio page property.

Protected Attributes

 $portfolio_id
 $type
 $title
 $order_nr

Additional Inherited Members

- Static Public Attributes inherited from ilPageObject
static $exists = array()

Detailed Description

Page for user portfolio.

Author
Jörg Lützenkirchen luetz.nosp@m.enki.nosp@m.rchen.nosp@m.@lei.nosp@m.fos.c.nosp@m.om
Version
$Id$

Definition at line 15 of file class.ilPortfolioPage.php.

Constructor & Destructor Documentation

ilPortfolioPage::__construct (   $a_portfolio_id,
  $a_id = 0,
  $a_old_nr = 0 
)

Constructor.

Parameters
int$a_portfolio_id
int$a_id
int$a_old_nr

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

References TYPE_PAGE.

{
$this->portfolio_id = (int)$a_portfolio_id;
$this->type = self::TYPE_PAGE;
parent::__construct("prtf", $a_id, $a_old_nr);
}

Member Function Documentation

ilPortfolioPage::create ( )

Create new portfolio page.

Reimplemented from ilPageObject.

Definition at line 142 of file class.ilPortfolioPage.php.

References ilPageObject\$id, getPropertiesForDB(), ilPageObject\getXMLContent(), ilPageObject\saveInternalLinks(), ilPageObject\setId(), and setOrderNr().

{
global $ilDB;
$this->setOrderNr(self::lookupMaxOrderNr($this->portfolio_id) + 10);
$id = $ilDB->nextId("usr_portfolio_page");
$this->setId($id);
$fields = $this->getPropertiesForDB();
$fields["id"] = array("integer", $id);
$ilDB->insert("usr_portfolio_page", $fields);
$this->saveInternalLinks($this->getXMLContent());
}

+ Here is the call graph for this function:

ilPortfolioPage::delete ( )

delete portfolio page and all related data

Reimplemented from ilPageObject.

Definition at line 205 of file class.ilPortfolioPage.php.

References ilPageObject\$id, $query, ilInternalLink\_deleteAllLinksToTarget(), and ilPageObject\getId().

Referenced by ilObjPortfolioGUI\deletePortfolioPages().

{
global $ilDB;
$id = $this->getId();
if($id)
{
// delete internal links information to this page
include_once("./Services/COPage/classes/class.ilInternalLink.php");
// delete record of table usr_portfolio_page
$query = "DELETE FROM usr_portfolio_page".
" WHERE id = ".$ilDB->quote($this->getId(), "integer");
$ilDB->manipulate($query);
// delete co page
}
}

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

static ilPortfolioPage::findPortfolioForPage (   $a_page_id)
static

Get portfolio id of page id.

Parameters
int$a_page_id
Returns
int

Definition at line 308 of file class.ilPortfolioPage.php.

References lookupProperty().

Referenced by ilObjMediaObject\getParentObjectIdForUsage().

{
return self::lookupProperty($a_page_id, "portfolio_id");
}

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

static ilPortfolioPage::fixOrdering (   $a_portfolio_id)
static

Fix ordering.

Parameters
int$a_portfolio_id

Definition at line 286 of file class.ilPortfolioPage.php.

References getAllPages().

Referenced by ilObjPortfolioGUI\savePortfolioPagesOrdering().

{
global $ilDB;
$pages = self::getAllPages($a_portfolio_id);
$cnt = 10;
foreach ($pages as $p)
{
$ilDB->manipulate("UPDATE usr_portfolio_page SET ".
" order_nr = ".$ilDB->quote($cnt, "integer").
" WHERE id = ".$ilDB->quote($p["id"], "integer")
);
$cnt+= 10;
}
}

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

static ilPortfolioPage::getAllPages (   $a_portfolio_id)
static

Get pages of portfolio.

Parameters
int$a_portfolio_id
Returns
array

Definition at line 260 of file class.ilPortfolioPage.php.

References $lng.

Referenced by ilObjPortfolio\doDelete(), ilPortfolioHTMLExport\exportHTMLPages(), fixOrdering(), ilPortfolioPageTableGUI\getItems(), and ilObjPortfolioGUI\preview().

{
global $ilDB, $lng;
$set = $ilDB->query("SELECT * FROM usr_portfolio_page".
" WHERE portfolio_id = ".$ilDB->quote($a_portfolio_id, "integer").
" ORDER BY order_nr");
$pages = array();
while ($rec = $ilDB->fetchAssoc($set))
{
// because of migration of extended user profiles
if($rec["title"] == "###-")
{
$rec["title"] = $lng->txt("profile");
}
$pages[] = $rec;
}
return $pages;
}

+ Here is the caller graph for this function:

ilPortfolioPage::getOrderNr ( )

Get order nr.

Returns
int order nr

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

References $order_nr.

Referenced by getPropertiesForDB().

{
}

+ Here is the caller graph for this function:

ilPortfolioPage::getPropertiesForDB ( )
protected

Get properties for insert/update statements.

Returns
array

Definition at line 129 of file class.ilPortfolioPage.php.

References getOrderNr(), getTitle(), and getType().

Referenced by create(), and update().

{
$fields = array("portfolio_id" => array("integer", $this->portfolio_id),
"type" => array("integer", $this->getType()),
"title" => array("text", $this->getTitle()),
"order_nr" => array("integer", $this->getOrderNr()));
return $fields;
}

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

ilPortfolioPage::getTitle ( )

Get Title.

Returns
string Title

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

References $lng, and $title.

Referenced by getPropertiesForDB().

{
global $lng;
// because of migration of extended user profiles
if($this->title == "###-")
{
return $lng->txt("profile");
}
return $this->title;
}

+ Here is the caller graph for this function:

ilPortfolioPage::getType ( )

Get type.

Returns
int type

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

References $type.

Referenced by ilObjExerciseVerificationGUI\downloadFromPortfolioPage(), ilObjTestVerificationGUI\downloadFromPortfolioPage(), and getPropertiesForDB().

{
return $this->type;
}

+ Here is the caller graph for this function:

static ilPortfolioPage::lookupMaxOrderNr (   $a_portfolio_id)
static

Lookup max order nr for portfolio.

Parameters
int$a_portfolio_id
Returns
int

Definition at line 114 of file class.ilPortfolioPage.php.

{
global $ilDB;
$set = $ilDB->query("SELECT MAX(order_nr) m FROM usr_portfolio_page".
" WHERE portfolio_id = ".$ilDB->quote($a_portfolio_id, "integer"));
$rec = $ilDB->fetchAssoc($set);
return (int) $rec["m"];
}
static ilPortfolioPage::lookupProperty (   $a_id,
  $a_prop 
)
staticprotected

Lookup portfolio page property.

Parameters
int$a_id
string$a_prop
Returns
mixed

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

Referenced by findPortfolioForPage(), and lookupTitle().

{
global $ilDB;
$set = $ilDB->query("SELECT ".$a_prop.
" FROM usr_portfolio_page".
" WHERE id = ".$ilDB->quote($a_id, "integer"));
$rec = $ilDB->fetchAssoc($set);
return $rec[$a_prop];
}

+ Here is the caller graph for this function:

static ilPortfolioPage::lookupTitle (   $a_page_id)
static

Lookup title.

Parameters
int$a_page_id

Definition at line 249 of file class.ilPortfolioPage.php.

References lookupProperty().

{
return self::lookupProperty($a_page_id, "title");
}

+ Here is the call graph for this function:

ilPortfolioPage::read ( )

Read page data.

Reimplemented from ilPageObject.

Definition at line 185 of file class.ilPortfolioPage.php.

References $query, ilPageObject\getId(), setOrderNr(), setTitle(), and setType().

{
global $ilDB;
$query = "SELECT * FROM usr_portfolio_page".
" WHERE id = ".$ilDB->quote($this->getId(), "integer");
$set = $ilDB->query($query);
$rec = $ilDB->fetchAssoc($set);
$this->setType($rec["type"]);
$this->setTitle($rec["title"]);
$this->setOrderNr($rec["order_nr"]);
// get co page
}

+ Here is the call graph for this function:

ilPortfolioPage::setOrderNr (   $a_val)

Set order nr.

Parameters
intorder nr

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

Referenced by create(), and read().

{
$this->order_nr = (int)$a_val;
}

+ Here is the caller graph for this function:

ilPortfolioPage::setTitle (   $a_title)

Set Title.

Parameters
string$a_titleTitle

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

Referenced by read(), and ilObjPortfolioGUI\savePortfolioPagesOrdering().

{
$this->title = $a_title;
}

+ Here is the caller graph for this function:

ilPortfolioPage::setType (   $a_val)

Set type.

Parameters
inttype

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

Referenced by read(), ilObjPortfolioGUI\save(), ilObjPortfolioGUI\saveBlog(), and ilObjPortfolioGUI\savePage().

{
$this->type = $a_val;
}

+ Here is the caller graph for this function:

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

Update page.

Returns
boolean

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

References ilPageObject\$id, ilPageObject\getId(), and getPropertiesForDB().

{
global $ilDB;
$id = $this->getId();
if($id)
{
$fields = $this->getPropertiesForDB();
$ilDB->update("usr_portfolio_page", $fields,
array("id"=>array("integer", $id)));
parent::update($a_validate, $a_no_history);
return true;
}
return false;
}

+ Here is the call graph for this function:

Field Documentation

ilPortfolioPage::$order_nr
protected

Definition at line 20 of file class.ilPortfolioPage.php.

Referenced by getOrderNr().

ilPortfolioPage::$portfolio_id
protected

Definition at line 17 of file class.ilPortfolioPage.php.

ilPortfolioPage::$title
protected

Definition at line 19 of file class.ilPortfolioPage.php.

Referenced by getTitle().

ilPortfolioPage::$type
protected

Definition at line 18 of file class.ilPortfolioPage.php.

Referenced by getType().

const ilPortfolioPage::TYPE_PAGE = 1

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