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

Class ilDataCollectionField. More...

+ Inheritance diagram for ilDataCollectionRecordViewViewdefinition:
+ Collaboration diagram for ilDataCollectionRecordViewViewdefinition:

Public Member Functions

 getParentType ()
 Get parent type.
 setTableId ($a_id)
 Set Table ID.
 getTableId ()
 Get Table ID.
 getType ()
 Get type.
 getFormtype ()
 Get Formtype.
 doRead ()
 Read Viewdefinition.
 create ($prevent_page_creation=false)
 Create new Viewdefinition.
 update ($a_validate=true, $a_no_history=false)
 Update Viewdefinition.
- 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.
 read ()
 Read page data.
 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.
 delete ()
 delete page object
 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 getInstance ($key)
static getIdByTableId ($a_table_id)
 Get view definition id by table id.
static getInstanceByTableId ($table_id)
static getAvailablePlaceholders ($a_table_id, $a_verbose=false)
 Get all placeholders for table id.
- 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.

Protected Attributes

 $active = false
 $table_id
 $type = 0
 $formtype = 0
- Protected Attributes inherited from ilPageObject
 $import_mode = false

Static Protected Attributes

static $record_view_cache = array()
static $instances = array()
- Static Protected Attributes inherited from ilPageObject
static $activation_data = array()

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).

Detailed Description

Member Function Documentation

ilDataCollectionRecordViewViewdefinition::create (   $prevent_page_creation = false)

Create new Viewdefinition.

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

References ilPageObject\$id, $ilDB, $query, ilPageObject\create(), getFormtype(), ilPageObject\getId(), getTableId(), getType(), ilPageObject\setActive(), and ilPageObject\setId().

{
global $ilDB;
$this->setActive(false);
$id = $ilDB->nextId("il_dcl_view");
$this->setId($id);
$query = "INSERT INTO il_dcl_view (" . "id" . ", table_id" . ", type" . ", formtype" . " ) VALUES (" . $ilDB->quote($this->getId(), "integer")
. "," . $ilDB->quote($this->getTableId(), "integer") . "," . $ilDB->quote($this->getType(), "integer") . ","
. $ilDB->quote($this->getFormtype(), "integer") . ")";
$ilDB->manipulate($query);
if (!$prevent_page_creation) {
}
}

+ Here is the call graph for this function:

ilDataCollectionRecordViewViewdefinition::doRead ( )

Read Viewdefinition.

Definition at line 116 of file class.ilDataCollectionRecordViewViewdefinition.php.

References $ilDB, $query, ilPageObject\getId(), ilPageObject\setActive(), and setTableId().

{
global $ilDB;
$query = "SELECT * FROM il_dcl_view WHERE table_id = " . $ilDB->quote($this->getId(), "integer");
$set = $ilDB->query($query);
$rec = $ilDB->fetchAssoc($set);
$this->setActive(false);
$this->setTableId($rec["table_id"]);
$this->type = $rec["type"];
$this->formtype = $rec["formtype"];
}

+ Here is the call graph for this function:

static ilDataCollectionRecordViewViewdefinition::getAvailablePlaceholders (   $a_table_id,
  $a_verbose = false 
)
static

Get all placeholders for table id.

Parameters
int$a_table_id
bool$a_verbose
Returns
array

Definition at line 216 of file class.ilDataCollectionRecordViewViewdefinition.php.

References ilDataCollectionCache\getTableCache(), ilDataCollectionDatatype\INPUTFORMAT_ILIAS_REF, and ilDataCollectionDatatype\INPUTFORMAT_REFERENCE.

Referenced by ilDataCollectionRecordViewViewdefinitionGUI\postOutputProcessing().

{
$all = array();
require_once("./Modules/DataCollection/classes/class.ilDataCollectionTable.php");
$objTable = ilDataCollectionCache::getTableCache($a_table_id);
$fields = $objTable->getRecordFields();
$standardFields = $objTable->getStandardFields();
foreach ($fields as $field) {
if (!$a_verbose) {
$all[] = "[" . $field->getTitle() . "]";
if ($field->getDatatypeId() == ilDataCollectionDatatype::INPUTFORMAT_REFERENCE) {
$all[] = '[dclrefln field="' . $field->getTitle() . '"][/dclrefln]';
}
if ($field->getDatatypeId() == ilDataCollectionDatatype::INPUTFORMAT_ILIAS_REF) {
$all[] = '[dcliln field="' . $field->getTitle() . '"][/dcliln]';
}
} else {
$all["[" . $field->getTitle() . "]"] = $field;
if ($field->getDatatypeId() == ilDataCollectionDatatype::INPUTFORMAT_REFERENCE) {
$all['[dclrefln field="' . $field->getTitle() . '"][/dclrefln]'] = $field;
}
if ($field->getDatatypeId() == ilDataCollectionDatatype::INPUTFORMAT_ILIAS_REF) {
$all['[dcliln field="' . $field->getTitle() . '"][/dcliln]'] = $field;
}
}
}
foreach ($standardFields as $field) {
$all[] = "[" . $field->getId() . "]";
}
return $all;
}

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

ilDataCollectionRecordViewViewdefinition::getFormtype ( )

Get Formtype.

Returns
int

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

References $formtype.

Referenced by create().

{
}

+ Here is the caller graph for this function:

static ilDataCollectionRecordViewViewdefinition::getIdByTableId (   $a_table_id)
static

Get view definition id by table id.

In the moment we have only one View-Viewdefinition per Table

Parameters
int$a_table_id
Returns
inte

Definition at line 181 of file class.ilDataCollectionRecordViewViewdefinition.php.

References $ilDB, and $row.

Referenced by ilDataCollectionRecordViewGUI\_getViewDefinitionId(), ilDataCollectionTable\cloneStructure(), ilDataCollectionRecordViewViewdefinitionGUI\deleteView(), getInstanceByTableId(), and ilDataCollectionDatatype\parseHTML().

{
if (!isset(self::$record_view_cache[$a_table_id])) {
global $ilDB;
//FIXME die werte bei type und formtype sollten vom constructor genommen werden
$set = $ilDB->query("SELECT id FROM il_dcl_view" . " WHERE table_id = " . $ilDB->quote($a_table_id, "integer") . " AND type = "
. $ilDB->quote(0, "integer") . " and formtype = " . $ilDB->quote(0, "integer"));
$row = $ilDB->fetchObject($set);
self::$record_view_cache[$a_table_id] = $row->id;
}
return self::$record_view_cache[$a_table_id];
}

+ Here is the caller graph for this function:

static ilDataCollectionRecordViewViewdefinition::getInstance (   $key)
static
Parameters
$key
Returns
ilDataCollectionRecordViewViewdefinition

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

Referenced by getInstanceByTableId().

{
// if (!isset(self::$instances[$key])) {
// var_dump($key); // FSX
self::$instances[$key] = new self($key);
// }
return self::$instances[$key];
}

+ Here is the caller graph for this function:

static ilDataCollectionRecordViewViewdefinition::getInstanceByTableId (   $table_id)
static
Parameters
$table_id
Returns
ilDataCollectionRecordViewViewdefinition

Definition at line 201 of file class.ilDataCollectionRecordViewViewdefinition.php.

References ilPageObject\$id, $table_id, getIdByTableId(), and getInstance().

Referenced by ilDataCollectionRecordViewGUI\hasTableValidViewDefinition(), and ilDataCollectionRecordViewGUI\hasValidViewDefinition().

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

ilDataCollectionRecordViewViewdefinition::getParentType ( )

Get parent type.

Returns
string parent type

Reimplemented from ilPageObject.

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

{
return "dclf";
}
ilDataCollectionRecordViewViewdefinition::getTableId ( )

Get Table ID.

Returns
int

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

References $table_id.

Referenced by create().

{
}

+ Here is the caller graph for this function:

ilDataCollectionRecordViewViewdefinition::getType ( )

Get type.

Returns
int

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

References $type.

Referenced by create().

{
return $this->type;
}

+ Here is the caller graph for this function:

ilDataCollectionRecordViewViewdefinition::setTableId (   $a_id)

Set Table ID.

Parameters
int$a_id

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

Referenced by doRead().

{
$this->table_id = $a_id;
}

+ Here is the caller graph for this function:

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

Update Viewdefinition.

Parameters
bool$a_validate
bool$a_no_history
Returns
boolean

Reimplemented from ilPageObject.

Definition at line 159 of file class.ilDataCollectionRecordViewViewdefinition.php.

{
//TODO
//Page-Object updaten
//Es wäre auch möglich direkt in der GUI-Klasse ilPageObject aufzurufen. Falls wir aber bei doCreate,
//das Page-Object anlegen, fänd ich es sinnvoll, wenn wir auch hier das PageObject updaten würden.
//Andernfalls sämtliche Page-Object-Methoden in der GUI-Klasse aufrufen.
parent::update($a_validate, $a_no_history);
return true;
}

Field Documentation

ilDataCollectionRecordViewViewdefinition::$active = false
protected
ilDataCollectionRecordViewViewdefinition::$formtype = 0
protected

Definition at line 36 of file class.ilDataCollectionRecordViewViewdefinition.php.

Referenced by getFormtype().

ilDataCollectionRecordViewViewdefinition::$instances = array()
staticprotected
ilDataCollectionRecordViewViewdefinition::$record_view_cache = array()
staticprotected
ilDataCollectionRecordViewViewdefinition::$table_id
protected
ilDataCollectionRecordViewViewdefinition::$type = 0
protected

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

Referenced by getType().


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