Verification object base class. More...

Inheritance diagram for ilVerificationObject:

Collaboration diagram for ilVerificationObject:

Public Member Functions
	__construct ($a_id=0, $a_reference=true)

	hasProperty ($a_name)
	Check if given property is valid. More...

	getPropertyType ($a_name)
	Get property data type. More...

	getProperty ($a_name)
	Get property value. More...

	setProperty ($a_name, $a_value)
	Set property value. More...

	doCreate ()

	doUpdate ()

	doDelete ()
	Delete entry from database. More...

	getFilePath ()

	getOfflineFilename ()

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

	withReferences ()

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

	getId ()

	setId ($a_id)

	setRefId ($a_id)

	getRefId ()

	getType ()

	setType ($a_type)

	getPresentationTitle ()

	getTitle ()

	getUntranslatedTitle ()

	setTitle ($a_title)

	getDescription ()

	setDescription ($a_desc)

	getLongDescription ()

	getImportId ()

	setImportId ($a_import_id)

	getOwner ()

	getOwnerName ()

	setOwner ($a_owner)

	getCreateDate ()

	getLastUpdateDate ()

	create ($a_clone_mode=false)

	update ()

	MDUpdateListener ($a_element)

	createMetaData ()

	updateMetaData ()

	deleteMetaData ()

	updateOwner ()

	putInTree ($a_parent_ref)

	setPermissions ($a_parent_ref)

	createReference ()

	countReferences ()

	delete ()

	initDefaultRoles ()

	setRegisterMode ($a_bool)

	isUserRegistered ($a_user_id=0)

	requireRegistration ()

	appendCopyInfo ($a_target_id, $a_copy_id)

	cloneMetaData ($target_obj)

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

	cloneDependencies ($a_target_id, $a_copy_id)

Public Member Functions inherited from ilObject
	__construct ($a_id=0, $a_reference=true)
	Constructor 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 public More...

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

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

	getRefId ()
	get reference id public More...

	getType ()
	get object type public More...

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

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

	getTitle ()
	get object title public More...

	getUntranslatedTitle ()
	get untranslated object title 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 public More...

	getLastUpdateDate ()
	get last update date 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...

	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) 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	initStorage ($a_id, $a_subdir=null)

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

static	_lookupOwnerName ($a_owner_id)

static	_getIdForImportId ($a_import_id)

static	_getAllReferences ($a_id)

static	_lookupTitle ($a_id)

static	_lookupOwner ($a_id)

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

static	_lookupDescription ($a_id)

static	_lookupLastUpdate ($a_id, $a_as_string=false)

static	_getLastUpdateOfObjects ($a_objs)

static	_lookupObjId ($a_id)

static	_setDeletedDate ($a_ref_id)

static	_resetDeletedDate ($a_ref_id)

static	_lookupDeletedDate ($a_ref_id)

static	_writeTitle ($a_obj_id, $a_title)

static	_writeDescription ($a_obj_id, $a_desc)

static	_writeImportId ($a_obj_id, $a_import_id)

static	_lookupType ($a_id, $a_reference=false)

static	_isInTrash ($a_ref_id)

static	_hasUntrashedReference ($a_obj_id)

static	_lookupObjectId ($a_ref_id)

static	_getObjectsDataForType ($a_type, $a_omit_trash=false)

static	_exists ($a_id, $a_reference=false, $a_type=null)

static	_getObjectsByType ($a_obj_type="", $a_owner="")

static	_prepareCloneSelection ($a_ref_ids, $new_type, $a_show_path=true)

static	_getIcon ($a_obj_id="", $a_size="big", $a_type="", $a_offline=false)

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	_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)
	only called in ilTree::saveSubTree More...

static	setDeletedDates ($a_ref_ids)
	Set deleted date type $ilDB. 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 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...

Data Fields
const	TYPE_STRING = 1

const	TYPE_BOOL = 2

const	TYPE_INT = 3

const	TYPE_DATE = 4

const	TYPE_RAW = 5

const	TYPE_ARRAY = 6

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 Member Functions
	getPropertyMap ()
	Return property map (name => type) More...

	importProperty ($a_type, $a_data=null, $a_raw_data=null)
	Import property from database. More...

	exportProperty ($a_name)
	Export property to database. More...

	doRead ()
	Read database entry. More...

	saveProperties ()
	Save current properties to database. More...

	handleQuotaUpdate ()

Protected Member Functions inherited from ilObject2
	initType ()

	doRead ()

	doCreate ()

	beforeCreate ()

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

Protected Attributes
	$map = array()

	$properties = array()

Protected Attributes inherited from ilObject
	$objDefinition

	$db

	$log

	$error

	$tree

	$app_event_handler

	$rbacadmin

	$rbacreview

Detailed Description

Verification object base class.

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

Constructor & Destructor Documentation

◆ __construct()

ilVerificationObject::__construct	(	$a_id = `0`,
		$a_reference = `true`
	)

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

References $DIC, and getPropertyMap().

     {
         global $DIC;
 
         $this->db = $DIC->database();
         $this->map = $this->getPropertyMap();
         parent::__construct($a_id, $a_reference);
     }

Here is the call graph for this function:

Member Function Documentation

◆ doCreate()

ilVerificationObject::doCreate ( )

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

References saveProperties().

     {
         return $this->saveProperties();
     }

Here is the call graph for this function:

◆ doDelete()

ilVerificationObject::doDelete ( )

Delete entry from database.

Returns: bool

Definition at line 248 of file class.ilVerificationObject.php.

References ilObject\$db, $ilDB, and handleQuotaUpdate().

     {
         $ilDB = $this->db;
 
         if ($this->id) {
             // remove all files
             include_once "Services/Verification/classes/class.ilVerificationStorageFile.php";
             $storage = new ilVerificationStorageFile($this->id);
             $storage->delete();
             
             $this->handleQuotaUpdate();
             
             $ilDB->manipulate("DELETE FROM il_verification" .
                 " WHERE id = " . $ilDB->quote($this->id, "integer"));
             return true;
         }
         return false;
     }

Here is the call graph for this function:

◆ doRead()

ilVerificationObject::doRead ( )

protected

Read database entry.

Returns: bool

Definition at line 179 of file class.ilVerificationObject.php.

References ilObject\$db, $ilDB, $row, and importProperty().

     {
         $ilDB = $this->db;
 
         if ($this->id) {
             $set = $ilDB->query("SELECT * FROM il_verification" .
                 " WHERE id = " . $ilDB->quote($this->id, "integer"));
             if ($ilDB->numRows($set)) {
                 while ($row = $ilDB->fetchAssoc($set)) {
                     $this->importProperty(
                         $row["type"],
                         $row["parameters"],
                         $row["raw_data"]
                     );
                 }
             }
             return true;
         }
         return false;
     }

Here is the call graph for this function:

◆ doUpdate()

ilVerificationObject::doUpdate ( )

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

References saveProperties().

     {
         return $this->saveProperties();
     }

Here is the call graph for this function:

◆ exportProperty()

ilVerificationObject::exportProperty ( $a_name )

protected

Export property to database.

Returns: array(parameters, raw_data)

Definition at line 143 of file class.ilVerificationObject.php.

References array, getProperty(), getPropertyType(), and IL_CAL_DATE.

Referenced by saveProperties().

     {
         $data_type = $this->getPropertyType($a_name);
         if ($data_type) {
             $value = $this->getProperty($a_name);
             $raw_data = null;
 
             switch ($data_type) {
                 case self::TYPE_DATE:
                     if ($value) {
                         $value = $value->get(IL_CAL_DATE);
                     }
                     break;
 
                 case self::TYPE_ARRAY:
                     if ($value) {
                         $value = serialize($value);
                     }
                     break;
 
                 case self::TYPE_RAW:
                     $raw_data = $value;
                     $value = null;
                     break;
             }
 
             return array("parameters" => $value,
                 "raw_data" => $raw_data);
         }
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getFilePath()

ilVerificationObject::getFilePath ( )

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

References $file, $path, ilObject2\getId(), getProperty(), and initStorage().

     {
         $file = $this->getProperty("file");
         if ($file) {
             $path = $this->initStorage($this->getId(), "certificate");
             return $path . $file;
         }
     }

Here is the call graph for this function:

◆ getOfflineFilename()

ilVerificationObject::getOfflineFilename ( )

Definition at line 295 of file class.ilVerificationObject.php.

References ilUtil\getASCIIFilename(), and ilObject2\getTitle().

     {
         return ilUtil::getASCIIFilename($this->getTitle()) . ".pdf";
     }

Here is the call graph for this function:

◆ getProperty()

ilVerificationObject::getProperty ( $a_name )

Get property value.

Parameters

string $a_name

Returns: mixed

Definition at line 73 of file class.ilVerificationObject.php.

References hasProperty(), and properties.

Referenced by exportProperty(), and getFilePath().

     {
         if ($this->hasProperty($a_name)) {
             return $this->properties[$a_name];
         }
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getPropertyMap()

ilVerificationObject::getPropertyMap ( )

abstractprotected

Return property map (name => type)

Returns: array

Referenced by __construct(), and saveProperties().

Here is the caller graph for this function:

◆ getPropertyType()

ilVerificationObject::getPropertyType ( $a_name )

Get property data type.

Parameters

string $a_name

Returns: string

Definition at line 60 of file class.ilVerificationObject.php.

References hasProperty().

Referenced by exportProperty(), and importProperty().

     {
         if ($this->hasProperty($a_name)) {
             return $this->map[$a_name];
         }
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ handleQuotaUpdate()

ilVerificationObject::handleQuotaUpdate ( )

protected

Definition at line 300 of file class.ilVerificationObject.php.

References array, ilUtil\dirsize(), ilObject2\getId(), ilObject2\getType(), ilDiskQuotaHandler\handleUpdatedSourceObject(), and initStorage().

Referenced by doDelete(), and saveProperties().

     {
         include_once "Services/DiskQuota/classes/class.ilDiskQuotaHandler.php";
         ilDiskQuotaHandler::handleUpdatedSourceObject(
             $this->getType(),
             $this->getId(),
             ilUtil::dirsize($this->initStorage($this->getId())),
             array($this->getId()),
             true
         );
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ hasProperty()

ilVerificationObject::hasProperty ( $a_name )

Check if given property is valid.

Parameters

string $a_name

Returns: bool

Definition at line 49 of file class.ilVerificationObject.php.

Referenced by getProperty(), getPropertyType(), and setProperty().

     {
         return array_key_exists($a_name, $this->map);
     }

Here is the caller graph for this function:

◆ importProperty()

ilVerificationObject::importProperty	(	$a_type,
		$a_data = `null`,
		$a_raw_data = `null`
	)

protected

Import property from database.

Parameters

string	$a_type
array	$a_data
string	$a_raw_data

Definition at line 100 of file class.ilVerificationObject.php.

References $a_type, getPropertyType(), IL_CAL_DATE, setProperty(), and string.

Referenced by doRead().

     {
         $data_type = $this->getPropertyType($a_type);
         if ($data_type) {
             $value = null;
             
             switch ($data_type) {
                 case self::TYPE_STRING:
                     $value = (string) $a_data;
                     break;
 
                 case self::TYPE_BOOL:
                     $value = (bool) $a_data;
                     break;
 
                 case self::TYPE_INT:
                     $value = (int) $a_data;
                     break;
 
                 case self::TYPE_DATE:
                     $value = new ilDate($a_data, IL_CAL_DATE);
                     break;
 
                 case self::TYPE_ARRAY:
                     if ($a_data) {
                         $value = unserialize($a_data);
                     }
                     break;
 
                 case self::TYPE_RAW:
                     $value = $a_raw_data;
                     break;
             }
 
             $this->setProperty($a_type, $value);
         }
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ initStorage()

static ilVerificationObject::initStorage	(	$a_id,
		$a_subdir = `null`
	)

static

Definition at line 267 of file class.ilVerificationObject.php.

References $path.

Referenced by getFilePath(), and handleQuotaUpdate().

     {
         include_once "Services/Verification/classes/class.ilVerificationStorageFile.php";
         $storage = new ilVerificationStorageFile($a_id);
         $storage->create();
         
         $path = $storage->getAbsolutePath() . "/";
         
         if ($a_subdir) {
             $path .= $a_subdir . "/";
             
             if (!is_dir($path)) {
                 mkdir($path);
             }
         }
                 
         return $path;
     }

Here is the caller graph for this function:

◆ saveProperties()

ilVerificationObject::saveProperties ( )

protected

Save current properties to database.

Returns: bool

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

References ilObject\$db, $ilDB, $name, ilObject\$type, array, exportProperty(), getPropertyMap(), and handleQuotaUpdate().

Referenced by doCreate(), and doUpdate().

     {
         $ilDB = $this->db;
         
         if ($this->id) {
             // remove all existing properties
             $ilDB->manipulate("DELETE FROM il_verification" .
                 " WHERE id = " . $ilDB->quote($this->id, "integer"));
             
             foreach ($this->getPropertyMap() as $name => $type) {
                 $property = $this->exportProperty($name);
                 
                 $fields = array("id" => array("integer", $this->id),
                     "type" => array("text", $name),
                     "parameters" => array("text", $property["parameters"]),
                     "raw_data" => array("text", $property["raw_data"]));
 
                 $ilDB->insert("il_verification", $fields);
             }
             
             $this->handleQuotaUpdate();
 
             return true;
         }
         return false;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setProperty()

ilVerificationObject::setProperty	(	$a_name,
		$a_value
	)

Set property value.

Parameters

string $a_name

Returns: mixed

Definition at line 86 of file class.ilVerificationObject.php.

References hasProperty(), and properties.

Referenced by importProperty().

     {
         if ($this->hasProperty($a_name)) {
             $this->properties[$a_name] = $a_value;
         }
     }

Here is the call graph for this function:

Here is the caller graph for this function:

Field Documentation

◆ $map

ilVerificationObject::$map = array()

protected

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

◆ $properties

ilVerificationObject::$properties = array()

protected

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

◆ TYPE_ARRAY

const ilVerificationObject::TYPE_ARRAY = 6

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

◆ TYPE_BOOL

const ilVerificationObject::TYPE_BOOL = 2

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

◆ TYPE_DATE

const ilVerificationObject::TYPE_DATE = 4

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

◆ TYPE_INT

const ilVerificationObject::TYPE_INT = 3

Definition at line 22 of file class.ilVerificationObject.php.

◆ TYPE_RAW

const ilVerificationObject::TYPE_RAW = 5

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

◆ TYPE_STRING

const ilVerificationObject::TYPE_STRING = 1

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

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

Services/Verification/classes/class.ilVerificationObject.php

Public Member Functions

Static Public Member Functions

Data Fields

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ doCreate()

◆ doDelete()

◆ doRead()

◆ doUpdate()

◆ exportProperty()

◆ getFilePath()

◆ getOfflineFilename()

◆ getProperty()

◆ getPropertyMap()

◆ getPropertyType()

◆ handleQuotaUpdate()

◆ hasProperty()

◆ importProperty()

◆ initStorage()

◆ saveProperties()

◆ setProperty()

Field Documentation

◆ $map

◆ $properties

◆ TYPE_ARRAY

◆ TYPE_BOOL

◆ TYPE_DATE

◆ TYPE_INT

◆ TYPE_RAW

◆ TYPE_STRING