ilStyleClassAddedObjective Class Reference

Inheritance diagram for ilStyleClassAddedObjective:

Collaboration diagram for ilStyleClassAddedObjective:

Public Member Functions
	__construct (string $class, string $type, string $tag, array $parameters=[], int $hide=0)
	getHash ()
	getLabel ()
	isNotable ()
	getPreconditions (Environment $environment)
	achieve (Environment $environment)
	isApplicable (Environment $environment)

Protected Attributes
string	$class
string	$type
string	$tag
array	$parameters
int	$hide

Detailed Description

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

Constructor & Destructor Documentation

__construct()

ilStyleClassAddedObjective::__construct	(	string	$class,
		string	$type,
		string	$tag,
		array	$parameters = [],
		int	$hide = 0
	)

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

References $hide, $parameters, $tag, $type, and ILIAS\UI\examples\Prompt\Standard\parameters().

    {
        $this->class = $class;
        $this->type = $type;
        $this->tag = $tag;
        $this->parameters = $parameters;
        $this->hide = $hide;
    }

Here is the call graph for this function:

Member Function Documentation

achieve()

ilStyleClassAddedObjective::achieve

(

Environment

$environment

)

Definition at line 63 of file class.ilStyleClassAddedObjective.php.

References $class, $hide, $res, $tag, $type, ILIAS\Setup\Environment\getResource(), and ILIAS\UI\examples\Prompt\Standard\parameters().

                                                     : Environment
    {
        $db = $environment->getResource(Environment::RESOURCE_DATABASE);

        $sql =
            "SELECT obj_id" . PHP_EOL
            . "FROM object_data" . PHP_EOL
            . "WHERE type = 'sty'" . PHP_EOL
        ;
        $result = $db->query($sql);

        while ($row = $db->fetchAssoc($result)) {
            $sql =
                "SELECT style_id, type, characteristic, hide" . PHP_EOL
                . "FROM style_char" . PHP_EOL
                . "WHERE style_id = " . $db->quote($row["obj_id"], "integer") . PHP_EOL
                . "AND characteristic = " . $db->quote($this->class, "text") . PHP_EOL
                . "AND type = " . $db->quote($this->type, "text") . PHP_EOL
            ;
            $res = $db->query($sql);

            if (!$db->fetchAssoc($res)) {
                $values = [
                    "style_id" => ["integer", $row["obj_id"]],
                    "type" => ["text", $this->type],
                    "characteristic" => ["text", $this->class],
                    "hide" => ["integer", $this->hide]
                ];
                $db->insert("style_char", $values);

                foreach ($this->parameters as $k => $v) {
                    $spid = $db->nextId("style_parameter");
                    $values = [
                        "id" => ["integer", $spid],
                        "style_id" => ["integer", $row["obj_id"]],
                        "tag" => ["text", $this->tag],
                        "class" => ["text", $this->class],
                        "parameter" => ["text", $k],
                        "value" => ["text", $v],
                        "type" => ["text", $this->type]
                    ];
                    $db->insert("style_parameter", $values);
                }
            }
        }

        return $environment;
    }

Here is the call graph for this function:

getHash()

ilStyleClassAddedObjective::getHash

(

)

Definition at line 41 of file class.ilStyleClassAddedObjective.php.

                             : string
    {
        return hash("sha256", self::class);
    }

getLabel()

ilStyleClassAddedObjective::getLabel

(

)

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

                              : string
    {
        return "Add style class";
    }

getPreconditions()

ilStyleClassAddedObjective::getPreconditions

(

Environment

$environment

)

Definition at line 56 of file class.ilStyleClassAddedObjective.php.

                                                              : array
    {
        return [
            new ilDatabaseInitializedObjective()
        ];
    }

isApplicable()

ilStyleClassAddedObjective::isApplicable

(

Environment

$environment

)

Definition at line 112 of file class.ilStyleClassAddedObjective.php.

References $res, and ILIAS\Setup\Environment\getResource().

                                                          : bool
    {
        $db = $environment->getResource(Environment::RESOURCE_DATABASE);

        $sql =
            "SELECT obj_id" . PHP_EOL
            . "FROM object_data" . PHP_EOL
            . "WHERE type = 'sty'" . PHP_EOL
        ;

        $result = $db->query($sql);

        while ($row = $db->fetchAssoc($result)) {
            $sql =
                "SELECT style_id, type, characteristic, hide" . PHP_EOL
                . "FROM style_char" . PHP_EOL
                . "WHERE style_id = " . $db->quote($row["obj_id"], "integer") . PHP_EOL
                . "AND characteristic = " . $db->quote($this->class, "text") . PHP_EOL
                . "AND type = " . $db->quote($this->type, "text") . PHP_EOL;
            $res = $db->query($sql);

            // return true if no entry exists in style_char for obj_id from object_data
            if ($db->numRows($res) == 0) {
                return true;
            }
        }

        return false;
    }

Here is the call graph for this function:

isNotable()

ilStyleClassAddedObjective::isNotable

(

)

Definition at line 51 of file class.ilStyleClassAddedObjective.php.

                               : bool
    {
        return true;
    }

Field Documentation

$class

string ilStyleClassAddedObjective::$class

protected

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

Referenced by achieve().

$hide

int ilStyleClassAddedObjective::$hide

protected

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

Referenced by __construct(), and achieve().

$parameters

array ilStyleClassAddedObjective::$parameters

protected

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

Referenced by __construct().

$tag

string ilStyleClassAddedObjective::$tag

protected

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

Referenced by __construct(), and achieve().

$type

string ilStyleClassAddedObjective::$type

protected

Definition at line 27 of file class.ilStyleClassAddedObjective.php.

Referenced by __construct(), and achieve().

---

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

• components/ILIAS/Style/classes/Setup/class.ilStyleClassAddedObjective.php