Stud.IP
5.4
|
Functions | |
htmlReady ($what, $trim=TRUE, $br=FALSE, $double_encode=true) | |
wysiwygReady ($what, $trim=TRUE, $br=FALSE, $double_encode=true) | |
jsReady ($what, $target='script-single') | |
quotes_encode ($text, $author='') | |
formatReady ($text, $trim=true) | |
formatLinks ($text, $nl2br=true) | |
wikiReady ($text, $trim=TRUE, $range_id=null, $page_id=null) | |
blubberReady ($text, $trim=TRUE) | |
decodeHTML ($string) | |
preg_call_format_signature ($username, $timestamp) | |
kill_format ($text) | |
isURL ($url) | |
isLinkIntern ($url) | |
idna_link ($link, $mail=false) | |
symbol ($text='') | |
mila ($titel, $size=60) | |
printhead ($breite, $left, $link, $open, $new, $icon, $titel, $zusatz, $timestmp=0, $printout=TRUE, $index="", $indikator="age", $css_class=NULL) | |
printcontent ($breite, $write, $inhalt, $edit, $printout=true, $addon='', $noTdTag=false) | |
tooltip ($text, $with_alt=TRUE, $with_popup=FALSE) | |
tooltip2 ($text, $with_alt=TRUE, $with_popup=FALSE) | |
tooltipIcon ($text, $important=false, $html=false) | |
tooltipHtmlIcon ($text, $important=false) | |
TransformInternalLinks ($str) | |
display_exception ($exception, $as_html=false, $deep=false) | |
arrayToHtmlAttributes (array $attributes) | |
Variables | |
const | FORMATTED_CONTENT_WRAPPER '<div class="formatted-content ck-content">%s</div>' |
arrayToHtmlAttributes | ( | array | $attributes | ) |
Returns the appropriate stud.ip icon for a given mime type.
String | $mime_type | Mime type to get the icon for |
array | $attributes | Associative array of attributes |
blubberReady | ( | $text, | |
$trim = TRUE |
|||
) |
Special version of formatReady for blubber, which includes hashtags
public
string | $what | Marked-up text. |
string | $trim | Trim leading and trailing whitespace, if TRUE. |
decodeHTML | ( | $string | ) |
decodes html entities to normal characters
public
string |
Displays the provided exception in a more readable fashion.
Exception | $exception | The exception to be displayed |
bool | $as_html | Indicates whether the exception shall be displayed as plain text or html (optional, defaults to plain text) |
bool | $deep | Indicates whether any previous exception should be included in the output (optional, defaults to false) |
formatLinks | ( | $text, | |
$nl2br = true |
|||
) |
Simplified version of formatReady that handles link formatting only.
string | $text | Marked-up text. |
bool | $nl2br | Convert newlines to . |
formatReady | ( | $text, | |
$trim = true |
|||
) |
Common function to get all special Stud.IP formattings.
public
string | $text | Marked-up text. |
boolean | $trim | Trim leading and trailing whitespace, if TRUE. |
htmlReady | ( | $what, | |
$trim = TRUE , |
|||
$br = FALSE , |
|||
$double_encode = true |
|||
) |
idna_link | ( | $link, | |
$mail = false |
|||
) |
convert links with 'umlauten' to punycode
public
string | link to convert |
boolean | for mailadr = true and for other link = false |
isLinkIntern | ( | $url | ) |
isURL | ( | $url | ) |
jsReady | ( | $what, | |
$target = 'script-single' |
|||
) |
kill_format | ( | $text | ) |
removes all characters used by quick-format-syntax
public
string |
mila | ( | $titel, | |
$size = 60 |
|||
) |
preg_call_format_signature | ( | $username, | |
$timestamp | |||
) |
formats a ~~~~ wiki signature with username and timestamp
string | |
unix | timestamp |
printhead | ( | $breite, | |
$left, | |||
$link, | |||
$open, | |||
$new, | |||
$icon, | |||
$titel, | |||
$zusatz, | |||
$timestmp = 0 , |
|||
$printout = TRUE , |
|||
$index = "" , |
|||
$indikator = "age" , |
|||
$css_class = NULL |
|||
) |
Ausgabe der Aufklapp-Kopfzeile
$breite | |
$left | |
$link | |
$open | |
$new | |
$icon | |
$titel | |
$zusatz | |
$timestmp | |
$printout | |
$index | |
$indikator | |
$css_class |
quotes_encode | ( | $text, | |
$author = '' |
|||
) |
Quote a piece of text, optionally include the author's name.
string | $text | Text that is to be quoted. |
string | $author | Name of the text's author (optional). |
symbol | ( | $text = '' | ) |
create symbols from the shorts
This functions converts the short, locatet in the config.inc into the assigned pictures. A tooltip which shows the symbol code is given, too.
public
string | the text to convert |
tooltip | ( | $text, | |
$with_alt = TRUE , |
|||
$with_popup = FALSE |
|||
) |
Returns a given text as html tooltip
title and alt attribute is default, with_popup means a JS alert box activated on click
string | $text | |
boolean | $with_alt | return text with alt attribute |
boolean | $with_popup | return text with JS alert box on click |
tooltip2 | ( | $text, | |
$with_alt = TRUE , |
|||
$with_popup = FALSE |
|||
) |
Returns a given text as an array of html attributes used as tooltip
title and alt attribute is default, with_popup means a JS alert box activated on click
string | $text | |
boolean | $with_alt | return text with alt attribute |
boolean | $with_popup | return text with JS alert box on click |
tooltipHtmlIcon | ( | $text, | |
$important = false |
|||
) |
returns a html-snippet with an icon and a tooltip on it
string | $text | tooltip text, html is rendered as is |
bool | $important | render icon in "important" style |
returns a html-snippet with an icon and a tooltip on it
string | $text | tooltip text, html gets encoded |
bool | $important | render icon in "important" style |
bool | $html | tooltip text is HTML content |
TransformInternalLinks | ( | $str | ) |
detects internal links in a given string and convert used domain to the domain actually used (only necessary if more than one domain exists), relative URLs are converted to absolute URLs
string | $str | URL/Link to convert |
wikiReady | ( | $text, | |
$trim = TRUE , |
|||
$range_id = null , |
|||
$page_id = null |
|||
) |
Special version of formatReady for wiki-webs.
public
string | $what | Marked-up text. |
string | $trim | Trim leading and trailing whitespace, if TRUE. |
string | $range_id | the id of the course or institute |
string | $page_id | the id of the page |
wysiwygReady | ( | $what, | |
$trim = TRUE , |
|||
$br = FALSE , |
|||
$double_encode = true |
|||
) |
Prepare text for wysiwyg (if enabled), otherwise convert special characters using htmlReady.
string | $text | The text. |
boolean | $trim | Trim text before applying markup rules, if TRUE. |
boolean | $br | Replace newlines by , if TRUE and wysiwyg editor disabled. |
boolean | $double_encode | Encode existing HTML entities, if TRUE and wysiwyg editor disabled. |
const FORMATTED_CONTENT_WRAPPER '<div class="formatted-content ck-content">%s</div>' |