ilObjCertificateSettings Class Reference

Class ilObjCertificateSettings. More...

Inheritance diagram for ilObjCertificateSettings:

Collaboration diagram for ilObjCertificateSettings:

Public Member Functions
	ilObjCertificateSettings ($a_id=0, $a_call_by_reference=true)
	Constructor public.
	hasBackgroundImage ()
	getBackgroundImageDefaultFolder ()
	getBackgroundImagePath ()
	Returns the filesystem path of the background image.
	getBackgroundImageName ()
	Returns the filename of the background image.
	getBackgroundImageThumbPath ()
	Returns the filesystem path of the background image thumbnail.
	getBackgroundImageTempfilePath ()
	Returns the filesystem path of the background image temp file during upload.
	getBackgroundImagePathWeb ()
	Returns the web path of the background image.
	getBackgroundImageThumbPathWeb ()
	Returns the web path of the background image thumbnail.
	uploadBackgroundImage ($image_tempfilename)
	Uploads a background image for the certificate.
	deleteBackgroundImage ()
	Deletes the background image of a certificate.
Public Member Functions inherited from ilObject
	ilObject ($a_id=0, $a_reference=true)
	Constructor public.
	withReferences ()
	determines wehter objects are referenced or not (got ref ids or not)
	read ($a_force_db=false)
	read object data from db into object
	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
	getDiskUsage ()
	Gets the disk usage of the object in bytes.
	setObjDataRecord ($a_record)
	set object_data record (note: this method should only be called from the ilObjectFactory class)
	create ()
	create
	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
	createRoleFolder ()
	creates a local role folder
	applyDidacticTemplate ($a_tpl_id)
	Apply template.
	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 ()
	getXMLZip ()
	getHTMLDirectory ()
	cloneObject ($a_target_id, $a_copy_id=0, $a_omit_tree=false)
	Clone object permissions, put in tree ...
	appendCopyInfo ($a_target_id, $a_copy_id)
	Prepend Copy info if object with same name exists in that container.
	cloneDependencies ($a_target_id, $a_copy_id)
	Clone object dependencies.
	cloneMetaData ($target_obj)
	Copy meta data.
	_lookupCreationDate ($a_id)
	Lookup creation date.

Additional Inherited Members
Static Public Member Functions inherited from ilObject
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
	_exists ($a_id, $a_reference=false)
	checks if an object exists in object_data
static	_getObjectsByType ($a_obj_type="", $a_owner="")
	Get objects by type.
static	_prepareCloneSelection ($a_ref_ids, $new_type, $show_path=true)
	Prepare copy wizard object selection.
static	_getIcon ($a_obj_id="", $a_size="big", $a_type="", $a_offline=false)
	Get icon for repository item.
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.
Data Fields inherited from ilObject
const	TITLE_LENGTH = 128
	max length of object title
	$ilias
	$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
	$obj_data_record
	object_data record

Detailed Description

Class ilObjCertificateSettings.

Author

Helmut Schottmüller ilias.nosp@m.@aur.nosp@m.ealis.nosp@m..de

Version

$Id$

Definition at line 34 of file class.ilObjCertificateSettings.php.

Member Function Documentation

ilObjCertificateSettings::deleteBackgroundImage

(

)

Deletes the background image of a certificate.

Returns

boolean TRUE if the process succeeds

Definition at line 176 of file class.ilObjCertificateSettings.php.

References $result, getBackgroundImagePath(), getBackgroundImageTempfilePath(), and getBackgroundImageThumbPath().

        {
                $result = TRUE;
                if (file_exists($this->getBackgroundImageThumbPath()))
                {
                        $result = $result & unlink($this->getBackgroundImageThumbPath());
                }
                if (file_exists($this->getBackgroundImagePath()))
                {
                        $result = $result & unlink($this->getBackgroundImagePath());
                }
                if (file_exists($this->getBackgroundImageTempfilePath()))
                {
                        $result = $result & unlink($this->getBackgroundImageTempfilePath());
                }
                return $result;
        }

Here is the call graph for this function:

ilObjCertificateSettings::getBackgroundImageDefaultFolder

(

)

Definition at line 61 of file class.ilObjCertificateSettings.php.

Referenced by getBackgroundImagePath(), getBackgroundImageTempfilePath(), getBackgroundImageThumbPath(), and uploadBackgroundImage().

        {
                return CLIENT_WEB_DIR . "/certificates/default/";
        }

Here is the caller graph for this function:

ilObjCertificateSettings::getBackgroundImageName

(

)

Returns the filename of the background image.

Returns

string The filename of the background image

Definition at line 81 of file class.ilObjCertificateSettings.php.

Referenced by getBackgroundImagePath(), getBackgroundImageThumbPath(), and uploadBackgroundImage().

        {
                return "background.jpg";
        }

Here is the caller graph for this function:

ilObjCertificateSettings::getBackgroundImagePath

(

)

Returns the filesystem path of the background image.

Returns

string The filesystem path of the background image

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

References getBackgroundImageDefaultFolder(), and getBackgroundImageName().

Referenced by deleteBackgroundImage(), getBackgroundImagePathWeb(), hasBackgroundImage(), and uploadBackgroundImage().

        {
                return $this->getBackgroundImageDefaultFolder() . $this->getBackgroundImageName();
        }

Here is the call graph for this function:

Here is the caller graph for this function:

ilObjCertificateSettings::getBackgroundImagePathWeb

(

)

Returns the web path of the background image.

Returns

string The web path of the background image

Definition at line 111 of file class.ilObjCertificateSettings.php.

References getBackgroundImagePath(), ILIAS_ABSOLUTE_PATH, and ilUtil\removeTrailingPathSeparators().

        {
                include_once "./Services/Utilities/classes/class.ilUtil.php";
                return str_replace(ilUtil::removeTrailingPathSeparators(ILIAS_ABSOLUTE_PATH), ilUtil::removeTrailingPathSeparators(ILIAS_HTTP_PATH), $this->getBackgroundImagePath());
        }

Here is the call graph for this function:

ilObjCertificateSettings::getBackgroundImageTempfilePath

(

)

Returns the filesystem path of the background image temp file during upload.

Returns

string The filesystem path of the background image temp file

Definition at line 101 of file class.ilObjCertificateSettings.php.

References getBackgroundImageDefaultFolder().

Referenced by deleteBackgroundImage(), and uploadBackgroundImage().

        {
                return $this->getBackgroundImageDefaultFolder() . "background_upload";
        }

Here is the call graph for this function:

Here is the caller graph for this function:

ilObjCertificateSettings::getBackgroundImageThumbPath

(

)

Returns the filesystem path of the background image thumbnail.

Returns

string The filesystem path of the background image thumbnail

Definition at line 91 of file class.ilObjCertificateSettings.php.

References getBackgroundImageDefaultFolder(), and getBackgroundImageName().

Referenced by deleteBackgroundImage(), getBackgroundImageThumbPathWeb(), and uploadBackgroundImage().

        {
                return $this->getBackgroundImageDefaultFolder() . $this->getBackgroundImageName() . ".thumb.jpg";
        }

Here is the call graph for this function:

Here is the caller graph for this function:

ilObjCertificateSettings::getBackgroundImageThumbPathWeb

(

)

Returns the web path of the background image thumbnail.

Returns

string The web path of the background image thumbnail

Definition at line 122 of file class.ilObjCertificateSettings.php.

References getBackgroundImageThumbPath(), ILIAS_ABSOLUTE_PATH, and ilUtil\removeTrailingPathSeparators().

        {
                include_once "./Services/Utilities/classes/class.ilUtil.php";
                return str_replace(ilUtil::removeTrailingPathSeparators(ILIAS_ABSOLUTE_PATH), ilUtil::removeTrailingPathSeparators(ILIAS_HTTP_PATH), $this->getBackgroundImageThumbPath());
        }

Here is the call graph for this function:

ilObjCertificateSettings::hasBackgroundImage

(

)

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

References getBackgroundImagePath().

        {
                if (@file_exists($this->getBackgroundImagePath()) && (@filesize($this->getBackgroundImagePath()) > 0))
                {
                        return TRUE;
                }
                else
                {
                        return FALSE;
                }
        }

Here is the call graph for this function:

ilObjCertificateSettings::ilObjCertificateSettings	(		$a_id = 0,
			$a_call_by_reference = true
	)

Constructor public.

Parameters

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

Definition at line 43 of file class.ilObjCertificateSettings.php.

References ilObject\ilObject().

        {
                $this->ilObject($a_id,$a_call_by_reference);
                $this->type = "cert";
        }

Here is the call graph for this function:

ilObjCertificateSettings::uploadBackgroundImage

(

$image_tempfilename

)

Uploads a background image for the certificate.

Creates a new directory for the certificate if needed. Removes an existing certificate image if necessary

Parameters

string

$image_tempfilename

Name of the temporary uploaded image file

Returns

integer An errorcode if the image upload fails, 0 otherwise

Definition at line 135 of file class.ilObjCertificateSettings.php.

References ilUtil\convertImage(), getBackgroundImageDefaultFolder(), getBackgroundImageName(), getBackgroundImagePath(), getBackgroundImageTempfilePath(), getBackgroundImageThumbPath(), ilUtil\makeDirParents(), and ilUtil\moveUploadedFile().

        {
                if (!empty($image_tempfilename))
                {
                        $image_filename = "background_upload";
                        $convert_filename = $this->getBackgroundImageName();
                        $imagepath = $this->getBackgroundImageDefaultFolder();
                        if (!file_exists($imagepath))
                        {
                                ilUtil::makeDirParents($imagepath);
                        }
                        // upload the file
                        if (!ilUtil::moveUploadedFile($image_tempfilename, $image_filename, $this->getBackgroundImageTempfilePath()))
                        {
                                return FALSE;
                        }
                        // convert the uploaded file to JPEG
                        ilUtil::convertImage($this->getBackgroundImageTempfilePath(), $this->getBackgroundImagePath(), "JPEG");
                        ilUtil::convertImage($this->getBackgroundImageTempfilePath(), $this->getBackgroundImageThumbPath(), "JPEG", 100);
                        if (!file_exists($this->getBackgroundImagePath()))
                        {
                                // something went wrong converting the file. use the original file and hope, that PDF can work with it
                                if (!ilUtil::moveUploadedFile($this->getBackgroundImageTempfilePath(), $convert_filename, $this->getBackgroundImagePath()))
                                {
                                        return FALSE;
                                }
                        }
                        unlink($this->getBackgroundImageTempfilePath());
                        if (file_exists($this->getBackgroundImagePath()) && (filesize($this->getBackgroundImagePath()) > 0))
                        {
                                return TRUE;
                        }
                }
                return FALSE;
        }

Here is the call graph for this function:

---

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

• Services/Certificate/classes/class.ilObjCertificateSettings.php