ilMathJaxImage Class Reference

Rendered MathJax image Supports image types SVG or PNG Files are stored in the web file system of ilias. More...

Collaboration diagram for ilMathJaxImage:

Public Member Functions
	__construct (string $a_tex, string $a_type, int $a_dpi)
	absolutePath ()
	Get the absolute path of the image. More...
	exists ()
	Check if an image is cached. More...
	read ()
	Read the content of a cached image. More...
	write (string $a_content)
	Save the content of a cached image. More...
	getCacheSize ()
	Get the total size of the cache with an appropriate unit for display. More...
	clearCache ()
	Delete all files from the cache. More...

Protected Member Functions
	filepath ()
	Create the relative file path of the image. More...

Protected Attributes
ILIAS Filesystem Filesystem	$fs
string	$basepath = '/temp/tex'
string	$tex
string	$suffix
string	$salt

Private Attributes
const	TYPE_PNG = 'png'
const	TYPE_SVG = 'svg'

Detailed Description

Rendered MathJax image Supports image types SVG or PNG Files are stored in the web file system of ilias.

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

Constructor & Destructor Documentation

__construct()

ilMathJaxImage::__construct	(	string	$a_tex,
		string	$a_type,
		int	$a_dpi
	)

Parameters

string	$a_tex	latex code
string	$a_type	image type ('png' or 'svg')
int	$a_dpi	dpi of rendered image

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

    {
        global $DIC;
 
        $this->fs = $DIC->filesystem()->web();
        $this->tex = $a_tex;
 
        switch ($a_type) {
            case self::TYPE_PNG:
                $this->suffix = '.png';
                break;
            case self::TYPE_SVG:
                $this->suffix = '.svg';
                break;
            default:
                throw new ilMathJaxException('imagetype not supported');
        }
 
        $this->salt = '#' . $a_dpi;
    }

References $DIC, TYPE_PNG, and TYPE_SVG.

Member Function Documentation

absolutePath()

ilMathJaxImage::absolutePath

(

)

Get the absolute path of the image.

Definition at line 100 of file class.ilMathJaxImage.php.

                                  : string
    {
        return CLIENT_WEB_DIR . $this->filepath();
    }

References CLIENT_WEB_DIR, and filepath().

Here is the call graph for this function:

clearCache()

ilMathJaxImage::clearCache

(

)

Delete all files from the cache.

Definition at line 156 of file class.ilMathJaxImage.php.

                                : void
    {
        $this->fs->deleteDir($this->basepath);
    }

exists()

ilMathJaxImage::exists

(

)

Check if an image is cached.

Definition at line 108 of file class.ilMathJaxImage.php.

                            : bool
    {
        return $this->fs->has($this->filepath());
    }

References filepath().

Here is the call graph for this function:

filepath()

ilMathJaxImage::filepath ( )

protected

Create the relative file path of the image.

Definition at line 88 of file class.ilMathJaxImage.php.

                                 : string
    {
        $hash = md5($this->tex . $this->salt);
        return $this->basepath
            . '/' . substr($hash, 0, 4)
            . '/' . substr($hash, 4, 4)
            . '/' . $hash . $this->suffix;
    }

References $suffix.

Referenced by absolutePath(), exists(), read(), and write().

Here is the caller graph for this function:

getCacheSize()

ilMathJaxImage::getCacheSize

(

)

Get the total size of the cache with an appropriate unit for display.

Definition at line 133 of file class.ilMathJaxImage.php.

                                  : string
    {
        $size = 0;
        if ($this->fs->hasDir($this->basepath)) {
            foreach ($this->fs->finder()->in([$this->basepath])->files() as $meta) {
                $size += $this->fs->getSize($meta->getPath(), 1)->inBytes();
            }
        }
 
        $type = array("K", "M", "G", "T", "P", "E", "Z", "Y");
        $size /= 1000;
        $counter = 0;
        while ($size >= 1000) {
            $size /= 1000;
            $counter++;
        }
 
        return (round($size, 1) . " " . $type[$counter] . "B");
    }

References $type.

read()

ilMathJaxImage::read

(

)

Read the content of a cached image.

Definition at line 116 of file class.ilMathJaxImage.php.

                          : string
    {
        return $this->fs->read($this->filepath());
    }

References filepath().

Here is the call graph for this function:

write()

ilMathJaxImage::write

(

string

$a_content

)

Save the content of a cached image.

Parameters

string

$a_content

image content

Definition at line 125 of file class.ilMathJaxImage.php.

                                            : void
    {
        $this->fs->put($this->filepath(), $a_content);
    }

References filepath().

Here is the call graph for this function:

Field Documentation

$basepath

string ilMathJaxImage::$basepath = '/temp/tex'

protected

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

$fs

ILIAS Filesystem Filesystem ilMathJaxImage::$fs

protected

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

$salt

string ilMathJaxImage::$salt

protected

Definition at line 57 of file class.ilMathJaxImage.php.

$suffix

string ilMathJaxImage::$suffix

protected

Definition at line 52 of file class.ilMathJaxImage.php.

Referenced by filepath().

$tex

string ilMathJaxImage::$tex

protected

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

TYPE_PNG

const ilMathJaxImage::TYPE_PNG = 'png'

private

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

Referenced by __construct().

TYPE_SVG

const ilMathJaxImage::TYPE_SVG = 'svg'

private

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

Referenced by __construct().

---

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

• Services/MathJax/classes/class.ilMathJaxImage.php