add_header_comment [line 419]
string add_header_comment(
string $tpl_source, &$smarty, string $smarty
)
|
|
ssmarty::add_header_comment()
// purpose: parsing for header comments in template files
Parameters:
|
string |
$tpl_source: |
// string to add in the templates |
|
string |
$smarty: |
// reference to smarty object |
|
|
&$smarty: |
|
cmp [line 304]
array cmp(
array $a, array $b
)
|
|
ssmarty::cmp()
// purpose: callback sort, called from the above function, will sort an array based on the probabily key
Parameters:
|
array |
$a: |
// array to sort |
|
array |
$b: |
// sort array |
API Tags:
isinrelation [line 317]
void isinrelation(
array $params, &$smarty, object $smarty
)
|
|
ssmarty::isinrelation()
// purpose: checks if a certain id is in the relations array
Parameters:
|
array |
$params: |
// given parameters |
|
object |
$smarty: |
// reference to smarty object |
|
|
&$smarty: |
|
smarty_modifier_checkMime [line 276]
string smarty_modifier_checkMime(
$filename, string $string
)
|
|
ssmarty::checkMime()
// purpose: escapes special characters in string
Parameters:
|
string |
$string: |
// string to truncate |
|
|
$filename: |
|
API Tags:
smarty_modifier_checkPDF [line 264]
string smarty_modifier_checkPDF(
$class, string $string
)
|
|
ssmarty::checkPDF()
// purpose: escapes special characters in string
Parameters:
|
string |
$string: |
// string to truncate |
|
|
$class: |
|
API Tags:
smarty_modifier_exclude [line 388]
array smarty_modifier_exclude(
$data $value, $param
)
|
|
ssmarty::include
// purpose: checks if a given value is NOT in a given array
Parameters:
|
$data |
$value: |
(array) |
|
|
$param: |
|
smarty_modifier_getMimeIcon [line 289]
string smarty_modifier_getMimeIcon(
$filename, string $string
)
|
|
ssmarty::getMimeIcon()
// purpose: escapes special characters in string
Parameters:
|
string |
$string: |
// string to truncate |
|
|
$filename: |
|
API Tags:
smarty_modifier_handleMacros [line 334]
array smarty_modifier_handleMacros(
$data $item
)
|
|
ssmarty::smarty_modifiers_handleMacros
// purpose: reads macros from configs and sets html including linebreak
Parameters:
smarty_modifier_inarray [line 371]
array smarty_modifier_inarray(
$data $value, $param
)
|
|
ssmarty::inarray
// purpose: checks if a given value is in a given array
Parameters:
|
$data |
$value: |
(array) |
|
|
$param: |
|
smarty_modifier_inImageClasses [line 404]
boolean smarty_modifier_inImageClasses(
$int $cid
)
|
|
ssmarty::inImages
// purpose: checks if a given class id is included in the imageClasses array
Parameters:
|
$int |
$cid: |
// given class id |
smarty_modifier_in_preview [line 359]
array smarty_modifier_in_preview(
$data $value
)
|
|
ssmarty::smarty_modifiers_in_preview
// purpose: checks if a given value is in the preview array
Parameters:
smarty_modifier_remreturn [line 347]
array smarty_modifier_remreturn(
$data $value
)
|
|
ssmarty::smarty_modifiers_handleMacros
// purpose: reads macros from configs and sets html including linebreak
Parameters:
smarty_modifier_sescape [line 189]
string smarty_modifier_sescape(
string $string, [string $esc_type = 'html']
)
|
|
ssmarty::smarty_modifier_sescape()
// purpose: escapes special characters in string
Parameters:
|
string |
$string: |
// string to escape |
|
string |
$esc_type: |
// identfier of string type |
API Tags:
smarty_modifier_struncate [line 244]
string smarty_modifier_struncate(
string $string, [int $length = 80], [string $etc = '...'], [boolean $break_words = false]
)
|
|
ssmarty::smarty_modifier_struncate()
// purpose: escapes special characters in string
Parameters:
|
string |
$string: |
// string to truncate |
|
int |
$length: |
// length to truncate of string |
|
string |
$etc: |
// ending of truncated string |
|
boolean |
$break_words: |
// define if words get breaked or not |
API Tags:
smarty_modifier_xtest [line 177]
float smarty_modifier_xtest(
array $params
)
|
|
ssmarty::smarty_modifier_xtest()
// purpose: debug function to print out given parameters
Parameters:
|
array |
$params: |
// given parameters for smarty modification |
API Tags:
| Return: | timestamp as float value |
