Collaboration diagram for ilBadgeAssignment:

Public Member Functions
	__construct ($a_badge_id=null, $a_user_id=null)

	getBadgeId ()

	getUserId ()

	getTimestamp ()

	setAwardedBy ($a_id)

	getAwardedBy ()

	setPosition ($a_value)

	getPosition ()

	store ()

	delete ()

	getImagePath (ilBadge $a_badge)

	getStaticUrl ()

	deleteStaticFiles ()

Static Public Member Functions
static	getInstancesByUserId ($a_user_id)

static	getInstancesByBadgeId ($a_badge_id)

static	getInstancesByParentId ($a_parent_obj_id)

static	getAssignedUsers ($a_badge_id)

static	exists ($a_badge_id, $a_user_id)

static	deleteByUserId ($a_user_id)

static	deleteByBadgeId ($a_badge_id)

static	deleteByParentId ($a_parent_obj_id)

static	updatePositions ($a_user_id, array $a_positions)

static	clearBadgeCache ($a_user_id)

Protected Member Functions
	setBadgeId ($a_value)

	setUserId ($a_value)

	setTimestamp ($a_value)

	importDBRow (array $a_row)

	read ($a_badge_id, $a_user_id)

	getPropertiesForStorage ()

	prepareJson ($a_url)

	bakeImage ($a_baked_image_path, $a_badge_image_path, $a_assertion_url)

Protected Attributes
	$badge_id

	$user_id

	$tstamp

	$awarded_by

	$pos

	$stored

Detailed Description

Definition at line 12 of file class.ilBadgeAssignment.php.

Constructor & Destructor Documentation

◆ __construct()

ilBadgeAssignment::__construct	(	$a_badge_id = `null`,
		$a_user_id = `null`
	)

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

References read(), setBadgeId(), and setUserId().

         {
                 if($a_badge_id &&
                         $a_user_id)
                 {
                         $this->setBadgeId($a_badge_id);
                         $this->setUserId($a_user_id);
                         
                         $this->read($a_badge_id, $a_user_id);
                 }               
         }

Here is the call graph for this function:

Member Function Documentation

◆ bakeImage()

ilBadgeAssignment::bakeImage	(	$a_baked_image_path,
		$a_badge_image_path,
		$a_assertion_url
	)

protected

Definition at line 372 of file class.ilBadgeAssignment.php.

Referenced by prepareJson().

         {                               
                 $suffix = strtolower(array_pop(explode(".", basename($a_badge_image_path))));           
                 if($suffix == "png")
                 {
                         // using chamilo baker lib
                         include_once "Services/Badge/lib/baker.lib.php";                        
                         $png = new PNGImageBaker(file_get_contents($a_badge_image_path));
                         
                         // add payload
                         if($png->checkChunks("tEXt", "openbadges")) 
                         {
                                 $baked = $png->addChunk("tEXt", "openbadges", $a_assertion_url);                                
                         }               
                         
                         // create baked file                    
                         if(!file_exists($a_baked_image_path))
                         {
                                 file_put_contents($a_baked_image_path, $baked);
                         }                                                       
                         
                         // verify file
                         $verify = $png->extractBadgeInfo(file_get_contents($a_baked_image_path));                       
                         if(is_array($verify)) 
                         {
                                 return true;
                         }
                 }
                 else if($suffix == "svg")
                 {
                         // :TODO: not really sure if this is correct
                         $svg = simplexml_load_file($a_badge_image_path);
                         $ass = $svg->addChild("openbadges:assertion", "", "http://openbadges.org");
                         $ass->addAttribute("verify", $a_assertion_url);
                         $baked = $svg->asXML();
                         
                         // create baked file                    
                         if(!file_exists($a_baked_image_path))
                         {
                                 file_put_contents($a_baked_image_path, $baked);                         
                         }               
                         
                         return true;
                 }               
                 
                 return false;
         }

Here is the caller graph for this function:

◆ clearBadgeCache()

static ilBadgeAssignment::clearBadgeCache ( $a_user_id )

static

Definition at line 445 of file class.ilBadgeAssignment.php.

Referenced by ilBadgeProfileGUI\saveSettings().

         {
                 foreach(self::getInstancesByUserId($a_user_id) as $ass)
                 {
                         $ass->deleteStaticFiles();
                 }
         }

Here is the caller graph for this function:

◆ delete()

ilBadgeAssignment::delete ( )

Definition at line 237 of file class.ilBadgeAssignment.php.

References $ilDB, deleteStaticFiles(), getBadgeId(), and getUserId().

         {
                 global $ilDB;
                 
                 if(!$this->getBadgeId() ||
                         !$this->getUserId())
                 {
                         return;
                 }
                 
                 $this->deleteStaticFiles();
                 
                 $ilDB->manipulate("DELETE FROM badge_user_badge".
                         " WHERE badge_id = ".$ilDB->quote($this->getBadgeId(), "integer").
                         " AND user_id = ".$ilDB->quote($this->getUserId(), "integer"));
         }

Here is the call graph for this function:

◆ deleteByBadgeId()

static ilBadgeAssignment::deleteByBadgeId ( $a_badge_id )

static

Definition at line 262 of file class.ilBadgeAssignment.php.

Referenced by ilBadge\delete().

         {               
                 foreach(self::getInstancesByBadgeId($a_badge_id) as $ass)
                 {
                         $ass->delete();
                 }               
         }

Here is the caller graph for this function:

◆ deleteByParentId()

static ilBadgeAssignment::deleteByParentId ( $a_parent_obj_id )

static

Definition at line 270 of file class.ilBadgeAssignment.php.

         {
                 foreach(self::getInstancesByParentId($a_parent_obj_id) as $ass)
                 {
                         $ass->delete();
                 }       
         }

◆ deleteByUserId()

static ilBadgeAssignment::deleteByUserId ( $a_user_id )

static

Definition at line 254 of file class.ilBadgeAssignment.php.

Referenced by ilObjUser\delete().

         {
                 foreach(self::getInstancesByUserId($a_user_id) as $ass)
                 {
                         $ass->delete();
                 }                       
         }

Here is the caller graph for this function:

◆ deleteStaticFiles()

ilBadgeAssignment::deleteStaticFiles ( )

Definition at line 436 of file class.ilBadgeAssignment.php.

References $path, and ilBadgeHandler\getInstance().

Referenced by delete().

         {
                 // remove instance files
                 include_once("./Services/Badge/classes/class.ilBadgeHandler.php");
                 $path = ilBadgeHandler::getInstance()->getInstancePath($this);                          
                 $path = str_replace(".json", ".*", $path);
                 array_map("unlink", glob($path));
         }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ exists()

static ilBadgeAssignment::exists	(	$a_badge_id,
		$a_user_id
	)

static

Definition at line 108 of file class.ilBadgeAssignment.php.

Referenced by ilBadgeManagementGUI\assignBadge(), ilBadgeHandler\sendNotification(), and ilBadgeHandler\triggerEvaluation().

         {
                 $obj = new self($a_badge_id, $a_user_id);
                 return $obj->stored;
         }                       

Here is the caller graph for this function:

◆ getAssignedUsers()

static ilBadgeAssignment::getAssignedUsers ( $a_badge_id )

static

Definition at line 96 of file class.ilBadgeAssignment.php.

References $res, and array.

Referenced by ilBadgeManagementGUI\confirmDeassignBadge().

         {
                 $res = array();
                 
                 foreach(self::getInstancesByBadgeId($a_badge_id) as $ass)
                 {
                         $res[] = $ass->getUserId();
                 }
                 
                 return $res;
         }

Here is the caller graph for this function:

◆ getAwardedBy()

ilBadgeAssignment::getAwardedBy ( )

Definition at line 154 of file class.ilBadgeAssignment.php.

References $awarded_by.

Referenced by getPropertiesForStorage().

         {
                 return $this->awarded_by;
         }

Here is the caller graph for this function:

◆ getBadgeId()

ilBadgeAssignment::getBadgeId ( )

Definition at line 124 of file class.ilBadgeAssignment.php.

References $badge_id.

Referenced by delete(), ilBadgeHandler\getInstancePath(), prepareJson(), and store().

         {
                 return $this->badge_id;
         }

Here is the caller graph for this function:

◆ getImagePath()

ilBadgeAssignment::getImagePath ( ilBadge $a_badge )

Definition at line 361 of file class.ilBadgeAssignment.php.

References ilBadge\getImagePath(), and ilBadgeHandler\getInstance().

Referenced by prepareJson().

         {
                 $json_path = ilBadgeHandler::getInstance()->getInstancePath($this);
                 $baked_path = dirname($json_path);
                 $baked_file = array_shift(explode(".", basename($json_path)));
                 
                 // get correct suffix from badge image
                 $suffix = strtolower(array_pop(explode(".", basename($a_badge->getImagePath()))));              
                 return $baked_path."/".$baked_file.".".$suffix;         
         }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getInstancesByBadgeId()

static ilBadgeAssignment::getInstancesByBadgeId ( $a_badge_id )

static

Definition at line 52 of file class.ilBadgeAssignment.php.

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

Referenced by ilBadgeManagementGUI\confirmDeleteBadges(), and ilObjBadgeAdministrationGUI\confirmDeleteObjectBadges().

         {
                 global $ilDB;
                 
                 $res = array();
                 
                 $set = $ilDB->query("SELECT * FROM badge_user_badge".
                         " WHERE badge_id = ".$ilDB->quote($a_badge_id, "integer"));
                 while($row = $ilDB->fetchAssoc($set))
                 {
                         $obj = new self();
                         $obj->importDBRow($row);
                         $res[] = $obj;                  
                 }
                 
                 return $res;
         }

Here is the caller graph for this function:

◆ getInstancesByParentId()

static ilBadgeAssignment::getInstancesByParentId ( $a_parent_obj_id )

static

Definition at line 70 of file class.ilBadgeAssignment.php.

References $ilDB, $res, $row, array, and ilBadge\getInstancesByParentId().

Referenced by ilBadgeUserTableGUI\getItems().

         {
                 global $ilDB;
                 
                 $res = array();
                 
                 $badge_ids = array();
                 foreach(ilBadge::getInstancesByParentId($a_parent_obj_id) as $badge)
                 {
                         $badge_ids[] = $badge->getId();
                 }
                 if(sizeof($badge_ids))
                 {
                         $set = $ilDB->query("SELECT * FROM badge_user_badge".
                         " WHERE ".$ilDB->in("badge_id", $badge_ids, "", "integer"));
                         while($row = $ilDB->fetchAssoc($set))
                         {
                                 $obj = new self();
                                 $obj->importDBRow($row);
                                 $res[] = $obj;                  
                         }               
                 }
                 
                 return $res;
         }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getInstancesByUserId()

static ilBadgeAssignment::getInstancesByUserId ( $a_user_id )

static

Definition at line 33 of file class.ilBadgeAssignment.php.

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

Referenced by ilPublicUserProfileGUI\getEmbeddable(), ilBadgePersonalTableGUI\getItems(), ilBadgeProfileGUI\listBadges(), and ilPersonalProfileGUI\showPublicProfileFields().

         {
                 global $ilDB;
                 
                 $res = array();
                 
                 $set = $ilDB->query("SELECT * FROM badge_user_badge".
                         " WHERE user_id = ".$ilDB->quote($a_user_id, "integer").
                         " ORDER BY pos");
                 while($row = $ilDB->fetchAssoc($set))
                 {
                         $obj = new self();
                         $obj->importDBRow($row);
                         $res[] = $obj;                  
                 }
                 
                 return $res;
         }

Here is the caller graph for this function:

◆ getPosition()

ilBadgeAssignment::getPosition ( )

Definition at line 168 of file class.ilBadgeAssignment.php.

References $pos.

Referenced by getPropertiesForStorage().

         {
                 return $this->pos;
         }

Here is the caller graph for this function:

◆ getPropertiesForStorage()

ilBadgeAssignment::getPropertiesForStorage ( )

protected

Definition at line 202 of file class.ilBadgeAssignment.php.

References array, getAwardedBy(), getPosition(), getTimestamp(), and time.

Referenced by store().

         {
                 return array(
                         "tstamp" => array("integer", (bool)$this->stored ? $this->getTimestamp() : time()),
                         "awarded_by" => array("integer", $this->getAwardedBy()),
                         "pos" => array("integer", $this->getPosition())
                 );              
         }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getStaticUrl()

ilBadgeAssignment::getStaticUrl ( )

Definition at line 420 of file class.ilBadgeAssignment.php.

References $path, $url, ilBadgeHandler\getInstance(), and prepareJson().

         {
                 include_once("./Services/Badge/classes/class.ilBadgeHandler.php");
                 $path = ilBadgeHandler::getInstance()->getInstancePath($this);
                 
                 $url = ILIAS_HTTP_PATH.substr($path, 1);
                 
                 if(!file_exists($path))
                 {                       
                         $json = json_encode($this->prepareJson($url));
                         file_put_contents($path, $json);
                 }
                 
                 return $url;
         }

Here is the call graph for this function:

◆ getTimestamp()

ilBadgeAssignment::getTimestamp ( )

Definition at line 144 of file class.ilBadgeAssignment.php.

References $tstamp.

Referenced by getPropertiesForStorage(), and prepareJson().

         {
                 return $this->tstamp;
         }

Here is the caller graph for this function:

◆ getUserId()

ilBadgeAssignment::getUserId ( )

Definition at line 134 of file class.ilBadgeAssignment.php.

References $user_id.

Referenced by delete(), ilBadgeHandler\getInstancePath(), prepareJson(), and store().

         {
                 return $this->user_id;
         }

Here is the caller graph for this function:

◆ importDBRow()

ilBadgeAssignment::importDBRow ( array $a_row )

protected

Definition at line 178 of file class.ilBadgeAssignment.php.

References setAwardedBy(), setBadgeId(), setPosition(), setTimestamp(), and setUserId().

Referenced by read().

         {
                 $this->stored = true;
                 $this->setBadgeId($a_row["badge_id"]);
                 $this->setUserId($a_row["user_id"]);
                 $this->setTimestamp($a_row["tstamp"]);
                 $this->setAwardedBy($a_row["awarded_by"]);
                 $this->setPosition($a_row["pos"]);              
         }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ prepareJson()

ilBadgeAssignment::prepareJson ( $a_url )

protected

Definition at line 308 of file class.ilBadgeAssignment.php.

References ilBadgeProfileGUI\BACKPACK_EMAIL, bakeImage(), getBadgeId(), getImagePath(), ilBadgeHandler\getInstance(), getTimestamp(), and getUserId().

Referenced by getStaticUrl().

         {                                               
                 $verify = new stdClass();
                 $verify->type = "hosted";
                 $verify->url = $a_url;
                 
                 $recipient = new stdClass();
                 $recipient->type = "email";
                 $recipient->hashed = true;
                 $recipient->salt = ilBadgeHandler::getInstance()->getObiSalt();
                                                 
                 // https://github.com/mozilla/openbadges-backpack/wiki/How-to-hash-&-salt-in-various-languages.
                 include_once "Services/Badge/classes/class.ilBadgeProfileGUI.php";
                 $user = new ilObjUser($this->getUserId());
                 $mail = $user->getPref(ilBadgeProfileGUI::BACKPACK_EMAIL);
                 if(!$mail)
                 {
                         $mail = $user->getEmail();
                 }
                 $recipient->identity = 'sha256$'.hash('sha256', $mail.$recipient->salt);
                 
                 // spec: should be locally unique
                 $unique_id = md5($this->getBadgeId()."-".$this->getUserId());           
                 
                 $json = new stdClass();
                 $json->{"@context"} = "https://w3id.org/openbadges/v1";
                 $json->type = "Assertion";
                 $json->id = $a_url;
                 $json->uid = $unique_id;
                 $json->recipient = $recipient;
                         
                 include_once "Services/Badge/classes/class.ilBadge.php";
                 $badge = new ilBadge($this->getBadgeId());
                 $badge_url = $badge->getStaticUrl();
                                                                         
                 // created baked image           
                 $baked_image = $this->getImagePath($badge);
                 if($this->bakeImage($baked_image, $badge->getImagePath(), $a_url))
                 {                       
                         // path to url
                         $parts = explode("/", $a_url);
                         array_pop($parts);
                         $parts[] = basename($baked_image);
                         $json->image = implode("/", $parts);            
                 }
                 
                 $json->issuedOn = $this->getTimestamp();
                 $json->badge =  $badge_url;             
                 $json->verify = $verify;        
                 
                 return $json;
         }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ read()

ilBadgeAssignment::read	(	$a_badge_id,
		$a_user_id
	)

protected

Definition at line 188 of file class.ilBadgeAssignment.php.

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

Referenced by __construct().

         {
                 global $ilDB;
                 
                 $set = $ilDB->query("SELECT * FROM badge_user_badge".
                         " WHERE badge_id = ".$ilDB->quote($a_badge_id, "integer").
                         " AND user_id = ".$ilDB->quote($a_user_id, "integer"));
                 $row = $ilDB->fetchAssoc($set);
                 if($row["user_id"])
                 {
                         $this->importDBRow($row);                               
                 }
         }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setAwardedBy()

ilBadgeAssignment::setAwardedBy ( $a_id )

Definition at line 149 of file class.ilBadgeAssignment.php.

Referenced by importDBRow().

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

Here is the caller graph for this function:

◆ setBadgeId()

ilBadgeAssignment::setBadgeId ( $a_value )

protected

Definition at line 119 of file class.ilBadgeAssignment.php.

Referenced by __construct(), and importDBRow().

         {
                 $this->badge_id = (int)$a_value;
         }

Here is the caller graph for this function:

◆ setPosition()

ilBadgeAssignment::setPosition ( $a_value )

Definition at line 159 of file class.ilBadgeAssignment.php.

Referenced by importDBRow().

         {
                 if($a_value !== null)
                 {
                         $a_value = (int)$a_value;
                 }
                 $this->pos = $a_value;
         }

Here is the caller graph for this function:

◆ setTimestamp()

ilBadgeAssignment::setTimestamp ( $a_value )

protected

Definition at line 139 of file class.ilBadgeAssignment.php.

Referenced by importDBRow().

         {
                 $this->tstamp = (int)$a_value;
         }

Here is the caller graph for this function:

◆ setUserId()

ilBadgeAssignment::setUserId ( $a_value )

protected

Definition at line 129 of file class.ilBadgeAssignment.php.

Referenced by __construct(), and importDBRow().

         {
                 $this->user_id = (int)$a_value;
         }

Here is the caller graph for this function:

◆ store()

ilBadgeAssignment::store ( )

Definition at line 211 of file class.ilBadgeAssignment.php.

References $ilDB, array, getBadgeId(), getPropertiesForStorage(), and getUserId().

Referenced by ilBadgeHandler\triggerEvaluation().

         {
                 global $ilDB;
                 
                 if(!$this->getBadgeId() ||
                         !$this->getUserId())
                 {
                         return;
                 }
                 
                 $keys = array(
                         "badge_id" => array("integer", $this->getBadgeId()),
                         "user_id" => array("integer", $this->getUserId())
                 );
                 $fields = $this->getPropertiesForStorage();
                 
                 if(!(bool)$this->stored)
                 {                                                                                               
                         $ilDB->insert("badge_user_badge", $fields + $keys);
                 }
                 else
                 {
                         $ilDB->update("badge_user_badge", $fields, $keys);
                 }
         }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ updatePositions()

static ilBadgeAssignment::updatePositions	(		$a_user_id,
		array	$a_positions
	)

static

Definition at line 278 of file class.ilBadgeAssignment.php.

References $title, and array.

Referenced by ilPersonalProfileGUI\savePublicProfile().

         {
                 $existing = array();
                 include_once "Services/Badge/classes/class.ilBadge.php";
                 foreach(self::getInstancesByUserId($a_user_id) as $ass)
                 {
                         $badge = new ilBadge($ass->getBadgeId());
                         $existing[$badge->getId()] = array($badge->getTitle(), $ass);
                 }               
                 
                 $new_pos = 0;
                 foreach($a_positions as $title)
                 {
                         foreach($existing as $id => $item)
                         {
                                 if($title == $item[0])
                                 {
                                         $item[1]->setPosition(++$new_pos);
                                         $item[1]->store();
                                         unset($existing[$id]);
                                 }
                         }
                 }
         }

Here is the caller graph for this function:

Field Documentation

◆ $awarded_by

ilBadgeAssignment::$awarded_by

protected

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

Referenced by getAwardedBy().

◆ $badge_id

ilBadgeAssignment::$badge_id

protected

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

Referenced by getBadgeId().

◆ $pos

ilBadgeAssignment::$pos

protected

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

Referenced by getPosition().

◆ $stored

ilBadgeAssignment::$stored

protected

Definition at line 19 of file class.ilBadgeAssignment.php.

◆ $tstamp

ilBadgeAssignment::$tstamp

protected

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

Referenced by getTimestamp().

◆ $user_id

ilBadgeAssignment::$user_id

protected

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

Referenced by getUserId().

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

Services/Badge/classes/class.ilBadgeAssignment.php

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ bakeImage()

◆ clearBadgeCache()

◆ delete()

◆ deleteByBadgeId()

◆ deleteByParentId()

◆ deleteByUserId()

◆ deleteStaticFiles()

◆ exists()

◆ getAssignedUsers()

◆ getAwardedBy()

◆ getBadgeId()

◆ getImagePath()

◆ getInstancesByBadgeId()

◆ getInstancesByParentId()

◆ getInstancesByUserId()

◆ getPosition()

◆ getPropertiesForStorage()

◆ getStaticUrl()

◆ getTimestamp()

◆ getUserId()

◆ importDBRow()

◆ prepareJson()

◆ read()

◆ setAwardedBy()

◆ setBadgeId()

◆ setPosition()

◆ setTimestamp()

◆ setUserId()

◆ store()

◆ updatePositions()

Field Documentation

◆ $awarded_by

◆ $badge_id

◆ $pos

◆ $stored

◆ $tstamp

◆ $user_id