/sources/lorem.php

Description
Description | Functions
Functions
Description | Functions
do_lorem_template (line 468)

Lorem version of do_template. It will reprocess the template into something that is "stable XHTML" and thus can work inside an XHTML editor

  • return: The tempcode for this template
tempcode do_lorem_template (ID_TEXT $codename, [?array $parameters = NULL], [?LANGUAGE_NAME $lang = NULL], [boolean $light_error = false], [?ID_TEXT $fallback = NULL], [string $suffix = '.tpl'], [string $type = 'templates'])
  • ID_TEXT $codename: The codename of the template being loaded
  • ?array $parameters: A map of parameters for the template (key to value) (NULL: no parameters)
  • ?LANGUAGE_NAME $lang: The language to load the template in (templates can embed language references) (NULL: users own language)
  • boolean $light_error: Whether to not produce a stack dump if the template is missing
  • ?ID_TEXT $fallback: Alternate template to use if the primary one does not exist (NULL: none)
  • string $suffix: File type suffix of template file (e.g. .tpl)
  • string $type: Subdirectory type to look in
find_all_previews__by_screen (line 662)

Find the template/screen previews

  • return: The map of previews (screen to a list of templates)
array find_all_previews__by_screen ()
find_all_previews__by_template (line 631)

Find the template/screen previews

  • return: The map of previews (template to a tuple of preview details)
array find_all_previews__by_template ()
find_comcodes (line 595)

Get all comcode files.

  • return: List of comcodes.
array find_comcodes ()
find_html (line 613)

Get all html files.

  • return: List of htmls.
array find_html ()
get_text_templates (line 764)

Get an additional list of templates that should be treated as text.

  • return: The list of templates
array get_text_templates ()
lorem_chunk (line 96)

Get suitable placeholder text.

  • return: Place holder text.
string lorem_chunk ()
lorem_chunk_html (line 166)

Get suitable placeholder text.

  • return: Place holder text.
tempcode lorem_chunk_html ()
lorem_globalise (line 483)

Lorem version of globalise. It will wrap the input into something that is "stable XHTML" and thus can work inside an XHTML editor

  • return: Standalone page
tempcode lorem_globalise (tempcode $middle, [?mixed $message = NULL], [string $type = ''], [boolean $include_header_and_footer = false])
  • tempcode $middle: The tempcode to put into a nice frame
  • ?mixed $message: 'Additional' message (NULL: none)
  • string $type: The type of special message
  • boolean $include_header_and_footer: Whether to automatically include the header and footer templates
lorem_paragraph (line 86)

Get suitable placeholder text.

  • return: Place holder text.
string lorem_paragraph ()
lorem_paragraph_html (line 154)

Get suitable placeholder text.

  • return: Place holder text.
tempcode lorem_paragraph_html ()
lorem_phrase (line 46)

Get suitable placeholder text.

  • return: Place holder text.
string lorem_phrase ()
lorem_phrase_html (line 130)

Get suitable placeholder text.

  • return: Place holder text.
tempcode lorem_phrase_html ()
lorem_sentence (line 76)

Get suitable placeholder text.

  • return: Place holder text.
string lorem_sentence ()
lorem_sentence_html (line 142)

Get suitable placeholder text.

  • return: Place holder text.
tempcode lorem_sentence_html ()
lorem_title (line 56)

Get suitable placeholder text: title.

  • return: Place holder text.
tempcode lorem_title ()
lorem_word (line 26)

Get suitable placeholder text.

  • return: Place holder text.
string lorem_word ()
lorem_word_2 (line 36)

Get suitable placeholder text.

  • return: Place holder text.
string lorem_word_2 ()
lorem_word_2_html (line 118)

Get suitable placeholder text.

  • return: Place holder text.
tempcode lorem_word_2_html ()
lorem_word_html (line 106)

Get suitable placeholder text.

  • return: Place holder text.
tempcode lorem_word_html ()
placeholder_archive (line 313)

Get a list

  • return: Place holder text.
tempcode placeholder_archive ()
placeholder_array (line 297)

Get an array

  • return: Place holder array.
array placeholder_array ([integer $num_elements = 3])
  • integer $num_elements: Number of array elements.
placeholder_avatar (line 523)

Get an avatar image.

  • return: image
tempcode placeholder_avatar ()
placeholder_blank (line 436)

Get a blank screen, for a parameter which is not visible and typically blank.

  • return: Place holder text.
string placeholder_blank ()
placeholder_breadcrumbs (line 446)

Get suitable placeholder breadcrumbs.

  • return: Place holder text.
tempcode placeholder_breadcrumbs ()
placeholder_button (line 268)

Get a button

  • return: Button
tempcode placeholder_button ()
placeholder_date (line 345)

Get suitable placeholder date.

  • return: Place holder text.
string placeholder_date ()
placeholder_date_raw (line 365)

Get suitable placeholder timestamp.

  • return: Place holder text.
string placeholder_date_raw ()
placeholder_emoticons (line 496)

Get an array of emoticons.

  • return: emoticons
array placeholder_emoticons ()
placeholder_emoticon_chooser (line 533)

Get a table of emoticons.

  • return: emotocons
tempcode placeholder_emoticon_chooser ()
placeholder_fields (line 190)

Get fields

  • return: Place holder text.
tempcode placeholder_fields ()
placeholder_filesize (line 395)

Get suitable placeholder filesize.

  • return: Place holder text.
string placeholder_filesize ()
placeholder_form (line 178)

Get suitable placeholder text.

  • return: Place holder text.
tempcode placeholder_form ()
placeholder_form_with_field (line 203)

Get form with a field

  • return: Place holder text.
tempcode placeholder_form_with_field (ID_TEXT $field_name)
  • ID_TEXT $field_name: The field name wanted.
placeholder_id (line 385)

Get suitable placeholder ID.

  • return: Place holder text.
string placeholder_id ()
placeholder_image (line 333)

Get an image

  • return: Place holder text.
tempcode placeholder_image ()
placeholder_image_url (line 426)

Get image url

  • return: Image url
string placeholder_image_url ()
placeholder_img_code (line 550)

Get a theme image code.

  • return: The code
string placeholder_img_code ([string $type = ''])
  • string $type: The theme image directory to find a code under
placeholder_ip (line 66)

Get suitable placeholder text: title.

  • return: Place holder text.
tempcode placeholder_ip ()
placeholder_javascript (line 406)

Get javascript code

  • return: Place holder text.
string placeholder_javascript ()
placeholder_javascript_code (line 416)

Get javascript code

  • return: Place holder text.
string placeholder_javascript_code ()
placeholder_link (line 246)

Get suitable placeholder link.

  • return: Place holder link.
tempcode placeholder_link ()
placeholder_number (line 375)

Get suitable placeholder number.

  • return: Place holder text.
string placeholder_number ()
placeholder_options (line 280)

Get options for drop-down box

  • return: Place holder text
string placeholder_options ()
placeholder_random (line 258)

Get a random number

  • return: Random number
string placeholder_random ()
placeholder_result_browser (line 571)

Get a results browser.

  • return: Results browser.
tempcode placeholder_result_browser ()
placeholder_table (line 222)

Get suitable placeholder text.

  • return: Place holder text.
tempcode placeholder_table ()
placeholder_time (line 355)

Get time

  • return: Place holder text.
string placeholder_time ()
placeholder_types (line 323)

Get some set of data

  • return: Place holder text.
tempcode placeholder_types ()
placeholder_url (line 234)

Get suitable placeholder URL.

  • return: Place holder URL.
tempcode placeholder_url ()
render_screen_preview (line 696)

Shows the preview of a screen

  • return: The previewed screen
tempcode render_screen_preview (ID_TEXT $template, ID_TEXT $hook, ID_TEXT $function)
  • ID_TEXT $template: The template to be previewed
  • ID_TEXT $hook: The hook the preview is in
  • ID_TEXT $function: The name of the screen preview

Documentation generated on Sun, 02 Jan 2011 23:17:10 +0000 by phpDocumentor 1.4.3