\patTemplate_Modifier_QuoteLatex

patTemplate modifier that quotes LaTeX special chars

This is useful when creating PDF documents with patTemplate

Summary

Methods
Properties
Constants
modify()
getName()
setParams()
getParam()
$_name
$_params
$_chars
No constants found
No protected methods found
No protected properties found
N/A
No private methods found
No private properties found
N/A

Properties

$_name

$_name : string

module name

This has to be set in the final module classes.

Type

string

$_params

$_params : array

module parameters

Type

array

$_chars

$_chars : 

Type

Methods

modify()

modify(  $value,   $params = array()) : string

modify the value

Parameters

$value
$params

Returns

string —

modified value

getName()

getName() : string

get the name of the module

Returns

string —

name of the module

setParams()

setParams(  $params,   $clear = false) 

sets parameters of the module

Parameters

$params
$clear

getParam()

getParam(  $name) : mixed

gets a parameter of the module

Parameters

$name

Returns

mixed —

value of the parameter