trait.ilObjFileUsages.php

Go to the documentation of this file.

<?php

trait ilObjFileUsages
{
    // FSX
    public static function _deleteAllUsages($a_type, $a_id, int $a_usage_hist_nr = 0, string $a_usage_lang = "-"): void
    {
        global $DIC;
        $ilDB = $DIC['ilDB'];

        $and_hist = ($a_usage_hist_nr !== false) ? " AND usage_hist_nr = "
            . $ilDB->quote($a_usage_hist_nr, "integer") : "";

        $file_ids = [];
        $set = $ilDB->query(
            "SELECT id FROM file_usage" . " WHERE usage_type = "
            . $ilDB->quote($a_type, "text") . " AND usage_id= "
            . $ilDB->quote($a_id, "integer") . " AND usage_lang= "
            . $ilDB->quote($a_usage_lang, "text") . $and_hist
        );
        while ($row = $ilDB->fetchAssoc($set)) {
            $file_ids[] = $row["id"];
        }

        $ilDB->manipulate(
            "DELETE FROM file_usage WHERE usage_type = "
            . $ilDB->quote($a_type, "text") . " AND usage_id = "
            . $ilDB->quote((int) $a_id, "integer") . " AND usage_lang= "
            . $ilDB->quote($a_usage_lang, "text") . " AND usage_hist_nr = "
            . $ilDB->quote($a_usage_hist_nr, "integer")
        );
    }

    public static function _saveUsage(
        $a_file_id,
        $a_type,
        $a_id,
        int $a_usage_hist_nr = 0,
        string $a_usage_lang = "-"
    ): void {
        global $DIC;
        $ilDB = $DIC['ilDB'];

        // check if file really exists
        if (ilObject::_lookupType($a_file_id) != "file") {
            return;
        }
        // #15143
        $ilDB->replace(
            "file_usage",
            [
            "id" => ["integer", (int) $a_file_id],
            "usage_type" => ["text", (string) $a_type],
            "usage_id" => ["integer", (int) $a_id],
            "usage_hist_nr" => ["integer", $a_usage_hist_nr],
            "usage_lang" => ["text", $a_usage_lang]
        ],
            []
        );
    }

    public function getUsages(): array
    {
        global $DIC;
        $ilDB = $DIC['ilDB'];

        // get usages in learning modules
        $q = "SELECT * FROM file_usage WHERE id = " . $ilDB->quote($this->getId(), "integer");
        $us_set = $ilDB->query($q);
        $ret = [];
        while ($us_rec = $ilDB->fetchAssoc($us_set)) {
            $ret[] = [
                "type" => $us_rec["usage_type"],
                "id" => $us_rec["usage_id"],
                "lang" => $us_rec["usage_lang"],
                "hist_nr" => $us_rec["usage_hist_nr"]
            ];
        }

        return $ret;
    }

    public static function _getFilesOfObject(
        string $a_type,
        int $a_id,
        int $a_usage_hist_nr = 0,
        string $a_usage_lang = "-"
    ): array {
        global $DIC;
        $ilDB = $DIC['ilDB'];

        $lstr = "";
        if ($a_usage_lang != "") {
            $lstr = "usage_lang = " . $ilDB->quote($a_usage_lang, "text") . " AND ";
        }

        // get usages in learning modules
        $q = "SELECT * FROM file_usage WHERE " . "usage_id = " . $ilDB->quote($a_id, "integer")
            . " AND " . "usage_type = " . $ilDB->quote($a_type, "text") . " AND " . $lstr
            . "usage_hist_nr = " . $ilDB->quote($a_usage_hist_nr, "integer");
        $file_set = $ilDB->query($q);
        $ret = [];
        while ($file_rec = $ilDB->fetchAssoc($file_set)) {
            $ret[$file_rec["id"]] = $file_rec["id"];
        }

        return $ret;
    }
}