ilBadgeImageTemplate Class Reference

Collaboration diagram for ilBadgeImageTemplate:

Public Member Functions
	__construct (?int $a_id=null)
	getId ()
	setTitle (string $a_value)
	getTitle ()
	getTypes ()
	setTypes (?array $types=null)
	getImage ()
	uploadImage (array $a_upload_meta)
	processImageUpload (ilBadgeImageTemplate $badge)
	getImagePath ()
	create ()
	update ()
	delete ()
	getImageRid ()
	setImageRid (?string $image_rid=null)
	getImageFromResourceId (int $size=ilBadgeImage::IMAGE_SIZE_XS)

Static Public Member Functions
static	getInstances ()
static	getInstancesByType (string $a_type_unique_id)

Protected Member Functions
	setId (int $a_id)
	setImage (?string $a_value)
	getFilePath (int $a_id, ?string $a_subdir=null)
	Init file system storage. More...
	read (int $a_id)
	readTypes (int $a_id)
	importDBRow (array $a_row)
	getPropertiesForStorage ()
	saveTypes ()

Protected Attributes
ilDBInterface	$db
int	$id = 0
string	$title = ""
string	$image = ""
string	$image_rid = ""
array	$types = null
Services	$resource_storage
FileUpload	$upload_service
ilGlobalTemplateInterface	$main_template

Detailed Description

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

Constructor & Destructor Documentation

__construct()

ilBadgeImageTemplate::__construct

(

?int

$a_id = null

)

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

References $DIC, and read().

    {
        global $DIC;

        $this->resource_storage = $DIC->resourceStorage();
        $this->upload_service = $DIC->upload();
        $this->main_template = $DIC->ui()->mainTemplate();
        $this->db = $DIC->database();
        if ($a_id) {
            $this->read($a_id);
        }
    }

Here is the call graph for this function:

Member Function Documentation

create()

ilBadgeImageTemplate::create

(

)

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

References $db, $ilDB, getId(), getPropertiesForStorage(), saveTypes(), setId(), and update().

Referenced by update().

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

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

        $id = $ilDB->nextId("badge_image_template");
        $this->setId($id);

        $fields = $this->getPropertiesForStorage();
        $fields["id"] = array("integer", $id);

        $ilDB->insert("badge_image_template", $fields);

        $this->saveTypes();
    }

Here is the call graph for this function:

Here is the caller graph for this function:

delete()

ilBadgeImageTemplate::delete

(

)

Definition at line 321 of file class.ilBadgeImageTemplate.php.

References $db, $ilDB, $path, ilFileUtils\delDir(), getFilePath(), and getId().

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

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

        $path = $this->getFilePath($this->getId());
        ilFileUtils::delDir($path);

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

Here is the call graph for this function:

getFilePath()

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

protected

Init file system storage.

Definition at line 212 of file class.ilBadgeImageTemplate.php.

References $path.

Referenced by delete(), getImagePath(), and uploadImage().

     : string {
        $storage = new ilFSStorageBadgeImageTemplate($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()

ilBadgeImageTemplate::getId

(

)

Definition at line 107 of file class.ilBadgeImageTemplate.php.

References $id.

Referenced by create(), delete(), getImagePath(), saveTypes(), update(), and uploadImage().

                           : int
    {
        return $this->id;
    }

Here is the caller graph for this function:

getImage()

ilBadgeImageTemplate::getImage

(

)

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

References $image.

Referenced by getImageFromResourceId(), getImagePath(), getPropertiesForStorage(), and ilObjBadgeAdministrationGUI\setImageTemplateFormValues().

                              : string
    {
        return $this->image;
    }

Here is the caller graph for this function:

getImageFromResourceId()

ilBadgeImageTemplate::getImageFromResourceId

(

int

$size = ilBadgeImage::IMAGE_SIZE_XS

)

Definition at line 378 of file class.ilBadgeImageTemplate.php.

References getImage(), getImagePath(), getImageRid(), null, and ilWACSignedPath\signFile().

Referenced by ilObjBadgeAdministrationGUI\setImageTemplateFormValues().

     : string {
        $image_src = '';

        if ($this->getImageRid()) {
            $identification = $this->resource_storage->manage()->find($this->getImageRid());
            if ($identification !== null) {
                $flavour = $this->resource_storage->flavours()->get($identification, new ilBadgePictureDefinition());
                $urls = $this->resource_storage->consume()->flavourUrls($flavour)->getURLsAsArray();
                if (count($urls) === ilBadgeImage::IMAGE_URL_COUNT && isset($urls[$size])) {
                    $image_src = $urls[$size];
                }
            }
        } elseif ($this->getImage()) {
            $image_src = ilWACSignedPath::signFile($this->getImagePath());
        }

        return $image_src;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getImagePath()

ilBadgeImageTemplate::getImagePath

(

)

Definition at line 195 of file class.ilBadgeImageTemplate.php.

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

Referenced by getImageFromResourceId(), and ilObjBadgeAdministrationGUI\setImageTemplateFormValues().

                                  : string
    {
        if ($this->getId()) {
            if (is_file($this->getFilePath($this->getId()) . "img" . $this->getId())) { // formerly (early 5.2 versino), images have been uploaded with no suffix
                return $this->getFilePath($this->getId()) . "img" . $this->getId();
            }

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

Here is the call graph for this function:

Here is the caller graph for this function:

getImageRid()

ilBadgeImageTemplate::getImageRid

(

)

Definition at line 368 of file class.ilBadgeImageTemplate.php.

References $image_rid.

Referenced by getImageFromResourceId(), getPropertiesForStorage(), processImageUpload(), and ilObjBadgeAdministrationGUI\setImageTemplateFormValues().

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

Here is the caller graph for this function:

getInstances()

static ilBadgeImageTemplate::getInstances ( )

static

Returns

self[]

Definition at line 54 of file class.ilBadgeImageTemplate.php.

References $DIC, $ilDB, $res, and null.

Referenced by ilObjBadgeAdministrationGUI\confirmDeleteImageTemplates(), ilObjBadgeAdministrationGUI\deleteImageTemplates(), ILIAS\Badge\ilBadgeImageTemplateTableGUI\getRecords(), and ILIAS\Badge\ilBadgeImageTemplateTableGUI\renderTable().

                                         : array
    {
        global $DIC;

        $ilDB = $DIC->database();

        $res = array();

        $types = array();
        $set = $ilDB->query("SELECT * FROM badge_image_templ_type");
        while ($row = $ilDB->fetchAssoc($set)) {
            $types[$row["tmpl_id"]][] = $row["type_id"];
        }

        $set = $ilDB->query("SELECT * FROM badge_image_template" .
            " ORDER BY title");
        while ($row = $ilDB->fetchAssoc($set)) {
            $row["types"] = (array) ($types[$row["id"]] ?? null);

            $obj = new self();
            $obj->importDBRow($row);
            $res[] = $obj;
        }

        return $res;
    }

Here is the caller graph for this function:

getInstancesByType()

static ilBadgeImageTemplate::getInstancesByType ( string  $a_type_unique_id )

static

Returns

self[]

Definition at line 84 of file class.ilBadgeImageTemplate.php.

References $res.

Referenced by ilBadgeManagementGUI\initBadgeForm().

                                                                       : array
    {
        $res = [];

        foreach (self::getInstances() as $tmpl) {
            if (!count($tmpl->getTypes()) || in_array($a_type_unique_id, $tmpl->getTypes(), true)) {
                $res[] = $tmpl;
            }
        }

        return $res;
    }

Here is the caller graph for this function:

getPropertiesForStorage()

ilBadgeImageTemplate::getPropertiesForStorage ( )

protected

Returns

array<string, array>

Definition at line 339 of file class.ilBadgeImageTemplate.php.

References getImage(), getImageRid(), and getTitle().

Referenced by create(), and update().

                                                : array
    {
        return [
            "title" => ["text", $this->getTitle()],
            "image" => ["text", $this->getImage()],
            "image_rid" => ["text", $this->getImageRid()]
        ];
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getTitle()

ilBadgeImageTemplate::getTitle

(

)

Definition at line 117 of file class.ilBadgeImageTemplate.php.

References $title.

Referenced by getPropertiesForStorage(), and ilObjBadgeAdministrationGUI\setImageTemplateFormValues().

                              : string
    {
        return $this->title;
    }

Here is the caller graph for this function:

getTypes()

ilBadgeImageTemplate::getTypes

(

)

Returns

string[]

Definition at line 132 of file class.ilBadgeImageTemplate.php.

References $types.

Referenced by saveTypes(), and ilObjBadgeAdministrationGUI\setImageTemplateFormValues().

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

Here is the caller graph for this function:

importDBRow()

ilBadgeImageTemplate::importDBRow ( array  $a_row )

protected

Definition at line 268 of file class.ilBadgeImageTemplate.php.

References setId(), setImage(), setImageRid(), setTitle(), and setTypes().

Referenced by read().

                                                : void
    {
        $this->setId($a_row["id"]);
        $this->setTitle($a_row["title"]);
        if (isset($a_row["image"])) {
            $this->setImage($a_row["image"]);
        }
        if (isset($a_row["image_rid"])) {
            $this->setImageRid($a_row["image_rid"]);
        }
        $this->setTypes($a_row["types"]);
    }

Here is the call graph for this function:

Here is the caller graph for this function:

processImageUpload()

ilBadgeImageTemplate::processImageUpload

(

ilBadgeImageTemplate

$badge

)

Definition at line 172 of file class.ilBadgeImageTemplate.php.

References Vendor\Package\$e, getImageRid(), setImageRid(), and update().

                                                                   : void
    {
        try {
            if (!$this->upload_service->hasBeenProcessed()) {
                $this->upload_service->process();
            }
            if ($this->upload_service->hasUploads()) {
                $array_result = $this->upload_service->getResults();
                $array_result = array_pop($array_result);
                if ($array_result->getName() !== '') {
                    $this->resource_storage->manage()->remove(new ResourceIdentification($badge->getImageRid()), new ilBadgeFileStakeholder());
                    $stakeholder = new ilBadgeFileStakeholder();
                    $identification = $this->resource_storage->manage()->upload($array_result, $stakeholder);
                    $this->resource_storage->flavours()->ensure($identification, new \ilBadgePictureDefinition());
                    $badge->setImageRid($identification);
                    $badge->update();
                }
            }
        } catch (IllegalStateException $e) {
            $this->main_template->setOnScreenMessage('failure', $e->getMessage(), true);
        }
    }

Here is the call graph for this function:

read()

ilBadgeImageTemplate::read ( int  $a_id )

protected

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

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

Referenced by __construct().

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

        $set = $ilDB->query("SELECT * FROM badge_image_template" .
            " WHERE id = " . $ilDB->quote($a_id, "integer"));
        if ($ilDB->numRows($set)) {
            $row = $ilDB->fetchAssoc($set);
            $row["types"] = $this->readTypes($a_id);
            $this->importDBRow($row);
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

readTypes()

ilBadgeImageTemplate::readTypes ( int  $a_id )

protected

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

References $db, $ilDB, $res, and null.

Referenced by read().

                                           : ?array
    {
        $ilDB = $this->db;

        $res = array();

        $set = $ilDB->query("SELECT * FROM badge_image_templ_type WHERE tmpl_id = " . $ilDB->quote($a_id, "integer"));
        while ($row = $ilDB->fetchAssoc($set)) {
            $res[] = $row["type_id"];
        }

        if (!count($res)) {
            $res = null;
        }

        return $res;
    }

Here is the caller graph for this function:

saveTypes()

ilBadgeImageTemplate::saveTypes ( )

protected

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

References $db, $ilDB, getId(), and getTypes().

Referenced by create(), and update().

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

        if ($this->getId()) {
            $ilDB->manipulate("DELETE FROM badge_image_templ_type" .
                " WHERE tmpl_id = " . $ilDB->quote($this->getId(), "integer"));

            if ($this->getTypes()) {
                foreach ($this->getTypes() as $type) {
                    $fields = array(
                        "tmpl_id" => array("integer", $this->getId()),
                        "type_id" => array("text", $type)
                    );
                    $ilDB->insert("badge_image_templ_type", $fields);
                }
            }
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

setId()

ilBadgeImageTemplate::setId ( int  $a_id )

protected

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

Referenced by create(), and importDBRow().

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

Here is the caller graph for this function:

setImage()

ilBadgeImageTemplate::setImage ( ?string  $a_value )

protected

Definition at line 122 of file class.ilBadgeImageTemplate.php.

References null.

Referenced by importDBRow(), and uploadImage().

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

Here is the caller graph for this function:

setImageRid()

ilBadgeImageTemplate::setImageRid

(

?string

$image_rid = null

)

Definition at line 373 of file class.ilBadgeImageTemplate.php.

References $image_rid.

Referenced by importDBRow(), and processImageUpload().

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

Here is the caller graph for this function:

setTitle()

ilBadgeImageTemplate::setTitle

(

string

$a_value

)

Definition at line 112 of file class.ilBadgeImageTemplate.php.

Referenced by importDBRow().

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

Here is the caller graph for this function:

setTypes()

ilBadgeImageTemplate::setTypes

(

?array

$types = null

)

Definition at line 137 of file class.ilBadgeImageTemplate.php.

References null.

Referenced by importDBRow().

                                                  : void
    {
        $this->types = is_array($types)
            ? array_unique($types)
            : null;
    }

Here is the caller graph for this function:

update()

ilBadgeImageTemplate::update

(

)

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

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

Referenced by create(), processImageUpload(), and uploadImage().

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

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

        $fields = $this->getPropertiesForStorage();

        $ilDB->update(
            "badge_image_template",
            $fields,
            array("id" => array("integer", $this->getId()))
        );

        $this->saveTypes();
    }

Here is the call graph for this function:

Here is the caller graph for this function:

uploadImage()

ilBadgeImageTemplate::uploadImage

(

array

$a_upload_meta

)

Exceptions

ilException
ilFileUtilsException

Definition at line 153 of file class.ilBadgeImageTemplate.php.

References $filename, $path, getFilePath(), getId(), ilFileUtils\getValidFilename(), ilFileUtils\moveUploadedFile(), setImage(), and update().

                                                     : void
    {
        if ($this->getId() &&
            $a_upload_meta["tmp_name"]) {
            $path = $this->getFilePath($this->getId());

            $filename = ilFileUtils::getValidFilename($a_upload_meta["name"]);

            $exp = explode(".", $filename);
            $suffix = strtolower(array_pop($exp));
            $tgt = $path . "img" . $this->getId() . "." . $suffix;

            if (ilFileUtils::moveUploadedFile($a_upload_meta["tmp_name"], "img" . $this->getId() . "." . $suffix, $tgt)) {
                $this->setImage($filename);
                $this->update();
            }
        }
    }

Here is the call graph for this function:

Field Documentation

$db

ilDBInterface ilBadgeImageTemplate::$db

protected

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

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

$id

int ilBadgeImageTemplate::$id = 0

protected

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

Referenced by getId().

$image

string ilBadgeImageTemplate::$image = ""

protected

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

Referenced by getImage().

$image_rid

string ilBadgeImageTemplate::$image_rid = ""

protected

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

Referenced by getImageRid(), and setImageRid().

$main_template

ilGlobalTemplateInterface ilBadgeImageTemplate::$main_template

protected

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

$resource_storage

Services ilBadgeImageTemplate::$resource_storage

protected

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

$title

string ilBadgeImageTemplate::$title = ""

protected

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

Referenced by getTitle().

$types

array ilBadgeImageTemplate::$types = null

protected

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

Referenced by getTypes().

$upload_service

FileUpload ilBadgeImageTemplate::$upload_service

protected

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

---

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

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