ilFileObjectDatabaseObjective Class Reference

Inheritance diagram for ilFileObjectDatabaseObjective:

Collaboration diagram for ilFileObjectDatabaseObjective:

Public Member Functions
	prepare (ilDBInterface $db)
	step_1 ()
	adds a new table column called 'direct_download' that is used to determine if the on-click action in the ilObjFileListGUI should download the file directly or redirect to the objects info-page. More...
	step_2 ()
	adds a new table column called 'downloads' which is used to keep track of the actual amount of downloads of a file object. More...
	step_3 ()
	sets the default visibility of the amount of downloads to visible ('1' or true). More...
	step_4 ()
	adds two new tables to store data concerning suffix-specific icons for files More...
	step_5 ()
	step_6 ()
	Adds a new table column called 'important_info' to store important information regarding a file such as work instructions. More...
	step_7 ()
	This step sets all files which were created before the "centralizing online/offline status" feature to online. 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

Thibeau Fuhrer thibe.nosp@m.au@s.nosp@m.r.sol.nosp@m.utio.nosp@m.ns AutoloadingIssuesInspection

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

Member Function Documentation

abortIfNotPrepared()

ilFileObjectDatabaseObjective::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 227 of file class.ilFileObjectDatabaseObjective.php.

References null.

Referenced by step_1(), step_2(), step_3(), step_4(), and step_6().

                                         : 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()

ilFileObjectDatabaseObjective::prepare

(

ilDBInterface

$db

)

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

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

step_1()

ilFileObjectDatabaseObjective::step_1

(

)

adds a new table column called 'direct_download' that is used to determine if the on-click action in the ilObjFileListGUI should download the file directly or redirect to the objects info-page.

---

NOTE: this won't affect the default-behaviour which currently downloads the file directly, since '1' or true is added as the default value to the new column.

Definition at line 46 of file class.ilFileObjectDatabaseObjective.php.

References abortIfNotPrepared(), and ilObjFile\CLICK_MODE_DOWNLOAD.

                            : void
    {
        $this->abortIfNotPrepared();
        if ($this->database->tableExists('file_data')) {
            $this->database->addTableColumn(
                'file_data',
                'on_click_mode',
                [
                    'type' => 'integer',
                    'length' => '1',
                    'notnull' => '1',
                    'default' => ilObjFile::CLICK_MODE_DOWNLOAD,
                ]
            );
        }
    }

Here is the call graph for this function:

step_2()

ilFileObjectDatabaseObjective::step_2

(

)

adds a new table column called 'downloads' which is used to keep track of the actual amount of downloads of a file object.

---

NOTE: the initial value will be the collective sum of read_count from the database table read_event of the tracking service. This will not be an accurate representation of the download count, but provides at least some insight.

Definition at line 72 of file class.ilFileObjectDatabaseObjective.php.

References abortIfNotPrepared().

                            : void
    {
        $this->abortIfNotPrepared();
        if (!$this->database->tableExists('file_data')) {
            return;
        }
        if ($this->database->tableColumnExists('file_data', 'downloads')) {
            return;
        }

        $this->database->addTableColumn(
            'file_data',
            'downloads',
            [
                'type' => 'integer',
                'length' => 8,
                'notnull' => false,
                'default' => 0 // will be adjusted in an update query.
            ]
        );

        $this->database->manipulate(
            "
            UPDATE file_data SET downloads = (
                SELECT COALESCE(SUM(read_event.read_count), 0) FROM read_event 
                    WHERE read_event.obj_id = file_data.file_id
            );
        "
        );
    }

Here is the call graph for this function:

step_3()

ilFileObjectDatabaseObjective::step_3

(

)

sets the default visibility of the amount of downloads to visible ('1' or true).

copied from

See also

ilSetting::set()

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

References abortIfNotPrepared().

                            : void
    {
        $this->abortIfNotPrepared();

        $this->database->insert(
            'settings',
            [
                'module' => ['text', General::MODULE_NAME],
                'keyword' => ['text', General::F_SHOW_AMOUNT_OF_DOWNLOADS],
                'value' => ['text', '1'],
            ]
        );
    }

Here is the call graph for this function:

step_4()

ilFileObjectDatabaseObjective::step_4

(

)

adds two new tables to store data concerning suffix-specific icons for files

Definition at line 124 of file class.ilFileObjectDatabaseObjective.php.

References abortIfNotPrepared().

                            : void
    {
        $this->abortIfNotPrepared();
        if (!$this->database->tableExists(IconDatabaseRepository::ICON_TABLE_NAME)) {
            $this->database->createTable(
                IconDatabaseRepository::ICON_TABLE_NAME,
                [
                    IconDatabaseRepository::ICON_RESOURCE_IDENTIFICATION => [
                        'type' => 'text',
                        'length' => 64,
                        'notnull' => true,
                        'default' => '',
                    ],
                    IconDatabaseRepository::ICON_ACTIVE => [
                        'type' => 'integer',
                        'length' => 1,
                        'notnull' => false,
                        'default' => 0,
                    ],
                    IconDatabaseRepository::IS_DEFAULT_ICON => [
                        'type' => 'integer',
                        'length' => 1,
                        'notnull' => false,
                        'default' => 0,
                    ]
                ]
            );
        }
        if (!$this->database->tableExists(IconDatabaseRepository::SUFFIX_TABLE_NAME)) {
            $this->database->createTable(
                IconDatabaseRepository::SUFFIX_TABLE_NAME,
                [
                    IconDatabaseRepository::ICON_RESOURCE_IDENTIFICATION => [
                        'type' => 'text',
                        'length' => 64,
                        'notnull' => true,
                        'default' => '',
                    ],
                    IconDatabaseRepository::SUFFIX => [
                        'type' => 'text',
                        'length' => 32,
                        'notnull' => false,
                        'default' => '',
                    ]
                ]
            );
        }
    }

Here is the call graph for this function:

step_5()

ilFileObjectDatabaseObjective::step_5

(

)

Definition at line 173 of file class.ilFileObjectDatabaseObjective.php.

                            : void
    {
        // replace wrong suffixes. currently they are stored with e.g. icon_file_docx and should be docx.
        // update the whole table with a replace statement.
        $this->database->manipulate(
            "UPDATE il_file_icon_suffixes SET suffix = REPLACE(suffix, 'icon_file_', '') WHERE suffix LIKE 'icon_file_%';"
        );
    }

step_6()

ilFileObjectDatabaseObjective::step_6

(

)

Adds a new table column called 'important_info' to store important information regarding a file such as work instructions.

Definition at line 186 of file class.ilFileObjectDatabaseObjective.php.

References abortIfNotPrepared(), and null.

                            : void
    {
        $this->abortIfNotPrepared();
        if (!$this->database->tableExists('file_data')) {
            return;
        }
        if ($this->database->tableColumnExists(
            'file_data',
            'important_info'
        )) {
            return;
        }
        $this->database->addTableColumn(
            'file_data',
            'important_info',
            [
                'type' => 'blob',
                'notnull' => false,
                'default' => null
            ]
        );
    }

Here is the call graph for this function:

step_7()

ilFileObjectDatabaseObjective::step_7

(

)

This step sets all files which were created before the "centralizing online/offline status" feature to online.

It will update the offline value in the table object_data of each object of type file whose offline value currently is null (as this was not set for files before the feature) to 0 (online), which is the new default online status for files.

Definition at line 215 of file class.ilFileObjectDatabaseObjective.php.

                            : void
    {
        $query = "UPDATE `object_data` SET `offline` = 0 WHERE `type` = \"file\" AND `offline` IS NULL";
        $this->database->manipulate($query);
    }

Field Documentation

$database

ilDBInterface ilFileObjectDatabaseObjective::$database = null

private

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

---

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

• components/ILIAS/File/classes/Setup/Database/class.ilFileObjectDatabaseObjective.php