Class for Server-side generation of latex formulas. More...

Collaboration diagram for ilMathJax:

Public Member Functions
	init ($a_purpose=self::PURPOSE_BROWSER)
	Initialize the usage This must be done before any rendering call. More...

	setRendering ($a_rendering)
	Set the image type rendered by the server. More...

	setDpi ($a_dpi)
	Set the dpi of the rendered images. More...

	setZoomFactor ($a_factor)
	Set the zoom factor for images. More...

	includeMathJax ($a_tpl=null)
	Include Mathjax javascript in a template. More...

	insertLatexImages ($a_text, $a_start='[tex]', $a_end='[/tex]', $a_dir=null, $a_path=null)
	Replace tex tags with formula image code New version of ilUtil::insertLatexImages. More...

	getCacheSize ()
	Get the size of the image cache. More...

	clearCache ()
	Clear the cache of rendered graphics. More...

Static Public Member Functions
static	getInstance ()
	Singleton: get instance. More...

Data Fields
const	PURPOSE_BROWSER = 'browser'

const	PURPOSE_EXPORT = 'export'

const	PURPOSE_PDF = 'pdf'

const	PURPOSE_DEFERRED_PDF = 'deferred_pdf'

const	ENGINE_SERVER = 'server'

const	ENGINE_CLIENT = 'client'

const	ENGINE_MIMETEX = 'mimetex'

const	ENGINE_DEFERRED = 'deferred'

const	ENGINE_NONE = 'none'

const	RENDER_SVG_AS_XML_EMBED = 'svg_as_xml_embed'

const	RENDER_SVG_AS_IMG_EMBED = 'svg_as_img_embed'

const	RENDER_SVG_AS_IMG_FILE = 'svg_as_img_file'

const	RENDER_PNG_AS_IMG_EMBED = 'png_as_img_embed'

const	RENDER_PNG_AS_IMG_FILE = 'png_as_img_file'

const	RENDER_PNG_AS_FO_FILE = 'png_as_fo_file'

Protected Member Functions
	__construct ()
	Singleton: protected constructor. More...

	renderMathJax ($a_tex, $a_output_dir=null, $a_image_path=null)
	Render image from tex code using the MathJax server. More...

	renderMimetex ($a_tex, $a_output_dir=null, $a_image_path=null)
	Render image from tex code using mimetex. More...

Protected Attributes
	$settings = null

	$engine = null

	$mathjax_url = ''

	$start_limiter = ''

	$end_limiter = ''

	$server_address = ''

	$server_timeout = 5

	$rendering = self::RENDER_SVG_AS_XML_EMBED

	$output = 'svg'

	$dpi = 150

	$zoom_factor = 1.0

	$mimetex_url = URL_TO_LATEX

	$mimetex_count = 0

	$use_curl = true

	$cache_dir = ''

	$default_options

Static Protected Attributes
static	$_instance = null

Detailed Description

Class for Server-side generation of latex formulas.

Definition at line 9 of file class.ilMathJax.php.

Constructor & Destructor Documentation

◆ __construct()

ilMathJax::__construct ( )

protected

Singleton: protected constructor.

Definition at line 137 of file class.ilMathJax.php.

References ilUtil\getWebspaceDir(), init(), and settings().

         {
                 // initiate the settings for browser as default
                 include_once "./Services/Administration/classes/class.ilSetting.php";
                 $this->settings = new ilSetting("MathJax");
                 $this->init(self::PURPOSE_BROWSER);
 
                 // set the connection method
                 $this->use_curl = extension_loaded('cURL');
 
                 // set the cache directory
                 $this->cache_dir = ilUtil::getWebspaceDir() . '/temp/tex';
         }

Here is the call graph for this function:

Member Function Documentation

◆ clearCache()

ilMathJax::clearCache ( )

Clear the cache of rendered graphics.

Definition at line 655 of file class.ilMathJax.php.

References ilUtil\delDir().

         {
                 ilUtil::delDir($this->cache_dir);
         }

Here is the call graph for this function:

◆ getCacheSize()

ilMathJax::getCacheSize ( )

Get the size of the image cache.

Returns: string

Definition at line 627 of file class.ilMathJax.php.

References $cache_dir, $counter, $size, array, and ilUtil\dirsize().

         {
                 $cache_dir = realpath($this->cache_dir);
 
                 if (!is_dir($cache_dir))
                 {
                         $size = 0;
                 }
                 else
                 {
                         $size = ilUtil::dirsize($cache_dir);
                 }
 
                 $type = array("k", "M", "G", "T");
                 $size = $size / 1024;
                 $counter = 0;
                 while($size >= 1024)
                 {
                         $size = $size / 1024;
                         $counter++;
                 }
 
                 return(round($size,1)." ".$type[$counter]."B");
         }

Here is the call graph for this function:

◆ getInstance()

static ilMathJax::getInstance ( )

static

Singleton: get instance.

Returns: ilMathJax|null

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

Referenced by ilWikiHTMLExport\buildExportFile(), ilScorm2004Export\buildExportFileHTML(), ilScorm2004Export\buildExportFileHTMLOne(), ilScorm2004Export\buildExportFileISO(), ilScorm2004Export\buildExportFilePDF(), ilScorm2004Export\buildExportFileSCORM(), ilUtil\buildLatexImages(), ilObjExternalToolsSettingsGUI\clearMathJaxCacheObject(), ilCertificate\createPreview(), ilObjExternalToolsSettingsGUI\editMathJaxObject(), ilObjGlossary\exportHTML(), ilObjContentObject\exportHTML(), ilObjBlogGUI\exportHTMLPages(), ilPresentationListTableGUI\fillRow(), ilTermListTableGUI\fillRow(), ilAssSelfAssessmentQuestionFormatter\format(), ilUtil\includeMathjax(), ilUtil\insertLatexImages(), ilCertificate\outCertificate(), ilGlossaryTermGUI\output(), ilForumExportGUI\prepare(), ilPDFGeneration\prepareGeneration(), ilBibliographicDetailsGUI\prepareLatex(), ilForum\prepareText(), ilUtil\prepareTextareaOutput(), ilSurveyEditorGUI\printViewObject(), and ilPageObjectGUI\showPage().

         {
                 if (self::$_instance === NULL) {
                         self::$_instance = new self;
                 }
                 return self::$_instance;
         }

Here is the caller graph for this function:

◆ includeMathJax()

ilMathJax::includeMathJax ( $a_tpl = null )

Include Mathjax javascript in a template.

Parameters

ilTemplate $a_tpl

Definition at line 305 of file class.ilMathJax.php.

References $tpl.

Referenced by init().

         {
                 global $tpl;
 
                 if ($a_tpl == null)
                 {
                         $a_tpl = $tpl;
                 }
 
                 if ($this->engine == self::ENGINE_CLIENT)
                 {
                         $a_tpl->addJavaScript($this->mathjax_url);
                 }
         }

Here is the caller graph for this function:

◆ init()

ilMathJax::init ( $a_purpose = self::PURPOSE_BROWSER )

Initialize the usage This must be done before any rendering call.

Parameters

string $a_purpose purpose of the request

Returns: ilMathJax

Definition at line 169 of file class.ilMathJax.php.

References includeMathJax(), setDpi(), setRendering(), settings(), and setZoomFactor().

Referenced by __construct().

         {
                 // reset the choice of a former initialisation
                 unset($this->engine);
 
                 // try server-side rendering first, set this engine, if possible
                 if ($this->settings->get('enable_server'))
                 {
                         $this->server_address = $this->settings->get('server_address');
                         $this->server_timeout = $this->settings->get('server_timeout');
 
                         if($a_purpose == self::PURPOSE_BROWSER && $this->settings->get('server_for_browser'))
                         {
                                 $this->engine = self::ENGINE_SERVER;
                                 // delivering svg directly in page may be faster than loading image files
                                 $this->setRendering(self::RENDER_SVG_AS_XML_EMBED);
                         }
                         elseif($a_purpose == self::PURPOSE_EXPORT && $this->settings->get('server_for_export'))
                         {
                                 $this->engine = self::ENGINE_SERVER;
                                 // offline pages must always embed the svg as image tags
                                 // otherwise the html base tag may conflict with references in svg
                                 $this->setRendering(self::RENDER_SVG_AS_IMG_EMBED);
                         }
                         elseif($a_purpose == self::PURPOSE_PDF && $this->settings->get('server_for_pdf'))
                         {
                                 $this->engine = self::ENGINE_SERVER;
                                 // embedded png works in TCPDF and should work in most engines
                                 $this->setRendering(self::RENDER_PNG_AS_IMG_EMBED);
                                 $this->setDpi(600);
                                 $this->setZoomFactor(0.17);
 
                         }
                         elseif ($a_purpose == self::PURPOSE_DEFERRED_PDF && $this->settings->get('server_for_pdf'))
                         {
                                 $this->engine = self::ENGINE_DEFERRED;
                         }
                 }
 
                 // if server is not generally enabled or not activated for the intended purpose
                 // then set engine for client-side rendering, if possible
                 if (!isset($this->engine) && $this->settings->get('enable'))
                 {
                         $this->engine = self::ENGINE_CLIENT;
                         $this->mathjax_url = $this->settings->get('path_to_mathjax');
                         $this->includeMathJax();
 
                         switch ((int) $this->settings->get("limiter"))
                         {
                                 case 1:
                                         $this->start_limiter = "[tex]";
                                         $this->end_limiter = "[/tex]";
                                         break;
 
                                 case 2:
                                         $this->start_limiter = '<span class="math">';
                                         $this->end_limiter = '</span>';
                                         break;
 
                                 default:
                                         $this->start_limiter = "\(";
                                         $this->end_limiter = "\)";
                                         break;
                         }
                 }
 
                 // neither server nor client side rendering is enabled
                 // the use the older mimetex as fallback, if configured in ilias.ini.php
                 if (!isset($this->engine) && !empty($this->mimetex_url))
                 {
                         $this->engine = self::ENGINE_MIMETEX;
                 }
 
                 // no engine available or configured
                 if (!isset($this->engine))
                 {
                         $this->engine = self::ENGINE_NONE;
                 }
 
                 return $this;
         }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ insertLatexImages()

ilMathJax::insertLatexImages	(	$a_text,
		$a_start = `'[tex]'`,
		$a_end = `'[/tex]'`,
		$a_dir = `null`,
		$a_path = `null`
	)

Replace tex tags with formula image code New version of ilUtil::insertLatexImages.

Parameters

string	$a_text	text to be converted
string	$a_start	start tag to be searched for
string	$a_end	end tag to be converted
string	$a_dir	output directory for rendered offline image files
string	$a_path	path to be used in the src of offline images

Returns: string replaced text

Definition at line 333 of file class.ilMathJax.php.

References $end_limiter, renderMathJax(), and renderMimetex().

         {
                 // is this replacement still needed?
                 // it was defined in the old ilUtil::insertLatexImages function
                 // perhaps it was related to jsmath
                 if ($this->engine != self::ENGINE_MIMETEX)
                 {
                         $a_text = preg_replace("/\\\\([RZN])([^a-zA-Z]|<\/span>)/", "\\mathbb{"."$1"."}"."$2", $a_text);
                 }
 
                 // this is a fix for bug5362
                 $a_start = str_replace("\\", "", $a_start);
                 $a_end = str_replace("\\", "", $a_end);
 
                 $cpos = 0;
                 while (is_int($spos = stripos($a_text, $a_start, $cpos)))       // find next start
                 {
                         if (is_int($epos = stripos($a_text, $a_end, $spos + strlen($a_start))))
                         {
                                 // extract the tex code inside the delimiters
                                 $tex = substr($a_text, $spos + strlen($a_start), $epos - $spos - strlen($a_start));
 
                                 // undo a code protection done by the deferred engine before
                                 if (substr($tex, 0, 7) == 'base64:')
                                 {
                                         $tex = base64_decode(substr($tex, 7));
                                 }
 
                                 // omit the html newlines added by the ILIAS page editor
                                 // handle custom newlines in JSMath (still needed?)
                                 $tex = str_replace('<br>', '', $tex);
                                 $tex = str_replace('<br/>', '', $tex);
                                 $tex = str_replace('<br />', '', $tex);
                                 $tex = str_replace('\\\\' , '\\cr', $tex);
 
                                 // replace, if tags do not go across div borders
                                 if (!is_int(strpos($tex, '</div>')))
                                 {
                                         switch ($this->engine)
                                         {
                                                 case self::ENGINE_CLIENT:
                                                         // prepare code for processing in the browser
                                                         // add necessary html encodings
                                                         // use the configured mathjax delimiters
                                                         $tex = str_replace('<', '&lt;', $tex);
                                                         $replacement = $this->start_limiter . $tex . $this->end_limiter;
                                                         break;
 
                                                 case self::ENGINE_SERVER:
                                                         // apply server-side processing
                                                         // mathjax-node expects pure tex code
                                                         // so revert any applied html encoding
                                                         $tex = html_entity_decode($tex, ENT_QUOTES, 'UTF-8');
                                                         $replacement = $this->renderMathJax($tex, $a_dir, $a_path);
                                                         break;
 
                                                 case self::ENGINE_MIMETEX:
                                                         // use mimetex
                                                         $replacement = $this->renderMimetex($tex, $a_dir, $a_path);
                                                         break;
 
                                                 case self::ENGINE_DEFERRED:
                                                         // protect code to save it for post production
                                                         $replacement = '[tex]' . 'base64:' . base64_encode($tex) .'[/tex]';
                                                         break;
 
                                                 case self::ENGINE_NONE:
                                                         // show only the pure tex code
                                                         $replacement = htmlspecialchars($tex);
                                                         break;
                                         }
 
                                         // replace tex code with prepared code or generated image
                                         $a_text = substr($a_text, 0, $spos) . $replacement . substr($a_text, $epos + strlen($a_end));
                                 }
                         }
                         $cpos = $spos + 1;
                 }
                 return $a_text;
         }

Here is the call graph for this function:

◆ renderMathJax()

ilMathJax::renderMathJax	(	$a_tex,
		$a_output_dir = `null`,
		$a_image_path = `null`
	)

protected

Render image from tex code using the MathJax server.

Parameters

string	$a_tex	tex code
string	$a_output_dir	directory to save an image file (without trailing slash)
string	$a_image_path	image path to be used in the src attribute (without trailing slash)

Returns: string html code of the rendered image

Definition at line 423 of file class.ilMathJax.php.

References $default_options, $dpi, $file, $html, $options, and array.

Referenced by insertLatexImages().

         {
                 $options = $this->default_options;
                 $options['math'] = $a_tex;
                 $options['dpi'] = $this->dpi;
 
                 switch ($this->output)
                 {
                         case 'png':
                                 $options['svg'] = false;
                                 $options['png'] = true;
                                 $suffix = ".png";
                                 break;
 
                         case 'svg':
                         default:
                                 $options['svg'] = true;
                                 $options['png'] = false;
                                 $suffix = ".svg";
                                 break;
                 }
 
                 // store cached rendered image in cascading sub directories
                 $hash = md5($a_tex . '#' . $this->dpi);
                 $file = $this->cache_dir . '/' . substr($hash, 0, 4) . '/' . substr($hash, 4, 4) . '/' . $hash . $suffix;
 
                 try
                 {
                         if (!is_file($file))
                         {
                                 // file has to be rendered
                                 if ($this->use_curl)
                                 {
                                         $curl = curl_init($this->server_address);
                                         curl_setopt($curl, CURLOPT_HEADER, false);
                                         curl_setopt($curl, CURLOPT_RETURNTRANSFER, true);
                                         curl_setopt($curl, CURLOPT_HTTPHEADER, array("Content-type: application/json"));
                                         curl_setopt($curl, CURLOPT_POST, true);
                                         curl_setopt($curl, CURLOPT_POSTFIELDS, json_encode($options));
                                         curl_setopt($curl, CURLOPT_TIMEOUT, $this->server_timeout);
 
                                         $response = curl_exec($curl);
                                         $status = curl_getinfo($curl, CURLINFO_HTTP_CODE);
                                         curl_close($curl);
 
                                         if ($status != 200)
                                         {
                                                 $lines = explode("\n", $response);
                                                 return "[TeX rendering failed: " . $lines[1] . " " . htmlspecialchars($a_tex) . "]";
                                         }
                                 }
                                 else
                                 {
                                         $context = stream_context_create(
                                                 array(
                                                         'http' => array(
                                                                 'method' => 'POST',
                                                                 'content' => json_encode($options),
                                                                 'header' => "Content-Type: application/json\r\n",
                                                                 'timeout' => $this->server_timeout,
                                                                 'ignore_errors' => true
                                                         )
                                                 ));
                                         $response = @file_get_contents($this->server_address, false, $context);
                                         if (empty($response))
                                         {
                                                 return "[TeX rendering failed: " . htmlspecialchars($a_tex) . "]";
                                         }
                                 }
 
                                 // create the parent directories recursively
                                 @mkdir(dirname($file), 0777, true);
 
                                 // save a rendered image to the temp folder
                                 file_put_contents($file, $response);
                         }
 
                         // handle output of images for offline usage without embedding
                         if (isset($a_output_dir) && is_dir($a_output_dir))
                         {
                                 @copy($file, $a_output_dir . '/' . $hash . $suffix);
                                 $src = $a_image_path . '/' . $hash . $suffix;
                         }
                         else
                         {
                                 $src = ILIAS_HTTP_PATH . '/' . $file;
                         }
 
                         // generate the image tag
                         switch ($this->output)
                         {
                                 case 'png':
                                         list($width, $height) = getimagesize($file);
                                         $width = round($width * $this->zoom_factor);
                                         $height = round($height * $this->zoom_factor);
                                         $mime = 'image/png';
                                         break;
 
                                 case 'svg':
                                 default:
                                         $svg = simplexml_load_file($file);
                                         $width = round($svg['width'] * $this->zoom_factor);
                                         $height = round($svg['height'] * $this->zoom_factor);
                                         $mime = 'image/svg+xml';
                                         break;
                         }
 
 
                         // generate the image tag
                         switch ($this->rendering)
                         {
                                 case self::RENDER_SVG_AS_XML_EMBED:
                                         $html = empty($response) ? file_get_contents($file) : $response;
                                         break;
 
                                 case self::RENDER_SVG_AS_IMG_EMBED:
                                 case self::RENDER_PNG_AS_IMG_EMBED:
                                         $html = '<img src="data:' . $mime . ';base64,'
                                                 . base64_encode(empty($response) ? file_get_contents($file) : $response)
                                                 . '" style="width:' . $width . '; height:' . $height . ';" />';
                                         break;
 
                                 case self::RENDER_SVG_AS_IMG_FILE:
                                 case self::RENDER_PNG_AS_IMG_FILE:
                                         $html = '<img src="' . $src . '" style="width:' . $width . '; height:' . $height . ';" />';
                                         break;
 
                                 case self::RENDER_PNG_AS_FO_FILE:
                                         $html = '<fo:external-graphic src="url(' . realpath($file) . ')"'
                                                 . ' content-height="' . $height . 'px" content-width="' . $width . 'px"></fo:external-graphic>';
                                         break;
 
                                 default:
                                         $html = htmlspecialchars($a_tex);
                                         break;
                         }
 
                         return $html;
                 }
                 catch (Exception $e)
                 {
                         return "[TeX rendering failed: " . $e->getMessage() . "]";
                 }
         }

Here is the caller graph for this function:

◆ renderMimetex()

ilMathJax::renderMimetex	(	$a_tex,
		$a_output_dir = `null`,
		$a_image_path = `null`
	)

protected

Render image from tex code using mimetex.

Parameters

string	$a_tex	tex code
string	$a_output_dir	directory to save an image file (without trailing slash)
string	$a_image_path	image path to be used in the src attribute (without trailing slash)

Returns: string html code of rendered image

Definition at line 577 of file class.ilMathJax.php.

References $html.

Referenced by insertLatexImages().

         {
                 $call = $this->mimetex_url.'?'
                         .rawurlencode(str_replace('&amp;', '&', str_replace('&gt;', '>', str_replace('&lt;', '<', $a_tex))));
 
                 if (empty($a_output_dir))
                 {
                         $html = '<img alt="'.htmlentities($a_tex).'" src="'.$call.'" />';
                 }
                 else
                 {
                         $cnt = $this->mimetex_count++;
 
                         // get image from cgi and write it to file
                         $fpr = @fopen($call, "r");
                         $lcnt = 0;
                         if ($fpr)
                         {
                                 while(!feof($fpr))
                                 {
                                         $buf = fread($fpr, 1024);
                                         if ($lcnt == 0)
                                         {
                                                 if (is_int(strpos(strtoupper(substr($buf, 0, 5)), "GIF")))
                                                 {
                                                         $suffix = "gif";
                                                 }
                                                 else
                                                 {
                                                         $suffix = "png";
                                                 }
                                                 $fpw = fopen($a_output_dir."/img".$cnt.".".$suffix, "w");
                                         }
                                         $lcnt++;
                                         fwrite($fpw, $buf);
                                 }
                                 fclose($fpw);
                                 fclose($fpr);
                         }
 
                         $html = '<img alt="'.htmlentities($a_tex).'" src='.$a_image_path.'/img"'.$cnt.'.'.$suffix.'/'.'" />';
                 }
 
                 return $html;
         }

Here is the caller graph for this function:

◆ setDpi()

ilMathJax::setDpi ( $a_dpi )

Set the dpi of the rendered images.

Parameters

int $a_dpi

Returns: ilMathJax

Definition at line 283 of file class.ilMathJax.php.

Referenced by init().

         {
                 $this->dpi = (float) $a_dpi;
                 return $this;
         }

Here is the caller graph for this function:

◆ setRendering()

ilMathJax::setRendering ( $a_rendering )

Set the image type rendered by the server.

Parameters

string $a_rendering

Returns: ilMathJax

Definition at line 257 of file class.ilMathJax.php.

Referenced by init().

         {
                 switch($a_rendering)
                 {
                         case self::RENDER_SVG_AS_XML_EMBED:
                         case self::RENDER_SVG_AS_IMG_EMBED:
                         case self::RENDER_SVG_AS_IMG_FILE:
                                 $this->rendering = $a_rendering;
                                 $this->output = 'svg';
                                 break;
 
                         case self::RENDER_PNG_AS_IMG_EMBED:
                         case self::RENDER_PNG_AS_IMG_FILE:
                         case self::RENDER_PNG_AS_FO_FILE:
                                 $this->rendering = $a_rendering;
                                 $this->output = 'png';
                                 break;
                 }
                 return $this;
         }

Here is the caller graph for this function:

◆ setZoomFactor()

ilMathJax::setZoomFactor ( $a_factor )

Set the zoom factor for images.

Parameters

float $a_factor

Returns: ilMathJax

Definition at line 294 of file class.ilMathJax.php.

Referenced by init().

         {
                 $this->zoom_factor = (float) $a_factor;
                 return $this;
         }

Here is the caller graph for this function:

Field Documentation

◆ $_instance

ilMathJax::$_instance = null

staticprotected

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

◆ $cache_dir

ilMathJax::$cache_dir = ''

protected

Definition at line 114 of file class.ilMathJax.php.

Referenced by getCacheSize().

◆ $default_options

ilMathJax::$default_options

protected

Initial value:

= array(
                "format" => "TeX",
                "math" => '',           
                "svg" => true,
                "mml" => false,
                "png" => false,
                "speakText" => false,
                "speakRuleset" => "mathspeak",
                "speakStyle"=> "default",
                "ex"=> 6,
                "width"=> 1000000,
                "linebreaks"=> false,
        )

Definition at line 119 of file class.ilMathJax.php.

Referenced by renderMathJax().

◆ $dpi

ilMathJax::$dpi = 150

protected

Definition at line 84 of file class.ilMathJax.php.

Referenced by renderMathJax().

◆ $end_limiter

ilMathJax::$end_limiter = ''

protected

Definition at line 59 of file class.ilMathJax.php.

Referenced by insertLatexImages().

◆ $engine

ilMathJax::$engine = null

protected

Definition at line 44 of file class.ilMathJax.php.

◆ $mathjax_url

ilMathJax::$mathjax_url = ''

protected

Definition at line 49 of file class.ilMathJax.php.

◆ $mimetex_count

ilMathJax::$mimetex_count = 0

protected

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

◆ $mimetex_url

ilMathJax::$mimetex_url = URL_TO_LATEX

protected

Definition at line 97 of file class.ilMathJax.php.

◆ $output

ilMathJax::$output = 'svg'

protected

Definition at line 79 of file class.ilMathJax.php.

◆ $rendering

ilMathJax::$rendering = self::RENDER_SVG_AS_XML_EMBED

protected

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

◆ $server_address

ilMathJax::$server_address = ''

protected

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

◆ $server_timeout

ilMathJax::$server_timeout = 5

protected

Definition at line 69 of file class.ilMathJax.php.

◆ $settings

ilMathJax::$settings = null

protected

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

◆ $start_limiter

ilMathJax::$start_limiter = ''

protected

Definition at line 54 of file class.ilMathJax.php.

◆ $use_curl

ilMathJax::$use_curl = true

protected

Definition at line 109 of file class.ilMathJax.php.

◆ $zoom_factor

ilMathJax::$zoom_factor = 1.0

protected

Definition at line 89 of file class.ilMathJax.php.

◆ ENGINE_CLIENT

const ilMathJax::ENGINE_CLIENT = 'client'

Definition at line 18 of file class.ilMathJax.php.

◆ ENGINE_DEFERRED

const ilMathJax::ENGINE_DEFERRED = 'deferred'

Definition at line 20 of file class.ilMathJax.php.

◆ ENGINE_MIMETEX

const ilMathJax::ENGINE_MIMETEX = 'mimetex'

Definition at line 19 of file class.ilMathJax.php.

◆ ENGINE_NONE

const ilMathJax::ENGINE_NONE = 'none'

Definition at line 21 of file class.ilMathJax.php.

◆ ENGINE_SERVER

const ilMathJax::ENGINE_SERVER = 'server'

Definition at line 17 of file class.ilMathJax.php.

◆ PURPOSE_BROWSER

const ilMathJax::PURPOSE_BROWSER = 'browser'

Definition at line 11 of file class.ilMathJax.php.

◆ PURPOSE_DEFERRED_PDF

const ilMathJax::PURPOSE_DEFERRED_PDF = 'deferred_pdf'

Definition at line 14 of file class.ilMathJax.php.

Referenced by ilScorm2004Export\buildExportFilePDF(), and ilSurveyEditorGUI\printViewObject().

◆ PURPOSE_EXPORT

const ilMathJax::PURPOSE_EXPORT = 'export'

Definition at line 12 of file class.ilMathJax.php.

Referenced by ilWikiHTMLExport\buildExportFile(), ilScorm2004Export\buildExportFileHTML(), ilScorm2004Export\buildExportFileHTMLOne(), ilScorm2004Export\buildExportFileISO(), ilScorm2004Export\buildExportFileSCORM(), ilObjGlossary\exportHTML(), ilObjContentObject\exportHTML(), ilObjBlogGUI\exportHTMLPages(), and ilForumExportGUI\prepare().

◆ PURPOSE_PDF

const ilMathJax::PURPOSE_PDF = 'pdf'

Definition at line 13 of file class.ilMathJax.php.

Referenced by ilScorm2004Export\buildExportFilePDF(), ilCertificate\createPreview(), ilCertificate\outCertificate(), ilPDFGeneration\prepareGeneration(), and ilSurveyEditorGUI\printViewObject().

◆ RENDER_PNG_AS_FO_FILE

const ilMathJax::RENDER_PNG_AS_FO_FILE = 'png_as_fo_file'

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

Referenced by ilScorm2004Export\buildExportFilePDF(), ilCertificate\createPreview(), ilCertificate\outCertificate(), and ilSurveyEditorGUI\printViewObject().

◆ RENDER_PNG_AS_IMG_EMBED

const ilMathJax::RENDER_PNG_AS_IMG_EMBED = 'png_as_img_embed'

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

◆ RENDER_PNG_AS_IMG_FILE

const ilMathJax::RENDER_PNG_AS_IMG_FILE = 'png_as_img_file'

Definition at line 28 of file class.ilMathJax.php.

◆ RENDER_SVG_AS_IMG_EMBED

const ilMathJax::RENDER_SVG_AS_IMG_EMBED = 'svg_as_img_embed'

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

◆ RENDER_SVG_AS_IMG_FILE

const ilMathJax::RENDER_SVG_AS_IMG_FILE = 'svg_as_img_file'

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

◆ RENDER_SVG_AS_XML_EMBED

const ilMathJax::RENDER_SVG_AS_XML_EMBED = 'svg_as_xml_embed'

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

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

Services/MathJax/classes/class.ilMathJax.php

Public Member Functions

Static Public Member Functions

Data Fields

Protected Member Functions

Protected Attributes

Static Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ clearCache()

◆ getCacheSize()

◆ getInstance()

◆ includeMathJax()

◆ init()

◆ insertLatexImages()

◆ renderMathJax()

◆ renderMimetex()

◆ setDpi()

◆ setRendering()

◆ setZoomFactor()

Field Documentation

◆ $_instance

◆ $cache_dir

◆ $default_options

◆ $dpi

◆ $end_limiter

◆ $engine

◆ $mathjax_url

◆ $mimetex_count

◆ $mimetex_url

◆ $output

◆ $rendering

◆ $server_address

◆ $server_timeout

◆ $settings

◆ $start_limiter

◆ $use_curl

◆ $zoom_factor

◆ ENGINE_CLIENT

◆ ENGINE_DEFERRED

◆ ENGINE_MIMETEX

◆ ENGINE_NONE

◆ ENGINE_SERVER

◆ PURPOSE_BROWSER

◆ PURPOSE_DEFERRED_PDF

◆ PURPOSE_EXPORT

◆ PURPOSE_PDF

◆ RENDER_PNG_AS_FO_FILE

◆ RENDER_PNG_AS_IMG_EMBED

◆ RENDER_PNG_AS_IMG_FILE

◆ RENDER_SVG_AS_IMG_EMBED

◆ RENDER_SVG_AS_IMG_FILE

◆ RENDER_SVG_AS_XML_EMBED