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 and try to correct it. 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 and try to correct it.

Correct automatically if MathJax in the browser is not enabled (change an old default setting)
Ask if MathJax in the browser is enabled
Warn if an outdated URL is used in the config.json

Return a config object which has to be saved, if changes are made

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

References ilMathJaxConfig\getClientScriptUrl(), ilMathJaxConfig\isClientEnabled(), and ilMathJaxConfig\withClientScriptUrl().

Referenced by getPreconditions().

                                                                                                          : ?ilMathJaxConfig
     {
         $change = false;
         $recommended = 'https://cdn.jsdelivr.net/npm/mathjax@2.7.9/MathJax.js?config=TeX-AMS-MML_HTMLorMML,Safe';
         $outdated = [
             'https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.1/MathJax.js?config=TeX-AMS-MML_HTMLorMML',
             'https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.1/MathJax.js?config=TeX-AMS-MML_HTMLorMML,Safe',
             'https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.9/MathJax.js?config=TeX-AMS-MML_HTMLorMML',
             'https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.9/MathJax.js?config=TeX-AMS-MML_HTMLorMML,Safe',
             'https://cdn.jsdelivr.net/npm/mathjax@2.7.1/MathJax.js?config=TeX-AMS-MML_HTMLorMML',
             'https://cdn.jsdelivr.net/npm/mathjax@2.7.9/MathJax.js?config=TeX-AMS-MML_HTMLorMML'
         ];
 
         if (in_array($config->getClientScriptUrl(), $outdated)) {
             if ($config->isClientEnabled()) {
                 $change = $interaction->confirmOrDeny("Replace outdated or unsave MathJax URL with $recommended ?");
             } else {
                 $interaction->inform("Replaced inactive outdated MathJax URL with $recommended");
                 $change = true;
             }
         }
         if ($change
             && $this->setup_config !== null
             && in_array($this->setup_config->getConfig()->getClientScriptUrl(), $outdated)
         ) {
             $interaction->inform("Please change the URL in the setup.json to avoid this message in the next update.");
         }
 
         if ($change) {
             return $config->withClientScriptUrl($recommended);
         }
         return null;
     }

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(), and ilMathJaxConfigSettingsRepository\updateConfig().

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

Here is the call graph for this function:

◆ isApplicable()

ilMathJaxConfigCheckedObjective::isApplicable ( Setup\Environment $environment )

Definition at line 68 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:

Services/MathJax/classes/Setup/class.ilMathJaxConfigCheckedObjective.php

Public Member Functions

Protected Member Functions

Protected Attributes