ilMathJaxConfigCheckedObjective Class Reference

Inheritance diagram for ilMathJaxConfigCheckedObjective:

Collaboration diagram for ilMathJaxConfigCheckedObjective:

Public Member Functions
	__construct (?\ilMathJaxSetupConfig $setup_config=null)
	getHash ()
	getLabel ()
	isNotable ()
	getPreconditions (Setup\Environment $environment)
	isApplicable (Setup\Environment $environment)

Protected Member Functions
	checkClientScriptUrl (ilMathJaxConfig $config, Setup\AdminInteraction $interaction)
	Check if an outdated script URL is used. More...

Protected Attributes
ilMathJaxSetupConfig	$setup_config = null

Detailed Description

Definition at line 23 of file class.ilMathJaxConfigCheckedObjective.php.

Constructor & Destructor Documentation

__construct()

ilMathJaxConfigCheckedObjective::__construct

(

?\ilMathJaxSetupConfig

$setup_config = null

)

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

References $setup_config.

    {
        $this->setup_config = $setup_config;
    }

Member Function Documentation

checkClientScriptUrl()

ilMathJaxConfigCheckedObjective::checkClientScriptUrl ( ilMathJaxConfig  $config, Setup\AdminInteraction  $interaction  )

protected

Check if an outdated script URL is used.

Definition at line 74 of file class.ilMathJaxConfigCheckedObjective.php.

References ilMathJaxConfig\getClientScriptUrl().

Referenced by getPreconditions().

                                                                                                         : void
    {
        $recommended = 'https://YOUR_ILIAS_URL/assets/js/cdn-mathjax2-tex-mml-chtml-safe.js';

        if (str_contains($config->getClientScriptUrl(), '?')) {
            $interaction->inform("ILIAS 10 cuts query params of javascript URLs that are added to the page."
                . " Please replace your MathJax URL with $recommended or a similar script that sets the save mode of MathJax!");

            if ($this->setup_config !== null && str_contains($this->setup_config->getConfig()->getClientScriptUrl(), '?')) {
                $interaction->inform("Change the URL in the setup.json to avoid this message in the next update.");
            }
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getHash()

ilMathJaxConfigCheckedObjective::getHash

(

)

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

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

getLabel()

ilMathJaxConfigCheckedObjective::getLabel

(

)

Definition at line 37 of file class.ilMathJaxConfigCheckedObjective.php.

                              : string
    {
        return "Check configuration of Services/MathJax";
    }

getPreconditions()

ilMathJaxConfigCheckedObjective::getPreconditions

(

Setup\Environment

$environment

)

Definition at line 47 of file class.ilMathJaxConfigCheckedObjective.php.

References checkClientScriptUrl().

                                                                    : array
    {
        return [
            new \ilSettingsFactoryExistsObjective()
        ];
    }

Here is the call graph for this function:

isApplicable()

ilMathJaxConfigCheckedObjective::isApplicable

(

Setup\Environment

$environment

)

Definition at line 66 of file class.ilMathJaxConfigCheckedObjective.php.

                                                                : bool
    {
        return true;
    }

isNotable()

ilMathJaxConfigCheckedObjective::isNotable

(

)

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

                               : bool
    {
        return false;
    }

Field Documentation

$setup_config

ilMathJaxSetupConfig ilMathJaxConfigCheckedObjective::$setup_config = null

protected

Definition at line 25 of file class.ilMathJaxConfigCheckedObjective.php.

Referenced by __construct().

---

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

• components/ILIAS/MathJax/classes/Setup/class.ilMathJaxConfigCheckedObjective.php