This file is part of ILIAS, a powerful learning management system published by ILIAS open source e-Learning e.V. More...

Collaboration diagram for ilBadgeAssignment:

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

	getBadgeId ()

	getUserId ()

	getTimestamp ()

	setAwardedBy (int $a_id)

	getAwardedBy ()

	setPosition (?int $a_value)

	getPosition ()

	store ()

	delete ()

	deleteStaticFiles ()

Static Public Member Functions
static	getNewCounter (int $a_user_id)

static	getLatestTimestamp (int $a_user_id)

static	getInstancesByUserId (int $a_user_id)

static	getInstancesByBadgeId (int $a_badge_id)

static	getInstancesByParentId (int $a_parent_obj_id)

static	getAssignedUsers (int $a_badge_id)

static	exists (int $a_badge_id, int $a_user_id)

static	deleteByUserId (int $a_user_id)

static	deleteByBadgeId (int $a_badge_id)

static	deleteByParentId (int $a_parent_obj_id)

static	updatePositions (int $a_user_id, array $a_positions)

static	getBadgesForUser (int $a_user_id, int $a_ts_from, int $a_ts_to)

static	clearBadgeCache (int $a_user_id)

Protected Member Functions
	setBadgeId (int $a_value)

	setUserId (int $a_value)

	setTimestamp (int $a_value)

	importDBRow (array $a_row)

	read (int $a_badge_id, int $a_user_id)

	getPropertiesForStorage ()

Protected Attributes
ilDBInterface	$db

int	$badge_id = 0

int	$user_id = 0

int	$tstamp = 0

int	$awarded_by = 0

int	$pos = null

bool	$stored = false

Detailed Description

This file is part of ILIAS, a powerful learning management system published by ILIAS open source e-Learning e.V.

ILIAS is licensed with the GPL-3.0, see https://www.gnu.org/licenses/gpl-3.0.en.html You should have received a copy of said license along with the source code, too.

If this is not the case or you just want to try ILIAS, you'll find us at: https://www.ilias.de https://github.com/ILIAS-eLearning Class ilBadgeAssignment

Author: Jörg Lützenkirchen luetz.nosp@m.enki.nosp@m.rchen.nosp@m.@lei.nosp@m.fos.c.nosp@m.om

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

Constructor & Destructor Documentation

◆ __construct()

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

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

      {
        global $DIC;
 
        $this->db = $DIC->database();
        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);
        }
    }

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

Here is the call graph for this function:

Member Function Documentation

◆ clearBadgeCache()

static ilBadgeAssignment::clearBadgeCache ( int $a_user_id )

static

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

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

Referenced by ilBadgeProfileGUI\saveSettings().

Here is the caller graph for this function:

◆ delete()

ilBadgeAssignment::delete ( )

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

                            : void
    {
        $ilDB = $this->db;
 
        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"));
    }

References $ilDB.

◆ deleteByBadgeId()

static ilBadgeAssignment::deleteByBadgeId ( int $a_badge_id )

static

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

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

Referenced by ilBadge\delete().

Here is the caller graph for this function:

◆ deleteByParentId()

static ilBadgeAssignment::deleteByParentId ( int $a_parent_obj_id )

static

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

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

◆ deleteByUserId()

static ilBadgeAssignment::deleteByUserId ( int $a_user_id )

static

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

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

Referenced by ilObjUser\delete().

Here is the caller graph for this function:

◆ deleteStaticFiles()

ilBadgeAssignment::deleteStaticFiles ( )

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

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

References $path, and ilBadgeHandler\getInstance().

Here is the call graph for this function:

◆ exists()

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

static

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

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

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

Here is the caller graph for this function:

◆ getAssignedUsers()

static ilBadgeAssignment::getAssignedUsers ( int $a_badge_id )

static

Parameters

int $a_badge_id

Returns: int[]

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

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

References $res.

Referenced by ilBadgeManagementGUI\confirmDeassignBadge().

Here is the caller graph for this function:

◆ getAwardedBy()

ilBadgeAssignment::getAwardedBy ( )

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

                                  : int
    {
        return $this->awarded_by;
    }

◆ getBadgeId()

ilBadgeAssignment::getBadgeId ( )

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

                                : int
    {
        return $this->badge_id;
    }

Referenced by ilBadgeHandler\getInstancePath().

Here is the caller graph for this function:

◆ getBadgesForUser()

static ilBadgeAssignment::getBadgesForUser	(	int	$a_user_id,
		int	$a_ts_from,
		int	$a_ts_to
	)

static

Parameters

int	$a_user_id
int	$a_ts_from
int	$a_ts_to

Returns: array[]

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

     : array {
        global $DIC;
 
        $db = $DIC->database();
 
        $set = $db->queryF(
            "SELECT bdg.parent_id, ub.tstamp, bdg.title FROM badge_user_badge ub JOIN badge_badge bdg" .
            " ON (ub.badge_id = bdg.id) " .
            " WHERE ub.user_id = %s AND ub.tstamp >= %s AND ub.tstamp <= %s",
            array("integer","integer","integer"),
            array($a_user_id, $a_ts_from, $a_ts_to)
        );
        $res = [];
        while ($rec = $db->fetchAssoc($set)) {
            $res[] = $rec;
        }
        return $res;
    }

References $res.

Referenced by ilBadgeLearningHistoryProvider\getEntries().

Here is the caller graph for this function:

◆ getInstancesByBadgeId()

static ilBadgeAssignment::getInstancesByBadgeId ( int $a_badge_id )

static

Parameters

int $a_badge_id

Returns: self[]

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

     : array {
        global $DIC;
 
        $ilDB = $DIC->database();
 
        $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;
    }

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

Here is the caller graph for this function:

◆ getInstancesByParentId()

static ilBadgeAssignment::getInstancesByParentId ( int $a_parent_obj_id )

static

Parameters

int $a_parent_obj_id

Returns: self[]

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

     : array {
        global $DIC;
 
        $ilDB = $DIC->database();
 
        $res = array();
 
        $badge_ids = array();
        foreach (ilBadge::getInstancesByParentId($a_parent_obj_id) as $badge) {
            $badge_ids[] = $badge->getId();
        }
        if (count($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;
    }

◆ getInstancesByUserId()

static ilBadgeAssignment::getInstancesByUserId ( int $a_user_id )

static

Parameters

int $a_user_id

Returns: self[]

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

     : array {
        global $DIC;
 
        $ilDB = $DIC->database();
 
        $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;
    }

Referenced by ilPublicUserProfileGUI\getEmbeddable(), ilBadgePersonalTableGUI\getItems(), ilBadgeWAC\isAssignedBadge(), and ilBadgeProfileGUI\listBadges().

Here is the caller graph for this function:

◆ getLatestTimestamp()

static ilBadgeAssignment::getLatestTimestamp ( int $a_user_id )

static

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

     : int {
        global $DIC;
 
        $db = $DIC->database();
 
        $set = $db->queryF(
            "SELECT max(tstamp) maxts FROM badge_user_badge " .
            " WHERE user_id = %s",
            ["integer"],
            [$a_user_id]
        );
        $rec = $db->fetchAssoc($set);
        return (int) $rec["maxts"];
    }

◆ getNewCounter()

static ilBadgeAssignment::getNewCounter ( int $a_user_id )

static

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

     : int {
        global $DIC;
 
        $db = $DIC->database();
 
        $user = new ilObjUser($a_user_id);
        $noti_repo = new \ILIAS\Badge\Notification\BadgeNotificationPrefRepository($user);
 
        $last = $noti_repo->getLastCheckedTimestamp();
 
 
        // if no last check exists, we use last 24 hours
        if ($last === 0) {
            $last = time() - (24 * 60 * 60);
        }
 
        if ($last > 0) {
            $set = $db->queryF(
                "SELECT count(*) cnt FROM badge_user_badge " .
                " WHERE user_id = %s AND tstamp >= %s",
                ["integer", "integer"],
                [$a_user_id, $last]
            );
            $rec = $db->fetchAssoc($set);
            return (int) $rec["cnt"];
        }
        return 0;
    }

◆ getPosition()

ilBadgeAssignment::getPosition ( )

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

                                 : ?int
    {
        return $this->pos;
    }

◆ getPropertiesForStorage()

ilBadgeAssignment::getPropertiesForStorage ( )

protected

Returns: array<string, array>

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

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

◆ getTimestamp()

ilBadgeAssignment::getTimestamp ( )

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

                                  : int
    {
        return $this->tstamp;
    }

◆ getUserId()

ilBadgeAssignment::getUserId ( )

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

                               : int
    {
        return $this->user_id;
    }

Referenced by ilBadgeHandler\getInstancePath().

Here is the caller graph for this function:

◆ importDBRow()

ilBadgeAssignment::importDBRow ( array $a_row )

protected

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

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

◆ read()

ilBadgeAssignment::read	(	int	$a_badge_id,
		int	$a_user_id
	)

protected

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

     : void {
        $ilDB = $this->db;
 
        $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 && $row["user_id"]) {
            $this->importDBRow($row);
        }
    }

Referenced by __construct().

Here is the caller graph for this function:

◆ setAwardedBy()

ilBadgeAssignment::setAwardedBy ( int $a_id )

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

                                           : void
    {
        $this->awarded_by = $a_id;
    }

◆ setBadgeId()

ilBadgeAssignment::setBadgeId ( int $a_value )

protected

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

                                               : void
    {
        $this->badge_id = $a_value;
    }

Referenced by __construct().

Here is the caller graph for this function:

◆ setPosition()

ilBadgeAssignment::setPosition ( ?int $a_value )

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

                                              : void
    {
        $this->pos = $a_value;
    }

◆ setTimestamp()

ilBadgeAssignment::setTimestamp ( int $a_value )

protected

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

                                                 : void
    {
        $this->tstamp = $a_value;
    }

◆ setUserId()

ilBadgeAssignment::setUserId ( int $a_value )

protected

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

                                              : void
    {
        $this->user_id = $a_value;
    }

Referenced by __construct().

Here is the caller graph for this function:

◆ store()

ilBadgeAssignment::store ( )

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

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

References $ilDB, and $keys.

◆ updatePositions()

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

static

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

     : void {
        $existing = array();
        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]);
                }
            }
        }
    }

Referenced by ilPersonalProfileGUI\savePublicProfile().

Here is the caller graph for this function:

Field Documentation

◆ $awarded_by

int ilBadgeAssignment::$awarded_by = 0

protected

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

◆ $badge_id

int ilBadgeAssignment::$badge_id = 0

protected

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

◆ $db

ilDBInterface ilBadgeAssignment::$db

protected

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

◆ $pos

int ilBadgeAssignment::$pos = null

protected

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

◆ $stored

bool ilBadgeAssignment::$stored = false

protected

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

◆ $tstamp

int ilBadgeAssignment::$tstamp = 0

protected

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

◆ $user_id

int ilBadgeAssignment::$user_id = 0

protected

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

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

◆ clearBadgeCache()

◆ delete()

◆ deleteByBadgeId()

◆ deleteByParentId()

◆ deleteByUserId()

◆ deleteStaticFiles()

◆ exists()

◆ getAssignedUsers()

◆ getAwardedBy()

◆ getBadgeId()

◆ getBadgesForUser()

◆ getInstancesByBadgeId()

◆ getInstancesByParentId()

◆ getInstancesByUserId()

◆ getLatestTimestamp()

◆ getNewCounter()

◆ getPosition()

◆ getPropertiesForStorage()

◆ getTimestamp()

◆ getUserId()

◆ importDBRow()

◆ read()

◆ setAwardedBy()

◆ setBadgeId()

◆ setPosition()

◆ setTimestamp()

◆ setUserId()

◆ store()

◆ updatePositions()

Field Documentation

◆ $awarded_by

◆ $badge_id

◆ $db

◆ $pos

◆ $stored

◆ $tstamp

◆ $user_id