ilDidacticTemplateIconFactory Class Reference

Icon factory for didactic template custom icons. More...

Collaboration diagram for ilDidacticTemplateIconFactory:

Public Member Functions
	__construct ()
	getIconPathForReference (int $ref_id)
	getIconPathForObject (int $obj_id)
	Get icon path for object Not applicable to non container objects, use getIconPathForReference instead. More...

Static Public Member Functions
static	getInstance ()

Protected Member Functions
	getIconPathForTemplate (int $template_id)
	findAssignedTemplate (int $ref_id)
	supportsCustomIcon (string $type)

Private Member Functions
	initTemplates ()

Private Attributes
ilObjectDefinition	$definition
ilDidacticTemplateSettings	$settings
array	$icon_types = []
array	$assignments = []

Static Private Attributes
static ilDidacticTemplateIconFactory	$instance = null

Detailed Description

Icon factory for didactic template custom icons.

Author

Stefan Meyer meyer.nosp@m.@lei.nosp@m.fos.c.nosp@m.om

Definition at line 20 of file class.ilDidacticTemplateIconFactory.php.

Constructor & Destructor Documentation

__construct()

ilDidacticTemplateIconFactory::__construct

(

)

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

References $DIC, and initTemplates().

    {
        global $DIC;

        $this->definition = $DIC['objDefinition'];
        $this->initTemplates();
    }

Here is the call graph for this function:

Member Function Documentation

findAssignedTemplate()

ilDidacticTemplateIconFactory::findAssignedTemplate ( int  $ref_id )

protected

Definition at line 76 of file class.ilDidacticTemplateIconFactory.php.

Referenced by getIconPathForReference().

                                                        : int
    {
        foreach ($this->assignments as $tpl_id => $assignments) {
            if (in_array($ref_id, $assignments, true)) {
                return $tpl_id;
            }
        }

        return 0;
    }

Here is the caller graph for this function:

getIconPathForObject()

ilDidacticTemplateIconFactory::getIconPathForObject

(

int

$obj_id

)

Get icon path for object Not applicable to non container objects, use getIconPathForReference instead.

Parameters

int

$obj_id

Returns

string

Definition at line 93 of file class.ilDidacticTemplateIconFactory.php.

References $ref_id, ilObject\_getAllReferences(), ilObject\_lookupType(), and getIconPathForReference().

                                                     : string
    {
        // no support for referenced objects
        if (!$this->definition->isContainer(ilObject::_lookupType($obj_id))) {
            return '';
        }
        $refs = ilObject::_getAllReferences($obj_id);
        $ref_id = end($refs);

        return $this->getIconPathForReference((int) $ref_id);
    }

Here is the call graph for this function:

getIconPathForReference()

ilDidacticTemplateIconFactory::getIconPathForReference

(

int

$ref_id

)

Definition at line 48 of file class.ilDidacticTemplateIconFactory.php.

References $path, $type, ilObject\_lookupObjId(), ilObject\_lookupType(), findAssignedTemplate(), getIconPathForTemplate(), and supportsCustomIcon().

Referenced by getIconPathForObject().

                                                        : string
    {
        $obj_id = ilObject::_lookupObjId($ref_id);
        $type = ilObject::_lookupType($obj_id);

        if (!$type || !$this->supportsCustomIcon($type)) {
            return '';
        }
        $assigned_template = $this->findAssignedTemplate($ref_id);
        if (!$assigned_template) {
            return '';
        }

        $path = $this->getIconPathForTemplate($assigned_template);
        return $path;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getIconPathForTemplate()

ilDidacticTemplateIconFactory::getIconPathForTemplate ( int  $template_id )

protected

Definition at line 65 of file class.ilDidacticTemplateIconFactory.php.

References ILIAS\Repository\settings().

Referenced by getIconPathForReference().

                                                               : ?string
    {
        foreach ($this->settings->getTemplates() as $template) {
            if ($template->getId() === $template_id) {
                return $template->getIconHandler()->getAbsolutePath();
            }
        }

        return null;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getInstance()

static ilDidacticTemplateIconFactory::getInstance ( )

static

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

Referenced by ilObject\cloneMetaData().

                                        : ilDidacticTemplateIconFactory
    {
        if (!isset(self::$instance)) {
            self::$instance = new self();
        }

        return self::$instance;
    }

Here is the caller graph for this function:

initTemplates()

ilDidacticTemplateIconFactory::initTemplates ( )

private

Definition at line 110 of file class.ilDidacticTemplateIconFactory.php.

References $tpl, ilDidacticTemplateObjSettings\getAssignmentsForTemplates(), ilDidacticTemplateSettings\getInstance(), and ILIAS\Repository\settings().

Referenced by __construct().

                                    : void
    {
        $this->settings = ilDidacticTemplateSettings::getInstance();
        $this->icon_types = [];

        $templates = [];
        foreach ($this->settings->getTemplates() as $tpl) {
            if ($tpl->getIconIdentifier() !== '') {
                $templates[] = $tpl->getId();
                foreach ($tpl->getAssignments() as $assignment) {
                    if (!in_array($assignment, $this->icon_types, true)) {
                        $this->icon_types[] = $assignment;
                    }
                }
            }
        }
        $this->assignments = ilDidacticTemplateObjSettings::getAssignmentsForTemplates($templates);
    }

Here is the call graph for this function:

Here is the caller graph for this function:

supportsCustomIcon()

ilDidacticTemplateIconFactory::supportsCustomIcon ( string  $type )

protected

Definition at line 105 of file class.ilDidacticTemplateIconFactory.php.

Referenced by getIconPathForReference().

                                                       : bool
    {
        return in_array($type, $this->icon_types, true);
    }

Here is the caller graph for this function:

Field Documentation

$assignments

array ilDidacticTemplateIconFactory::$assignments = []

private

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

$definition

ilObjectDefinition ilDidacticTemplateIconFactory::$definition

private

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

$icon_types

array ilDidacticTemplateIconFactory::$icon_types = []

private

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

$instance

ilDidacticTemplateIconFactory ilDidacticTemplateIconFactory::$instance = null

staticprivate

Definition at line 22 of file class.ilDidacticTemplateIconFactory.php.

$settings

ilDidacticTemplateSettings ilDidacticTemplateIconFactory::$settings

private

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

---

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

• Services/DidacticTemplate/classes/Icon/class.ilDidacticTemplateIconFactory.php