Verification object base class. More...

Inheritance diagram for ilVerificationObject:

Collaboration diagram for ilVerificationObject:

Public Member Functions
	__construct ($a_id=0, $a_reference=true)
	Constructor public.
	hasProperty ($a_name)
	Check if given property is valid.
	getPropertyType ($a_name)
	Get property data type.
	getProperty ($a_name)
	Get property value.
	setProperty ($a_name, $a_value)
	Set property value.
	doCreate ()
	doUpdate ()
	doDelete ()
	Delete entry from database.
	getFilePath ()
	getOfflineFilename ()
Public Member Functions inherited from ilObject2
	withReferences ()
	determines wehter objects are referenced or not (got ref ids or not)
	read ($a_force_db=false)
	Read data from db.
	getId ()
	get object id public
	setId ($a_id)
	set object id public
	setRefId ($a_id)
	set reference id public
	getRefId ()
	get reference id public
	getType ()
	get object type public
	setType ($a_type)
	set object type public
	getPresentationTitle ()
	get presentation title Normally same as title Overwritten for sessions
	getTitle ()
	get object title public
	getUntranslatedTitle ()
	get untranslated object title public
	setTitle ($a_title)
	set object title
	getDescription ()
	get object description
	setDescription ($a_desc)
	set object description
	getLongDescription ()
	get object long description (stored in object_description)
	getImportId ()
	get import id
	setImportId ($a_import_id)
	set import id
	getOwner ()
	get object owner
	getOwnerName ()
	_lookupOwnerName ($a_owner_id)
	lookup owner name for owner id
	setOwner ($a_owner)
	set object owner
	getCreateDate ()
	get create date public
	getLastUpdateDate ()
	get last update date public
	setObjDataRecord ($a_record)
	set object_data record (note: this method should only be called from the ilObjectFactory class)
	create ($a_clone_mode=false)
	update ()
	update object in db
	MDUpdateListener ($a_element)
	Meta data update listener.
	createMetaData ()
	create meta data entry
	updateMetaData ()
	update meta data entry
	deleteMetaData ()
	delete meta data entry
	updateOwner ()
	update owner of object in db
	_getIdForImportId ($a_import_id)
	get current object id for import id (static)
	_lookupOwner ($a_id)
	lookup object owner
	_lookupLastUpdate ($a_id, $a_as_string=false)
	lookup last update
	_getLastUpdateOfObjects ($a_objs)
	Get last update for a set of media objects.
	_setDeletedDate ($a_ref_id)
	only called in ilTree::saveSubTree
	_resetDeletedDate ($a_ref_id)
	only called in ilObjectGUI::insertSavedNodes
	_lookupDeletedDate ($a_ref_id)
	only called in ilObjectGUI::insertSavedNodes
	_writeTitle ($a_obj_id, $a_title)
	write title to db (static)
	_writeDescription ($a_obj_id, $a_desc)
	write description to db (static)
	_writeImportId ($a_obj_id, $a_import_id)
	write import id to db (static)
	_isInTrash ($a_ref_id)
	checks wether object is in trash
	_hasUntrashedReference ($a_obj_id)
	checks wether an object has at least one reference that is not in trash
	_getObjectsDataForType ($a_type, $a_omit_trash=false)
	get all objects of a certain type
	putInTree ($a_parent_ref)
	maybe this method should be in tree object!?
	setPermissions ($a_parent_ref)
	set permissions of object
	createReference ()
	creates reference for object
	countReferences ()
	count references of object
	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!!
	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
	notify ($a_event, $a_ref_id, $a_parent_non_rbac_id, $a_node_id, $a_params=0)
	notifys an object about an event occured Based on the event passed, each object may decide how it reacts.
	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.
	cloneMetaData ($target_obj)
	Copy meta data.
	cloneObject ($a_target_id, $a_copy_id=null, $a_omit_tree=false)
	Clone object permissions, put in tree ...
	cloneDependencies ($a_target_id, $a_copy_id)
	Clone object dependencies.
Public Member Functions inherited from ilObject
	ilObject ($a_id=0, $a_reference=true)
	Constructor public.
	getDiskUsage ()
	Gets the disk usage of the object in bytes.
	create ()
	create
	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.
	applyDidacticTemplate ($a_tpl_id)
	Apply template.
	getXMLZip ()
	getHTMLDirectory ()
	_lookupCreationDate ($a_id)
	Lookup creation date.

Static Public Member Functions
static	initStorage ($a_id, $a_subdir=null)
Static Public Member Functions inherited from ilObject2
static	_lookupObjIdByImportId ($a_import_id)
static	_getAllReferences ($a_id)
	get all reference ids of object
static	_lookupTitle ($a_id)
	lookup object title
static	_getIdsForTitle ($title, $type= '', $partialmatch=false)
static	_lookupDescription ($a_id)
	lookup object description
static	_lookupObjId ($a_id)
static	_lookupType ($a_id, $a_reference=false)
	lookup object type
static	_lookupObjectId ($a_ref_id)
	lookup object id
static	_exists ($a_id, $a_reference=false)
static	_getObjectsByType ($a_obj_type="", $a_owner="")
	Get objects by type.
static	_prepareCloneSelection ($a_ref_ids, $new_type)
static	_getIcon ($a_obj_id="", $a_size="big", $a_type="", $a_offline=false)
	Get icon for repository item.
Static Public Member Functions inherited from ilObject
static	setDeletedDates ($a_ref_ids)
	Set deleted date type $ilDB.
static	_exists ($a_id, $a_reference=false, $a_type=null)
	checks if an object exists in object_data
static	_prepareCloneSelection ($a_ref_ids, $new_type, $show_path=true)
	Prepare copy wizard object selection.
static	collectDeletionDependencies (&$deps, $a_ref_id, $a_obj_id, $a_type, $a_depth=0)
	Collect deletion dependencies.
static	getDeletionDependencies ($a_obj_id)
	Get deletion dependencies.
static	getLongDescriptions (array $a_obj_ids)
	Get long description data.
static	getAllOwnedRepositoryObjects ($a_user_id)
	Get all ids of objects user owns.
static	hasAutoRating ($a_type, $a_ref_id)
	Check if auto rating is active for parent group/course.

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

Protected Member Functions
	getPropertyMap ()
	Return property map (name => type)
	importProperty ($a_type, $a_data=null, $a_raw_data=null)
	Import property from database.
	exportProperty ($a_name)
	Export property to database.
	doRead ()
	Read database entry.
	saveProperties ()
	Save current properties to database.
	handleQuotaUpdate ()
Protected Member Functions inherited from ilObject2
	initType ()
	beforeCreate ()
	beforeUpdate ()
	doMDUpdateListener ($a_element)
	beforeMDUpdateListener ($a_element)
	doCreateMetaData ()
	beforeCreateMetaData ()
	doUpdateMetaData ()
	beforeUpdateMetaData ()
	beforeDelete ()
	doCloneObject ($new_obj, $a_target_id, $a_copy_id=null)
	beforeCloneObject ()

Protected Attributes
	$map = array()
	$properties = array()

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

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

Constructor public.

Parameters

integer	reference_id or object_id
boolean	treat the id as reference_id (true) or object_id (false)

Reimplemented from ilObject2.

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

References getPropertyMap().

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

Here is the call graph for this function:

Member Function Documentation

ilVerificationObject::doCreate ( )

Reimplemented from ilObject2.

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

References saveProperties().

        {
                return $this->saveProperties();
        }

Here is the call graph for this function:

ilVerificationObject::doDelete ( )

Delete entry from database.

Returns: bool

Reimplemented from ilObject2.

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

References $ilDB, and handleQuotaUpdate().

        {
                global $ilDB;
                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:

ilVerificationObject::doRead ( )

protected

Read database entry.

Returns: bool

Reimplemented from ilObject2.

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

References $ilDB, $row, and importProperty().

        {
                global $ilDB;
                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:

ilVerificationObject::doUpdate ( )

Reimplemented from ilObject2.

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

References saveProperties().

        {
                return $this->saveProperties();
        }

Here is the call graph for this function:

ilVerificationObject::exportProperty ( $a_name )

protected

Export property to database.

Returns: array(parameters, raw_data)

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

References 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:

ilVerificationObject::getFilePath ( )

Definition at line 298 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:

ilVerificationObject::getOfflineFilename ( )

Definition at line 308 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:

ilVerificationObject::getProperty ( $a_name )

Get property value.

Parameters

string $a_name

Returns: mixed

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

References hasProperty().

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:

ilVerificationObject::getPropertyMap ( )

abstractprotected

Return property map (name => type)

Returns: array

Reimplemented in ilObjCourseVerification, ilObjExerciseVerification, ilObjSCORMVerification, and ilObjTestVerification.

Referenced by __construct(), and saveProperties().

Here is the caller graph for this function:

ilVerificationObject::getPropertyType ( $a_name )

Get property data type.

Parameters

string $a_name

Returns: string

Definition at line 57 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:

ilVerificationObject::handleQuotaUpdate ( )

protected

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

References 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:

ilVerificationObject::hasProperty ( $a_name )

Check if given property is valid.

Parameters

string $a_name

Returns: bool

Definition at line 46 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:

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 getPropertyType(), IL_CAL_DATE, and setProperty().

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:

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

static

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

References $path.

Referenced by ilObjCourseVerification\createFromCourse(), ilObjExerciseVerification\createFromExercise(), ilObjSCORMVerification\createFromSCORMLM(), ilObjTestVerification\createFromTest(), 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:

ilVerificationObject::saveProperties ( )

protected

Save current properties to database.

Returns: bool

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

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

Referenced by doCreate(), and doUpdate().

        {
                global $ilDB;
                
                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:

ilVerificationObject::setProperty	(	$a_name,
		$a_value
	)

Set property value.

Parameters

string $a_name

Returns: mixed

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

References hasProperty().

Referenced by importProperty().

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

Here is the call graph for this function: