ILIAS  release_4-4 Revision
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. More...
 
 hasBackgroundImage ()
 
 getBackgroundImageDefaultFolder ()
 
 getBackgroundImagePath ()
 Returns the filesystem path of the background image. More...
 
 getBackgroundImageName ()
 Returns the filename of the background image. More...
 
 getBackgroundImageThumbPath ()
 Returns the filesystem path of the background image thumbnail. More...
 
 getBackgroundImageTempfilePath ()
 Returns the filesystem path of the background image temp file during upload. More...
 
 getBackgroundImagePathWeb ()
 Returns the web path of the background image. More...
 
 getBackgroundImageThumbPathWeb ()
 Returns the web path of the background image thumbnail. More...
 
 uploadBackgroundImage ($image_tempfilename)
 Uploads a background image for the certificate. More...
 
 deleteBackgroundImage ()
 Deletes the background image of a certificate. More...
 
- Public Member Functions inherited from ilObject
 ilObject ($a_id=0, $a_reference=true)
 Constructor public. More...
 
 withReferences ()
 determines wehter objects are referenced or not (got ref ids or not) More...
 
 read ($a_force_db=false)
 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 ()
 
 _lookupOwnerName ($a_owner_id)
 lookup owner name for owner id More...
 
 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...
 
 setObjDataRecord ($a_record)
 set object_data record (note: this method should only be called from the ilObjectFactory class) 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...
 
 _getIdForImportId ($a_import_id)
 get current object id for import id (static) More...
 
 _lookupOwner ($a_id)
 lookup object owner More...
 
 _lookupLastUpdate ($a_id, $a_as_string=false)
 lookup last update More...
 
 _getLastUpdateOfObjects ($a_objs)
 Get last update for a set of media objects. More...
 
 _setDeletedDate ($a_ref_id)
 only called in ilTree::saveSubTree More...
 
 _resetDeletedDate ($a_ref_id)
 only called in ilObjectGUI::insertSavedNodes More...
 
 _lookupDeletedDate ($a_ref_id)
 only called in ilObjectGUI::insertSavedNodes More...
 
 _writeTitle ($a_obj_id, $a_title)
 write title to db (static) More...
 
 _writeDescription ($a_obj_id, $a_desc)
 write description to db (static) More...
 
 _writeImportId ($a_obj_id, $a_import_id)
 write import id to db (static) More...
 
 _isInTrash ($a_ref_id)
 checks wether object is in trash More...
 
 _hasUntrashedReference ($a_obj_id)
 checks wether an object has at least one reference that is not in trash More...
 
 _getObjectsDataForType ($a_type, $a_omit_trash=false)
 get all objects of a certain type 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) public More...
 
 createRoleFolder ()
 creates a local role folder More...
 
 applyDidacticTemplate ($a_tpl_id)
 Apply template. More...
 
 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. More...
 
 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 ... More...
 
 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...
 
 _lookupCreationDate ($a_id)
 Lookup creation date. More...
 

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 More...
 
static _lookupTitle ($a_id)
 lookup object title More...
 
static _getIdsForTitle ($title, $type='', $partialmatch=false)
 
static _lookupDescription ($a_id)
 lookup object description More...
 
static _lookupObjId ($a_id)
 
static setDeletedDates ($a_ref_ids)
 Set deleted date type $ilDB. More...
 
static _lookupType ($a_id, $a_reference=false)
 lookup object type More...
 
static _lookupObjectId ($a_ref_id)
 lookup object id 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 hasAutoRating ($a_type, $a_ref_id)
 Check if auto rating is active for parent group/course. More...
 
- Data Fields inherited from ilObject
const TITLE_LENGTH = 255
 max length of object title More...
 
const DESC_LENGTH = 128
 
 $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 More...
 

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

◆ deleteBackgroundImage()

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

177  {
178  $result = TRUE;
179  if (file_exists($this->getBackgroundImageThumbPath()))
180  {
181  $result = $result & unlink($this->getBackgroundImageThumbPath());
182  }
183  if (file_exists($this->getBackgroundImagePath()))
184  {
185  $result = $result & unlink($this->getBackgroundImagePath());
186  }
187  if (file_exists($this->getBackgroundImageTempfilePath()))
188  {
189  $result = $result & unlink($this->getBackgroundImageTempfilePath());
190  }
191  return $result;
192  }
$result
getBackgroundImagePath()
Returns the filesystem path of the background image.
getBackgroundImageTempfilePath()
Returns the filesystem path of the background image temp file during upload.
getBackgroundImageThumbPath()
Returns the filesystem path of the background image thumbnail.
+ Here is the call graph for this function:

◆ getBackgroundImageDefaultFolder()

ilObjCertificateSettings::getBackgroundImageDefaultFolder ( )

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

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

62  {
63  return CLIENT_WEB_DIR . "/certificates/default/";
64  }
+ Here is the caller graph for this function:

◆ getBackgroundImageName()

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

82  {
83  return "background.jpg";
84  }
+ Here is the caller graph for this function:

◆ getBackgroundImagePath()

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

72  {
74  }
getBackgroundImageName()
Returns the filename of the background image.
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ getBackgroundImagePathWeb()

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

112  {
113  include_once "./Services/Utilities/classes/class.ilUtil.php";
115  }
getBackgroundImagePath()
Returns the filesystem path of the background image.
const ILIAS_ABSOLUTE_PATH
static removeTrailingPathSeparators($path)
+ Here is the call graph for this function:

◆ getBackgroundImageTempfilePath()

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

102  {
103  return $this->getBackgroundImageDefaultFolder() . "background_upload";
104  }
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ getBackgroundImageThumbPath()

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

92  {
93  return $this->getBackgroundImageDefaultFolder() . $this->getBackgroundImageName() . ".thumb.jpg";
94  }
getBackgroundImageName()
Returns the filename of the background image.
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ getBackgroundImageThumbPathWeb()

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

123  {
124  include_once "./Services/Utilities/classes/class.ilUtil.php";
126  }
const ILIAS_ABSOLUTE_PATH
static removeTrailingPathSeparators($path)
getBackgroundImageThumbPath()
Returns the filesystem path of the background image thumbnail.
+ Here is the call graph for this function:

◆ hasBackgroundImage()

ilObjCertificateSettings::hasBackgroundImage ( )

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

References getBackgroundImagePath().

50  {
51  if (@file_exists($this->getBackgroundImagePath()) && (@filesize($this->getBackgroundImagePath()) > 0))
52  {
53  return TRUE;
54  }
55  else
56  {
57  return FALSE;
58  }
59  }
getBackgroundImagePath()
Returns the filesystem path of the background image.
+ Here is the call graph for this function:

◆ ilObjCertificateSettings()

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

Constructor public.

Parameters
integerreference_id or object_id
booleantreat the id as reference_id (true) or object_id (false)

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

References ilObject\ilObject().

44  {
45  $this->ilObject($a_id,$a_call_by_reference);
46  $this->type = "cert";
47  }
ilObject($a_id=0, $a_reference=true)
Constructor public.
+ Here is the call graph for this function:

◆ uploadBackgroundImage()

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

136  {
137  if (!empty($image_tempfilename))
138  {
139  $image_filename = "background_upload";
140  $convert_filename = $this->getBackgroundImageName();
141  $imagepath = $this->getBackgroundImageDefaultFolder();
142  if (!file_exists($imagepath))
143  {
144  ilUtil::makeDirParents($imagepath);
145  }
146  // upload the file
147  if (!ilUtil::moveUploadedFile($image_tempfilename, $image_filename, $this->getBackgroundImageTempfilePath()))
148  {
149  return FALSE;
150  }
151  // convert the uploaded file to JPEG
154  if (!file_exists($this->getBackgroundImagePath()))
155  {
156  // something went wrong converting the file. use the original file and hope, that PDF can work with it
157  if (!ilUtil::moveUploadedFile($this->getBackgroundImageTempfilePath(), $convert_filename, $this->getBackgroundImagePath()))
158  {
159  return FALSE;
160  }
161  }
162  unlink($this->getBackgroundImageTempfilePath());
163  if (file_exists($this->getBackgroundImagePath()) && (filesize($this->getBackgroundImagePath()) > 0))
164  {
165  return TRUE;
166  }
167  }
168  return FALSE;
169  }
static makeDirParents($a_dir)
Create a new directory and all parent directories.
getBackgroundImagePath()
Returns the filesystem path of the background image.
getBackgroundImageTempfilePath()
Returns the filesystem path of the background image temp file during upload.
static moveUploadedFile($a_file, $a_name, $a_target, $a_raise_errors=true, $a_mode="move_uploaded")
move uploaded file
getBackgroundImageName()
Returns the filename of the background image.
static convertImage($a_from, $a_to, $a_target_format="", $a_geometry="", $a_background_color="")
convert image
getBackgroundImageThumbPath()
Returns the filesystem path of the background image thumbnail.
+ Here is the call graph for this function:

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