Stud.IP  2.0 Revision 48548
 All Data Structures Namespaces Files Functions Variables Pages
visual.inc.php File Reference

Functions

 get_ampel_state ($cur_ampel_state, $new_level, $new_text)
 get_ampel_write ($mein_status, $admission_status, $write_level, $print="TRUE", $start=-1, $ende=-1, $temporaly=0)
 get_ampel_read ($mein_status, $admission_status, $read_level, $print="TRUE", $start=-1, $ende=-1, $temporaly=0)
 htmlReady ($what, $trim=TRUE, $br=FALSE)
 JSReady ($what="", $target="overlib")
 quotes_decode ($description)
 quotes_encode ($description, $author)
 format_help ($what, $trim=TRUE, $extern=FALSE, $wiki=FALSE, $show_comments="icon")
 formatReady ($what, $trim=TRUE, $extern=FALSE, $wiki=FALSE, $show_comments="icon")
 wikiReady ($what, $trim=TRUE, $extern=FALSE, $show_comments="icon")
 wiki_format ($text, $show_comments)
 format_wiki_comment ($comment, $metainfo, $show_comment)
 latex ($text, $extern=FALSE)
 decodeHTML ($string)
 format ($text)
 preg_call_format_text ($ctxt, $content)
 preg_call_format_list ($content)
 preg_call_format_table ($content)
 preg_call_format_signature ($username, $timestamp)
 kill_format ($text)
 FixLinks ($data="", $fix_nl=TRUE, $nl_to_br=TRUE, $img=FALSE, $extern=FALSE, $wiki=FALSE)
 preg_call_link ($params, $mod, $img, $extern=FALSE, $wiki=FALSE)
 idna_link ($link, $mail=false)
 smile ($text="", $extern=FALSE)
 symbol ($text="", $extern=FALSE)
 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=FALSE, $inhalt, $edit, $printout=TRUE, $addon="")
 print_infobox ($content, $picture= '', $dont_display_immediatly=false)
 tooltip ($text, $with_alt=TRUE, $with_popup=FALSE)
 tooltip2 ($text, $with_alt=TRUE, $with_popup=FALSE)
 MakeToolbar ($icon, $URL, $text, $tooltip, $size, $target, $align="center", $toolwindow="FALSE", $accesskey=FALSE)
 TransformInternalLinks ($str)
 createQuestion ($question, $approveParams, $disapproveParams=array(), $baseUrl= '?')

Function Documentation

createQuestion (   $question,
  $approveParams,
  $disapproveParams = array(),
  $baseUrl = '?' 
)

creates a modal dialog ensuring that the user is really aware about the action to perform

Parameters
string$questionquestion of the modal dialog
string$approveParamsan array of params for a link to be used on approval
string$disapproveParamsan array of params for a link to be used on disapproval
string$baseUrlif set, this url is used, PHP_SELF otherwise
Returns
string $dialog text which contains the dialog

Here is the call graph for this function:

Here is the caller graph for this function:

decodeHTML (   $string)

decodes html entities to normal characters

public

Parameters
string
Returns
string

Here is the caller graph for this function:

FixLinks (   $data = "",
  $fix_nl = TRUE,
  $nl_to_br = TRUE,
  $img = FALSE,
  $extern = FALSE,
  $wiki = FALSE 
)

detects links in a given string and convert it into html-links

public

Parameters
stringtext to convert
stringTRUE if all forms of newlines have to be converted in single
booleanTRUE if newlines have to be converted into
booleanTRUE if pictures should be displayed
booleanTRUE if called from external pages ('externe Seiten')
Returns
string

Here is the call graph for this function:

Here is the caller graph for this function:

format (   $text)

uses a special syntax to formatting text

public

Parameters
stringtext to format
Returns
string

Here is the caller graph for this function:

format_help (   $what,
  $trim = TRUE,
  $extern = FALSE,
  $wiki = FALSE,
  $show_comments = "icon" 
)

Here is the call graph for this function:

Here is the caller graph for this function:

format_wiki_comment (   $comment,
  $metainfo,
  $show_comment 
)

Here is the call graph for this function:

formatReady (   $what,
  $trim = TRUE,
  $extern = FALSE,
  $wiki = FALSE,
  $show_comments = "icon" 
)

universal and very usable functions to get all the special stud.ip formattings

public

Parameters
string$whatwhat to format
boolean$trimshould the output trimmed?
boolean$externTRUE if called from external pages ('externe Seiten')
boolean$wikiif TRUE format for wiki
string$show_commentsComment mode (none, all, icon), used for Wiki comments
Returns
string

Here is the call graph for this function:

Here is the caller graph for this function:

get_ampel_read (   $mein_status,
  $admission_status,
  $read_level,
  $print = "TRUE",
  $start = -1,
  $ende = -1,
  $temporaly = 0 
)

get_ampel_read, waehlt die geeignete Grafik in der Ampel Ansicht (fuer Berechtigungen) aus. Benoetigt den Status in der Veranstaltung und auf der Anmeldeliste und den read_level der Veranstaltung

Parameters
unknown_type$mein_status
unknown_type$admission_status
unknown_type$read_level
unknown_type$print
unknown_type$start
unknown_type$ende
unknown_type$temporaly

Here is the call graph for this function:

get_ampel_state (   $cur_ampel_state,
  $new_level,
  $new_text 
)

get_ampel_state is a helper function for get_ampel_write and get_ampel_read. It checks if the new parameters lead to a "lower" trafficlight. If so, the new level and the new text are set and returned.

Parameters
unknown_type$cur_ampel_state
unknown_type$new_level
unknown_type$new_text
Returns

Here is the caller graph for this function:

get_ampel_write (   $mein_status,
  $admission_status,
  $write_level,
  $print = "TRUE",
  $start = -1,
  $ende = -1,
  $temporaly = 0 
)

get_ampel_write, waehlt die geeignete Grafik in der Ampel Ansicht (fuer Berechtigungen) aus. Benoetigt den Status in der Veranstaltung und auf der Anmeldeliste und den read_level der Veranstaltung

Parameters
unknown_type$mein_status
unknown_type$admission_status
unknown_type$write_level
unknown_type$print
unknown_type$start
unknown_type$ende
unknown_type$temporaly

Here is the call graph for this function:

htmlReady (   $what,
  $trim = TRUE,
  $br = FALSE 
)
idna_link (   $link,
  $mail = false 
)

convert links with 'umlauten' to punycode

public

Parameters
stringlink to convert
booleanfor mailadr = true and for other link = false
Returns
string link in punycode

Here is the caller graph for this function:

JSReady (   $what = "",
  $target = "overlib" 
)

Here is the call graph for this function:

Here is the caller graph for this function:

kill_format (   $text)

removes all characters used by quick-format-syntax

public

Parameters
string
Returns
string

Here is the caller graph for this function:

latex (   $text,
  $extern = FALSE 
)

Here is the call graph for this function:

Here is the caller graph for this function:

MakeToolbar (   $icon,
  $URL,
  $text,
  $tooltip,
  $size,
  $target,
  $align = "center",
  $toolwindow = "FALSE",
  $accesskey = FALSE 
)

Returns a an entry in the top navigation bar

public

Parameters
string$iconPath to the icon
string$URLURL on button
string$textHovertext under the Button
string$tooltipfor Tooltip Window
integer$sizeWidth of the Element
string$targetsame or new window...
string$align
string$toolwindowFor a special Toolwindow string key used for the shortcut
Returns
string

Here is the call graph for this function:

mila (   $titel,
  $size = 60 
)

Here is the caller graph for this function:

preg_call_format_list (   $content)

callback function used by format() to generate html-lists

private

Parameters
stringstring containing a list in quick-format-syntax
Returns
string
preg_call_format_signature (   $username,
  $timestamp 
)

formats a ~~~~ wiki signature with username and timestamp

Parameters
string
unixtimestamp

Here is the call graph for this function:

preg_call_format_table (   $content)

callback function used by format() to generate tables

private

Parameters
stringstring containing a table in quick-format-syntax
Returns
string
preg_call_format_text (   $ctxt,
  $content 
)

callback function used by format() to generate big and small font

private

Parameters
stringstring containing a string with quick-format char (++ or –)
stringstring containing text between quick-format char
Returns
string
preg_call_link (   $params,
  $mod,
  $img,
  $extern = FALSE,
  $wiki = FALSE 
)

callback function used by FixLinks()

private

Parameters
array$paramsparameters extracted by the regular expression
string$modtype of lin ('LINK' or 'MAIL')
boolean$imgTRUE to handle image-links
boolean$externTRUE if called from external pages ('externe Seiten')
Returns
string

Here is the call graph for this function:

print_infobox (   $content,
  $picture = '',
  $dont_display_immediatly = false 
)

Here is the caller graph for this function:

printcontent (   $breite,
  $write = FALSE,
  $inhalt,
  $edit,
  $printout = TRUE,
  $addon = "" 
)

Here is the call graph for this function:

Here is the caller graph for this function:

printhead (   $breite,
  $left,
  $link,
  $open,
  $new,
  $icon,
  $titel,
  $zusatz,
  $timestmp = 0,
  $printout = TRUE,
  $index = "",
  $indikator = "age",
  $css_class = NULL 
)

Ausgabe der Aufklapp-Kopfzeile

Parameters
$breite
$left
$link
$open
$new
$icon
$titel
$zusatz
$timestmp
$printout
$index
$indikator
$css_class

Here is the call graph for this function:

Here is the caller graph for this function:

quotes_decode (   $description)

Hilfsfunktion, die sich den zu quotenden Text holt, encodiert und zurueckgibt.

Parameters
string$descriptionHilfsfunktion, die sich den zu quotenden Text holt, encodiert und zurueckgibt.
Returns
string

Here is the caller graph for this function:

quotes_encode (   $description,
  $author 
)

Funktion um Quotings zu encoden

Parameters
string$descriptionder Text der gequotet werden soll, wird zurueckgegeben
string$authorName des urspruenglichen Autors
Returns
string

Here is the caller graph for this function:

smile (   $text = "",
  $extern = FALSE 
)

create smileys

This functions converts the smileys codes (":name:") notation an the shorts, located in the config.inc into the assigned pictures. On every smiley a link to show_smiley.php overview is given (only if $extern is FALSE). A tooltip which shows the smiley code is given, too.

public

Parameters
stringthe text to convert
booleanTRUE if function is called from external pages
Returns
string convertet text

Here is the caller graph for this function:

symbol (   $text = "",
  $extern = FALSE 
)

create symbols from the shorts

This functions converts the short, locatet in the config.inc into the assigned pictures. It uses a different directory as the smile-function, becauso symbols should not be shown in the smiley and so, no link is given onto the picture. A tooltip which shows the symbol code is given, too.

public

Parameters
stringthe text to convert
booleanTRUE if function is called from external pages
Returns
string convertet text

Here is the caller graph for this function:

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

Parameters
string$text
boolean$with_altreturn text with alt attribute
boolean$with_popupreturn text with JS alert box on click
Returns
string

Here is the call graph for this function:

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

Parameters
string$text
boolean$with_altreturn text with alt attribute
boolean$with_popupreturn text with JS alert box on click
Returns
string

Here is the call graph for this function:

Here is the caller graph for this function:

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)

Parameters
stringtext to convert
Returns
string text with convertes internal links

Here is the caller graph for this function:

wiki_format (   $text,
  $show_comments 
)

a special wiki formatting routine (used for comments)

public

Parameters
string$textwhat to format
string$show_commentsHow to show comments

Here is the caller graph for this function:

wikiReady (   $what,
  $trim = TRUE,
  $extern = FALSE,
  $show_comments = "icon" 
)

the special version of formatReady for Wiki-Webs

public

Parameters
string$whatwhat to format
string$trimshould the output trimmed?
boolean$externTRUE if called from external pages ('externe Seiten')
Returns
string

Here is the call graph for this function:

Here is the caller graph for this function: