Inheritance diagram for ilObjDataCollection:

Collaboration diagram for ilObjDataCollection:

Public Member Functions
	__construct (int $a_id=0, bool $a_reference=true)
	Constructor. More...

	sendRecordNotification (ilDclNotificationType $action, ilDclBaseRecordModel $record)

	cloneStructure (int $original_id)

	setOnline (bool $a_val)

	getOnline ()

	setRating (bool $a_val)

	getRating ()

	setPublicNotes (bool $a_val)

	getPublicNotes ()

	setApproval (bool $a_val)

	getApproval ()

	setNotification (bool $a_val)

	getNotification ()

	getTables ()

	getTableById (int $table_id)

	getVisibleTables ()

	getStyleSheetId ()

Public Member Functions inherited from ilObject2
	__construct (int $a_id=0, bool $a_reference=true)
	Constructor. More...

	read ()

	create (bool $a_clone_mode=false)

	update ()

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

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

	cloneObject (int $target_id, int $copy_id=0, bool $omit_tree=false)

Public Member Functions inherited from ilObject
	getObjectProperties ()

	flushObjectProperties ()

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

	processAutoRating ()

	read ()

	getId ()

	setId (int $id)

	setRefId (int $ref_id)

	getRefId ()

	getType ()

	setType (string $type)

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

	getTitle ()

	getUntranslatedTitle ()
	Get untranslated object title WebDAV needs to access the untranslated title of an object. More...

	setTitle (string $title)

	getDescription ()

	setDescription (string $description)

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

	getImportId ()

	setImportId (string $import_id)

	setOfflineStatus (bool $status)

	getOfflineStatus ()

	supportsOfflineHandling ()

	getOwner ()

	getOwnerName ()
	get full name of object owner More...

	setOwner (int $usr_id)

	getCreateDate ()
	Get create date in YYYY-MM-DD HH-MM-SS format. More...

	getLastUpdateDate ()
	Get last update date in YYYY-MM-DD HH-MM-SS format. More...

	create ()
	note: title, description and type should be set when this function is called More...

	update ()

	MDUpdateListener (string $element)
	Metadata update listener. More...

	createMetaData ()

	updateMetaData ()

	deleteMetaData ()

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

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

	setPermissions (int $parent_ref_id)

	setParentRolePermissions (int $parent_ref_id)
	Initialize the permissions of parent roles (local roles of categories, global roles...) This method is overwritten in e.g. More...

	createReference ()
	creates reference for object More...

	countReferences ()

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

	applyDidacticTemplate (int $tpl_id)

	getXMLZip ()

	getHTMLDirectory ()

	appendCopyInfo (int $target_id, int $copy_id, int $new_obj_id)
	Prepend Copy info if object with same name exists in that container. More...

	cloneDependencies (int $target_id, int $copy_id)
	Clone object dependencies. More...

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

	selfOrParentWithRatingEnabled ()

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

Data Fields
const	TYPE = 'dcl'

Data Fields inherited from ilObject
const	TITLE_LENGTH = 255

const	DESC_LENGTH = 128

const	LONG_DESC_LENGTH = 4000

const	TABLE_OBJECT_DATA = "object_data"

array	$objectList

string	$untranslatedTitle

Protected Member Functions
	initType ()

	doRead ()

	doCreate (bool $clone_mode=false)

	doDelete ()

	doUpdate ()

	doCloneObject (ilObject2 $new_obj, int $a_target_id, ?int $a_copy_id=null)

Protected Member Functions inherited from ilObject2
	initType ()

	doRead ()

	doCreate (bool $clone_mode=false)

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

	doUpdate ()

	beforeUpdate ()

	doDelete ()

	beforeDelete ()

	doCloneObject (ilObject2 $new_obj, int $a_target_id, ?int $a_copy_id=null)

	beforeCloneObject ()

Protected Member Functions inherited from ilObject
	doMDUpdateListener (string $a_element)

	beforeMDUpdateListener (string $a_element)

	doCreateMetaData ()

	beforeCreateMetaData ()

	doUpdateMetaData ()

	beforeUpdateMetaData ()

	doDeleteMetaData ()

	beforeDeleteMetaData ()

	handleAutoRating ()

	hasAutoRating ()

Private Attributes
bool	$is_online = false

bool	$rating = false

bool	$approval = false

bool	$public_notes = false

bool	$notification = false

ilDclNotification	$notification_settings

Additional Inherited Members
Static Public Member Functions inherited from ilObject
static	_lookupObjIdByImportId (string $import_id)
	Get (latest) object id for an import id. More...

static	_lookupImportId (int $obj_id)

static	_lookupOwnerName (int $owner_id)
	Lookup owner name for owner id. More...

static	_getIdForImportId (string $import_id)

static	_getAllReferences (int $id)
	get all reference ids for object ID More...

static	_lookupTitle (int $obj_id)

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

static	_lookupOwner (int $obj_id)
	Lookup owner user ID for object ID. More...

static	_getIdsForTitle (string $title, string $type='', bool $partial_match=false)

static	_lookupDescription (int $obj_id)

static	_lookupLastUpdate (int $obj_id, bool $formatted=false)

static	_getLastUpdateOfObjects (array $obj_ids)

static	_lookupObjId (int $ref_id)

static	_setDeletedDate (int $ref_id, int $deleted_by)

static	setDeletedDates (array $ref_ids, int $user_id)

static	_resetDeletedDate (int $ref_id)

static	_lookupDeletedDate (int $ref_id)

static	_writeTitle (int $obj_id, string $title)
	write title to db (static) More...

static	_writeDescription (int $obj_id, string $desc)
	write description to db (static) More...

static	_writeImportId (int $obj_id, string $import_id)
	write import id to db (static) More...

static	_lookupType (int $id, bool $reference=false)

static	_isInTrash (int $ref_id)

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

static	_lookupObjectId (int $ref_id)

static	_getObjectsDataForType (string $type, bool $omit_trash=false)
	get all objects of a certain type More...

static	_exists (int $id, bool $reference=false, ?string $type=null)
	checks if an object exists in object_data More...

static	_getObjectsByType (string $obj_type="", ?int $owner=null)

static	_prepareCloneSelection (array $ref_ids, string $new_type, bool $show_path=true)
	Prepare copy wizard object selection. More...

static	getIconForType (string $type)

static	_getIcon (int $obj_id=0, string $size="big", string $type="", bool $offline=false)
	Get icon for repository item. More...

static	collectDeletionDependencies (array &$deps, int $ref_id, int $obj_id, string $type, int $depth=0)
	Collect deletion dependencies. More...

static	getDeletionDependencies (int $obj_id)
	Get deletion dependencies. More...

static	getLongDescriptions (array $obj_ids)

static	getAllOwnedRepositoryObjects (int $user_id)

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

static	_lookupCreationDate (int $obj_id)

static	_getObjectTypeIdByTitle (string $type, ?\ilDBInterface $ilDB=null)

Protected Attributes inherited from ilObject
ilLogger	$obj_log

ILIAS	$ilias

ilObjectDefinition	$obj_definition

ilDBInterface	$db

ilLogger	$log

ilErrorHandling	$error

ilTree	$tree

ilAppEventHandler	$app_event_handler

ilRbacAdmin	$rbac_admin

ilRbacReview	$rbac_review

ilObjUser	$user

ilLanguage	$lng

LOMServices	$lom_services

bool	$call_by_reference

int	$max_title = self::TITLE_LENGTH

int	$max_desc = self::DESC_LENGTH

bool	$add_dots = true

int	$ref_id = null

string	$type = ""

string	$title = ""

string	$desc = ""

string	$long_desc = ""

int	$owner = 0

string	$create_date = ""

string	$last_update = ""

string	$import_id = ""

bool	$register = false

Detailed Description

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

Constructor & Destructor Documentation

◆ __construct()

ilObjDataCollection::__construct	(	int	$a_id = `0`,
		bool	$a_reference = `true`
	)

Constructor.

Parameters

int	$a_id	reference_id or object_id
bool	$a_reference	treat the id as reference_id (true) or object_id (false)

Reimplemented from ilObject2.

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

    {
        parent::__construct($a_id, $a_reference);
        $this->notification_settings = new ilDclNotification($this->db);
    }

References ILIAS\GlobalScreen\Provider\__construct().

Here is the call graph for this function:

Member Function Documentation

◆ cloneStructure()

ilObjDataCollection::cloneStructure ( int $original_id )

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

                                                    : void
    {
        $original = new ilObjDataCollection($original_id);
        $this->setApproval($original->getApproval());
        $this->setNotification($original->getNotification());
        $this->setPublicNotes($original->getPublicNotes());
        $this->setRating($original->getRating());
        foreach ($this->getTables() as $table) {
            $table->doDelete();
        }
        foreach ($original->getTables() as $table) {
            $new_table = new ilDclTable();
            $new_table->setObjId($this->getId());
            $new_table->cloneStructure($table);
        }
        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:

◆ doCloneObject()

ilObjDataCollection::doCloneObject	(	ilObject2	$new_obj,
		int	$a_target_id,
		?int	$a_copy_id = `null`
	)

protected

Reimplemented from ilObject2.

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

                                                                                                  : void
    {
        $new_obj->setNotification($this->getNotification());
        if (!(ilCopyWizardOptions::_getInstance($a_copy_id))->isRootNode($this->getRefId())) {
            $new_obj->setOnline($this->getOnline());
            $new_obj->update();
        }
        $new_obj->cloneStructure($this->getRefId());
        $this->cloneMetaData($new_obj);
    }

References ilCopyWizardOptions\_getInstance(), ilObject2\cloneMetaData(), getNotification(), getOnline(), ilObject\getRefId(), and ilObject2\update().

Here is the call graph for this function:

◆ doCreate()

ilObjDataCollection::doCreate ( bool $clone_mode = false )

protected

Reimplemented from ilObject2.

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

                                                         : void
    {
        if (!$clone_mode) {
            $main_table = ilDclCache::getTableCache();
            $main_table->setObjId($this->getId());
            $main_table->setTitle($this->getTitle());
            $main_table->setAddPerm(true);
            $main_table->setEditPerm(true);
            $main_table->setDeletePerm(false);
            $main_table->setDeleteByOwner(true);
            $main_table->setEditByOwner(true);
            $main_table->setLimited(false);
            $main_table->setIsVisible(true);
            $main_table->doCreate();
        }
        $this->createMetaData();
        $this->db->insert(
            'il_dcl_data',
            [
                'id' => [ilDBConstants::T_INTEGER, $this->getId()],
                'is_online' => [ilDBConstants::T_INTEGER, $this->getOnline() ? 1 : 0],
                'rating' => [ilDBConstants::T_INTEGER, $this->getRating() ? 1 : 0],
                'public_notes' => [ilDBConstants::T_INTEGER, $this->getPublicNotes() ? 1 : 0],
                'approval' => [ilDBConstants::T_INTEGER, $this->getApproval() ? 1 : 0],
                'notification' => [ilDBConstants::T_INTEGER, $this->getNotification() ? 1 : 0],
            ]
        );
    }

References ilObject\createMetaData(), getApproval(), ilObject\getId(), getNotification(), getOnline(), getPublicNotes(), getRating(), ilDclCache\getTableCache(), ilObject\getTitle(), and ilDBConstants\T_INTEGER.

Here is the call graph for this function:

◆ doDelete()

ilObjDataCollection::doDelete ( )

protected

Reimplemented from ilObject2.

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

                                 : void
    {
        foreach ($this->getTables() as $table) {
            $table->doDelete(false, true);
        }
        $this->deleteMetaData();
        $this->notification_settings->deleteForObject($this);
        $this->db->manipulateF('DELETE FROM il_dcl_data WHERE id = %s', [ilDBConstants::T_INTEGER], [$this->getId()]);
    }

References ilObject\deleteMetaData(), ilObject\getId(), getTables(), and ilDBConstants\T_INTEGER.

Here is the call graph for this function:

◆ doRead()

ilObjDataCollection::doRead ( )

protected

Reimplemented from ilObject2.

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

                               : void
    {
        $stmt = $this->db->queryF('SELECT * FROM il_dcl_data WHERE id = %s', [ilDBConstants::T_INTEGER], [$this->getId()]);
        if ($data = $this->db->fetchObject($stmt)) {
            $this->setOnline((bool) $data->is_online);
            $this->setRating((bool) $data->rating);
            $this->setApproval((bool) $data->approval);
            $this->setPublicNotes((bool) $data->public_notes);
            $this->setNotification((bool) $data->notification);
        }
    }

References $data, ilObject\getId(), setApproval(), setNotification(), setOnline(), setPublicNotes(), setRating(), and ilDBConstants\T_INTEGER.

Here is the call graph for this function:

◆ doUpdate()

ilObjDataCollection::doUpdate ( )

protected

Reimplemented from ilObject2.

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

                                 : void
    {
        $this->updateMetaData();
        $this->db->update(
            'il_dcl_data',
            [
                'id' => [ilDBConstants::T_INTEGER, $this->getId()],
                'is_online' => [ilDBConstants::T_INTEGER, $this->getOnline() ? 1 : 0],
                'rating' => [ilDBConstants::T_INTEGER, $this->getRating() ? 1 : 0],
                'public_notes' => [ilDBConstants::T_INTEGER, $this->getPublicNotes() ? 1 : 0],
                'approval' => [ilDBConstants::T_INTEGER, $this->getApproval() ? 1 : 0],
                'notification' => [ilDBConstants::T_INTEGER, $this->getNotification() ? 1 : 0],
            ],
            [
                'id' => [ilDBConstants::T_INTEGER, $this->getId()],
            ]
        );
    }

References getApproval(), ilObject\getId(), getNotification(), getOnline(), getPublicNotes(), getRating(), ilDBConstants\T_INTEGER, and ilObject\updateMetaData().

Here is the call graph for this function:

◆ getApproval()

ilObjDataCollection::getApproval ( )

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

                                 : bool
    {
        return $this->approval;
    }

References $approval.

Referenced by doCreate(), and doUpdate().

Here is the caller graph for this function:

◆ getNotification()

ilObjDataCollection::getNotification ( )

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

                                     : bool
    {
        return $this->notification;
    }

References $notification.

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

Here is the caller graph for this function:

◆ getOnline()

ilObjDataCollection::getOnline ( )

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

                               : bool
    {
        return $this->is_online;
    }

References $is_online.

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

Here is the caller graph for this function:

◆ getPublicNotes()

ilObjDataCollection::getPublicNotes ( )

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

                                    : bool
    {
        return $this->public_notes;
    }

References $public_notes.

Referenced by doCreate(), and doUpdate().

Here is the caller graph for this function:

◆ getRating()

ilObjDataCollection::getRating ( )

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

                               : bool
    {
        return $this->rating;
    }

References $rating.

Referenced by doCreate(), and doUpdate().

Here is the caller graph for this function:

◆ getStyleSheetId()

ilObjDataCollection::getStyleSheetId ( )

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

◆ getTableById()

ilObjDataCollection::getTableById ( int $table_id )

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

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

References ilDclCache\getTableCache().

Referenced by getTables().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getTables()

ilObjDataCollection::getTables ( )

Returns: ilDclTable[]

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

                               : array
    {
        $stmt = $this->db->queryF(
            'SELECT id FROM il_dcl_table WHERE obj_id = %s ORDER BY table_order',
            [ilDBConstants::T_INTEGER],
            [$this->getId()]
        );
        $tables = [];
        while ($rec = $this->db->fetchAssoc($stmt)) {
            $tables[$rec['id']] = $this->getTableById($rec['id']);
        }
        return $tables;
    }

References ilObject\getId(), getTableById(), and ilDBConstants\T_INTEGER.

Referenced by ilDclCopyFieldRepresentation\buildFieldCreationInput(), 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: ilDclTable[]

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

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

References getTables().

Here is the call graph for this function:

◆ initType()

ilObjDataCollection::initType ( )

protected

Reimplemented from ilObject2.

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

                                 : void
    {
        $this->type = $this::TYPE;
    }

◆ sendRecordNotification()

ilObjDataCollection::sendRecordNotification	(	ilDclNotificationType	$action,
		ilDclBaseRecordModel	$record
	)

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

                                                                                                       : void
    {
        if (!$this->getNotification()) {
            return;
        }
 
        $users = ilNotification::getNotificationsForObject(
            ilNotification::TYPE_DATA_COLLECTION,
            $this->getId(),
            1
        );
 
        ilNotification::updateNotificationTime(ilNotification::TYPE_DATA_COLLECTION, $this->getId(), $users);
 
        $mail = new ilDataCollectionMailNotification();
        $mail->setType($action->value);
        $mail->setActor($this->user->getId());
        $mail->setObjId($this->getId());
        $mail->setRefId($this->getRefId());
        $mail->setRecord($record);
        $mail->setSender(ANONYMOUS_USER_ID);
 
        foreach ($users as $user_id) {
            if (
                $user_id !== $this->user->getId() &&
                $record->getTable()->hasPermissionToViewRecord($this->getRefId(), $record, $user_id) &&
                [] !== $record->getTable()->getVisibleTableViews($user_id) &&
                $this->notification_settings->has($this, $user_id, $action)
            ) {
                $mail->addRecipient($user_id);
            }
        }
 
        $mail->send();
    }

References $user_id, ANONYMOUS_USER_ID, ilObject\getId(), getNotification(), ilNotification\getNotificationsForObject(), ilObject\getRefId(), ilDclBaseRecordModel\getTable(), ilNotification\TYPE_DATA_COLLECTION, ilNotification\updateNotificationTime(), and ILIAS\Repository\user().

Here is the call graph for this function:

◆ setApproval()

ilObjDataCollection::setApproval ( bool $a_val )

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

                                            : void
    {
        $this->approval = $a_val;
    }

Referenced by cloneStructure(), and doRead().

Here is the caller graph for this function:

◆ setNotification()

ilObjDataCollection::setNotification ( bool $a_val )

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

                                                : void
    {
        $this->notification = $a_val;
    }

References ILIAS\UI\examples\Symbol\Glyph\Notification\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 ( bool $a_val )

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

                                          : void
    {
        $this->is_online = $a_val;
    }

Referenced by doRead().

Here is the caller graph for this function:

◆ setPublicNotes()

ilObjDataCollection::setPublicNotes ( bool $a_val )

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

                                               : void
    {
        $this->public_notes = $a_val;
    }

Referenced by cloneStructure(), and doRead().

Here is the caller graph for this function:

◆ setRating()

ilObjDataCollection::setRating ( bool $a_val )

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

                                          : void
    {
        $this->rating = $a_val;
    }

Referenced by cloneStructure(), and doRead().

Here is the caller graph for this function:

Field Documentation

◆ $approval

bool ilObjDataCollection::$approval = false

private

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

Referenced by getApproval().

◆ $is_online

bool ilObjDataCollection::$is_online = false

private

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

Referenced by getOnline().

◆ $notification

bool ilObjDataCollection::$notification = false

private

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

Referenced by getNotification().

◆ $notification_settings

ilDclNotification ilObjDataCollection::$notification_settings

private

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

◆ $public_notes

bool ilObjDataCollection::$public_notes = false

private

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

Referenced by getPublicNotes().

◆ $rating

bool ilObjDataCollection::$rating = false

private

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

Referenced by getRating().

◆ TYPE

const ilObjDataCollection::TYPE = 'dcl'

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

Referenced by ilObjDataCollectionGUI\getType().

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

components/ILIAS/DataCollection/classes/class.ilObjDataCollection.php

Public Member Functions

Data Fields

Protected Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ cloneStructure()

◆ doCloneObject()

◆ doCreate()

◆ doDelete()

◆ doRead()

◆ doUpdate()

◆ getApproval()

◆ getNotification()

◆ getOnline()

◆ getPublicNotes()

◆ getRating()

◆ getStyleSheetId()

◆ getTableById()

◆ getTables()

◆ getVisibleTables()

◆ initType()

◆ sendRecordNotification()

◆ setApproval()

◆ setNotification()

◆ setOnline()

◆ setPublicNotes()

◆ setRating()

Field Documentation

◆ $approval

◆ $is_online

◆ $notification

◆ $notification_settings

◆ $public_notes

◆ $rating

◆ TYPE