Inheritance diagram for ilObjDataCollection:

Collaboration diagram for ilObjDataCollection:

Public Member Functions
	initType ()

	doRead ()

	doClone ()

	doUpdate ()

	reorderTables ($table_order)

	doCloneObject ($new_obj, $a_target_id, $a_copy_id=null, $a_omit_tree=false)
	Clone DCL. More...

	cloneStructure ($original_id)
	Attention only use this for objects who have not yet been created (use like: $x = new ilObjDataCollection; $x->cloneStructure($id)) More...

	setOnline ($a_val)
	setOnline More...

	getOnline ()
	getOnline More...

	setRating ($a_val)
	setRating More...

	getRating ()
	getRating More...

	setPublicNotes ($a_val)
	setPublicNotes More...

	getPublicNotes ()
	getPublicNotes More...

	setApproval ($a_val)
	setApproval More...

	getApproval ()
	getApproval More...

	setNotification ($a_val)
	setNotification More...

	getNotification ()
	getNotification More...

	getTables ()

	getTableById ($table_id)

	getVisibleTables ()

	getStyleSheetId ()

	prepareMessageText (string $body)

Public Member Functions inherited from ilObject2
	__construct ($a_id=0, $a_reference=true)
	Constructor @access public. More...

	withReferences ()
	determines wehter objects are referenced or not (got ref ids or not) More...

	read ()
	Read data from db. More...

	setRefId ($a_id)
	set reference id @access public More...

	getRefId ()
	get reference id @access public More...

	getType ()
	get object type @access public More...

	setType ($a_type)
	set object type @access public More...

	getPresentationTitle ()
	get presentation title Normally same as title Overwritten for sessions More...

	getTitle ()
	get object title @access public More...

	getUntranslatedTitle ()
	get untranslated object title @access public More...

	setTitle ($a_title)
	set object title More...

	getDescription ()
	get object description More...

	setDescription ($a_desc)
	set object description More...

	getLongDescription ()
	get object long description (stored in object_description) More...

	getImportId ()
	get import id More...

	setImportId ($a_import_id)
	set import id More...

	getOwner ()
	get object owner More...

	getOwnerName ()

	setOwner ($a_owner)
	set object owner More...

	getCreateDate ()
	get create date @access public More...

	getLastUpdateDate ()
	get last update date @access public More...

	create ($a_clone_mode=false)

	update ()
	update object in db More...

	MDUpdateListener ($a_element)
	Meta data update listener. More...

	createMetaData ()
	create meta data entry More...

	updateMetaData ()
	update meta data entry More...

	deleteMetaData ()
	delete meta data entry More...

	updateOwner ()
	update owner of object in db More...

	putInTree ($a_parent_ref)
	maybe this method should be in tree object!? More...

	setPermissions ($a_parent_ref)
	set permissions of object More...

	createReference ()
	creates reference for object More...

	countReferences ()
	count references of object More...

	delete ()
	delete object or referenced object (in the case of a referenced object, object data is only deleted if last reference is deleted) This function removes an object entirely from system!! More...

	initDefaultRoles ()
	init default roles settings Purpose of this function is to create a local role folder and local roles, that are needed depending on the object type If you want to setup default local roles you MUST overwrite this method in derived object classes (see ilObjForum for an example) @access public More...

	setRegisterMode ($a_bool)

	isUserRegistered ($a_user_id=0)

	requireRegistration ()

	appendCopyInfo ($a_target_id, $a_copy_id)
	Prepend Copy info if object with same name exists in that container. More...

	cloneMetaData ($target_obj)
	Copy meta data. More...

	cloneObject ($a_target_id, $a_copy_id=null, $a_omit_tree=false)

	cloneDependencies ($a_target_id, $a_copy_id)
	Clone object dependencies. More...

Public Member Functions inherited from ilObject
	__construct ($a_id=0, $a_reference=true)
	Constructor @access public. More...

	withReferences ()
	determines wehter objects are referenced or not (got ref ids or not) More...

	read ()
	read object data from db into object More...

	getId ()
	get object id @access public More...

	setId ($a_id)
	set object id @access public More...

	setRefId ($a_id)
	set reference id @access public More...

	getRefId ()
	get reference id @access public More...

	getType ()
	get object type @access public More...

	setType ($a_type)
	set object type @access public More...

	getPresentationTitle ()
	get presentation title Normally same as title Overwritten for sessions More...

	getTitle ()
	get object title @access public More...

	getUntranslatedTitle ()
	get untranslated object title @access public More...

	setTitle ($a_title)
	set object title More...

	getDescription ()
	get object description More...

	setDescription ($a_desc)
	set object description More...

	getLongDescription ()
	get object long description (stored in object_description) More...

	getImportId ()
	get import id More...

	setImportId ($a_import_id)
	set import id More...

	setOfflineStatus ($a_status)
	Set offline status. More...

	getOfflineStatus ()
	Get offline status. More...

	supportsOfflineHandling ()
	Check whether object supports offline handling. More...

	getOwner ()
	get object owner More...

	getOwnerName ()

	setOwner ($a_owner)
	set object owner More...

	getCreateDate ()
	get create date @access public More...

	getLastUpdateDate ()
	get last update date @access public More...

	getDiskUsage ()
	Gets the disk usage of the object in bytes. More...

	create ()
	create More...

	update ()
	update object in db More...

	MDUpdateListener ($a_element)
	Meta data update listener. More...

	createMetaData ()
	create meta data entry More...

	updateMetaData ()
	update meta data entry More...

	deleteMetaData ()
	delete meta data entry More...

	updateOwner ()
	update owner of object in db More...

	putInTree ($a_parent_ref)
	maybe this method should be in tree object!? More...

	setPermissions ($a_parent_ref)
	set permissions of object More...

	setParentRolePermissions ($a_parent_ref)
	Initialize the permissions of parent roles (local roles of categories, global roles...) This method is overwritten in e.g courses, groups for building permission intersections with non_member templates. More...

	createReference ()
	creates reference for object More...

	countReferences ()
	count references of object More...

	delete ()
	delete object or referenced object (in the case of a referenced object, object data is only deleted if last reference is deleted) This function removes an object entirely from system!! More...

	initDefaultRoles ()
	init default roles settings Purpose of this function is to create a local role folder and local roles, that are needed depending on the object type If you want to setup default local roles you MUST overwrite this method in derived object classes (see ilObjForum for an example) @access public More...

	applyDidacticTemplate ($a_tpl_id)
	Apply template. More...

	setRegisterMode ($a_bool)

	isUserRegistered ($a_user_id=0)

	requireRegistration ()

	getXMLZip ()

	getHTMLDirectory ()

	appendCopyInfo ($a_target_id, $a_copy_id)
	Prepend Copy info if object with same name exists in that container. More...

	cloneDependencies ($a_target_id, $a_copy_id)
	Clone object dependencies. More...

	cloneMetaData ($target_obj)
	Copy meta data. More...

	getPossibleSubObjects ($a_filter=true)
	get all possible subobjects of this type the object can decide which types of subobjects are possible jut in time overwrite if the decision distinguish from standard model More...

Static Public Member Functions
static	_hasWriteAccess ($ref)

static	_hasReadAccess ($ref)

static	_hasTableByTitle ($title, $obj_id)
	Checks if a DataCollection has a table with a given title. More...

Static Public Member Functions inherited from ilObject2
static	_lookupObjIdByImportId ($a_import_id)

static	_lookupOwnerName ($a_owner_id)
	lookup owner name for owner id More...

static	_getIdForImportId ($a_import_id)
	get current object id for import id (static) More...

static	_getAllReferences ($a_id)
	get all reference ids of object More...

static	_lookupTitle ($a_id)
	lookup object title More...

static	_lookupOwner ($a_id)
	lookup object owner More...

static	_getIdsForTitle ($title, $type='', $partialmatch=false)

static	_lookupDescription ($a_id)
	lookup object description More...

static	_lookupLastUpdate ($a_id, $a_as_string=false)
	lookup last update More...

static	_getLastUpdateOfObjects ($a_objs)
	Get last update for a set of media objects. More...

static	_lookupObjId ($a_id)

static	_setDeletedDate ($a_ref_id, $a_deleted_by)

static	_resetDeletedDate ($a_ref_id)
	only called in ilObjectGUI::insertSavedNodes More...

static	_lookupDeletedDate ($a_ref_id)
	only called in ilObjectGUI::insertSavedNodes More...

static	_writeTitle ($a_obj_id, $a_title)
	write title to db (static) More...

static	_writeDescription ($a_obj_id, $a_desc)
	write description to db (static) More...

static	_writeImportId ($a_obj_id, $a_import_id)
	write import id to db (static) More...

static	_lookupType ($a_id, $a_reference=false)
	lookup object type More...

static	_isInTrash ($a_ref_id)
	checks wether object is in trash More...

static	_hasUntrashedReference ($a_obj_id)
	checks wether an object has at least one reference that is not in trash More...

static	_lookupObjectId ($a_ref_id)
	lookup object id More...

static	_getObjectsDataForType ($a_type, $a_omit_trash=false)
	get all objects of a certain type More...

static	_exists ($a_id, $a_reference=false, $a_type=null)
	checks if an object exists in object_data@access public More...

static	_getObjectsByType ($a_obj_type="", $a_owner="")
	Get objects by type. More...

static	_prepareCloneSelection ($a_ref_ids, $new_type, $a_show_path=true)
	Prepare copy wizard object selection. More...

static	_getIcon ($a_obj_id="", $a_size="big", $a_type="", $a_offline=false)
	Get icon for repository item. More...

Static Public Member Functions inherited from ilObject
static	_lookupObjIdByImportId ($a_import_id)

static	_lookupImportId ($a_obj_id)

static	_lookupOwnerName ($a_owner_id)
	lookup owner name for owner id More...

static	_getIdForImportId ($a_import_id)
	get current object id for import id (static) More...

static	_getAllReferences ($a_id)
	get all reference ids of object More...

static	_lookupTitle ($a_id)
	lookup object title More...

static	lookupOfflineStatus ($a_obj_id)
	Lookup offline status using objectDataCache. More...

static	_lookupOwner ($a_id)
	lookup object owner More...

static	_getIdsForTitle ($title, $type='', $partialmatch=false)

static	_lookupDescription ($a_id)
	lookup object description More...

static	_lookupLastUpdate ($a_id, $a_as_string=false)
	lookup last update More...

static	_getLastUpdateOfObjects ($a_objs)
	Get last update for a set of media objects. More...

static	_lookupObjId ($a_id)

static	_setDeletedDate ($a_ref_id, $a_deleted_by)

static	setDeletedDates ($a_ref_ids, $a_user_id)
	Set deleted date. More...

static	_resetDeletedDate ($a_ref_id)
	only called in ilObjectGUI::insertSavedNodes More...

static	_lookupDeletedDate ($a_ref_id)
	only called in ilObjectGUI::insertSavedNodes More...

static	_writeTitle ($a_obj_id, $a_title)
	write title to db (static) More...

static	_writeDescription ($a_obj_id, $a_desc)
	write description to db (static) More...

static	_writeImportId ($a_obj_id, $a_import_id)
	write import id to db (static) More...

static	_lookupType ($a_id, $a_reference=false)
	lookup object type More...

static	_isInTrash ($a_ref_id)
	checks wether object is in trash More...

static	_hasUntrashedReference ($a_obj_id)
	checks wether an object has at least one reference that is not in trash More...

static	_lookupObjectId ($a_ref_id)
	lookup object id More...

static	_getObjectsDataForType ($a_type, $a_omit_trash=false)
	get all objects of a certain type More...

static	_exists ($a_id, $a_reference=false, $a_type=null)
	checks if an object exists in object_data@access public More...

static	_getObjectsByType ($a_obj_type="", $a_owner="")
	Get objects by type. More...

static	_prepareCloneSelection ($a_ref_ids, $new_type, $show_path=true)
	Prepare copy wizard object selection. More...

static	_getIcon ( $a_obj_id="", $a_size="big", $a_type="", $a_offline=false)
	Get icon for repository item. More...

static	collectDeletionDependencies (&$deps, $a_ref_id, $a_obj_id, $a_type, $a_depth=0)
	Collect deletion dependencies. More...

static	getDeletionDependencies ($a_obj_id)
	Get deletion dependencies. More...

static	getLongDescriptions (array $a_obj_ids)
	Get long description data. More...

static	getAllOwnedRepositoryObjects ($a_user_id)
	Get all ids of objects user owns. More...

static	fixMissingTitles ($a_type, array &$a_obj_title_map)
	Try to fix missing object titles. More...

static	_lookupCreationDate ($a_id)
	Lookup creation date. More...

static	hasAutoRating ($a_type, $a_ref_id)
	Check if auto rating is active for parent group/course. More...

Protected Member Functions
	doCreate ($clone_mode=false)

	doDelete ()

Protected Member Functions inherited from ilObject2
	initType ()

	doRead ()

	doCreate ()

	beforeCreate ()
	If overwritten this method should return true, there is currently no "abort" handling for cases where "false" is returned. More...

	doUpdate ()

	beforeUpdate ()

	doMDUpdateListener ($a_element)

	beforeMDUpdateListener ($a_element)

	doCreateMetaData ()

	beforeCreateMetaData ()

	doUpdateMetaData ()

	beforeUpdateMetaData ()

	doDelete ()

	beforeDelete ()

	doCloneObject ($new_obj, $a_target_id, $a_copy_id=null)

	beforeCloneObject ()

Additional Inherited Members
Data Fields inherited from ilObject
const	TITLE_LENGTH = 255
	max length of object title More...

const	DESC_LENGTH = 128

	$lng

	$id

	$ref_id

	$type

	$title

	$untranslatedTitle

	$desc

	$long_desc

	$owner

	$create_date

	$last_update

	$import_id

	$register = false

	$referenced

	$objectList

	$max_title

	$max_desc

	$add_dots

Protected Attributes inherited from ilObject
	$objDefinition

	$db

	$log

	$error

	$tree

	$app_event_handler

	$rbacadmin

	$rbacreview

Detailed Description

Class ilObjDataCollection.

Author: Jörg Lützenkirchen luetz.nosp@m.enki.nosp@m.rchen.nosp@m.@lei.nosp@m.fos.c.nosp@m.om; Fabian Schmid fs@st.nosp@m.uder.nosp@m.-raim.nosp@m.ann..nosp@m.ch

Version

Id: class.ilObjFolder.php 25528 2010-09-03 10:37:11Z smeyer

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

Member Function Documentation

◆ _hasReadAccess()

static ilObjDataCollection::_hasReadAccess ( $ref )

static

Parameters

$ref	int the reference id of the datacollection object to check.

Returns: bool whether or not the current user has add/edit_entry access to the referenced datacollection

Deprecated:

Definition at line 479 of file class.ilObjDataCollection.php.

    {
        return ilObjDataCollectionAccess::hasReadAccess($ref);
    }

References ilObjDataCollectionAccess\hasReadAccess().

Here is the call graph for this function:

◆ _hasTableByTitle()

static ilObjDataCollection::_hasTableByTitle	(	$title,
		$obj_id
	)

static

Checks if a DataCollection has a table with a given title.

Parameters

$title	Title of table
$obj_id	Obj-ID of the table

Returns: bool

Definition at line 536 of file class.ilObjDataCollection.php.

    {
        global $DIC;
        $ilDB = $DIC['ilDB'];
        $result = $ilDB->query(
            'SELECT * FROM il_dcl_table WHERE obj_id = ' . $ilDB->quote($obj_id, 'integer') . ' AND title = '
            . $ilDB->quote($title, 'text')
        );
 
        return ($ilDB->numRows($result)) ? true : false;
    }

References $DIC, $ilDB, $result, ilObject\$title, and true.

Referenced by ilDclTableEditGUI\checkInput().

Here is the caller graph for this function:

◆ _hasWriteAccess()

static ilObjDataCollection::_hasWriteAccess ( $ref )

static

Parameters

$ref	int the reference id of the datacollection object to check.

Returns: bool whether or not the current user has admin/write access to the referenced datacollection

Deprecated:

Definition at line 467 of file class.ilObjDataCollection.php.

    {
        return ilObjDataCollectionAccess::hasWriteAccess($ref);
    }

References ilObjDataCollectionAccess\hasWriteAccess().

Here is the call graph for this function:

◆ cloneStructure()

ilObjDataCollection::cloneStructure ( $original_id )

Attention only use this for objects who have not yet been created (use like: $x = new ilObjDataCollection; $x->cloneStructure($id))

Parameters

$original_id The original ID of the dataselection you want to clone it's structure

Definition at line 341 of file class.ilObjDataCollection.php.

    {
        $original = new ilObjDataCollection($original_id);
 
        $this->setApproval($original->getApproval());
        $this->setNotification($original->getNotification());
        $this->setPublicNotes($original->getPublicNotes());
        $this->setRating($original->getRating());
 
        // delete old tables.
        foreach ($this->getTables() as $table) {
            $table->doDelete();
        }
 
        // add new tables.
        foreach ($original->getTables() as $table) {
            $new_table = new ilDclTable();
            $new_table->setObjId($this->getId());
            $new_table->cloneStructure($table);
        }
 
        // mandatory for all cloning functions
        ilDclCache::setCloneOf($original_id, $this->getId(), ilDclCache::TYPE_DATACOLLECTION);
 
        foreach ($this->getTables() as $table) {
            $table->afterClone();
        }
    }

References ilObject\getId(), getTables(), setApproval(), ilDclCache\setCloneOf(), setNotification(), setPublicNotes(), setRating(), and ilDclCache\TYPE_DATACOLLECTION.

Here is the call graph for this function:

◆ doClone()

ilObjDataCollection::doClone ( )

Returns: bool

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

    {
        return false;
    }

◆ doCloneObject()

ilObjDataCollection::doCloneObject	(	$new_obj,
		$a_target_id,
		$a_copy_id = `null`,
		$a_omit_tree = `false`
	)

Clone DCL.

Parameters

ilObjDataCollection	$new_obj
int	$a_target_id	ref_id
int	$a_copy_id

Returns: ilObjPoll

Definition at line 290 of file class.ilObjDataCollection.php.

    {
 
        //copy online status if object is not the root copy object
        $cp_options = ilCopyWizardOptions::_getInstance($a_copy_id);
 
        if (!$cp_options->isRootNode($this->getRefId())) {
            $new_obj->setOnline($this->getOnline());
        }
 
        $new_obj->cloneStructure($this->getRefId());
 
        return $new_obj;
    }

References ilCopyWizardOptions\_getInstance(), getOnline(), and ilObject2\getRefId().

Here is the call graph for this function:

◆ doCreate()

ilObjDataCollection::doCreate ( $clone_mode = false )

protected

Definition at line 39 of file class.ilObjDataCollection.php.

    {
        global $DIC;
        $ilDB = $DIC['ilDB'];
        $ilLog = $DIC['ilLog'];
 
        $ilLog->write('doCreate');
 
        if (!$clone_mode) {
            //Create Main Table - The title of the table is per default the title of the data collection object
            $main_table = ilDclCache::getTableCache();
            $main_table->setObjId($this->getId());
            $main_table->setTitle($this->getTitle());
            $main_table->setAddPerm(1);
            $main_table->setEditPerm(1);
            $main_table->setDeletePerm(0);
            $main_table->setDeleteByOwner(1);
            $main_table->setEditByOwner(1);
            $main_table->setLimited(0);
            $main_table->setIsVisible(true);
            $main_table->doCreate();
        }
 
        $ilDB->insert(
            "il_dcl_data",
            array(
                "id" => array("integer", $this->getId()),
                "is_online" => array("integer", (int) $this->getOnline()),
                "rating" => array("integer", (int) $this->getRating()),
                "public_notes" => array("integer", (int) $this->getPublicNotes()),
                "approval" => array("integer", (int) $this->getApproval()),
                "notification" => array("integer", (int) $this->getNotification()),
            )
        );
    }

References $DIC, $ilDB, getApproval(), ilObject\getId(), getNotification(), getOnline(), getPublicNotes(), getRating(), ilDclCache\getTableCache(), and ilObject2\getTitle().

Here is the call graph for this function:

◆ doDelete()

ilObjDataCollection::doDelete ( )

protected

Reimplemented from ilObject2.

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

    {
        global $DIC;
        $ilDB = $DIC['ilDB'];
 
        foreach ($this->getTables() as $table) {
            $table->doDelete(false, true);
        }
 
        $query = "DELETE FROM il_dcl_data WHERE id = " . $ilDB->quote($this->getId(), "integer");
        $ilDB->manipulate($query);
    }

References $DIC, $ilDB, $query, ilObject\getId(), and getTables().

Here is the call graph for this function:

◆ doRead()

ilObjDataCollection::doRead ( )

Reimplemented from ilObject2.

Definition at line 23 of file class.ilObjDataCollection.php.

    {
        global $DIC;
        $ilDB = $DIC['ilDB'];
 
        $result = $ilDB->query("SELECT * FROM il_dcl_data WHERE id = " . $ilDB->quote($this->getId(), "integer"));
 
        $data = $ilDB->fetchObject($result);
        $this->setOnline($data->is_online);
        $this->setRating($data->rating);
        $this->setApproval($data->approval);
        $this->setPublicNotes($data->public_notes);
        $this->setNotification($data->notification);
    }

References $data, $DIC, $ilDB, $result, setApproval(), setNotification(), setOnline(), setPublicNotes(), and setRating().

Here is the call graph for this function:

◆ doUpdate()

ilObjDataCollection::doUpdate ( )

Reimplemented from ilObject2.

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

    {
        global $DIC;
        $ilDB = $DIC['ilDB'];
 
        $ilDB->update(
            "il_dcl_data",
            array(
            "id" => array("integer", $this->getId()),
            "is_online" => array("integer", (int) $this->getOnline()),
            "rating" => array("integer", (int) $this->getRating()),
            "public_notes" => array("integer", (int) $this->getPublicNotes()),
            "approval" => array("integer", (int) $this->getApproval()),
            "notification" => array("integer", (int) $this->getNotification()),
        ),
            array(
                "id" => array("integer", $this->getId()),
            )
        );
    }

References $DIC, $ilDB, getApproval(), ilObject\getId(), getNotification(), getOnline(), getPublicNotes(), and getRating().

Here is the call graph for this function:

◆ getApproval()

ilObjDataCollection::getApproval ( )

getApproval

Definition at line 437 of file class.ilObjDataCollection.php.

    {
        return $this->approval;
    }

Referenced by doCreate(), and doUpdate().

Here is the caller graph for this function:

◆ getNotification()

ilObjDataCollection::getNotification ( )

getNotification

Definition at line 455 of file class.ilObjDataCollection.php.

    {
        return $this->notification;
    }

Referenced by doCreate(), and doUpdate().

Here is the caller graph for this function:

◆ getOnline()

ilObjDataCollection::getOnline ( )

getOnline

Definition at line 383 of file class.ilObjDataCollection.php.

    {
        return $this->is_online;
    }

Referenced by doCloneObject(), doCreate(), and doUpdate().

Here is the caller graph for this function:

◆ getPublicNotes()

ilObjDataCollection::getPublicNotes ( )

getPublicNotes

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

    {
        return $this->public_notes;
    }

Referenced by doCreate(), and doUpdate().

Here is the caller graph for this function:

◆ getRating()

ilObjDataCollection::getRating ( )

getRating

Definition at line 401 of file class.ilObjDataCollection.php.

    {
        return $this->rating;
    }

Referenced by doCreate(), and doUpdate().

Here is the caller graph for this function:

◆ getStyleSheetId()

ilObjDataCollection::getStyleSheetId ( )

Definition at line 549 of file class.ilObjDataCollection.php.

550 {

551 }

◆ getTableById()

ilObjDataCollection::getTableById ( $table_id )

Definition at line 506 of file class.ilObjDataCollection.php.

    {
        return ilDclCache::getTableCache($table_id);
    }

References ilDclCache\getTableCache().

Here is the call graph for this function:

◆ getTables()

ilObjDataCollection::getTables ( )

Returns: ilDclTable[] Returns an array of tables of this collection with ids of the tables as keys.

Definition at line 488 of file class.ilObjDataCollection.php.

    {
        global $DIC;
        $ilDB = $DIC['ilDB'];
 
        $query = "SELECT id FROM il_dcl_table WHERE obj_id = " . $ilDB->quote($this->getId(), "integer") .
            " ORDER BY -table_order DESC";
        $set = $ilDB->query($query);
        $tables = array();
 
        while ($rec = $ilDB->fetchAssoc($set)) {
            $tables[$rec['id']] = ilDclCache::getTableCache($rec['id']);
        }
 
        return $tables;
    }

References $DIC, $ilDB, $query, ilObject\getId(), and ilDclCache\getTableCache().

Referenced by ilDclReferenceFieldRepresentation\buildFieldCreationInput(), cloneStructure(), doDelete(), and getVisibleTables().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getVisibleTables()

ilObjDataCollection::getVisibleTables ( )

Returns: array

Definition at line 515 of file class.ilObjDataCollection.php.

    {
        $tables = array();
        foreach ($this->getTables() as $table) {
            if ($table->getIsVisible() && $table->getVisibleTableViews($this->ref_id)) {
                $tables[$table->getId()] = $table;
            }
        }
 
        return $tables;
    }

References getTables().

Here is the call graph for this function:

◆ initType()

ilObjDataCollection::initType ( )

Reimplemented from ilObject2.

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

    {
        $this->type = "dcl";
    }

◆ prepareMessageText()

ilObjDataCollection::prepareMessageText ( string $body )

Definition at line 553 of file class.ilObjDataCollection.php.

                                                    : string
    {
        if (preg_match_all('/<.*?br.*?>/', $body, $matches)) {
            $matches = array_unique($matches[0]);
            $brNewLineMatches = array_map(static function($match): string {
                return $match . "\n";
            }, $matches);
 
            //Remove carriage return to guarantee all new line can be properly found
            $body = str_replace("\r", '', $body);
            //Replace occurrence of <br> + \n with a single \n
            $body = str_replace($brNewLineMatches, "\n", $body);
            //Replace additional <br> with a \”
            $body = str_replace($matches, "\n", $body);
            //Revert removal of carriage return
            return str_replace("\n", "\r\n", $body);
        }
        return $body;
    }

◆ reorderTables()

ilObjDataCollection::reorderTables ( $table_order )

Parameters

$table_order

Definition at line 266 of file class.ilObjDataCollection.php.

    {
        if ($table_order) {
            $order = 10;
            foreach ($table_order as $title) {
                $table_id = ilDclTable::_getTableIdByTitle($title, $this->getId());
                $table = ilDclCache::getTableCache($table_id);
                $table->setOrder($order);
                $table->doUpdate();
                $order += 10;
            }
        }
    }

References ilObject\$title, ilDclTable\_getTableIdByTitle(), ilObject\getId(), and ilDclCache\getTableCache().

Here is the call graph for this function:

◆ setApproval()

ilObjDataCollection::setApproval ( $a_val )

setApproval

Definition at line 428 of file class.ilObjDataCollection.php.

    {
        $this->approval = $a_val;
    }

Referenced by cloneStructure(), and doRead().

Here is the caller graph for this function:

◆ setNotification()

ilObjDataCollection::setNotification ( $a_val )

setNotification

Definition at line 446 of file class.ilObjDataCollection.php.

    {
        $this->notification = $a_val;
    }

References notification().

Referenced by cloneStructure(), and doRead().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setOnline()

ilObjDataCollection::setOnline ( $a_val )

setOnline

Definition at line 374 of file class.ilObjDataCollection.php.

    {
        $this->is_online = $a_val;
    }

Referenced by doRead().

Here is the caller graph for this function:

◆ setPublicNotes()

ilObjDataCollection::setPublicNotes ( $a_val )

setPublicNotes

Definition at line 410 of file class.ilObjDataCollection.php.

    {
        $this->public_notes = $a_val;
    }

Referenced by cloneStructure(), and doRead().

Here is the caller graph for this function:

◆ setRating()

ilObjDataCollection::setRating ( $a_val )

setRating

Definition at line 392 of file class.ilObjDataCollection.php.

    {
        $this->rating = $a_val;
    }

Referenced by cloneStructure(), and doRead().

Here is the caller graph for this function:

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

Modules/DataCollection/classes/class.ilObjDataCollection.php

Public Member Functions

Static Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ _hasReadAccess()

◆ _hasTableByTitle()

◆ _hasWriteAccess()

◆ cloneStructure()

◆ doClone()

◆ doCloneObject()

◆ doCreate()

◆ doDelete()

◆ doRead()

◆ doUpdate()

◆ getApproval()

◆ getNotification()

◆ getOnline()

◆ getPublicNotes()

◆ getRating()

◆ getStyleSheetId()

◆ getTableById()

◆ getTables()

◆ getVisibleTables()

◆ initType()

◆ prepareMessageText()

◆ reorderTables()

◆ setApproval()

◆ setNotification()

◆ setOnline()

◆ setPublicNotes()

◆ setRating()