ILIAS\Style\Content\CharacteristicDBRepo Class Reference

Collaboration diagram for ILIAS\Style\Content\CharacteristicDBRepo:

Public Member Functions
	__construct (ilDBInterface $db, InternalDataService $factory)
	addCharacteristic (int $style_id, string $type, string $char, bool $hidden=false, int $order_nr=0, bool $outdated=false)
	exists (int $style_id, string $type, string $char)
	getByKey (int $style_id, string $type, string $characteristic)
	getByType (int $style_id, string $type)
	getByTypes (int $style_id, array $types, bool $include_hidden=true, bool $include_outdated=true)
	getBySuperType (int $style_id, string $super_type)
	Get characteristics by supertype. More...
	saveTitles (int $style_id, string $type, string $characteristic, array $titles)
	Save titles for characteristic. More...
	addTitle (int $style_id, string $type, string $characteristic, string $lang, string $title)
	cloneAllFromStyle (int $from_style_id, int $to_style_id)
	saveHidden (int $style_id, string $type, string $characteristic, bool $hide)
	Save characteristic hidden status. More...
	saveOutdated (int $style_id, string $type, string $characteristic, bool $outdated)
	Save characteristic outdated status. More...
	isOutdated (int $style_id, string $type, string $characteristic)
	saveOrderNr (int $style_id, string $type, string $characteristic, int $order_nr)
	deleteCharacteristic (int $style_id, string $type, string $tag, string $class)
	replaceParameter (int $style_id, string $a_tag, string $a_class, string $a_par, string $a_val, string $a_type, int $a_mq_id=0, bool $a_custom=false)
	getAllParametersOfCharacteristic (int $style_id, string $type, string $characteristic)
	deleteParameter (int $style_id, string $tag, string $class, string $par, string $type, int $mq_id=0, bool $custom=false)
	updateColorName (int $style_id, string $old_name, string $new_name)

Protected Attributes
ilDBInterface	$db
InternalDataService	$factory

Detailed Description

Author

Alexander Killing killi.nosp@m.ng@l.nosp@m.eifos.nosp@m..de

Definition at line 29 of file class.CharacteristicDBRepo.php.

Constructor & Destructor Documentation

__construct()

ILIAS\Style\Content\CharacteristicDBRepo::__construct	(	ilDBInterface	$db,
		InternalDataService	$factory
	)

Definition at line 34 of file class.CharacteristicDBRepo.php.

      {
        $this->db = $db;
        $this->factory = $factory;
    }

References ILIAS\Style\Content\CharacteristicDBRepo\$db, ILIAS\Style\Content\CharacteristicDBRepo\$factory, and factory().

Here is the call graph for this function:

Member Function Documentation

addCharacteristic()

ILIAS\Style\Content\CharacteristicDBRepo::addCharacteristic	(	int	$style_id,
		string	$type,
		string	$char,
		bool	$hidden = false,
		int	$order_nr = 0,
		bool	$outdated = false
	)

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

     : void {
        $db = $this->db;
 
        $db->insert("style_char", [
            "style_id" => ["integer", $style_id],
            "type" => ["text", $type],
            "characteristic" => ["text", $char],
            "hide" => ["integer", $hidden],
            "order_nr" => ["integer", $order_nr],
            "outdated" => ["integer", $outdated]
        ]);
    }

addTitle()

ILIAS\Style\Content\CharacteristicDBRepo::addTitle	(	int	$style_id,
		string	$type,
		string	$characteristic,
		string	$lang,
		string	$title
	)

Definition at line 220 of file class.CharacteristicDBRepo.php.

     : void {
        $db = $this->db;
 
        $db->insert("style_char_title", [
            "style_id" => ["integer", $style_id],
            "type" => ["text", $type],
            "characteristic" => ["text", $characteristic],
            "lang" => ["text", $lang],
            "title" => ["text", $title]
        ]);
    }

cloneAllFromStyle()

ILIAS\Style\Content\CharacteristicDBRepo::cloneAllFromStyle	(	int	$from_style_id,
		int	$to_style_id
	)

Definition at line 239 of file class.CharacteristicDBRepo.php.

     : void {
        $set = $this->db->queryF(
            "SELECT * FROM style_char " .
            " WHERE style_id = %s ",
            ["integer"],
            [$from_style_id]
        );
        while ($rec = $this->db->fetchAssoc($set)) {
            $this->db->insert("style_char", [
                "style_id" => ["integer", $to_style_id],
                "type" => ["text", $rec["type"]],
                "characteristic" => ["text", $rec["characteristic"]],
                "hide" => ["integer", (int) ($rec["hide"] ?? 0)],
                "outdated" => ["integer", (int) ($rec["outdated"] ?? 0)],
                "order_nr" => ["integer", (int) ($rec["order_nr"] ?? 0)]
            ]);
        }
        $set = $this->db->queryF(
            "SELECT * FROM style_char_title " .
            " WHERE style_id = %s ",
            ["integer"],
            [$from_style_id]
        );
        while ($rec = $this->db->fetchAssoc($set)) {
            $this->db->insert("style_char_title", [
                "style_id" => ["integer", $to_style_id],
                "type" => ["text", $rec["type"]],
                "characteristic" => ["text", $rec["characteristic"]],
                "lang" => ["text", $rec["lang"]],
                "title" => ["text", $rec["title"]]
            ]);
        }
    }

deleteCharacteristic()

ILIAS\Style\Content\CharacteristicDBRepo::deleteCharacteristic	(	int	$style_id,
		string	$type,
		string	$tag,
		string	$class
	)

Definition at line 364 of file class.CharacteristicDBRepo.php.

     : void {
        $db = $this->db;
 
        // delete characteristic record
        $db->manipulateF(
            "DELETE FROM style_char WHERE style_id = %s AND type = %s AND characteristic = %s",
            array("integer", "text", "text"),
            array($style_id, $type, $class)
        );
 
        // delete parameter records
        $db->manipulateF(
            "DELETE FROM style_parameter WHERE style_id = %s AND tag = %s AND type = %s AND class = %s",
            array("integer", "text", "text", "text"),
            array($style_id, $tag, $type, $class)
        );
    }

deleteParameter()

ILIAS\Style\Content\CharacteristicDBRepo::deleteParameter	(	int	$style_id,
		string	$tag,
		string	$class,
		string	$par,
		string	$type,
		int	$mq_id = 0,
		bool	$custom = false
	)

Definition at line 461 of file class.CharacteristicDBRepo.php.

     : void {
        $db = $this->db;
 
        $q = "DELETE FROM style_parameter WHERE " .
            " style_id = " . $db->quote($style_id, "integer") . " AND " .
            " tag = " . $db->quote($tag, "text") . " AND " .
            " class = " . $db->quote($class, "text") . " AND " .
            " mq_id = " . $db->quote($mq_id, "integer") . " AND " .
            " custom = " . $db->quote($custom, "integer") . " AND " .
            " " . $db->equals("type", $type, "text", true) . " AND " .
            " parameter = " . $db->quote($par, "text");
 
        $db->manipulate($q);
    }

exists()

ILIAS\Style\Content\CharacteristicDBRepo::exists	(	int	$style_id,
		string	$type,
		string	$char
	)

Definition at line 62 of file class.CharacteristicDBRepo.php.

     : bool {
        $db = $this->db;
 
        $set = $db->queryF(
            "SELECT * FROM style_char " .
            " WHERE style_id = %s AND type = %s AND characteristic = %s",
            ["integer", "text", "text"],
            [$style_id, $type, $char]
        );
        if ($db->fetchAssoc($set)) {
            return true;
        }
        return false;
    }

getAllParametersOfCharacteristic()

ILIAS\Style\Content\CharacteristicDBRepo::getAllParametersOfCharacteristic	(	int	$style_id,
		string	$type,
		string	$characteristic
	)

Definition at line 443 of file class.CharacteristicDBRepo.php.

     : array {
        $set = $this->db->queryF(
            "SELECT * FROM style_parameter " .
            " WHERE style_id = %s AND class = %s AND type = %s",
            ["integer", "string", "string"],
            [$style_id, $characteristic, $type]
        );
        $data = [];
        while ($rec = $this->db->fetchAssoc($set)) {
            $data[] = $rec;
        }
        return $data;
    }

References $data.

getByKey()

ILIAS\Style\Content\CharacteristicDBRepo::getByKey	(	int	$style_id,
		string	$type,
		string	$characteristic
	)

Definition at line 81 of file class.CharacteristicDBRepo.php.

     : ?Characteristic {
        $db = $this->db;
 
        $set = $db->queryF(
            "SELECT * FROM style_char " .
            " WHERE style_id = %s AND type = %s AND characteristic = %s ",
            ["integer", "text", "text"],
            [$style_id, $type, $characteristic]
        );
        if ($rec = $db->fetchAssoc($set)) {
            $set2 = $db->queryF(
                "SELECT * FROM style_char_title " .
                " WHERE style_id = %s AND type = %s AND characteristic = %s ",
                ["integer", "text", "text"],
                [$style_id, $type, $characteristic]
            );
            $titles = [];
            while ($rec2 = $db->fetchAssoc($set2)) {
                $titles[$rec2["lang"]] = $rec2["title"];
            }
            return $this->factory->characteristic(
                $type,
                $characteristic,
                (bool) $rec["hide"],
                $titles,
                $style_id,
                (int) $rec["order_nr"],
                (bool) $rec["outdated"]
            );
        }
        return null;
    }

References factory(), ilDBInterface\fetchAssoc(), and ilDBInterface\queryF().

Here is the call graph for this function:

getBySuperType()

ILIAS\Style\Content\CharacteristicDBRepo::getBySuperType	(	int	$style_id,
		string	$super_type
	)

Get characteristics by supertype.

Returns

Characteristic[]

Definition at line 177 of file class.CharacteristicDBRepo.php.

     : array {
        $stypes = ilObjStyleSheet::_getStyleSuperTypes();
        $types = $stypes[$super_type];
 
        return $this->getByTypes(
            $style_id,
            $types
        );
    }

getByType()

ILIAS\Style\Content\CharacteristicDBRepo::getByType	(	int	$style_id,
		string	$type
	)

Definition at line 118 of file class.CharacteristicDBRepo.php.

     : array {
        return $this->getByTypes(
            $style_id,
            [$type]
        );
    }

getByTypes()

ILIAS\Style\Content\CharacteristicDBRepo::getByTypes	(	int	$style_id,
		array	$types,
		bool	$include_hidden = true,
		bool	$include_outdated = true
	)

Definition at line 128 of file class.CharacteristicDBRepo.php.

     : array {
        $db = $this->db;
 
        $set = $db->queryF(
            "SELECT * FROM style_char " .
            " WHERE style_id = %s AND " . $db->in("type", $types, false, "text") .
            " ORDER BY order_nr, type, characteristic",
            ["integer"],
            [$style_id]
        );
        $chars = [];
        while ($rec = $db->fetchAssoc($set)) {
            if (($rec["hide"] && !$include_hidden) ||
                ($rec["outdated"] && !$include_outdated)) {
                continue;
            }
 
            $set2 = $db->queryF(
                "SELECT * FROM style_char_title " .
                " WHERE style_id = %s AND type = %s AND characteristic = %s ",
                ["integer", "text", "text"],
                [$style_id, $rec["type"], $rec["characteristic"]]
            );
            $titles = [];
            while ($rec2 = $db->fetchAssoc($set2)) {
                $titles[$rec2["lang"]] = $rec2["title"];
            }
            $chars[] = $this->factory->characteristic(
                $rec["type"],
                $rec["characteristic"],
                (bool) $rec["hide"],
                $titles,
                $style_id,
                (int) $rec["order_nr"],
                (bool) $rec["outdated"]
            );
        }
        return $chars;
    }

References factory(), ilDBInterface\fetchAssoc(), and ilDBInterface\queryF().

Here is the call graph for this function:

isOutdated()

ILIAS\Style\Content\CharacteristicDBRepo::isOutdated	(	int	$style_id,
		string	$type,
		string	$characteristic
	)

Definition at line 324 of file class.CharacteristicDBRepo.php.

     : bool {
        $db = $this->db;
 
        $set = $db->queryF(
            "SELECT outdated FROM style_char " .
            " WHERE style_id = %s AND type = %s AND characteristic = %s",
            ["integer", "text", "text"],
            [$style_id, $type, $characteristic]
        );
        if ($rec = $db->fetchAssoc($set)) {
            return (bool) $rec["outdated"];
        }
        return false;
    }

replaceParameter()

ILIAS\Style\Content\CharacteristicDBRepo::replaceParameter	(	int	$style_id,
		string	$a_tag,
		string	$a_class,
		string	$a_par,
		string	$a_val,
		string	$a_type,
		int	$a_mq_id = 0,
		bool	$a_custom = false
	)

Definition at line 391 of file class.CharacteristicDBRepo.php.

     : void {
        $db = $this->db;
 
        $set = $db->queryF(
            "SELECT * FROM style_parameter " .
            " WHERE style_id = %s AND tag = %s AND class = %s AND mq_id = %s " .
            " AND custom = %s AND type = %s AND parameter = %s ",
            ["integer", "text", "text", "integer", "integer", "text", "text"],
            [$style_id, $a_tag, $a_class, $a_mq_id, $a_custom, $a_type, $a_par]
        );
 
        if ($set->fetchRow()) {
            $db->update(
                "style_parameter",
                [
                "value" => ["text", $a_val]
            ],
                [    // where
                    "style_id" => ["integer", $style_id],
                    "tag" => ["text", $a_tag],
                    "class" => ["text", $a_class],
                    "mq_id" => ["integer", $a_mq_id],
                    "custom" => ["integer", $a_custom],
                    "type" => ["text", $a_type],
                    "parameter" => ["text", $a_par]
                ]
            );
        } else {
            $id = $db->nextId("style_parameter");
            $db->insert("style_parameter", [
                "id" => ["integer", $id],
                "value" => ["text", $a_val],
                "style_id" => ["integer", $style_id],
                "tag" => ["text", $a_tag],
                "class" => ["text", $a_class],
                "type" => ["text", $a_type],
                "parameter" => ["text", $a_par],
                "mq_id" => ["integer", $a_mq_id],
                "custom" => ["integer", $a_custom]
            ]);
        }
    }

References ilDBInterface\update().

Here is the call graph for this function:

saveHidden()

ILIAS\Style\Content\CharacteristicDBRepo::saveHidden	(	int	$style_id,
		string	$type,
		string	$characteristic,
		bool	$hide
	)

Save characteristic hidden status.

Definition at line 279 of file class.CharacteristicDBRepo.php.

     : void {
        $db = $this->db;
 
        $db->update(
            "style_char",
            [
            "hide" => ["integer", $hide]
        ],
            [    // where
                "style_id" => ["integer", $style_id],
                "type" => ["text", $type],
                "characteristic" => ["text", $characteristic]
            ]
        );
    }

saveOrderNr()

ILIAS\Style\Content\CharacteristicDBRepo::saveOrderNr	(	int	$style_id,
		string	$type,
		string	$characteristic,
		int	$order_nr
	)

Definition at line 343 of file class.CharacteristicDBRepo.php.

     : void {
        $db = $this->db;
 
        $db->update(
            "style_char",
            [
            "order_nr" => ["integer", $order_nr]
        ],
            [    // where
                "style_id" => ["integer", $style_id],
                "type" => ["text", $type],
                "characteristic" => ["text", $characteristic]
            ]
        );
    }

saveOutdated()

ILIAS\Style\Content\CharacteristicDBRepo::saveOutdated	(	int	$style_id,
		string	$type,
		string	$characteristic,
		bool	$outdated
	)

Save characteristic outdated status.

Definition at line 303 of file class.CharacteristicDBRepo.php.

     : void {
        $db = $this->db;
 
        $db->update(
            "style_char",
            [
            "outdated" => ["integer", $outdated]
        ],
            [    // where
                "style_id" => ["integer", $style_id],
                "type" => ["text", $type],
                "characteristic" => ["text", $characteristic]
            ]
        );
    }

saveTitles()

ILIAS\Style\Content\CharacteristicDBRepo::saveTitles	(	int	$style_id,
		string	$type,
		string	$characteristic,
		array	$titles
	)

Save titles for characteristic.

Definition at line 194 of file class.CharacteristicDBRepo.php.

     : void {
        $db = $this->db;
 
        $db->manipulateF(
            "DELETE FROM style_char_title " .
            " WHERE style_id = %s AND type = %s AND characteristic = %s ",
            ["integer", "text", "text"],
            [$style_id, $type, $characteristic]
        );
 
        foreach ($titles as $l => $title) {
            $this->addTitle(
                $style_id,
                $type,
                $characteristic,
                $l,
                $title
            );
        }
    }

updateColorName()

ILIAS\Style\Content\CharacteristicDBRepo::updateColorName	(	int	$style_id,
		string	$old_name,
		string	$new_name
	)

Definition at line 484 of file class.CharacteristicDBRepo.php.

     : void {
        if ($old_name == $new_name) {
            return;
        }
 
        $db = $this->db;
 
        $color_attributes = [
            "background-color",
            "color",
            "border-color",
            "border-top-color",
            "border-bottom-color",
            "border-left-color",
            "border-right-color",
        ];
 
        $set = $db->queryF(
            "SELECT * FROM style_parameter " .
            " WHERE style_id = %s AND " . $db->in("parameter", $color_attributes, false, "text"),
            ["integer"],
            [$style_id]
        );
        while ($rec = $db->fetchAssoc($set)) {
            if ($rec["value"] == "!" . $old_name ||
                is_int(strpos($rec["value"], "!" . $old_name . "("))) {
                // parameter is based on color -> rename it
                $this->replaceParameter(
                    $style_id,
                    $rec["tag"],
                    $rec["class"],
                    $rec["parameter"],
                    str_replace($old_name, $new_name, $rec["value"]),
                    $rec["type"],
                    $rec["mq_id"],
                    (bool) $rec["custom"]
                );
            }
        }
    }

Field Documentation

$db

ilDBInterface ILIAS\Style\Content\CharacteristicDBRepo::$db

protected

Definition at line 31 of file class.CharacteristicDBRepo.php.

Referenced by ILIAS\Style\Content\CharacteristicDBRepo\__construct().

$factory

InternalDataService ILIAS\Style\Content\CharacteristicDBRepo::$factory

protected

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

Referenced by ILIAS\Style\Content\CharacteristicDBRepo\__construct().

---

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

• components/ILIAS/Style/Content/Characteristic/class.CharacteristicDBRepo.php