class.ilMathJaxConfig.php

Go to the documentation of this file.

<?php

declare(strict_types=1);

class ilMathJaxConfig
{
    private const MATHJAX2_DEFAULT_URL = 'https://cdn.jsdelivr.net/npm/mathjax@2.7.9/MathJax.js?config=TeX-AMS-MML_HTMLorMML,Safe';
    private const MATHJAX3_RELATIVE_URL = 'Services/MathJax/js/cdn-mathjax3-es5-tex-mml-chtml-safe.js';

    private const LIMITER_MATHJAX = 0;
    private const LIMITER_TEX = 1;
    private const LIMITER_SPAN = 2;

    protected bool $client_enabled;
    protected string $client_polyfill_url;
    protected string $client_script_url;
    protected int $client_limiter;
    protected bool $server_enabled;
    protected string $server_address;
    protected int $server_timeout;
    protected bool $server_for_browser;
    protected bool $server_for_export;
    protected bool $server_for_pdf;

    public function __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
    ) {
        $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;
    }

    public function getMathJax2DefaultUrl(): string
    {
        return self::MATHJAX2_DEFAULT_URL;
    }

    public function getMathJax3DefaultUrl(): string
    {
        return ILIAS_HTTP_PATH . '/' . self::MATHJAX3_RELATIVE_URL;
    }


    public function isClientEnabled(): bool
    {
        return $this->client_enabled;
    }

    public function getClintPolyfillUrl(): string
    {
        return $this->client_polyfill_url;
    }

    public function getClientScriptUrl(): string
    {
        return $this->client_script_url;
    }

    public function getClientLimiter(): int
    {
        return $this->client_limiter;
    }

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

    public function getClientLimiterStart(): 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 '\(';
        }
    }

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

    public function isServerEnabled(): bool
    {
        return $this->server_enabled;
    }

    public function getServerAddress(): string
    {
        return $this->server_address;
    }

    public function getServerTimeout(): int
    {
        return $this->server_timeout;
    }

    public function isServerForBrowser(): bool
    {
        return $this->server_for_browser;
    }

    public function isServerForExport(): bool
    {
        return $this->server_for_export;
    }

    public function isServerForPdf(): bool
    {
        return $this->server_for_pdf;
    }

    public function withClientEnabled(bool $client_enabled): ilMathJaxConfig
    {
        $clone = clone $this;
        $clone->client_enabled = $client_enabled;
        return $clone;
    }

    public function withClientPolyfillUrl(string $client_js_url): ilMathJaxConfig
    {
        $clone = clone $this;
        $clone->client_polyfill_url = $client_js_url;
        return $clone;
    }

    public function withClientScriptUrl(string $client_async_url): ilMathJaxConfig
    {
        $clone = clone $this;
        $clone->client_script_url = $client_async_url;
        return $clone;
    }

    public function withClientLimiter(int $client_limiter): ilMathJaxConfig
    {
        $clone = clone $this;
        $clone->client_limiter = $client_limiter;
        return $clone;
    }

    public function withServerEnabled(bool $server_enabled): ilMathJaxConfig
    {
        $clone = clone $this;
        $clone->server_enabled = $server_enabled;
        return $clone;
    }

    public function withServerAddress(string $server_address): ilMathJaxConfig
    {
        $clone = clone $this;
        $clone->server_address = $server_address;
        return $clone;
    }

    public function withServerTimeout(int $server_timeout): ilMathJaxConfig
    {
        $clone = clone $this;
        $clone->server_timeout = $server_timeout;
        return $clone;
    }

    public function withServerForBrowser(bool $server_for_browser): ilMathJaxConfig
    {
        $clone = clone $this;
        $clone->server_for_browser = $server_for_browser;
        return $clone;
    }

    public function withServerForExport(bool $server_for_export): ilMathJaxConfig
    {
        $clone = clone $this;
        $clone->server_for_export = $server_for_export;
        return $clone;
    }

    public function withServerForPdf(bool $server_for_pdf): ilMathJaxConfig
    {
        $clone = clone $this;
        $clone->server_for_pdf = $server_for_pdf;
        return $clone;
    }
}