Badge Template. More...

Collaboration diagram for ilBadgeImageTemplate:

Public Member Functions
	__construct ($a_id=null)
	Constructor. More...

	getId ()

	setTitle ($a_value)

	getTitle ()

	getTypes ()

	setTypes (array $types=null)

	getImage ()

	uploadImage (array $a_upload_meta)

	getImagePath ()

	create ()

	update ()

	delete ()

Static Public Member Functions
static	getInstances ()

static	getInstancesByType ($a_type_unique_id)

Protected Member Functions
	setId ($a_id)

	setImage ($a_value)

	getFilePath ($a_id, $a_subdir=null)
	Init file system storage. More...

	read ($a_id)

	readTypes ($a_id)

	importDBRow (array $a_row)

	getPropertiesForStorage ()

	saveTypes ()

Protected Attributes
	$id

	$title

	$image

	$types

Detailed Description

Badge Template.

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 11 of file class.ilBadgeImageTemplate.php.

Constructor & Destructor Documentation

◆ __construct()

ilBadgeImageTemplate::__construct ( $a_id = null )

Constructor.

Parameters

int $a_id

Returns: self

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

References read().

         {
                 if($a_id)
                 {
                         $this->read($a_id);
                 }
         }

Here is the call graph for this function:

Member Function Documentation

◆ create()

ilBadgeImageTemplate::create ( )

Definition at line 241 of file class.ilBadgeImageTemplate.php.

References $id, $ilDB, array, getId(), getPropertiesForStorage(), saveTypes(), setId(), and update().

Referenced by update().

         {
                 global $ilDB;
                 
                 if($this->getId())
                 {
                         return $this->update();
                 }
                 
                 $id = $ilDB->nextId("badge_image_template");
                 $this->setId($id);
                 
                 $fields = $this->getPropertiesForStorage();                     
                 $fields["id"] = array("integer", $id);                                          
                 
                 $ilDB->insert("badge_image_template", $fields);
                 
                 $this->saveTypes();
         }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ delete()

ilBadgeImageTemplate::delete ( )

Definition at line 279 of file class.ilBadgeImageTemplate.php.

References $ilDB, $path, ilUtil\delDir(), getFilePath(), and getId().

         {
                 global $ilDB;
                 
                 if(!$this->getId())
                 {
                         return;
                 }
                 
                 $path = $this->getFilePath($this->getId());
                 ilUtil::delDir($path);
                 
                 $ilDB->manipulate("DELETE FROM badge_image_template".
                         " WHERE id = ".$ilDB->quote($this->getId(), "integer"));
         }

Here is the call graph for this function:

◆ getFilePath()

ilBadgeImageTemplate::getFilePath	(	$a_id,
		$a_subdir = `null`
	)

protected

Init file system storage.

Parameters

type	$a_id
type	$a_subdir

Returns: string

Definition at line 172 of file class.ilBadgeImageTemplate.php.

References $path.

Referenced by delete(), getImagePath(), and uploadImage().

         {               
                 include_once "Services/Badge/classes/class.ilFSStorageBadgeImageTemplate.php";
                 $storage = new ilFSStorageBadgeImageTemplate($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:

◆ getId()

ilBadgeImageTemplate::getId ( )

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

References $id.

Referenced by create(), delete(), getImagePath(), saveTypes(), update(), and uploadImage().

         {
                 return $this->id;
         }

Here is the caller graph for this function:

◆ getImage()

ilBadgeImageTemplate::getImage ( )

Definition at line 117 of file class.ilBadgeImageTemplate.php.

References $image.

Referenced by getImagePath(), getPropertiesForStorage(), and ilObjBadgeAdministrationGUI\setImageTemplateFormValues().

         {
                 return $this->image;
         }

Here is the caller graph for this function:

◆ getImagePath()

ilBadgeImageTemplate::getImagePath ( )

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

References getFilePath(), getId(), and getImage().

Referenced by ilObjBadgeAdministrationGUI\setImageTemplateFormValues().

         {
                 if($this->getId())
                 {
                         if (is_file($this->getFilePath($this->getId())."img".$this->getId()))   // formerly (early 5.2 versino), images have been uploaded with no suffix
                         {
                                 return $this->getFilePath($this->getId()) . "img" . $this->getId();
                         }
                         else
                         {
                                 $suffix = strtolower(array_pop(explode(".", $this->getImage())));
                                 return $this->getFilePath($this->getId()) . "img" . $this->getId() . "." . $suffix;
                         }
                 }
                 return "";
         }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getInstances()

static ilBadgeImageTemplate::getInstances ( )

static

Definition at line 32 of file class.ilBadgeImageTemplate.php.

References $ilDB, $res, $row, $types, and array.

Referenced by ilBadgeImageTemplateTableGUI\getItems().

         {
                 global $ilDB;
                 
                 $res = array();
                 
                 $types = array();
                 $set = $ilDB->query("SELECT * FROM badge_image_templ_type");
                 while($row = $ilDB->fetchAssoc($set))
                 {
                         $types[$row["tmpl_id"]][] = $row["type_id"];
                 }
                 
                 $set = $ilDB->query("SELECT * FROM badge_image_template".
                         " ORDER BY title");
                 while($row = $ilDB->fetchAssoc($set))
                 {
                         $row["types"] = (array)$types[$row["id"]];
                         
                         $obj = new self();
                         $obj->importDBRow($row);
                         $res[] = $obj;
                 }
                                 
                 return $res;
         }

Here is the caller graph for this function:

◆ getInstancesByType()

static ilBadgeImageTemplate::getInstancesByType ( $a_type_unique_id )

static

Definition at line 59 of file class.ilBadgeImageTemplate.php.

References $res, and array.

Referenced by ilBadgeManagementGUI\initBadgeForm().

         {
                 $res = array();
                 
                 foreach(self::getInstances() as $tmpl)
                 {                       
                         if(!sizeof($tmpl->getTypes()) ||
                                 in_array($a_type_unique_id, $tmpl->getTypes()))
                         {
                                 $res[] = $tmpl;
                         }                       
                 }
                 
                 return $res;
         }

Here is the caller graph for this function:

◆ getPropertiesForStorage()

ilBadgeImageTemplate::getPropertiesForStorage ( )

protected

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

References array, getImage(), and getTitle().

Referenced by create(), and update().

         {
                 return array(                   
                         "title" => array("text", $this->getTitle()),
                         "image" => array("text", $this->getImage())
                 );              
         }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getTitle()

ilBadgeImageTemplate::getTitle ( )

Definition at line 95 of file class.ilBadgeImageTemplate.php.

References $title.

Referenced by getPropertiesForStorage(), and ilObjBadgeAdministrationGUI\setImageTemplateFormValues().

         {
                 return $this->title;
         }

Here is the caller graph for this function:

◆ getTypes()

ilBadgeImageTemplate::getTypes ( )

Definition at line 105 of file class.ilBadgeImageTemplate.php.

References $types, and array.

Referenced by saveTypes(), and ilObjBadgeAdministrationGUI\setImageTemplateFormValues().

         {
                 return (array)$this->types;
         }

Here is the caller graph for this function:

◆ importDBRow()

ilBadgeImageTemplate::importDBRow ( array $a_row )

protected

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

References setId(), setImage(), setTitle(), and setTypes().

Referenced by read().

         {
                 $this->setId($a_row["id"]);             
                 $this->setTitle($a_row["title"]);
                 $this->setImage($a_row["image"]);                                                               
                 $this->setTypes($a_row["types"]);                                                               
         }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ read()

ilBadgeImageTemplate::read ( $a_id )

protected

Definition at line 198 of file class.ilBadgeImageTemplate.php.

References $ilDB, $row, importDBRow(), and readTypes().

Referenced by __construct().

         {
                 global $ilDB;
                 
                 $set = $ilDB->query("SELECT * FROM badge_image_template".
                         " WHERE id = ".$ilDB->quote($a_id, "integer"));
                 if($ilDB->numRows($set))
                 {
                         $row = $ilDB->fetchAssoc($set);
                         $row["types"] = $this->readTypes($a_id); 
                         $this->importDBRow($row);                                               
                 }               
         }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ readTypes()

ilBadgeImageTemplate::readTypes ( $a_id )

protected

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

References $ilDB, $res, $row, and array.

Referenced by read().

         {
                 global $ilDB;
                 
                 $res = array();
                 
                 $set = $ilDB->query("SELECT * FROM badge_image_templ_type".
                         " WHERE tmpl_id = ".$ilDB->quote($a_id, "integer"));
                 while($row = $ilDB->fetchAssoc($set))
                 {
                         $res[] = $row["type_id"];
                 }
                 
                 if(!sizeof($res))
                 {
                         $res = null;
                 }
                 
                 return $res;
         }

Here is the caller graph for this function:

◆ saveTypes()

ilBadgeImageTemplate::saveTypes ( )

protected

Definition at line 303 of file class.ilBadgeImageTemplate.php.

References $ilDB, array, getId(), and getTypes().

Referenced by create(), and update().

         {
                 global $ilDB;
                 
                 if($this->getId())
                 {
                         $ilDB->manipulate("DELETE FROM badge_image_templ_type".
                                 " WHERE tmpl_id = ".$ilDB->quote($this->getId(), "integer"));
                         
                         if($this->getTypes())
                         {
                                 foreach($this->getTypes() as $type)
                                 {
                                         $fields = array(
                                                 "tmpl_id" => array("integer", $this->getId()),
                                                 "type_id" => array("text", $type)
                                         );                              
                                         $ilDB->insert("badge_image_templ_type", $fields);
                                 }       
                         }
                 }
         }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setId()

ilBadgeImageTemplate::setId ( $a_id )

protected

Definition at line 80 of file class.ilBadgeImageTemplate.php.

Referenced by create(), and importDBRow().

         {
                 $this->id = (int)$a_id;
         }

Here is the caller graph for this function:

◆ setImage()

ilBadgeImageTemplate::setImage ( $a_value )

protected

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

References image.

Referenced by importDBRow(), and uploadImage().

         {
                 $this->image = trim($a_value);
         }

Here is the caller graph for this function:

◆ setTitle()

ilBadgeImageTemplate::setTitle ( $a_value )

Definition at line 90 of file class.ilBadgeImageTemplate.php.

Referenced by importDBRow().

         {
                 $this->title = trim($a_value);
         }

Here is the caller graph for this function:

◆ setTypes()

ilBadgeImageTemplate::setTypes ( array $types = null )

Definition at line 110 of file class.ilBadgeImageTemplate.php.

References $types.

Referenced by importDBRow().

         {               
                 $this->types = is_array($types) 
                         ? array_unique($types)
                         : null;
         }

Here is the caller graph for this function:

◆ update()

ilBadgeImageTemplate::update ( )

Definition at line 261 of file class.ilBadgeImageTemplate.php.

References $ilDB, array, create(), getId(), getPropertiesForStorage(), and saveTypes().

Referenced by create(), and uploadImage().

         {
                 global $ilDB;
                 
                 if(!$this->getId())
                 {
                         return $this->create();
                 }
                 
                 $fields = $this->getPropertiesForStorage();
                 
                 $ilDB->update("badge_image_template", $fields,
                         array("id"=>array("integer", $this->getId()))
                 );
                 
                 $this->saveTypes();
         }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ uploadImage()

ilBadgeImageTemplate::uploadImage ( array $a_upload_meta )

Parameters

array $a_upload_meta

Exceptions

ilFileUtilsException

Definition at line 126 of file class.ilBadgeImageTemplate.php.

References $filename, $path, getFilePath(), getId(), ilFileUtils\getValidFilename(), ilUtil\moveUploadedFile(), setImage(), and update().

         {               
                 if($this->getId() &&
                         $a_upload_meta["tmp_name"])
                 {
                         $path = $this->getFilePath($this->getId());
 
 
                         include_once("./Services/Utilities/classes/class.ilFileUtils.php");
                         $filename = ilFileUtils::getValidFilename($a_upload_meta["name"]);
 
                         $suffix = strtolower(array_pop(explode(".", $filename)));
                         $tgt = $path."img".$this->getId().".".$suffix;
 
                         if(ilUtil::moveUploadedFile($a_upload_meta["tmp_name"], "img".$this->getId().".".$suffix, $tgt))
                         {
                                 $this->setImage($filename);
                                 $this->update();                        
                         }
                 }
         }

Here is the call graph for this function:

Field Documentation

◆ $id

ilBadgeImageTemplate::$id

protected

Definition at line 13 of file class.ilBadgeImageTemplate.php.

Referenced by create(), and getId().

◆ $image

ilBadgeImageTemplate::$image

protected

Definition at line 15 of file class.ilBadgeImageTemplate.php.

Referenced by getImage().

◆ $title

ilBadgeImageTemplate::$title

protected

Definition at line 14 of file class.ilBadgeImageTemplate.php.

Referenced by getTitle().

◆ $types

ilBadgeImageTemplate::$types

protected

Definition at line 16 of file class.ilBadgeImageTemplate.php.

Referenced by getInstances(), getTypes(), and setTypes().

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

Services/Badge/classes/class.ilBadgeImageTemplate.php

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ create()

◆ delete()

◆ getFilePath()

◆ getId()

◆ getImage()

◆ getImagePath()

◆ getInstances()

◆ getInstancesByType()

◆ getPropertiesForStorage()

◆ getTitle()

◆ getTypes()

◆ importDBRow()

◆ read()

◆ readTypes()

◆ saveTypes()

◆ setId()

◆ setImage()

◆ setTitle()

◆ setTypes()

◆ update()

◆ uploadImage()

Field Documentation

◆ $id

◆ $image

◆ $title

◆ $types