div (line 178)
Get the tempcode for a div. Similar to paragraph, but may contain more formatting (such as
's)
tempcode
div
(tempcode $tempcode, [string $guid = ''])
-
tempcode
$tempcode: The tempcode to put into a div
-
string
$guid: GUID for call
form_input_hidden (line 217)
Get the tempcode for a hidden form element.
tempcode
form_input_hidden
(ID_TEXT $name, string $value)
-
ID_TEXT
$name: The name which this input field is for
-
string
$value: The value for this input field
form_input_list_entry (line 232)
Get the tempcode for a list entry. (You would gather together the outputs of several of these functions, then put them in as the $content in a form_input_list function call).
tempcode
form_input_list_entry
(string $value, [boolean $selected = false], [mixed $text = ''], [boolean $red = false], [boolean $disabled = false])
-
string
$value: The value for this entry
-
boolean
$selected: Whether this entry is selected by default or not
-
mixed
$text: The text associated with this choice (blank: just use name for text)
-
boolean
$red: Whether this entry will be put as red (marking it as important somehow)
-
boolean
$disabled: Whether this list entry is disabled (like a header in a list)
get_page_title (line 90)
Get the tempcode for a page title. (Ones below the page header, not in the browser title bar.)
tempcode
get_page_title
(mixed $title, [boolean $dereference_lang = true], [?array $params = NULL], [?tempcode $user_online_title = NULL], [?array $awards = NULL])
-
mixed
$title: The title to use (usually, a language string code, see below)
-
boolean
$dereference_lang: Whether the given title is actually a language string code, and hence gets dereferenced
-
?array
$params: Parameters sent to the language string (NULL: none)
-
?tempcode
$user_online_title: Separate title to put into the 'currently viewing' data (NULL: use $title)
-
?array
$awards: Awards to say this has won (NULL: none)
hyperlink (line 143)
Get the tempcode for a hyperlink.
tempcode
hyperlink
(mixed $url, mixed $caption, [boolean $external = false], [boolean $escape = false], [mixed $title = ''], [?string $accesskey = NULL], [?tempcode $post_data = NULL], [?string $rel = NULL])
-
mixed
$url: The URL to put in the hyperlink (URLPATH or tempcode)
-
mixed
$caption: The hyperlinks caption (either tempcode or string)
-
boolean
$external: Whether the link is an external one (by default, the external template makes it open in a new window)
-
boolean
$escape: Whether to escape the hyperlink caption (only applies if it is not passed as tempcode)
-
mixed
$title: Link title (either tempcode or string) (blank: none)
-
?string
$accesskey: The access key to use (NULL: none)
-
?tempcode
$post_data: Data to post (NULL: an ordinary link)
-
?string
$rel: Rel (link type) (NULL: no special type)
inform_screen (line 190)
Get the tempcode for an info page.
tempcode
inform_screen
(tempcode $title, mixed $text)
-
tempcode
$title: The title of the info page
-
mixed
$text: The text to put on the info page (string, or language-tempcode)
init__templates (line 24)
Standard code module initialisation function.
void
init__templates
()
paragraph (line 166)
Get the tempcode for a paragraph. This function should only be used with escaped text strings that need to be put into a paragraph, not with sections of HTML. Remember, paragraphs are literally that, and should only be used with templates that don't assume that they are going to put the given parameters into paragraphs themselves.
tempcode
paragraph
(mixed $text, [string $guid = ''], [?string $class = NULL])
-
mixed
$text: The text to put into the paragraph (string or tempcode)
-
string
$guid: GUID for call
-
?string
$class: CSS classname (NULL: none)
put_in_standard_box (line 44)
Get the tempcode for a standard box (CSS driven), with the specified content entered. Please rarely use this function; it is not good to assume people want anythings in one of these boxes... use templates instead
tempcode
put_in_standard_box
(tempcode $content, [mixed $title = ''], [?string $dimensions = NULL], [ID_TEXT $type = 'classic'], [string $options = ''], [string $meta = ''], [string $links = ''], [boolean $expand = false], [string $toplink = ''])
-
tempcode
$content: The content being put inside the box
-
mixed
$title: The title of the standard box, string or Tempcode (blank: titleless standard box)
-
?string
$dimensions: The width/height classification (e.g. 100%, 100%|300px, ...) (NULL: unset)
-
ID_TEXT
$type: The type of the table. Refers to a template (STANDARDBOX_type)
-
string
$options: '|' separated list of options (meaning dependant upon templates interpretation)
-
string
$meta: '|' separated list of meta information (key|value|key|value|...)
-
string
$links: '|' separated list of link information (linkhtml|...)
-
boolean
$expand: If the box will be allowed to expand.
-
string
$toplink: Link to be added to the header of the box
redirect_screen (line 264)
Redirect the user - transparently, storing a message that will be shown on their destination page.
tempcode
redirect_screen
(tempcode $title, mixed $url, mixed $text, [boolean $intermediatory_hop = false], [ID_TEXT $msg_type = 'inform'])
-
tempcode
$title: Title to display on redirect page
-
mixed
$url: Destination URL (may be Tempcode)
-
mixed
$text: Message to show (may be Tempcode)
-
boolean
$intermediatory_hop: For intermediatory hops, don't mark so as to read status messages - save them up for the next hop (which will not be intermediatory)
-
ID_TEXT
$msg_type: Code of message type to show
warn_screen (line 203)
Get the tempcode for a warn page.
tempcode
warn_screen
(tempcode $title, mixed $text, [boolean $provide_back = true])
-
tempcode
$title: The title of the warn page
-
mixed
$text: The text to put on the warn page (either tempcode or string)
-
boolean
$provide_back: Whether to provide a back button
with_whitespace (line 248)
Display some raw text so that it is repeated as raw visually in HTML.
tempcode
with_whitespace
(string $in)