Collaboration diagram for ilBadge:

Public Member Functions
	__construct (int $a_id=null)

	clone (int $target_parent_obj_id)

	getTypeInstance ()

	copy (int $a_new_parent_id)

	getId ()

	setParentId (int $a_id)

	getParentId ()

	setTypeId (string $a_id)

	getTypeId ()

	setActive (bool $a_value)

	isActive ()

	setTitle (string $a_value)

	getTitle ()

	setDescription (string $a_value)

	getDescription ()

	setCriteria (string $a_value)

	getCriteria ()

	setValid (string $a_value)

	getValid ()

	setConfiguration (array $a_value=null)

	getConfiguration ()

	getImage ()

	uploadImage (array $a_upload_meta)

	importImage (string $a_name, string $a_file)

	getImagePath (bool $a_full_path=true)

	create ()

	update ()

	delete ()

	getParentMeta ()

	deleteStaticFiles ()

Static Public Member Functions
static	getInstancesByParentId (int $a_parent_id, array $a_filter=null)

static	getInstancesByType (string $a_type_id)

static	getObjectInstances (array $a_filter=null)

static	getExtendedTypeCaption (ilBadgeType $a_type)

Protected Member Functions
	setId (int $a_id)

	setImage (string $a_value)

	getFilePath (int $a_id, string $a_subdir=null)

	read (int $a_id)

	importDBRow (array $a_row)

	getPropertiesForStorage ()

	prepareJson (string $a_base_url, string $a_img_suffix)

Protected Attributes
ilLanguage	$lng

ilDBInterface	$db

int	$id = 0

int	$parent_id = 0

string	$type_id = ""

bool	$active = false

string	$title = ""

string	$desc = ""

string	$image = ""

string	$valid = ""

array	$config = null

string	$criteria = ""

Detailed Description

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.ilBadge.php.

Constructor & Destructor Documentation

◆ __construct()

ilBadge::__construct ( int $a_id = null )

Definition at line 40 of file class.ilBadge.php.

      {
        global $DIC;
 
        $this->lng = $DIC->language();
        $this->db = $DIC->database();
        if ($a_id) {
            $this->read($a_id);
        }
    }

References $DIC, ILIAS\Repository\lng(), and read().

Here is the call graph for this function:

Member Function Documentation

◆ clone()

ilBadge::clone ( int $target_parent_obj_id )

Definition at line 115 of file class.ilBadge.php.

                                                    : void
    {
        $this->setParentId($target_parent_obj_id);
        $this->setActive(false);
 
        if ($this->getId()) {
            $img = $this->getImagePath();
 
            $this->setId(0);
            $this->create();
 
            if ($img) {
                // see uploadImage()
                copy($img, $this->getImagePath());
            }
        }
    }

References $img, and ILIAS\Survey\Mode\getId().

Here is the call graph for this function:

◆ copy()

ilBadge::copy ( int $a_new_parent_id )

Definition at line 142 of file class.ilBadge.php.

     : void {
        $lng = $this->lng;
 
        $this->setTitle($this->getTitle() . " " . $lng->txt("copy_of_suffix"));
        $this->setParentId($a_new_parent_id);
        $this->setActive(false);
 
        if ($this->getId()) {
            $img = $this->getImagePath();
 
            $this->setId(0);
            $this->create();
 
            if ($img) {
                // see uploadImage()
                copy($img, $this->getImagePath());
            }
        }
    }

◆ create()

ilBadge::create ( )

Definition at line 431 of file class.ilBadge.php.

                            : void
    {
        $ilDB = $this->db;
 
        if ($this->getId()) {
            $this->update();
            return;
        }
 
        $id = $ilDB->nextId("badge_badge");
        $this->setId($id);
 
        $fields = $this->getPropertiesForStorage();
 
        $fields["id"] = ["integer", $id];
        $fields["parent_id"] = ["integer", $this->getParentId()];
        $fields["type_id"] = ["text", $this->getTypeId()];
 
        $ilDB->insert("badge_badge", $fields);
    }

References $id, $ilDB, and ILIAS\Survey\Mode\getId().

Here is the call graph for this function:

◆ delete()

ilBadge::delete ( )

Definition at line 470 of file class.ilBadge.php.

                            : void
    {
        $ilDB = $this->db;
 
        if (!$this->getId()) {
            return;
        }
 
        if (file_exists($this->getImagePath())) {
            unlink($this->getImagePath());
        }
 
        $this->deleteStaticFiles();
 
        ilBadgeAssignment::deleteByBadgeId($this->getId());
 
        $ilDB->manipulate("DELETE FROM badge_badge" .
            " WHERE id = " . $ilDB->quote($this->getId(), "integer"));
    }

References $ilDB, ilBadgeAssignment\deleteByBadgeId(), and ILIAS\Survey\Mode\getId().

Here is the call graph for this function:

◆ deleteStaticFiles()

ilBadge::deleteStaticFiles ( )

Definition at line 564 of file class.ilBadge.php.

                                       : void
    {
        // remove instance files
        $path = ilBadgeHandler::getInstance()->getBadgePath($this);
        if (is_dir($path)) {
            ilFileUtils::delDir($path);
        }
    }

References $path, ilFileUtils\delDir(), and ilBadgeHandler\getInstance().

Here is the call graph for this function:

◆ getConfiguration()

ilBadge::getConfiguration ( )

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

                                      : ?array
    {
        return $this->config;
    }

References $config.

Referenced by ilBadgeManagementGUI\setBadgeFormValues().

Here is the caller graph for this function:

◆ getCriteria()

ilBadge::getCriteria ( )

Definition at line 285 of file class.ilBadge.php.

                                 : string
    {
        return $this->criteria;
    }

◆ getDescription()

ilBadge::getDescription ( )

Definition at line 275 of file class.ilBadge.php.

                                    : string
    {
        return $this->desc;
    }

◆ getExtendedTypeCaption()

static ilBadge::getExtendedTypeCaption ( ilBadgeType $a_type )

static

Definition at line 573 of file class.ilBadge.php.

     : string {
        global $DIC;
 
        $lng = $DIC->language();
 
        return $a_type->getCaption() . " (" .
            ($a_type instanceof ilBadgeAuto
                ? $lng->txt("badge_subtype_auto")
                : $lng->txt("badge_subtype_manual")) . ")";
    }

Referenced by ilObjectBadgeTableGUI\getItems(), ilBadgeTableGUI\getItems(), ilBadgeTableGUI\initFilter(), ilObjectBadgeTableGUI\initFilter(), and ilBadgeManagementGUI\listBadges().

Here is the caller graph for this function:

◆ getFilePath()

ilBadge::getFilePath	(	int	$a_id,
		string	$a_subdir = `null`
	)

protected

Definition at line 377 of file class.ilBadge.php.

     : string {
        $storage = new ilFSStorageBadge($a_id);
        $storage->create();
 
        $path = $storage->getAbsolutePath() . "/";
 
        if ($a_subdir) {
            $path .= $a_subdir . "/";
 
            if (!is_dir($path)) {
                mkdir($path);
            }
        }
 
        return $path;
    }

References $path.

◆ getId()

ilBadge::getId ( )

Definition at line 225 of file class.ilBadge.php.

                           : int
    {
        return $this->id;
    }

References $id.

Referenced by ilBadgeHandler\countStaticBadgeInstances(), and ilBadgeHandler\getBadgePath().

Here is the caller graph for this function:

◆ getImage()

ilBadge::getImage ( )

Definition at line 318 of file class.ilBadge.php.

                              : string
    {
        return $this->image;
    }

◆ getImagePath()

ilBadge::getImagePath ( bool $a_full_path = true )

Definition at line 362 of file class.ilBadge.php.

     : string {
        if ($this->getId()) {
            $exp = explode(".", $this->getImage());
            $suffix = strtolower(array_pop($exp));
            if ($a_full_path) {
                return $this->getFilePath($this->getId()) . "img" . $this->getId() . "." . $suffix;
            }
 
            return "img" . $this->getId() . "." . $suffix;
        }
        return "";
    }

References ILIAS\Survey\Mode\getId().

Here is the call graph for this function:

◆ getInstancesByParentId()

static ilBadge::getInstancesByParentId	(	int	$a_parent_id,
		array	$a_filter = `null`
	)

static

Parameters

int	$a_parent_id
array \| null	$a_filter

Returns: self[]

Definition at line 57 of file class.ilBadge.php.

     : array {
        global $DIC;
 
        $ilDB = $DIC->database();
 
        $res = [];
 
        $sql = "SELECT * FROM badge_badge" .
            " WHERE parent_id = " . $ilDB->quote($a_parent_id);
 
        if ($a_filter) {
            if ($a_filter["title"] ?? false) {
                $sql .= " AND " . $ilDB->like("title", "text", "%" . trim($a_filter["title"]) . "%");
            }
            if ($a_filter["type"] ?? false) {
                $sql .= " AND type_id = " . $ilDB->quote($a_filter["type"], "integer");
            }
        }
 
        $set = $ilDB->query($sql .
            " ORDER BY title");
        while ($row = $ilDB->fetchAssoc($set)) {
            $obj = new self();
            $obj->importDBRow($row);
            $res[] = $obj;
        }
 
        return $res;
    }

References $ilDB.

Referenced by ilObjCourse\cloneObject(), and ilBadgeTableGUI\getItems().

Here is the caller graph for this function:

◆ getInstancesByType()

static ilBadge::getInstancesByType ( string $a_type_id )

static

Parameters

string $a_type_id

Returns: self[]

Definition at line 94 of file class.ilBadge.php.

     : array {
        global $DIC;
 
        $ilDB = $DIC->database();
 
        $res = [];
 
        $set = $ilDB->query("SELECT * FROM badge_badge" .
            " WHERE type_id = " . $ilDB->quote($a_type_id, "text") .
            " ORDER BY title");
        while ($row = $ilDB->fetchAssoc($set)) {
            $obj = new self();
            $obj->importDBRow($row);
            $res[] = $obj;
        }
 
        return $res;
    }

References $res.

◆ getObjectInstances()

static ilBadge::getObjectInstances ( array $a_filter = null )

static

Parameters

array<string,mixed>|null $a_filter

Returns: array[]

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

     : array {
        global $DIC;
 
        $ilDB = $DIC->database();
 
        $res = $raw = [];
 
        $where = "";
 
        if ($a_filter["type"]) {
            $where .= " AND bb.type_id = " . $ilDB->quote($a_filter["type"], "text");
        }
        if ($a_filter["title"]) {
            $where .= " AND " . $ilDB->like("bb.title", "text", "%" . $a_filter["title"] . "%");
        }
        if ($a_filter["object"]) {
            $where .= " AND " . $ilDB->like("od.title", "text", "%" . $a_filter["object"] . "%");
        }
 
        $set = $ilDB->query("SELECT bb.*, od.title parent_title, od.type parent_type" .
            " FROM badge_badge bb" .
            " JOIN object_data od ON (bb.parent_id = od.obj_id)" .
            " WHERE od.type <> " . $ilDB->quote("bdga", "text") .
            $where);
        while ($row = $ilDB->fetchAssoc($set)) {
            $raw[] = $row;
        }
 
        $set = $ilDB->query("SELECT bb.*, od.title parent_title, od.type parent_type" .
            " FROM badge_badge bb" .
            " JOIN object_data_del od ON (bb.parent_id = od.obj_id)" .
            " WHERE od.type <> " . $ilDB->quote("bdga", "text") .
            $where);
        while ($row = $ilDB->fetchAssoc($set)) {
            $row["deleted"] = true;
            $raw[] = $row;
        }
 
        foreach ($raw as $row) {
            $res[] = $row;
        }
 
        return $res;
    }

References $ilDB.

Referenced by ilObjectBadgeTableGUI\getItems().

Here is the caller graph for this function:

◆ getParentId()

ilBadge::getParentId ( )

Definition at line 235 of file class.ilBadge.php.

                                 : int
    {
        return $this->parent_id;
    }

◆ getParentMeta()

ilBadge::getParentMeta ( )

Returns: array{id: int, type: string, title: string, deleted: bool}

Definition at line 516 of file class.ilBadge.php.

                                   : array
    {
        $parent_type = ilObject::_lookupType($this->getParentId());
        $parent_title = "";
        if ($parent_type) {
            $parent_title = ilObject::_lookupTitle($this->getParentId());
            $deleted = false;
        } else {
            // already deleted?
            $parent = ilObjectDataDeletionLog::get($this->getParentId());
            if ($parent["type"]) {
                $parent_type = $parent["type"];
                $parent_title = $parent["title"];
            }
            $deleted = true;
        }
 
        return [
            "id" => $this->getParentId(),
            "type" => $parent_type,
            "title" => $parent_title,
            "deleted" => $deleted
        ];
    }

References ilObject\_lookupTitle(), ilObject\_lookupType(), and ilObjectDataDeletionLog\get().

Here is the call graph for this function:

◆ getPropertiesForStorage()

ilBadge::getPropertiesForStorage ( )

protected

Returns: array<string, array>

Definition at line 493 of file class.ilBadge.php.

                                                : array
    {
        return [
            "active" => ["integer", $this->isActive()],
            "title" => ["text", $this->getTitle()],
            "descr" => ["text", $this->getDescription()],
            "crit" => ["text", $this->getCriteria()],
            "image" => ["text", $this->getImage()],
            "valid" => ["text", $this->getValid()],
            "conf" => [
                "text", $this->getConfiguration() ? serialize($this->getConfiguration()) : null
            ]
        ];
    }

◆ getTitle()

ilBadge::getTitle ( )

Definition at line 265 of file class.ilBadge.php.

                              : string
    {
        return $this->title;
    }

◆ getTypeId()

ilBadge::getTypeId ( )

Definition at line 245 of file class.ilBadge.php.

                               : string
    {
        return $this->type_id;
    }

◆ getTypeInstance()

ilBadge::getTypeInstance ( )

Definition at line 133 of file class.ilBadge.php.

                                     : ?ilBadgeType
    {
        if ($this->getTypeId()) {
            $handler = ilBadgeHandler::getInstance();
            return $handler->getTypeInstanceByUniqueId($this->getTypeId());
        }
        return null;
    }

References ilBadgeHandler\getInstance().

Here is the call graph for this function:

◆ getValid()

ilBadge::getValid ( )

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

                              : string
    {
        return $this->valid;
    }

References $valid.

◆ importDBRow()

ilBadge::importDBRow ( array $a_row )

protected

Definition at line 414 of file class.ilBadge.php.

     : void {
        $this->setId($a_row["id"]);
        $this->setParentId($a_row["parent_id"]);
        $this->setTypeId($a_row["type_id"]);
        $this->setActive($a_row["active"]);
        $this->setTitle($a_row["title"]);
        $this->setDescription($a_row["descr"]);
        $this->setCriteria($a_row["crit"]);
        $this->setImage($a_row["image"]);
        $this->setValid($a_row["valid"]);
        $this->setConfiguration($a_row["conf"]
                ? unserialize($a_row["conf"], ["allowed_classes" => false])
                : null);
    }

◆ importImage()

ilBadge::importImage	(	string	$a_name,
		string	$a_file
	)

Exceptions

BadgeException

Definition at line 348 of file class.ilBadge.php.

     : void {
        if (file_exists($a_file)) {
            $this->setImage($a_name);
            copy($a_file, $this->getImagePath()); // #18280
 
            $this->update();
        } else {
            throw BadgeException::uploadedBadgeImageFileNotFound($this);
        }
    }

◆ isActive()

ilBadge::isActive ( )

Definition at line 255 of file class.ilBadge.php.

                              : bool
    {
        return $this->active;
    }

◆ prepareJson()

ilBadge::prepareJson	(	string	$a_base_url,
		string	$a_img_suffix
	)

protected

Definition at line 546 of file class.ilBadge.php.

     : stdClass {
        $json = new stdClass();
        $json->{"@context"} = "https://w3id.org/openbadges/v1";
        $json->type = "BadgeClass";
        $json->id = $a_base_url . "class.json";
        $json->name = $this->getTitle();
        $json->description = $this->getDescription();
        $json->image = $a_base_url . "image." . $a_img_suffix;
        $json->criteria = $a_base_url . "criteria.txt";
        $json->issuer = ilBadgeHandler::getInstance()->getIssuerStaticUrl();
 
        return $json;
    }

◆ read()

ilBadge::read ( int $a_id )

protected

Definition at line 402 of file class.ilBadge.php.

                                      : void
    {
        $ilDB = $this->db;
 
        $set = $ilDB->query("SELECT * FROM badge_badge" .
            " WHERE id = " . $ilDB->quote($a_id, "integer"));
        if ($ilDB->numRows($set)) {
            $row = $ilDB->fetchAssoc($set);
            $this->importDBRow($row);
        }
    }

References $ilDB.

Referenced by __construct().

Here is the caller graph for this function:

◆ setActive()

ilBadge::setActive ( bool $a_value )

Definition at line 250 of file class.ilBadge.php.

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

◆ setConfiguration()

ilBadge::setConfiguration ( array $a_value = null )

Definition at line 300 of file class.ilBadge.php.

                                                           : void
    {
        if (is_array($a_value) && !count($a_value)) {
            $a_value = null;
        }
        $this->config = $a_value;
    }

◆ setCriteria()

ilBadge::setCriteria ( string $a_value )

Definition at line 280 of file class.ilBadge.php.

                                                : void
    {
        $this->criteria = trim($a_value);
    }

◆ setDescription()

ilBadge::setDescription ( string $a_value )

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

                                                   : void
    {
        $this->desc = trim($a_value);
    }

◆ setId()

ilBadge::setId ( int $a_id )

protected

Definition at line 220 of file class.ilBadge.php.

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

◆ setImage()

ilBadge::setImage ( string $a_value )

protected

Definition at line 313 of file class.ilBadge.php.

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

◆ setParentId()

ilBadge::setParentId ( int $a_id )

Definition at line 230 of file class.ilBadge.php.

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

◆ setTitle()

ilBadge::setTitle ( string $a_value )

Definition at line 260 of file class.ilBadge.php.

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

◆ setTypeId()

ilBadge::setTypeId ( string $a_id )

Definition at line 240 of file class.ilBadge.php.

                                           : void
    {
        $this->type_id = trim($a_id);
    }

◆ setValid()

ilBadge::setValid ( string $a_value )

Definition at line 290 of file class.ilBadge.php.

                                             : void
    {
        $this->valid = trim($a_value);
    }

◆ update()

ilBadge::update ( )

Definition at line 452 of file class.ilBadge.php.

                            : void
    {
        $ilDB = $this->db;
 
        if (!$this->getId()) {
            $this->create();
            return;
        }
 
        $fields = $this->getPropertiesForStorage();
 
        $ilDB->update(
            "badge_badge",
            $fields,
            ["id" => ["integer", $this->getId()]]
        );
    }

References $ilDB, and ILIAS\Survey\Mode\getId().

Here is the call graph for this function:

◆ uploadImage()

ilBadge::uploadImage ( array $a_upload_meta )

Exceptions

BadgeException

Definition at line 326 of file class.ilBadge.php.

     : void {
        if ($this->getId() &&
            $a_upload_meta["tmp_name"]) {
            $this->setImage($a_upload_meta["name"]);
            $path = $this->getImagePath();
 
            try {
                if (ilFileUtils::moveUploadedFile($a_upload_meta['tmp_name'], $this->getImagePath(false), $path)) {
                    $this->update();
                }
            } catch (ilException $e) {
                throw BadgeException::moveUploadedBadgeImageFailed($this, $e);
            }
 
        }
    }

References Vendor\Package\$e, $path, and ilFileUtils\moveUploadedFile().

Here is the call graph for this function:

Field Documentation

◆ $active

bool ilBadge::$active = false

protected

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

◆ $config

array ilBadge::$config = null

protected

Definition at line 37 of file class.ilBadge.php.

◆ $criteria

string ilBadge::$criteria = ""

protected

Definition at line 38 of file class.ilBadge.php.

◆ $db

ilDBInterface ilBadge::$db

protected

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

◆ $desc

string ilBadge::$desc = ""

protected

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

◆ $id

int ilBadge::$id = 0

protected

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

◆ $image

string ilBadge::$image = ""

protected

Definition at line 35 of file class.ilBadge.php.

◆ $lng

ilLanguage ilBadge::$lng

protected

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

◆ $parent_id

int ilBadge::$parent_id = 0

protected

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

◆ $title

string ilBadge::$title = ""

protected

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

◆ $type_id

string ilBadge::$type_id = ""

protected

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

◆ $valid

string ilBadge::$valid = ""

protected

Definition at line 36 of file class.ilBadge.php.

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

Services/Badge/classes/class.ilBadge.php

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ clone()

◆ copy()

◆ create()

◆ delete()

◆ deleteStaticFiles()

◆ getConfiguration()

◆ getCriteria()

◆ getDescription()

◆ getExtendedTypeCaption()

◆ getFilePath()

◆ getId()

◆ getImage()

◆ getImagePath()

◆ getInstancesByParentId()

◆ getInstancesByType()

◆ getObjectInstances()

◆ getParentId()

◆ getParentMeta()

◆ getPropertiesForStorage()

◆ getTitle()

◆ getTypeId()

◆ getTypeInstance()

◆ getValid()

◆ importDBRow()

◆ importImage()

◆ isActive()

◆ prepareJson()

◆ read()

◆ setActive()

◆ setConfiguration()

◆ setCriteria()

◆ setDescription()

◆ setId()

◆ setImage()

◆ setParentId()

◆ setTitle()

◆ setTypeId()

◆ setValid()

◆ update()

◆ uploadImage()

Field Documentation

◆ $active

◆ $config

◆ $criteria

◆ $db

◆ $desc

◆ $id

◆ $image

◆ $lng

◆ $parent_id

◆ $title

◆ $type_id

◆ $valid