ilBadge Class Reference

Collaboration diagram for ilBadge:

Public Member Functions
	__construct (int $a_id=null, Container $container=null)
	clone (int $target_parent_obj_id)
	getTypeInstance ()
	copy (int $a_new_parent_id, string $copy_suffix)
	setId (int $a_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 ()
	setImage (?string $a_value)
	getImage ()
	uploadImage (array $a_upload_meta)
	importImage (string $a_name, string $a_file)
	getImagePath (bool $a_full_path=true)
	create ()
	update ()
	delete ()
	getParentMeta ()
	deleteStaticFiles ()
	getImageRid ()
	setImageRid (?string $image_rid)

Static Public Member Functions
static	getInstancesByParentId (int $a_parent_id, array $a_filter=null)
static	getInstancesByType (string $a_type_id)
static	getObjectInstances (?array $filter=null)
static	getExtendedTypeCaption (ilBadgeType $a_type)

Protected Member Functions
	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
ilDBInterface	$db
int	$id = 0
int	$parent_id = 0
string	$type_id = ""
bool	$active = false
string	$title = ""
string	$desc = ""
string	$image = ""
string	$image_rid = null
string	$valid = ""
array	$config = null
string	$criteria = ""

Private Attributes
ilLogger	$log
Services	$resource_storage

Detailed Description

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

Constructor & Destructor Documentation

__construct()

ilBadge::__construct	(	int	$a_id = null,
		Container	$container = null
	)

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

References $container, $DIC, and read().

      {

        if ($container === null) {
            global $DIC;
            $container = $DIC;
        }

        $this->db = $container->database();
        $this->resource_storage = $container->resourceStorage();
        $this->log = $container->logger()->root();
        if ($a_id) {
            $this->read($a_id);
        }
    }

Here is the call graph for this function:

Member Function Documentation

clone()

ilBadge::clone

(

int

$target_parent_obj_id

)

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

References create(), getId(), getImageRid(), setActive(), setId(), setImageRid(), and setParentId().

                                                    : void
    {
        $this->setParentId($target_parent_obj_id);
        $this->setActive(false);

        if ($this->getId()) {
            if ($this->getImageRid()) {
                $current_collection_id = new ResourceIdentification($this->getImageRid());
                $new_collection_id = $this->resource_storage->manage()->clone($current_collection_id);
                $this->setId(0);
                $this->setImageRid($new_collection_id);
                $this->create();
            } else {
                $this->log->warning('Please run the "Migration of files of badges to the resource storage service" job, before working with badges.');
            }
        }
    }

Here is the call graph for this function:

copy()

ilBadge::copy	(	int	$a_new_parent_id,
		string	$copy_suffix
	)

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

References create(), getId(), getImageRid(), getTitle(), setActive(), setId(), setImageRid(), setParentId(), setTitle(), and update().

Referenced by importImage().

     : void {
        $this->setTitle($this->getTitle() . " " . $copy_suffix);
        $this->setParentId($a_new_parent_id);
        $this->setActive(false);

        if ($this->getId()) {
            $this->setId(0);
            $old_rid = $this->getImageRid();
            $this->create();
            if ($old_rid !== null) {
                $new_rid = $this->resource_storage->manage()->clone(new ResourceIdentification($old_rid));
                $this->setImageRid($new_rid);
                $this->update();
            }
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

create()

ilBadge::create

(

)

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

References $db, $id, $ilDB, getId(), getParentId(), getPropertiesForStorage(), getTypeId(), setId(), and update().

Referenced by clone(), copy(), and update().

                            : 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);
    }

Here is the call graph for this function:

Here is the caller graph for this function:

delete()

ilBadge::delete

(

)

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

References $db, Vendor\Package\$e, $ilDB, ilBadgeAssignment\deleteByBadgeId(), deleteStaticFiles(), getId(), and getImageRid().

                            : void
    {
        $ilDB = $this->db;

        if (!$this->getId()) {
            return;
        }

        if ($this->getImageRid()) {
            try {
                $this->resource_storage->manage()->remove(new ResourceIdentification($this->getImageRid()), new ilBadgeFileStakeholder());
            } catch (Exception $e) {
                $this->log->warning(sprintf('There was an exception, while deleting the badge with id %s. Exception: %s', $this->getId(), $e->getMessage()));
            }
        }

        $this->deleteStaticFiles();

        ilBadgeAssignment::deleteByBadgeId($this->getId());

        $ilDB->manipulate("DELETE FROM badge_badge" .
            " WHERE id = " . $ilDB->quote($this->getId(), "integer"));
    }

Here is the call graph for this function:

deleteStaticFiles()

ilBadge::deleteStaticFiles

(

)

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

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

Referenced by delete().

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

Here is the call graph for this function:

Here is the caller graph for this function:

getConfiguration()

ilBadge::getConfiguration

(

)

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

References $config.

Referenced by getPropertiesForStorage(), and ilBadgeManagementGUI\setBadgeFormValues().

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

Here is the caller graph for this function:

getCriteria()

ilBadge::getCriteria

(

)

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

References $criteria.

Referenced by getPropertiesForStorage(), ILIAS\Badge\Tile\modalContent(), and ilBadgeManagementGUI\setBadgeFormValues().

                                 : string
    {
        return $this->criteria;
    }

Here is the caller graph for this function:

getDescription()

ilBadge::getDescription

(

)

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

References $desc.

Referenced by getPropertiesForStorage(), prepareJson(), and ilBadgeManagementGUI\setBadgeFormValues().

                                    : string
    {
        return $this->desc;
    }

Here is the caller graph for this function:

getExtendedTypeCaption()

static ilBadge::getExtendedTypeCaption ( ilBadgeType  $a_type )

static

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

References $DIC, $lng, and ilBadgeType\getCaption().

Referenced by ILIAS\Badge\ilBadgeUserTableGUI\__construct(), ILIAS\Badge\ilBadgeTableGUI\getRecords(), ILIAS\Badge\ilObjectBadgeTableGUI\getRecords(), and ilBadgeManagementGUI\listBadges().

     : string {
        global $DIC;

        $lng = $DIC->language();

        return $a_type->getCaption() . " (" .
            ($a_type instanceof ilBadgeAuto
                ? $lng->txt("badge_subtype_auto")
                : $lng->txt("badge_subtype_manual")) . ")";
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getFilePath()

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

protected

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

References $path.

Referenced by getImagePath().

     : 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;
    }

Here is the caller graph for this function:

getId()

ilBadge::getId

(

)

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

References $id.

Referenced by clone(), copy(), ilBadgeHandler\countStaticBadgeInstances(), create(), delete(), ilBadgeHandler\getBadgePath(), getImagePath(), ILIAS\Badge\Tile\profileButton(), update(), and uploadImage().

                           : int
    {
        return $this->id;
    }

Here is the caller graph for this function:

getImage()

ilBadge::getImage

(

)

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

References $image.

Referenced by ILIAS\Badge\ilBadgeImage\getImageFromResourceId(), getImagePath(), getPropertiesForStorage(), and ilBadgeManagementGUI\setBadgeFormValues().

                              : string
    {
        return $this->image;
    }

Here is the caller graph for this function:

getImagePath()

ilBadge::getImagePath

(

bool

$a_full_path = true

)

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

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

Referenced by ILIAS\Badge\ilBadgeImage\getImageFromResourceId(), importImage(), ilBadgeManagementGUI\setBadgeFormValues(), and uploadImage().

     : 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 "";
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getImageRid()

ilBadge::getImageRid

(

)

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

References $image_rid.

Referenced by clone(), copy(), delete(), ILIAS\Badge\ilBadgeImage\getImageFromResourceId(), getPropertiesForStorage(), and ilBadgeManagementGUI\removeResourceStorageImage().

                                 : ?string
    {
        return $this->image_rid;
    }

Here is the caller graph for this function:

getInstancesByParentId()

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

static

Parameters

array | null

$a_filter

Returns

self[]

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

References $DIC, $ilDB, and $res.

Referenced by ILIAS\Badge\ilBadgeUserTableGUI\__construct(), ilObjCourse\cloneObject(), ilBadgeManagementGUI\confirmDeleteBadges(), ilBadgeHandler\getAvailableManualBadges(), ilBadgeAssignment\getInstancesByParentId(), ILIAS\Badge\ilBadgeTableGUI\getRecords(), and ilBadgeManagementGUI\toggleBadges().

     : 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;
    }

Here is the caller graph for this function:

getInstancesByType()

static ilBadge::getInstancesByType ( string  $a_type_id )

static

Returns

self[]

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

References $DIC, $ilDB, and $res.

Referenced by ilBadgeHandler\triggerEvaluation().

     : 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;
    }

Here is the caller graph for this function:

getObjectInstances()

static ilBadge::getObjectInstances ( ?array  $filter = null )

static

Parameters

array{type

string, title: string, object: string}|null $filter

Returns

list<array{ id: int, parent_id: int, type_id: string, active: int, title: ?string, descr: ?string, conf: ?string, image: ?string, valid: ?string, crit: ?string, image_rid: ?string, parent_title: ?string, parent_type: ?string, deleted: bool }>

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

References $DIC, $ilDB, and ilDBConstants\T_TEXT.

Referenced by ilObjBadgeAdministrationGUI\confirmDeleteObjectBadges(), ILIAS\Badge\ilObjectBadgeTableGUI\getRecords(), ILIAS\Badge\ilObjectBadgeTableGUI\renderTable(), and ilObjBadgeAdministrationGUI\toggleObjectBadges().

     : array {
        global $DIC;

        $ilDB = $DIC->database();

        $rows = [];

        $where = '';

        if ($filter['type']) {
            $where .= ' AND bb.type_id = ' . $ilDB->quote($filter['type'], ilDBConstants::T_TEXT);
        }
        if ($filter['title']) {
            $where .= ' AND ' . $ilDB->like('bb.title', ilDBConstants::T_TEXT, '%' . $filter['title'] . '%');
        }
        if ($filter['object']) {
            $where .= ' AND ' . $ilDB->like('od.title', ilDBConstants::T_TEXT, '%' . $filter['object'] . '%');
        }

        $set = $ilDB->query('SELECT bb.*, od.title parent_title, od.type parent_type' .
            ' FROM badge_badge bb' .
            ' INNER JOIN object_data od ON bb.parent_id = od.obj_id' .
            ' WHERE od.type != ' . $ilDB->quote('bdga', ilDBConstants::T_TEXT) .
            $where);
        while ($row = $ilDB->fetchAssoc($set)) {
            $row['deleted'] = false;
            $rows[] = $row;
        }

        $set = $ilDB->query('SELECT bb.*, od.title parent_title, od.type parent_type' .
            ' FROM badge_badge bb' .
            ' INNER JOIN object_data_del od ON bb.parent_id = od.obj_id' .
            ' WHERE od.type != ' . $ilDB->quote('bdga', ilDBConstants::T_TEXT) .
            $where);
        while ($row = $ilDB->fetchAssoc($set)) {
            $row['deleted'] = true;
            $rows[] = $row;
        }

        return $rows;
    }

Here is the caller graph for this function:

getParentId()

ilBadge::getParentId

(

)

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

References $parent_id.

Referenced by create(), getParentMeta(), and ILIAS\Badge\BadgeParent\metaData().

                                 : int
    {
        return $this->parent_id;
    }

Here is the caller graph for this function:

getParentMeta()

ilBadge::getParentMeta

(

)

Returns

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

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

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

Referenced by ilBadgePersonalTableGUI\getRecords(), and ILIAS\Badge\BadgeParent\metaData().

                                   : 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
        ];
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getPropertiesForStorage()

ilBadge::getPropertiesForStorage ( )

protected

Returns

array<string, array>

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

References getConfiguration(), getCriteria(), getDescription(), getImage(), getImageRid(), getTitle(), getValid(), and isActive().

Referenced by create(), and update().

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

Here is the call graph for this function:

Here is the caller graph for this function:

getTitle()

ilBadge::getTitle

(

)

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

References $title.

Referenced by copy(), getPropertiesForStorage(), ILIAS\Badge\Tile\image(), prepareJson(), ilBadgeManagementGUI\setBadgeFormValues(), and ILIAS\Badge\Tile\title().

                              : string
    {
        return $this->title;
    }

Here is the caller graph for this function:

getTypeId()

ilBadge::getTypeId

(

)

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

References $type_id.

Referenced by create(), ilBadgeManagementGUI\executeCommand(), and getTypeInstance().

                               : string
    {
        return $this->type_id;
    }

Here is the caller graph for this function:

getTypeInstance()

ilBadge::getTypeInstance

(

)

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

References $handler, ilBadgeHandler\getInstance(), and getTypeId().

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

Here is the call graph for this function:

getValid()

ilBadge::getValid

(

)

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

References $valid.

Referenced by getPropertiesForStorage(), ILIAS\Badge\Tile\modalContent(), and ilBadgeManagementGUI\setBadgeFormValues().

                              : string
    {
        return $this->valid;
    }

Here is the caller graph for this function:

importDBRow()

ilBadge::importDBRow ( array  $a_row )

protected

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

References setActive(), setConfiguration(), setCriteria(), setDescription(), setId(), setImage(), setImageRid(), setParentId(), setTitle(), setTypeId(), and setValid().

Referenced by read().

     : 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->setImageRid($a_row["image_rid"]);
        $this->setValid($a_row["valid"]);
        $this->setConfiguration($a_row["conf"]
            ? unserialize($a_row["conf"], ["allowed_classes" => false])
            : null);
    }

Here is the call graph for this function:

Here is the caller graph for this function:

importImage()

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

Exceptions

BadgeException

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

References copy(), getImagePath(), setImage(), and update().

     : void {
        if (file_exists($a_file)) {
            $this->setImage($a_name);
            copy($a_file, $this->getImagePath()); // #18280

            $this->update();
        } else {
            throw BadgeException::uploadedBadgeImageFileNotFound($this);
        }
    }

Here is the call graph for this function:

isActive()

ilBadge::isActive

(

)

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

References $active.

Referenced by getPropertiesForStorage(), and ilBadgeManagementGUI\setBadgeFormValues().

                              : bool
    {
        return $this->active;
    }

Here is the caller graph for this function:

prepareJson()

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

protected

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

References getDescription(), ilBadgeHandler\getInstance(), and getTitle().

     : 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;
    }

Here is the call graph for this function:

read()

ilBadge::read ( int  $a_id )

protected

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

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

Referenced by __construct().

                                      : 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);
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

setActive()

ilBadge::setActive

(

bool

$a_value

)

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

Referenced by clone(), copy(), and importDBRow().

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

Here is the caller graph for this function:

setConfiguration()

ilBadge::setConfiguration

(

array

$a_value = null

)

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

Referenced by importDBRow().

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

Here is the caller graph for this function:

setCriteria()

ilBadge::setCriteria

(

string

$a_value

)

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

Referenced by importDBRow().

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

Here is the caller graph for this function:

setDescription()

ilBadge::setDescription

(

string

$a_value

)

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

Referenced by importDBRow().

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

Here is the caller graph for this function:

setId()

ilBadge::setId

(

int

$a_id

)

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

Referenced by clone(), copy(), create(), and importDBRow().

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

Here is the caller graph for this function:

setImage()

ilBadge::setImage

(

?string

$a_value

)

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

Referenced by importDBRow(), importImage(), and uploadImage().

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

Here is the caller graph for this function:

setImageRid()

ilBadge::setImageRid

(

?string

$image_rid

)

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

References $image_rid.

Referenced by clone(), ilBadgeManagementGUI\cloneBadgeTemplate(), copy(), importDBRow(), and ILIAS\Badge\ilBadgeImage\processImageUpload().

                                                   : void
    {
        $this->image_rid = $image_rid;
    }

Here is the caller graph for this function:

setParentId()

ilBadge::setParentId

(

int

$a_id

)

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

Referenced by clone(), copy(), and importDBRow().

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

Here is the caller graph for this function:

setTitle()

ilBadge::setTitle

(

string

$a_value

)

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

Referenced by copy(), and importDBRow().

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

Here is the caller graph for this function:

setTypeId()

ilBadge::setTypeId

(

string

$a_id

)

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

Referenced by importDBRow().

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

Here is the caller graph for this function:

setValid()

ilBadge::setValid

(

string

$a_value

)

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

Referenced by importDBRow().

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

Here is the caller graph for this function:

update()

ilBadge::update

(

)

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

References $db, $ilDB, create(), getId(), and getPropertiesForStorage().

Referenced by ilBadgeManagementGUI\cloneBadgeTemplate(), copy(), create(), importImage(), ILIAS\Badge\ilBadgeImage\processImageUpload(), and uploadImage().

                            : void
    {
        $ilDB = $this->db;

        if (!$this->getId()) {
            $this->create();
            return;
        }

        $fields = $this->getPropertiesForStorage();

        $ilDB->update(
            "badge_badge",
            $fields,
            ["id" => ["integer", $this->getId()]]
        );
    }

Here is the call graph for this function:

Here is the caller graph for this function:

uploadImage()

ilBadge::uploadImage

(

array

$a_upload_meta

)

Exceptions

BadgeException

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

References Vendor\Package\$e, $path, getId(), getImagePath(), ilFileUtils\moveUploadedFile(), setImage(), and update().

     : 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);
            }

        }
    }

Here is the call graph for this function:

Field Documentation

$active

bool ilBadge::$active = false

protected

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

Referenced by isActive().

$config

array ilBadge::$config = null

protected

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

Referenced by getConfiguration().

$criteria

string ilBadge::$criteria = ""

protected

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

Referenced by getCriteria().

$db

ilDBInterface ilBadge::$db

protected

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

Referenced by create(), delete(), read(), and update().

$desc

string ilBadge::$desc = ""

protected

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

Referenced by getDescription().

$id

int ilBadge::$id = 0

protected

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

Referenced by create(), and getId().

$image

string ilBadge::$image = ""

protected

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

Referenced by getImage().

$image_rid

string ilBadge::$image_rid = null

protected

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

Referenced by getImageRid(), and setImageRid().

$log

ilLogger ilBadge::$log

private

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

$parent_id

int ilBadge::$parent_id = 0

protected

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

Referenced by getParentId().

$resource_storage

Services ilBadge::$resource_storage

private

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

$title

string ilBadge::$title = ""

protected

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

Referenced by getTitle().

$type_id

string ilBadge::$type_id = ""

protected

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

Referenced by getTypeId().

$valid

string ilBadge::$valid = ""

protected

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

Referenced by getValid().

---

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

• components/ILIAS/Badge/classes/class.ilBadge.php