ilMathJaxSetupConfig Class Reference

Inheritance diagram for ilMathJaxSetupConfig:

Collaboration diagram for ilMathJaxSetupConfig:

Public Member Functions
	__construct (array $data)
	Create the config fron a data array. More...
	getConfig ()
	Get the MathJaxConfig object which is created from the data in config.json. More...
	getDataFromConfig (ilMathJaxConfig $config)
	Get a data array from a config. More...
	isApplicableTo (ilMathJaxConfig $config)
	Check if the setup config can be applied to an existing stored config Only the values that are actually defined in the config.json will be applied The setup config is applicable if at least one setting in config.json is defined and differs fron the stored config. More...
	applyTo (ilMathJaxConfig $config)
	Apply the setup config to an existing stored config Only the values that are actually defined in the config.json will be applied. More...

Protected Attributes
array	$data = []
ilMathJaxConfig	$config

Detailed Description

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

Constructor & Destructor Documentation

__construct()

ilMathJaxSetupConfig::__construct

(

array

$data

)

Create the config fron a data array.

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

References $data.

    {
        $this->data = $data;

        $this->config = new \ilMathJaxConfig(
            (bool) ($this->data['client_enabled'] ?? false),
            (string) ($this->data['client_polyfill_url'] ?? ''),
            (string) ($this->data['client_script_url'] ?? ''),
            (int) ($this->data['client_limiter'] ?? 0),
            (bool) ($this->data['server_enabled'] ?? false),
            (string) ($this->data['server_address'] ?? ''),
            (int) ($this->data['server_timeout'] ?? 0),
            (bool) ($this->data['server_for_browser'] ?? false),
            (bool) ($this->data['server_for_export'] ?? false),
            (bool) ($this->data['server_for_pdf'] ?? false)
        );
    }

Member Function Documentation

applyTo()

ilMathJaxSetupConfig::applyTo

(

ilMathJaxConfig

$config

)

Apply the setup config to an existing stored config Only the values that are actually defined in the config.json will be applied.

Definition at line 103 of file class.ilMathJaxSetupConfig.php.

References $config, ilMathJaxConfig\withClientEnabled(), ilMathJaxConfig\withClientLimiter(), ilMathJaxConfig\withClientPolyfillUrl(), ilMathJaxConfig\withClientScriptUrl(), ilMathJaxConfig\withServerAddress(), ilMathJaxConfig\withServerEnabled(), ilMathJaxConfig\withServerForBrowser(), ilMathJaxConfig\withServerForExport(), ilMathJaxConfig\withServerForPdf(), and ilMathJaxConfig\withServerTimeout().

                                                    : ilMathJaxConfig
    {
        if (isset($this->data['client_enabled'])) {
            $config = $config->withClientEnabled($this->config->isClientEnabled());
        }
        if (isset($this->data['client_polyfill_url'])) {
            $config = $config->withClientPolyfillUrl($this->config->getClintPolyfillUrl());
        }
        if (isset($this->data['client_script_url'])) {
            $config = $config->withClientScriptUrl($this->config->getClientScriptUrl());
        }
        if (isset($this->data['client_limiter'])) {
            $config = $config->withClientLimiter($this->config->getClientLimiter());
        }
        if (isset($this->data['server_enabled'])) {
            $config = $config->withServerEnabled($this->config->isServerEnabled());
        }
        if (isset($this->data['server_address'])) {
            $config = $config->withServerAddress($this->config->getServerAddress());
        }
        if (isset($this->data['server_timeout'])) {
            $config = $config->withServerTimeout($this->config->getServerTimeout());
        }
        if (isset($this->data['server_for_browser'])) {
            $config = $config->withServerForBrowser($this->config->isServerForBrowser());
        }
        if (isset($this->data['server_for_export'])) {
            $config = $config->withServerForExport($this->config->isServerForExport());
        }
        if (isset($this->data['server_for_pdf'])) {
            $config = $config->withServerForPdf($this->config->isServerForPdf());
        }

        return $config;
    }

Here is the call graph for this function:

getConfig()

ilMathJaxSetupConfig::getConfig

(

)

Get the MathJaxConfig object which is created from the data in config.json.

Returns

ilMathJaxConfig

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

References $config.

                               : ilMathJaxConfig
    {
        return $this->config;
    }

getDataFromConfig()

ilMathJaxSetupConfig::getDataFromConfig

(

ilMathJaxConfig

$config

)

Get a data array from a config.

Definition at line 64 of file class.ilMathJaxSetupConfig.php.

References ilMathJaxConfig\getClientLimiter(), ilMathJaxConfig\getClientScriptUrl(), ilMathJaxConfig\getClintPolyfillUrl(), ilMathJaxConfig\getServerAddress(), ilMathJaxConfig\getServerTimeout(), ilMathJaxConfig\isClientEnabled(), ilMathJaxConfig\isServerEnabled(), ilMathJaxConfig\isServerForBrowser(), ilMathJaxConfig\isServerForExport(), and ilMathJaxConfig\isServerForPdf().

                                                              : array
    {
        return [
            'client_enabled' => $config->isClientEnabled(),
            'client_polyfill_url' => $config->getClintPolyfillUrl(),
            'client_script_url' => $config->getClientScriptUrl(),
            'client_limiter' => $config->getClientLimiter(),
            'server_enabled' => $config->isServerEnabled(),
            'server_address' => $config->getServerAddress(),
            'server_timeout' => $config->getServerTimeout(),
            'server_for_browser' => $config->isServerForBrowser(),
            'server_for_export' => $config->isServerForExport(),
            'server_for_pdf' => $config->isServerForPdf()
        ];
    }

Here is the call graph for this function:

isApplicableTo()

ilMathJaxSetupConfig::isApplicableTo

(

ilMathJaxConfig

$config

)

Check if the setup config can be applied to an existing stored config Only the values that are actually defined in the config.json will be applied The setup config is applicable if at least one setting in config.json is defined and differs fron the stored config.

Definition at line 85 of file class.ilMathJaxSetupConfig.php.

References ilMathJaxConfig\getClientLimiter(), ilMathJaxConfig\getClientScriptUrl(), ilMathJaxConfig\getClintPolyfillUrl(), ilMathJaxConfig\getServerAddress(), ilMathJaxConfig\isClientEnabled(), ilMathJaxConfig\isServerEnabled(), ilMathJaxConfig\isServerForBrowser(), ilMathJaxConfig\isServerForExport(), and ilMathJaxConfig\isServerForPdf().

                                                           : bool
    {
        return isset($this->data['client_enabled']) && $this->config->isClientEnabled() !== $config->isClientEnabled()
            || isset($this->data['client_polyfill_url']) && $this->config->getClintPolyfillUrl() !== $config->getClintPolyfillUrl()
            || isset($this->data['client_script_url']) && $this->config->getClientScriptUrl() !== $config->getClientScriptUrl()
            || isset($this->data['client_limiter']) && $this->config->getClientLimiter() !== $config->getClientLimiter()
            || isset($this->data['server_enabled']) && $this->config->isServerEnabled() !== $config->isServerEnabled()
            || isset($this->data['server_address']) && $this->config->getServerAddress() !== $config->getServerAddress()
            || isset($this->data['server_timeout']) && $this->config->getServerAddress() !== $config->getServerAddress()
            || isset($this->data['server_for_browser']) && $this->config->isServerForBrowser() !== $config->isServerForBrowser()
            || isset($this->data['server_for_export']) && $this->config->isServerForExport() !== $config->isServerForExport()
            || isset($this->data['server_for_pdf']) && $this->config->isServerForPdf() !== $config->isServerForPdf();
    }

Here is the call graph for this function:

Field Documentation

$config

ilMathJaxConfig ilMathJaxSetupConfig::$config

protected

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

Referenced by applyTo(), and getConfig().

$data

array ilMathJaxSetupConfig::$data = []

protected

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

Referenced by __construct().

---

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

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