ilLearningSequenceSettingsDB Class Reference

This file is part of ILIAS, a powerful learning management system published by ILIAS open source e-Learning e.V. More...

Collaboration diagram for ilLearningSequenceSettingsDB:

Public Member Functions
	__construct (ilDBInterface $database, ilLearningSequenceFilesystem $ls_filesystem)
	store (ilLearningSequenceSettings $settings)
	delete (int $obj_id)
	getSettingsFor (int $lso_obj_id)

Data Fields
const	TABLE_NAME = 'lso_settings'

Protected Member Functions
	select (int $obj_id)
	buildSettings (int $obj_id, string $abstract='', string $extro='', string $abstract_image=null, string $extro_image=null, bool $gallery=false)
	insert (ilLearningSequenceSettings $settings)

Protected Attributes
ilDBInterface	$database
ilLearningSequenceFilesystem	$ls_filesystem

Detailed Description

This file is part of ILIAS, a powerful learning management system published by ILIAS open source e-Learning e.V.

ILIAS is licensed with the GPL-3.0, see https://www.gnu.org/licenses/gpl-3.0.en.html You should have received a copy of said license along with the source code, too.

If this is not the case or you just want to try ILIAS, you'll find us at: https://www.ilias.de https://github.com/ILIAS-eLearning Persistence for Settings (like abstract, extro)

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

Constructor & Destructor Documentation

__construct()

ilLearningSequenceSettingsDB::__construct	(	ilDBInterface	$database,
		ilLearningSequenceFilesystem	$ls_filesystem
	)

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

References $database, and $ls_filesystem.

    {
        $this->database = $database;
        $this->ls_filesystem = $ls_filesystem;
    }

Member Function Documentation

buildSettings()

ilLearningSequenceSettingsDB::buildSettings ( int  $obj_id, string  $abstract = '', string  $extro = '', string  $abstract_image = null, string  $extro_image = null, bool  $gallery = false  )

protected

Definition at line 123 of file class.ilLearningSequenceSettingsDB.php.

Referenced by getSettingsFor().

     : ilLearningSequenceSettings {
        return new ilLearningSequenceSettings(
            $obj_id,
            $abstract,
            $extro,
            $abstract_image,
            $extro_image,
            $gallery
        );
    }

Here is the caller graph for this function:

delete()

ilLearningSequenceSettingsDB::delete

(

int

$obj_id

)

Definition at line 64 of file class.ilLearningSequenceSettingsDB.php.

References $query, ILIAS\LTI\ToolProvider\$settings, getSettingsFor(), ilLearningSequenceFilesystem\IMG_ABSTRACT, and ilLearningSequenceFilesystem\IMG_EXTRO.

                                       : void
    {
        $settings = $this->getSettingsFor($obj_id);

        foreach ([ilLearningSequenceFilesystem::IMG_ABSTRACT, ilLearningSequenceFilesystem::IMG_EXTRO] as $pre) {
            $settings = $this->ls_filesystem->delete_image($pre, $settings);
        }

        $query =
              "DELETE FROM " . static::TABLE_NAME . PHP_EOL
            . "WHERE obj_id = " . $this->database->quote($obj_id, "integer") . PHP_EOL
        ;

        $this->database->manipulate($query);
    }

Here is the call graph for this function:

getSettingsFor()

ilLearningSequenceSettingsDB::getSettingsFor

(

int

$lso_obj_id

)

Definition at line 80 of file class.ilLearningSequenceSettingsDB.php.

References $data, ILIAS\LTI\ToolProvider\$settings, buildSettings(), insert(), and select().

Referenced by delete().

                                                   : ilLearningSequenceSettings
    {
        $data = $this->select($lso_obj_id);

        if (count($data) == 0) {
            $settings = $this->buildSettings($lso_obj_id);
            $this->insert($settings);
        } else {
            $settings = $this->buildSettings(
                $lso_obj_id,
                $data['abstract'],
                $data['extro'],
                $data['abstract_image'],
                $data['extro_image'],
                (bool) $data['gallery']
            );
        }

        return $settings;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

insert()

ilLearningSequenceSettingsDB::insert ( ilLearningSequenceSettings  $settings )

protected

Definition at line 141 of file class.ilLearningSequenceSettingsDB.php.

References ilLearningSequenceSettings\getAbstract(), ilLearningSequenceSettings\getExtro(), ilLearningSequenceSettings\getMembersGallery(), and ilLearningSequenceSettings\getObjId().

Referenced by getSettingsFor().

                                                                   : void
    {
        $values = [
            "obj_id" => ["integer", $settings->getObjId()],
            "abstract" => ["text", $settings->getAbstract()],
            "extro" => ["text", $settings->getExtro()],
            "gallery" => ["integer", $settings->getMembersGallery()]
        ];
        $this->database->insert(static::TABLE_NAME, $values);
    }

Here is the call graph for this function:

Here is the caller graph for this function:

select()

ilLearningSequenceSettingsDB::select ( int  $obj_id )

protected

Returns

array<string, mixed>

Definition at line 104 of file class.ilLearningSequenceSettingsDB.php.

References $query.

Referenced by getSettingsFor().

                                          : array
    {
        $ret = [];
        $query =
              "SELECT abstract, extro, abstract_image, extro_image, gallery" . PHP_EOL
            . "FROM " . static::TABLE_NAME . PHP_EOL
            . "WHERE obj_id = " . $this->database->quote($obj_id, "integer") . PHP_EOL
        ;

        $result = $this->database->query($query);

        if ($this->database->numRows($result) !== 0) {
            // TODO PHP8 Review: Check array building, should be $ret[] = ... IMO
            $ret = $this->database->fetchAssoc($result);
        }

        return $ret;
    }

Here is the caller graph for this function:

store()

ilLearningSequenceSettingsDB::store

(

ilLearningSequenceSettings

$settings

)

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

References ilLearningSequenceSettings\getAbstract(), ilLearningSequenceSettings\getAbstractImage(), ilLearningSequenceSettings\getDeletions(), ilLearningSequenceSettings\getExtro(), ilLearningSequenceSettings\getExtroImage(), ilLearningSequenceSettings\getMembersGallery(), ilLearningSequenceSettings\getObjId(), and ilLearningSequenceSettings\getUploads().

                                                               : void
    {
        $uploads = $settings->getUploads();
        foreach ($uploads as $pre => $info) {
            $settings = $this->ls_filesystem->moveUploaded($pre, $info, $settings);
        }

        $deletions = $settings->getDeletions();
        foreach ($deletions as $pre) {
            $settings = $this->ls_filesystem->delete_image($pre, $settings);
        }

        $where = [
            "obj_id" => ["integer", $settings->getObjId()]
        ];

        $values = [
            "abstract" => ["text", $settings->getAbstract()],
            "extro" => ["text", $settings->getExtro()],
            "abstract_image" => ["text", $settings->getAbstractImage()],
            "extro_image" => ["text", $settings->getExtroImage()],
            "gallery" => ["integer", $settings->getMembersGallery()]
        ];

        $this->database->update(static::TABLE_NAME, $values, $where);
    }

Here is the call graph for this function:

Field Documentation

$database

ilDBInterface ilLearningSequenceSettingsDB::$database

protected

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

Referenced by __construct().

$ls_filesystem

ilLearningSequenceFilesystem ilLearningSequenceSettingsDB::$ls_filesystem

protected

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

Referenced by __construct().

TABLE_NAME

const ilLearningSequenceSettingsDB::TABLE_NAME = 'lso_settings'

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

---

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

• Modules/LearningSequence/classes/Settings/class.ilLearningSequenceSettingsDB.php