ilADNDatabaseObjective Class Reference

Inheritance diagram for ilADNDatabaseObjective:

Collaboration diagram for ilADNDatabaseObjective:

Public Member Functions
	prepare (ilDBInterface $db)
	step_1 ()
	Adds a new table column called 'has_language_limitation' which is used to define whether a notification is only shown for certain languages or if it is shown for all languages. More...
Public Member Functions inherited from ilDatabaseUpdateSteps
	prepare (\ilDBInterface $db)
	Prepare the execution of the steps. More...

Private Member Functions
	abortIfNotPrepared ()
	Halts the execution of these update steps if no database was provided. More...

Private Attributes
ilDBInterface	$database = null

Detailed Description

Author

Lukas Zehnder lukas.nosp@m.@sr..nosp@m.solut.nosp@m.ions

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

Member Function Documentation

abortIfNotPrepared()

ilADNDatabaseObjective::abortIfNotPrepared ( )

private

Halts the execution of these update steps if no database was provided.

Exceptions

LogicException

if the database update steps were not yet prepared.

Definition at line 91 of file class.ilADNDatabaseObjective.php.

References null.

Referenced by step_1().

                                         : void
    {
        if (null === $this->database) {
            throw new LogicException(self::class . '::prepare() must be called before db-update-steps execution.');
        }
    }

Here is the caller graph for this function:

prepare()

ilADNDatabaseObjective::prepare

(

ilDBInterface

$db

)

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

                                              : void
    {
        $this->database = $db;
    }

step_1()

ilADNDatabaseObjective::step_1

(

)

Adds a new table column called 'has_language_limitation' which is used to define whether a notification is only shown for certain languages or if it is shown for all languages.

Also adds a new table column called 'limited_to_languages' which specifies which languages a notification with

the above limitation is shown for.

NOTE: the initial values will be set to 0 and "" respectively so that existing notifications will not be affected.

Definition at line 42 of file class.ilADNDatabaseObjective.php.

References abortIfNotPrepared().

                            : void
    {
        $this->abortIfNotPrepared();

        if (!$this->database->tableExists('il_adn_notifications') ||
            $this->database->tableColumnExists('il_adn_notifications', 'has_language_limitation')
        ) {
            return;
        }
        $this->database->addTableColumn(
            'il_adn_notifications',
            'has_language_limitation',
            [
                'type' => 'integer',
                'length' => 1,
                'notnull' => true,
                'default' => 0,
            ]
        );
        $this->database->manipulate('
            UPDATE il_adn_notifications SET has_language_limitation = 0;
        ');

        if ($this->database->tableColumnExists('il_adn_notifications', 'limited_to_languages')
        ) {
            return;
        }
        $this->database->addTableColumn(
            'il_adn_notifications',
            'limited_to_languages',
            [
                'type' => 'text',
                'length' => 256,
                'notnull' => true,
                'default' => '',
            ]
        );
        $this->database->manipulate('
            UPDATE il_adn_notifications SET limited_to_languages = "[]";
        ');
    }

Here is the call graph for this function:

Field Documentation

$database

ilDBInterface ilADNDatabaseObjective::$database = null

private

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

---

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

• components/ILIAS/AdministrativeNotification/classes/Setup/class.ilADNDatabaseObjective.php