ilLearningSequenceActivationDB 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 ilLearningSequenceActivationDB:

Public Member Functions
	__construct (ilDBInterface $database)
	getActivationForRefId (int $ref_id)
	deleteForRefId (int $ref_id)
	store (ilLearningSequenceActivation $settings)
	setEffectiveOnlineStatus (int $ref_id, bool $status)

Data Fields
const	TABLE_NAME = 'lso_activation'

Protected Member Functions
	insert (ilLearningSequenceActivation $settings)
	select (int $ref_id)
	buildActivationSettings (int $ref_id, bool $online=false, bool $effective_online=false, \DateTime $activation_start=null, \DateTime $activation_end=null)

Protected Attributes
ilDBInterface	$database

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 online/activation period

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

Constructor & Destructor Documentation

__construct()

ilLearningSequenceActivationDB::__construct

(

ilDBInterface

$database

)

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

References $database.

    {
        $this->database = $database;
    }

Member Function Documentation

buildActivationSettings()

ilLearningSequenceActivationDB::buildActivationSettings ( int  $ref_id, bool  $online = false, bool  $effective_online = false, \DateTime  $activation_start = null, \DateTime  $activation_end = null  )

protected

Definition at line 147 of file class.ilLearningSequenceActivationDB.php.

Referenced by getActivationForRefId().

     : ilLearningSequenceActivation {
        return new ilLearningSequenceActivation(
            $ref_id,
            $online,
            $effective_online,
            $activation_start,
            $activation_end
        );
    }

Here is the caller graph for this function:

deleteForRefId()

ilLearningSequenceActivationDB::deleteForRefId

(

int

$ref_id

)

Definition at line 68 of file class.ilLearningSequenceActivationDB.php.

                                               : void
    {
        $query = "DELETE FROM " . static::TABLE_NAME . PHP_EOL
            . "WHERE ref_id = " . $this->database->quote($ref_id, "integer") . PHP_EOL
        ;
        $this->database->manipulate($query);
    }

getActivationForRefId()

ilLearningSequenceActivationDB::getActivationForRefId

(

int

$ref_id

)

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

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

                                                      : ilLearningSequenceActivation
    {
        $data = $this->select($ref_id);
        if (count($data) == 0) {
            $settings = $this->buildActivationSettings($ref_id);
            $this->insert($settings);
        } else {
            if ($data['activation_start_ts']) {
                $start = new \DateTime();
                $start->setTimestamp((int) $data['activation_start_ts']);
            } else {
                $start = null;
            }

            if ($data['activation_end_ts']) {
                $end = new \DateTime();
                $end->setTimestamp((int) $data['activation_end_ts']);
            } else {
                $end = null;
            }

            $settings = $this->buildActivationSettings(
                (int) $data['ref_id'],
                (bool) $data['online'],
                (bool) $data['effective_online'],
                $start,
                $end
            );
        }

        return $settings;
    }

Here is the call graph for this function:

insert()

ilLearningSequenceActivationDB::insert ( ilLearningSequenceActivation  $settings )

protected

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

References ilLearningSequenceActivation\getActivationEnd(), ilLearningSequenceActivation\getActivationStart(), ilLearningSequenceActivation\getEffectiveOnlineStatus(), ilLearningSequenceActivation\getIsOnline(), and ilLearningSequenceActivation\getRefId().

Referenced by getActivationForRefId().

                                                                     : void
    {
        $start = $settings->getActivationStart();
        $end = $settings->getActivationEnd();

        if ($start) {
            $start = $start->getTimestamp();
        }

        if ($end) {
            $end = $end->getTimestamp();
        }

        $values = [
            "ref_id" => ["integer", $settings->getRefId()],
            "online" => ["integer", $settings->getIsOnline()],
            "effective_online" => ["integer", $settings->getEffectiveOnlineStatus()],
            "activation_start_ts" => ["integer", $start],
            "activation_end_ts" => ["integer", $end]
        ];

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

Here is the call graph for this function:

Here is the caller graph for this function:

select()

ilLearningSequenceActivationDB::select ( int  $ref_id )

protected

Returns

string[]

Definition at line 129 of file class.ilLearningSequenceActivationDB.php.

Referenced by getActivationForRefId().

                                          : array
    {
        $ret = [];
        $query =
             "SELECT ref_id, online, effective_online, activation_start_ts, activation_end_ts" . PHP_EOL
            . "FROM " . static::TABLE_NAME . PHP_EOL
            . "WHERE ref_id = " . $this->database->quote($ref_id, "integer") . PHP_EOL
        ;

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

        if ($this->database->numRows($result) !== 0) {
            $ret = $this->database->fetchAssoc($result);
        }

        return $ret;
    }

Here is the caller graph for this function:

setEffectiveOnlineStatus()

ilLearningSequenceActivationDB::setEffectiveOnlineStatus	(	int	$ref_id,
		bool	$status
	)

Definition at line 163 of file class.ilLearningSequenceActivationDB.php.

References $ref_id.

                                                                       : void
    {
        $where = ["ref_id" => ["integer", $ref_id]];
        $values = ["effective_online" => ["integer", $status]];

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

store()

ilLearningSequenceActivationDB::store

(

ilLearningSequenceActivation

$settings

)

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

References ilLearningSequenceActivation\getActivationEnd(), ilLearningSequenceActivation\getActivationStart(), ilLearningSequenceActivation\getIsOnline(), and ilLearningSequenceActivation\getRefId().

                                                                 : void
    {
        $where = [
            "ref_id" => ["integer", $settings->getRefId()]
        ];

        $start = $settings->getActivationStart();
        $end = $settings->getActivationEnd();

        if ($start) {
            $start = $start->getTimestamp();
        }

        if ($end) {
            $end = $end->getTimestamp();
        }

        $values = [
            "online" => ["integer", $settings->getIsOnline()],
            "activation_start_ts" => ["integer", $start],
            "activation_end_ts" => ["integer", $end]
        ];

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

Here is the call graph for this function:

Field Documentation

$database

ilDBInterface ilLearningSequenceActivationDB::$database

protected

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

Referenced by __construct().

TABLE_NAME

const ilLearningSequenceActivationDB::TABLE_NAME = 'lso_activation'

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

---

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

• Modules/LearningSequence/classes/Activation/class.ilLearningSequenceActivationDB.php