ilDidacticTemplateIconFactory Class Reference

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

Collaboration diagram for ilDidacticTemplateIconFactory:

Public Member Functions
	__construct ()
	ilDidacticTemplateIconFactory constructor. More...
	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
	$definition
	$settings
	$icon_types = []
	$assignments = []
	$logger

Static Private Attributes
static	$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 21 of file class.ilDidacticTemplateIconFactory.php.

Constructor & Destructor Documentation

__construct()

ilDidacticTemplateIconFactory::__construct

(

)

ilDidacticTemplateIconFactory constructor.

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

References $DIC, and initTemplates().

    {
        global $DIC;

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

Here is the call graph for this function:

Member Function Documentation

findAssignedTemplate()

ilDidacticTemplateIconFactory::findAssignedTemplate ( int  $ref_id )

protected

Parameters

int

$ref_id

Returns

int

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

References $assignments.

Referenced by getIconPathForReference().

                                                         : int
    {
        foreach ($this->assignments as $tpl_id => $assignments) {
            if (in_array($ref_id, $assignments)) {
                return (int) $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 122 of file class.ilDidacticTemplateIconFactory.php.

References 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

)

Parameters

int

$ref_id

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

References $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

Parameters

int

$template_id

Returns

string

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

References settings().

Referenced by getIconPathForReference().

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

Here is the call graph for this function:

Here is the caller graph for this function:

getInstance()

static ilDidacticTemplateIconFactory::getInstance ( )

static

Returns

ilDidacticTemplateIconFactory

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

Referenced by ilObject\cloneMetaData().

    {
        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 142 of file class.ilDidacticTemplateIconFactory.php.

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

Referenced by __construct().

    {
        $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)) {
                        $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

Parameters

string

$type

Returns

bool

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

Referenced by getIconPathForReference().

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

Here is the caller graph for this function:

Field Documentation

$assignments

ilDidacticTemplateIconFactory::$assignments = []

private

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

Referenced by findAssignedTemplate().

$definition

ilDidacticTemplateIconFactory::$definition

private

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

$icon_types

ilDidacticTemplateIconFactory::$icon_types = []

private

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

$instance

ilDidacticTemplateIconFactory::$instance = null

staticprivate

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

$logger

ilDidacticTemplateIconFactory::$logger

private

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

$settings

ilDidacticTemplateIconFactory::$settings

private

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

---

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

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