Global Mathjax configuration. More...

Collaboration diagram for ilMathJaxConfig:

Public Member Functions
	__construct (bool $client_enabled, string $client_polyfill_url, string $client_script_url, int $client_limiter, bool $server_enabled, string $server_address, int $server_timeout, bool $server_for_browser, bool $server_for_export, bool $server_for_pdf)
	Constructor. More...

	getMathJax2DefaultUrl ()
	Get the default URL for including MathJax 2. More...

	getMathJax3DefaultUrl ()
	Get the default URL for including MathJax 3. More...

	isClientEnabled ()
	Should latex code be rendered in the browser. More...

	getClintPolyfillUrl ()
	Url of a javascript polyfill (needed by MathJax 3) More...

	getClientScriptUrl ()
	Url of Mathjax script to be embedded with script tag on the page. More...

	getClientLimiter ()
	Type of enclosing limiters for wich the embedded client-side Mathjax is configured. More...

	getClientLimiterOptions ()
	Get the avaliable options for the client limiters. More...

	getClientLimiterStart ()
	Start limiter of Latex code which the client-side Mathjax searches for. More...

	getClientLimiterEnd ()
	End limiter of Latex code which the client-side Mathjax searches for. More...

	isServerEnabled ()
	Is a server side rendering engine configured and enabled. More...

	getServerAddress ()
	Url of Mathjax server. More...

	getServerTimeout ()
	timeout (s) to wait for the result of the rendering server More...

	isServerForBrowser ()
	Should the server-side rendingeing be used for browser output. More...

	isServerForExport ()
	Should the server-side rendingeing be used for HTML exports. More...

	isServerForPdf ()
	Should the server-side rendingeing be used for PDF generation. More...

	withClientEnabled (bool $client_enabled)
	Enable latex code bing rendered in the browser. More...

	withClientPolyfillUrl (string $client_js_url)
	Set the url of a polyfill script neededby MathJax 3. More...

	withClientScriptUrl (string $client_async_url)
	Set the url of Mathjax script to be embedded on the page (for MathJax 3) More...

	withClientLimiter (int $client_limiter)
	Set the type of enclosing limiters for wich the embedded client-side Mathjax is configured. More...

	withServerEnabled (bool $server_enabled)
	Enable a server side rendering engine configured and enabled. More...

	withServerAddress (string $server_address)
	Set the url of the Mathjax server. More...

	withServerTimeout (int $server_timeout)
	Set the timeout (s) to wait for the result of the rendering server. More...

	withServerForBrowser (bool $server_for_browser)
	Enable the server-side rendingeing for browser output. More...

	withServerForExport (bool $server_for_export)
	Enable the server-side rendingeing for HTML exports. More...

	withServerForPdf (bool $server_for_pdf)
	Enable the server-side rendingeing for PDF generation. More...

Protected Attributes
bool	$client_enabled

string	$client_polyfill_url

string	$client_script_url

int	$client_limiter

bool	$server_enabled

string	$server_address

int	$server_timeout

bool	$server_for_browser

bool	$server_for_export

bool	$server_for_pdf

Private Attributes
const	MATHJAX2_DEFAULT_URL = 'https://cdn.jsdelivr.net/npm/mathjax@2.7.9/MathJax.js?config=TeX-AMS-MML_HTMLorMML,Safe'

const	MATHJAX3_RELATIVE_URL = 'Services/MathJax/js/cdn-mathjax3-es5-tex-mml-chtml-safe.js'

const	LIMITER_MATHJAX = 0

const	LIMITER_TEX = 1

const	LIMITER_SPAN = 2

Detailed Description

Global Mathjax configuration.

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

Constructor & Destructor Documentation

◆ __construct()

ilMathJaxConfig::__construct	(	bool	$client_enabled,
		string	$client_polyfill_url,
		string	$client_script_url,
		int	$client_limiter,
		bool	$server_enabled,
		string	$server_address,
		int	$server_timeout,
		bool	$server_for_browser,
		bool	$server_for_export,
		bool	$server_for_pdf
	)

Constructor.

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

      {
        $this->client_enabled = $client_enabled;
        $this->client_polyfill_url = trim($client_polyfill_url);
        $this->client_script_url = trim($client_script_url);
        $this->client_limiter = (in_array(
            $client_limiter,
            [self::LIMITER_MATHJAX, self::LIMITER_TEX, self::LIMITER_SPAN]
        ) ? $client_limiter : self::LIMITER_MATHJAX);
        $this->server_enabled = $server_enabled;
        $this->server_address = trim($server_address);
        $this->server_timeout = (empty($server_timeout) ? 5 : $server_timeout);
        $this->server_for_browser = $server_for_browser;
        $this->server_for_export = $server_for_export;
        $this->server_for_pdf = $server_for_pdf;
    }

References $client_enabled, $client_limiter, $client_polyfill_url, $client_script_url, $server_address, $server_enabled, $server_for_browser, $server_for_export, $server_for_pdf, $server_timeout, and LIMITER_MATHJAX.

Member Function Documentation

◆ getClientLimiter()

ilMathJaxConfig::getClientLimiter ( )

Type of enclosing limiters for wich the embedded client-side Mathjax is configured.

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

                                      : int
    {
        return $this->client_limiter;
    }

References $client_limiter.

Referenced by ilMathJaxSetupConfig\getDataFromConfig(), ilMathJaxSetupConfig\isApplicableTo(), and ilMathJaxConfigSettingsRepository\updateConfig().

Here is the caller graph for this function:

◆ getClientLimiterEnd()

ilMathJaxConfig::getClientLimiterEnd ( )

End limiter of Latex code which the client-side Mathjax searches for.

Definition at line 155 of file class.ilMathJaxConfig.php.

                                         : string
    {
        switch ($this->client_limiter) {
            case self::LIMITER_TEX:
                return '[/tex]';
            case self::LIMITER_SPAN:
                return '</span>';
            case self::LIMITER_MATHJAX:
            default:
                return '\‍)';
        }
    }

References LIMITER_MATHJAX, LIMITER_SPAN, and LIMITER_TEX.

◆ getClientLimiterOptions()

ilMathJaxConfig::getClientLimiterOptions ( )

Get the avaliable options for the client limiters.

Returns: array limiter => display text

Definition at line 127 of file class.ilMathJaxConfig.php.

                                             : array
    {
        return [
            self::LIMITER_MATHJAX => '\&#8203;(...\&#8203;)',
            self::LIMITER_TEX => '[tex]...[/tex]',
            self::LIMITER_SPAN => '&lt;span class="math"&gt;...&lt;/span&gt;'
        ];
    }

◆ getClientLimiterStart()

ilMathJaxConfig::getClientLimiterStart ( )

Start limiter of Latex code which the client-side Mathjax searches for.

Definition at line 139 of file class.ilMathJaxConfig.php.

                                           : string
    {
        switch ($this->client_limiter) {
            case self::LIMITER_TEX:
                return '[tex]';
            case self::LIMITER_SPAN:
                return '<span class="math">';
            case self::LIMITER_MATHJAX:
            default:
                return '\‍(';
        }
    }

References LIMITER_MATHJAX, LIMITER_SPAN, and LIMITER_TEX.

◆ getClientScriptUrl()

ilMathJaxConfig::getClientScriptUrl ( )

Url of Mathjax script to be embedded with script tag on the page.

Definition at line 110 of file class.ilMathJaxConfig.php.

                                        : string
    {
        return $this->client_script_url;
    }

References $client_script_url.

Referenced by ilMathJaxSetupConfig\getDataFromConfig(), ilMathJaxSetupConfig\isApplicableTo(), and ilMathJaxConfigSettingsRepository\updateConfig().

Here is the caller graph for this function:

◆ getClintPolyfillUrl()

ilMathJaxConfig::getClintPolyfillUrl ( )

Url of a javascript polyfill (needed by MathJax 3)

Definition at line 102 of file class.ilMathJaxConfig.php.

                                         : string
    {
        return $this->client_polyfill_url;
    }

References $client_polyfill_url.

Referenced by ilMathJaxSetupConfig\getDataFromConfig(), ilMathJaxSetupConfig\isApplicableTo(), and ilMathJaxConfigSettingsRepository\updateConfig().

Here is the caller graph for this function:

◆ getMathJax2DefaultUrl()

ilMathJaxConfig::getMathJax2DefaultUrl ( )

Get the default URL for including MathJax 2.

Definition at line 77 of file class.ilMathJaxConfig.php.

                                           : string
    {
        return self::MATHJAX2_DEFAULT_URL;
    }

References MATHJAX2_DEFAULT_URL.

◆ getMathJax3DefaultUrl()

ilMathJaxConfig::getMathJax3DefaultUrl ( )

Get the default URL for including MathJax 3.

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

                                           : string
    {
        return ILIAS_HTTP_PATH . '/' . self::MATHJAX3_RELATIVE_URL;
    }

References MATHJAX3_RELATIVE_URL.

◆ getServerAddress()

ilMathJaxConfig::getServerAddress ( )

Url of Mathjax server.

Definition at line 179 of file class.ilMathJaxConfig.php.

                                      : string
    {
        return $this->server_address;
    }

References $server_address.

Referenced by ilMathJaxSetupConfig\getDataFromConfig(), ilMathJaxSetupConfig\isApplicableTo(), and ilMathJaxConfigSettingsRepository\updateConfig().

Here is the caller graph for this function:

◆ getServerTimeout()

ilMathJaxConfig::getServerTimeout ( )

timeout (s) to wait for the result of the rendering server

Definition at line 187 of file class.ilMathJaxConfig.php.

                                      : int
    {
        return $this->server_timeout;
    }

References $server_timeout.

Referenced by ilMathJaxSetupConfig\getDataFromConfig(), and ilMathJaxConfigSettingsRepository\updateConfig().

Here is the caller graph for this function:

◆ isClientEnabled()

ilMathJaxConfig::isClientEnabled ( )

Should latex code be rendered in the browser.

Definition at line 94 of file class.ilMathJaxConfig.php.

                                     : bool
    {
        return $this->client_enabled;
    }

References $client_enabled.

Referenced by ilMathJaxSetupConfig\getDataFromConfig(), ilMathJaxSetupConfig\isApplicableTo(), and ilMathJaxConfigSettingsRepository\updateConfig().

Here is the caller graph for this function:

◆ isServerEnabled()

ilMathJaxConfig::isServerEnabled ( )

Is a server side rendering engine configured and enabled.

Definition at line 171 of file class.ilMathJaxConfig.php.

                                     : bool
    {
        return $this->server_enabled;
    }

References $server_enabled.

Referenced by ilMathJaxSetupConfig\getDataFromConfig(), ilMathJaxSetupConfig\isApplicableTo(), and ilMathJaxConfigSettingsRepository\updateConfig().

Here is the caller graph for this function:

◆ isServerForBrowser()

ilMathJaxConfig::isServerForBrowser ( )

Should the server-side rendingeing be used for browser output.

Definition at line 195 of file class.ilMathJaxConfig.php.

                                        : bool
    {
        return $this->server_for_browser;
    }

References $server_for_browser.

Referenced by ilMathJaxSetupConfig\getDataFromConfig(), ilMathJaxSetupConfig\isApplicableTo(), and ilMathJaxConfigSettingsRepository\updateConfig().

Here is the caller graph for this function:

◆ isServerForExport()

ilMathJaxConfig::isServerForExport ( )

Should the server-side rendingeing be used for HTML exports.

Definition at line 203 of file class.ilMathJaxConfig.php.

                                       : bool
    {
        return $this->server_for_export;
    }

References $server_for_export.

Referenced by ilMathJaxSetupConfig\getDataFromConfig(), ilMathJaxSetupConfig\isApplicableTo(), and ilMathJaxConfigSettingsRepository\updateConfig().

Here is the caller graph for this function:

◆ isServerForPdf()

ilMathJaxConfig::isServerForPdf ( )

Should the server-side rendingeing be used for PDF generation.

Definition at line 211 of file class.ilMathJaxConfig.php.

                                    : bool
    {
        return $this->server_for_pdf;
    }

References $server_for_pdf.

Referenced by ilMathJaxSetupConfig\getDataFromConfig(), ilMathJaxSetupConfig\isApplicableTo(), and ilMathJaxConfigSettingsRepository\updateConfig().

Here is the caller graph for this function:

◆ withClientEnabled()

ilMathJaxConfig::withClientEnabled ( bool $client_enabled )

Enable latex code bing rendered in the browser.

Definition at line 219 of file class.ilMathJaxConfig.php.

                                                           : ilMathJaxConfig
    {
        $clone = clone $this;
        $clone->client_enabled = $client_enabled;
        return $clone;
    }

References $client_enabled.

Referenced by ilMathJaxSetupConfig\applyTo().

Here is the caller graph for this function:

◆ withClientLimiter()

ilMathJaxConfig::withClientLimiter ( int $client_limiter )

Set the type of enclosing limiters for wich the embedded client-side Mathjax is configured.

Definition at line 249 of file class.ilMathJaxConfig.php.

                                                          : ilMathJaxConfig
    {
        $clone = clone $this;
        $clone->client_limiter = $client_limiter;
        return $clone;
    }

References $client_limiter.

Referenced by ilMathJaxSetupConfig\applyTo().

Here is the caller graph for this function:

◆ withClientPolyfillUrl()

ilMathJaxConfig::withClientPolyfillUrl ( string $client_js_url )

Set the url of a polyfill script neededby MathJax 3.

Definition at line 229 of file class.ilMathJaxConfig.php.

                                                                : ilMathJaxConfig
    {
        $clone = clone $this;
        $clone->client_polyfill_url = $client_js_url;
        return $clone;
    }

Referenced by ilMathJaxSetupConfig\applyTo().

Here is the caller graph for this function:

◆ withClientScriptUrl()

ilMathJaxConfig::withClientScriptUrl ( string $client_async_url )

Set the url of Mathjax script to be embedded on the page (for MathJax 3)

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

                                                                 : ilMathJaxConfig
    {
        $clone = clone $this;
        $clone->client_script_url = $client_async_url;
        return $clone;
    }

Referenced by ilMathJaxSetupConfig\applyTo().

Here is the caller graph for this function:

◆ withServerAddress()

ilMathJaxConfig::withServerAddress ( string $server_address )

Set the url of the Mathjax server.

Definition at line 269 of file class.ilMathJaxConfig.php.

                                                             : ilMathJaxConfig
    {
        $clone = clone $this;
        $clone->server_address = $server_address;
        return $clone;
    }

References $server_address.

Referenced by ilMathJaxSetupConfig\applyTo().

Here is the caller graph for this function:

◆ withServerEnabled()

ilMathJaxConfig::withServerEnabled ( bool $server_enabled )

Enable a server side rendering engine configured and enabled.

Definition at line 259 of file class.ilMathJaxConfig.php.

                                                           : ilMathJaxConfig
    {
        $clone = clone $this;
        $clone->server_enabled = $server_enabled;
        return $clone;
    }

References $server_enabled.

Referenced by ilMathJaxSetupConfig\applyTo().

Here is the caller graph for this function:

◆ withServerForBrowser()

ilMathJaxConfig::withServerForBrowser ( bool $server_for_browser )

Enable the server-side rendingeing for browser output.

Definition at line 289 of file class.ilMathJaxConfig.php.

                                                                  : ilMathJaxConfig
    {
        $clone = clone $this;
        $clone->server_for_browser = $server_for_browser;
        return $clone;
    }

References $server_for_browser.

Referenced by ilMathJaxSetupConfig\applyTo().

Here is the caller graph for this function:

◆ withServerForExport()

ilMathJaxConfig::withServerForExport ( bool $server_for_export )

Enable the server-side rendingeing for HTML exports.

Definition at line 299 of file class.ilMathJaxConfig.php.

                                                                : ilMathJaxConfig
    {
        $clone = clone $this;
        $clone->server_for_export = $server_for_export;
        return $clone;
    }

References $server_for_export.

Referenced by ilMathJaxSetupConfig\applyTo().

Here is the caller graph for this function:

◆ withServerForPdf()

ilMathJaxConfig::withServerForPdf ( bool $server_for_pdf )

Enable the server-side rendingeing for PDF generation.

Definition at line 309 of file class.ilMathJaxConfig.php.

                                                          : ilMathJaxConfig
    {
        $clone = clone $this;
        $clone->server_for_pdf = $server_for_pdf;
        return $clone;
    }

References $server_for_pdf.

Referenced by ilMathJaxSetupConfig\applyTo().

Here is the caller graph for this function:

◆ withServerTimeout()

ilMathJaxConfig::withServerTimeout ( int $server_timeout )

Set the timeout (s) to wait for the result of the rendering server.

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

                                                          : ilMathJaxConfig
    {
        $clone = clone $this;
        $clone->server_timeout = $server_timeout;
        return $clone;
    }

References $server_timeout.

Referenced by ilMathJaxSetupConfig\applyTo().

Here is the caller graph for this function:

Field Documentation

◆ $client_enabled

bool ilMathJaxConfig::$client_enabled

protected

Definition at line 33 of file class.ilMathJaxConfig.php.

Referenced by __construct(), isClientEnabled(), and withClientEnabled().

◆ $client_limiter

int ilMathJaxConfig::$client_limiter

protected

Definition at line 36 of file class.ilMathJaxConfig.php.

Referenced by __construct(), getClientLimiter(), and withClientLimiter().

◆ $client_polyfill_url

string ilMathJaxConfig::$client_polyfill_url

protected

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

Referenced by __construct(), and getClintPolyfillUrl().

◆ $client_script_url

string ilMathJaxConfig::$client_script_url

protected

Definition at line 35 of file class.ilMathJaxConfig.php.

Referenced by __construct(), and getClientScriptUrl().

◆ $server_address

string ilMathJaxConfig::$server_address

protected

Definition at line 38 of file class.ilMathJaxConfig.php.

Referenced by __construct(), getServerAddress(), and withServerAddress().

◆ $server_enabled

bool ilMathJaxConfig::$server_enabled

protected

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

Referenced by __construct(), isServerEnabled(), and withServerEnabled().

◆ $server_for_browser

bool ilMathJaxConfig::$server_for_browser

protected

Definition at line 40 of file class.ilMathJaxConfig.php.

Referenced by __construct(), isServerForBrowser(), and withServerForBrowser().

◆ $server_for_export

bool ilMathJaxConfig::$server_for_export

protected

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

Referenced by __construct(), isServerForExport(), and withServerForExport().

◆ $server_for_pdf

bool ilMathJaxConfig::$server_for_pdf

protected

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

Referenced by __construct(), isServerForPdf(), and withServerForPdf().

◆ $server_timeout

int ilMathJaxConfig::$server_timeout

protected

Definition at line 39 of file class.ilMathJaxConfig.php.

Referenced by __construct(), getServerTimeout(), and withServerTimeout().

◆ LIMITER_MATHJAX

const ilMathJaxConfig::LIMITER_MATHJAX = 0

private

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

Referenced by __construct(), getClientLimiterEnd(), and getClientLimiterStart().

◆ LIMITER_SPAN

const ilMathJaxConfig::LIMITER_SPAN = 2

private

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

Referenced by getClientLimiterEnd(), and getClientLimiterStart().

◆ LIMITER_TEX

const ilMathJaxConfig::LIMITER_TEX = 1

private

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

Referenced by getClientLimiterEnd(), and getClientLimiterStart().

◆ MATHJAX2_DEFAULT_URL

const ilMathJaxConfig::MATHJAX2_DEFAULT_URL = 'https://cdn.jsdelivr.net/npm/mathjax@2.7.9/MathJax.js?config=TeX-AMS-MML_HTMLorMML,Safe'

private

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

Referenced by getMathJax2DefaultUrl().

◆ MATHJAX3_RELATIVE_URL

const ilMathJaxConfig::MATHJAX3_RELATIVE_URL = 'Services/MathJax/js/cdn-mathjax3-es5-tex-mml-chtml-safe.js'

private

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

Referenced by getMathJax3DefaultUrl().

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

Services/MathJax/classes/class.ilMathJaxConfig.php

Public Member Functions

Protected Attributes

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ getClientLimiter()

◆ getClientLimiterEnd()

◆ getClientLimiterOptions()

◆ getClientLimiterStart()

◆ getClientScriptUrl()

◆ getClintPolyfillUrl()

◆ getMathJax2DefaultUrl()

◆ getMathJax3DefaultUrl()

◆ getServerAddress()

◆ getServerTimeout()

◆ isClientEnabled()

◆ isServerEnabled()

◆ isServerForBrowser()

◆ isServerForExport()

◆ isServerForPdf()

◆ withClientEnabled()

◆ withClientLimiter()

◆ withClientPolyfillUrl()

◆ withClientScriptUrl()

◆ withServerAddress()

◆ withServerEnabled()

◆ withServerForBrowser()

◆ withServerForExport()

◆ withServerForPdf()

◆ withServerTimeout()

Field Documentation

◆ $client_enabled

◆ $client_limiter

◆ $client_polyfill_url

◆ $client_script_url

◆ $server_address

◆ $server_enabled

◆ $server_for_browser

◆ $server_for_export

◆ $server_for_pdf

◆ $server_timeout

◆ LIMITER_MATHJAX

◆ LIMITER_SPAN

◆ LIMITER_TEX

◆ MATHJAX2_DEFAULT_URL

◆ MATHJAX3_RELATIVE_URL