ilDidacticTemplateSettings Class Reference

Collaboration diagram for ilDidacticTemplateSettings:

Public Member Functions
	getTemplates ()
	getObjectType ()
	readInactive ()
	Read disabled templates. More...

Static Public Member Functions
static	getInstance ()
static	getInstanceByObjectType (string $a_obj_type)
static	lookupAssignedObjectTypes ()

Protected Member Functions
	read ()
	Read active didactic templates. More...

Private Member Functions
	__construct (string $a_obj_type='')

Private Attributes
array	$templates = []
string	$obj_type = ''
ilDBInterface	$db

Static Private Attributes
static ilDidacticTemplateSettings	$instance = null
static array	$instances = []

Detailed Description

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

Constructor & Destructor Documentation

__construct()

ilDidacticTemplateSettings::__construct ( string  $a_obj_type = '' )

private

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

References $DIC, and read().

    {
        global $DIC;

        $this->obj_type = $a_obj_type;
        $this->db = $DIC->database();
        $this->read();
    }

Here is the call graph for this function:

Member Function Documentation

getInstance()

static ilDidacticTemplateSettings::getInstance ( )

static

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

Referenced by ilDidacticTemplateSettingsGUI\confirmDelete(), ilDidacticTemplateSettingsTableDataRetrieval\getTemplates(), and ilDidacticTemplateIconFactory\initTemplates().

                                        : ilDidacticTemplateSettings
    {
        if (self::$instance) {
            return self::$instance;
        }

        return self::$instance = new ilDidacticTemplateSettings();
    }

Here is the caller graph for this function:

getInstanceByObjectType()

static ilDidacticTemplateSettings::getInstanceByObjectType ( string  $a_obj_type )

static

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

Referenced by ilDidacticTemplateGUI\appendToolbarSwitch(), ilSessionDataSet\applyDidacticTemplate(), ILIAS\Repository\Form\buildDidacticTemplateOptions(), ilObjectGUI\buildDidacticTemplateOptions(), and ilObjGroup\updateGroupType().

                                                                      : ilDidacticTemplateSettings
    {
        return self::$instances[$a_obj_type] ?? (self::$instances[$a_obj_type] = new ilDidacticTemplateSettings($a_obj_type));
    }

Here is the caller graph for this function:

getObjectType()

ilDidacticTemplateSettings::getObjectType

(

)

Definition at line 87 of file class.ilDidacticTemplateSettings.php.

References $obj_type.

Referenced by read(), and readInactive().

                                   : string
    {
        return $this->obj_type;
    }

Here is the caller graph for this function:

getTemplates()

ilDidacticTemplateSettings::getTemplates

(

)

Returns

ilDidacticTemplateSetting[]

Definition at line 82 of file class.ilDidacticTemplateSettings.php.

References $templates.

                                  : array
    {
        return $this->templates;
    }

lookupAssignedObjectTypes()

static ilDidacticTemplateSettings::lookupAssignedObjectTypes ( )

static

Returns

string[]

Exceptions

ilDatabaseException

Definition at line 63 of file class.ilDidacticTemplateSettings.php.

References $DIC, $res, ilDBConstants\FETCHMODE_OBJECT, and ilDBInterface\query().

Referenced by ilDidacticTemplateSettingsTableFilter\init().

                                                      : array
    {
        global $DIC;

        $db = $DIC->database();
        $query = 'select distinct (obj_type) from didactic_tpl_sa ' .
            'group by obj_type';
        $res = $db->query($query);
        $types = [];
        while ($row = $res->fetchRow(ilDBConstants::FETCHMODE_OBJECT)) {
            $types[] = $row->obj_type;
        }

        return $types;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

read()

ilDidacticTemplateSettings::read ( )

protected

Read active didactic templates.

Returns

bool

Definition at line 120 of file class.ilDidacticTemplateSettings.php.

References $res, ilDBConstants\FETCHMODE_OBJECT, and getObjectType().

Referenced by __construct().

                             : bool
    {
        $query = 'SELECT dtpl.id FROM didactic_tpl_settings dtpl ';
        if ($this->getObjectType()) {
            $query .= 'JOIN didactic_tpl_sa tplsa ON dtpl.id = tplsa.id ';
        }
        $query .= 'WHERE enabled = ' . $this->db->quote(1, 'integer') . ' ';

        if ($this->getObjectType()) {
            $query .= 'AND obj_type = ' . $this->db->quote($this->getObjectType(), 'text');
        }
        $res = $this->db->query($query);
        while ($row = $res->fetchRow(ilDBConstants::FETCHMODE_OBJECT)) {
            $this->templates[$row->id] = new ilDidacticTemplateSetting((int) $row->id);
        }

        return true;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

readInactive()

ilDidacticTemplateSettings::readInactive

(

)

Read disabled templates.

Definition at line 95 of file class.ilDidacticTemplateSettings.php.

References $res, ilDBConstants\FETCHMODE_OBJECT, and getObjectType().

                                  : bool
    {
        $query = 'SELECT dtpl.id FROM didactic_tpl_settings dtpl ';

        if ($this->getObjectType()) {
            $query .= 'JOIN didactic_tpl_sa tplsa ON dtpl.id = tplsa.id ';
        }
        $query .= 'WHERE enabled = ' . $this->db->quote(0, 'integer') . ' ';

        if ($this->getObjectType()) {
            $query .= 'AND obj_type = ' . $this->db->quote($this->getObjectType(), 'text');
        }

        $res = $this->db->query($query);
        while ($row = $res->fetchRow(ilDBConstants::FETCHMODE_OBJECT)) {
            $this->templates[$row->id] = new ilDidacticTemplateSetting((int) $row->id);
        }

        return true;
    }

Here is the call graph for this function:

Field Documentation

$db

ilDBInterface ilDidacticTemplateSettings::$db

private

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

$instance

ilDidacticTemplateSettings ilDidacticTemplateSettings::$instance = null

staticprivate

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

$instances

array ilDidacticTemplateSettings::$instances = []

staticprivate

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

$obj_type

string ilDidacticTemplateSettings::$obj_type = ''

private

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

Referenced by getObjectType().

$templates

array ilDidacticTemplateSettings::$templates = []

private

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

Referenced by getTemplates().

---

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

• components/ILIAS/DidacticTemplate/classes/Setting/class.ilDidacticTemplateSettings.php