class.ilUserFormSettings.php

Go to the documentation of this file.

<?php

class ilUserFormSettings
{
    protected ilDBInterface $db;
    protected int $user_id;
    protected string $id;
    protected array $settings = []; // Missing array type.
    private bool $has_stored_entry = false;

    public function __construct(
        string $a_id,
        ?int $a_user_id = null
    ) {
        global $DIC;

        $ilDB = $DIC['ilDB'];
        $ilUser = $DIC['ilUser'];

        $this->user_id = (int) $a_user_id;
        $this->id = $a_id;
        $this->db = $ilDB;

        if (!$this->user_id) {
            $this->user_id = $ilUser->getId();
        }

        $this->read();
    }

    public function hasStoredEntry(): bool
    {
        return $this->has_stored_entry;
    }

    public function set(array $a_data): void // Missing array type.
    {
        $this->settings = $a_data;
    }

    public function reset(): void
    {
        $this->settings = [];
    }

    public function enabled(string $a_option): bool
    {
        return (bool) $this->getValue($a_option);
    }

    public function getValue(string $a_option)
    {
        if ($this->valueExists($a_option)) {
            return $this->settings[$a_option];
        }
        return null;
    }

    public function setValue(string $a_option, $a_value): void
    {
        $this->settings[$a_option] = $a_value;
    }

    public function deleteValue(string $a_option): void
    {
        if ($this->valueExists($a_option)) {
            unset($this->settings[$a_option]);
        }
    }

    public function valueExists(string $a_option): bool
    {
        return array_key_exists($a_option, $this->settings);
    }

    public function store(): void
    {
        $this->delete(false);

        $query = "INSERT INTO usr_form_settings (user_id,id,settings) " .
            "VALUES( " .
                $this->db->quote($this->user_id, 'integer') . ", " .
                $this->db->quote($this->id, 'text') . ", " .
                $this->db->quote(serialize($this->settings), 'text') . " " .
            ")";
        $this->db->manipulate($query);
    }

    protected function read(): void
    {
        $query = "SELECT * FROM usr_form_settings" .
            " WHERE user_id = " . $this->db->quote($this->user_id, 'integer') .
            " AND id = " . $this->db->quote($this->id, 'text');
        $res = $this->db->query($query);

        if ($res->numRows()) {
            $this->has_stored_entry = true;
        }

        $this->reset();
        if ($row = $res->fetchRow(ilDBConstants::FETCHMODE_OBJECT)) {
            $this->settings = unserialize($row->settings, ['allowed_classes' => false]);
        }
    }

    public function delete(bool $a_reset = true): void
    {
        $query = "DELETE FROM usr_form_settings" .
            " WHERE user_id = " . $this->db->quote($this->user_id, 'integer') .
            " AND id = " . $this->db->quote($this->id, 'text');
        $this->db->manipulate($query);

        if ($a_reset) {
            $this->reset();
        }
    }

    public static function deleteAllForUser(int $a_user_id): void
    {
        global $DIC;

        $ilDB = $DIC['ilDB'];
        $query = "DELETE FROM usr_form_settings" .
            " WHERE user_id = " . $ilDB->quote($a_user_id, 'integer');
        $ilDB->manipulate($query);
    }

    public static function deleteAllForId(string $a_id): void
    {
        $query = "DELETE FROM usr_form_settings" .
            " WHERE id = " . $GLOBALS['DIC']['ilDB']->quote($a_id, 'text');
        $GLOBALS['DIC']['ilDB']->manipulate($query);
    }

    public static function deleteAllForPrefix(string $a_prefix): void
    {
        $query = "DELETE FROM usr_form_settings " .
            'WHERE ' . $GLOBALS['DIC']['ilDB']->like('id', 'text', $a_prefix . '%');

        $GLOBALS['DIC']['ilDB']->manipulate($query);
    }

    public function importFromForm(ilPropertyFormGUI $a_form): void
    {
        $this->reset();
        $value = null;

        foreach ($a_form->getItems() as $item) {
            if (method_exists($item, "getPostVar")) {
                $field = $item->getPostVar();

                if (method_exists($item, "getDate")) {
                    $value = $item->getDate();
                    if ($value && !$value->isNull()) {
                        $value = $value->get(IL_CAL_DATETIME);
                    }
                } elseif (method_exists($item, "getChecked")) {
                    $value = $item->getChecked();
                } elseif (method_exists($item, "getMulti") && $item->getMulti()) {
                    $value = $item->getMultiValues();
                } elseif (method_exists($item, "getValue")) {
                    $value = $item->getValue();
                }

                $this->setValue($field, $value);
            }
        }
    }

    public function exportToForm(
        ilPropertyFormGUI $a_form,
        bool $a_set_post = false
    ): void {
        foreach ($a_form->getItems() as $item) {
            if (method_exists($item, "getPostVar")) {
                $field = $item->getPostVar();

                if ($this->valueExists($field)) {
                    $value = $this->getValue($field);

                    if (method_exists($item, "setDate")) {
                        $date = new ilDateTime($value, IL_CAL_DATETIME);
                        $item->setDate($date);
                    } elseif (method_exists($item, "setChecked")) {
                        $item->setChecked((bool) $value);
                    } elseif (method_exists($item, "setValue")) {
                        $item->setValue($value);
                    }
                }
            }
        }
    }
}