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 ()
	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
	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_rid = null
string	$valid = ''
array	$config = null
string	$criteria = ''

Private Attributes
ilLogger	$log
Services	$resource_storage

Detailed Description

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

Constructor & Destructor Documentation

__construct()

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

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

      {
        if ($container === null) {
            global $DIC;
            $container = $DIC;
        }
 
        $this->db = $container->database();
        $this->resource_storage = $container->resourceStorage();
        $this->log = $container->logger()->forComponent('badge');
        if ($a_id) {
            $this->read($a_id);
        }
    }

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

Here is the call graph for this function:

Member Function Documentation

clone()

ilBadge::clone

(

int

$target_parent_obj_id

)

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

                                                    : void
    {
        $this->setParentId($target_parent_obj_id);
        $this->setActive(false);
 
        if (!$this->getId()) {
            return;
        }
 
        $image_rid = $this->getImageRid();
        $this->setId(0);
        if ($image_rid !== null) {
            $cloned_rid = $this->resource_storage->manage()->clone(new ResourceIdentification($image_rid));
            $this->setImageRid($cloned_rid);
        }
        $this->create();
    }

References ILIAS\Survey\Mode\getId().

Referenced by ILIAS\UI\Implementation\Component\Table\Presentation\getCollapseAllSignal(), ILIAS\UI\Implementation\Component\Table\Presentation\getExpandAllSignal(), ILIAS\UI\Implementation\Component\Table\PresentationRow\withAction(), ILIAS\UI\Implementation\Component\Table\AbstractTable\withActions(), ILIAS\UI\Implementation\Component\Table\PresentationRow\withContent(), ILIAS\UI\Implementation\Component\Table\Presentation\withData(), ILIAS\UI\Implementation\Component\Table\DataRow\withDisabledAction(), ILIAS\UI\Implementation\Component\Table\Presentation\withEnvironment(), ILIAS\UI\Implementation\Component\Table\PresentationRow\withFurtherFields(), ILIAS\UI\Implementation\Component\Table\PresentationRow\withFurtherFieldsHeadline(), ILIAS\UI\Implementation\Component\Table\PresentationRow\withHeadline(), ILIAS\UI\Implementation\Component\Table\AbstractTable\withId(), ILIAS\UI\Implementation\Component\Table\PresentationRow\withImportantFields(), ILIAS\UI\Implementation\Component\Table\PresentationRow\withLeadingSymbol(), ILIAS\UI\Implementation\Component\Table\Ordering\withOrderingDisabled(), ILIAS\UI\Implementation\Component\Table\OrderingRow\withOrderingDisabled(), ILIAS\UI\Implementation\Component\Table\OrderingRow\withPosition(), ILIAS\UI\Implementation\Component\Table\AbstractTable\withRequest(), ILIAS\UI\Implementation\Component\Table\PresentationRow\withResetSignals(), ILIAS\UI\Implementation\Component\Table\Presentation\withRowMapping(), ILIAS\UI\Implementation\Component\Table\PresentationRow\withSubheadline(), ILIAS\UI\Implementation\Component\Table\PresentationRow\withTags(), and ILIAS\UI\Implementation\Component\Table\Table\withTitle().

Here is the call graph for this function:

Here is the caller graph for this function:

copy()

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

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

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

create()

ilBadge::create

(

)

Definition at line 357 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 398 of file class.ilBadge.php.

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

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

Here is the call graph for this function:

deleteStaticFiles()

ilBadge::deleteStaticFiles

(

)

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

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

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

Here is the call graph for this function:

getConfiguration()

ilBadge::getConfiguration

(

)

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

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

getCriteria()

ilBadge::getCriteria

(

)

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

                                 : string
    {
        return $this->criteria;
    }

Referenced by ILIAS\Badge\Tile\modalContent().

Here is the caller graph for this function:

getDescription()

ilBadge::getDescription

(

)

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

                                    : string
    {
        return $this->desc;
    }

getExtendedTypeCaption()

static ilBadge::getExtendedTypeCaption ( ilBadgeType  $a_type )

static

Definition at line 502 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 ILIAS\Badge\ilBadgeTableGUI\getRecords(), ILIAS\Badge\ilObjectBadgeTableGUI\getRecords(), and ilBadgeManagementGUI\listBadgesCmd().

Here is the caller graph for this function:

getId()

ilBadge::getId

(

)

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

                           : int
    {
        return $this->id;
    }

References $id.

Referenced by ilBadgeHandler\countStaticBadgeInstances(), ilBadgeHandler\getBadgePath(), and ILIAS\Badge\Tile\profileButton().

Here is the caller graph for this function:

getImageRid()

ilBadge::getImageRid

(

)

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

                                 : ?string
    {
        // '-' was written by the removed filesystem migration for badges without an image.
        if ($this->image_rid === null || $this->image_rid === '' || $this->image_rid === '-') {
            return null;
        }
 
        return $this->image_rid;
    }

Referenced by ilBadgeManagementGUI\removeResourceStorageImage().

Here is the caller graph for this function:

getInstancesByParentId()

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

static

Returns

self[]

Definition at line 59 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(), ilBadgeManagementGUI\confirmDeleteBadges(), ILIAS\Badge\ilBadgeTableGUI\getRecords(), and ilBadgeManagementGUI\toggleBadges().

Here is the caller graph for this function:

getInstancesByType()

static ilBadge::getInstancesByType ( string  $a_type_id )

static

Returns

self[]

Definition at line 95 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  $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, valid: ?string, crit: ?string, image_rid: ?string, parent_title: ?string, parent_type: ?string, deleted: bool }>

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

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

References $ilDB, and ilDBConstants\T_TEXT.

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

Here is the caller graph for this function:

getParentId()

ilBadge::getParentId

(

)

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

                                 : int
    {
        return $this->parent_id;
    }

Referenced by ILIAS\Badge\BadgeParent\metaData().

Here is the caller graph for this function:

getParentMeta()

ilBadge::getParentMeta

(

)

Returns

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

Definition at line 447 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().

Referenced by ILIAS\Badge\BadgeParent\metaData().

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 425 of file class.ilBadge.php.

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

References ILIAS\GlobalScreen\Scope\Footer\Factory\getTitle().

Here is the call graph for this function:

getTitle()

ilBadge::getTitle

(

)

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

                              : string
    {
        return $this->title;
    }

Referenced by ILIAS\Badge\Tile\image(), and ILIAS\Badge\Tile\title().

Here is the caller graph for this function:

getTypeId()

ilBadge::getTypeId

(

)

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

                               : string
    {
        return $this->type_id;
    }

getTypeInstance()

ilBadge::getTypeInstance

(

)

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

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

References $handler, and ilBadgeHandler\getInstance().

Here is the call graph for this function:

getValid()

ilBadge::getValid

(

)

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

                              : string
    {
        return $this->valid;
    }

Referenced by ILIAS\Badge\Tile\modalContent().

Here is the caller graph for this function:

importDBRow()

ilBadge::importDBRow ( array  $a_row )

protected

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

isActive()

ilBadge::isActive

(

)

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

                              : bool
    {
        return $this->active;
    }

prepareJson()

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

protected

Definition at line 476 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 328 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 261 of file class.ilBadge.php.

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

setConfiguration()

ilBadge::setConfiguration

(

?array

$a_value = null

)

Definition at line 311 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 291 of file class.ilBadge.php.

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

setDescription()

ilBadge::setDescription

(

string

$a_value

)

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

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

setId()

ilBadge::setId

(

int

$a_id

)

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

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

setImageRid()

ilBadge::setImageRid

(

?string

$image_rid

)

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

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

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

Here is the caller graph for this function:

setParentId()

ilBadge::setParentId

(

int

$a_id

)

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

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

setTitle()

ilBadge::setTitle

(

string

$a_value

)

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

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

setTypeId()

ilBadge::setTypeId

(

string

$a_id

)

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

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

setValid()

ilBadge::setValid

(

string

$a_value

)

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

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

update()

ilBadge::update

(

)

Definition at line 379 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().

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

Here is the call graph for this function:

Here is the caller graph for this function:

Field Documentation

$active

bool ilBadge::$active = false

protected

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

$config

array ilBadge::$config = null

protected

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

$criteria

string ilBadge::$criteria = ''

protected

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

$db

ilDBInterface ilBadge::$db

protected

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

$desc

string ilBadge::$desc = ''

protected

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

$id

int ilBadge::$id = 0

protected

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

$image_rid

string ilBadge::$image_rid = null

protected

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

$log

ilLogger ilBadge::$log

private

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

$parent_id

int ilBadge::$parent_id = 0

protected

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

$resource_storage

Services ilBadge::$resource_storage

private

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

$title

string ilBadge::$title = ''

protected

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

$type_id

string ilBadge::$type_id = ''

protected

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

$valid

string ilBadge::$valid = ''

protected

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

---

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

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