phpDocumentor templates
[ class tree: templates ] [ index: templates ] [ all elements ]
Prev Next

Template Tags info/samples

Intra-page navigation (TOC)

theoretically helpful text

lorem ipsum

debug_info()

debug_info() accepts $force and $force_clean (default is false for both).

  1. <?php
  2. debug_info()// output debug info if requested
  3. ?>

⇑ top of page ⇑

display_if_empty()

Minimum params with defaults shown >> chasing $params <<

  1. <?php
  2. // display a message if list is empty
  3.     'before' => '<p class="msg_nothing">',
  4.     'msg_empty' => T_('Sorry, there is nothing to display...'),
  5.     'after' => '</p>',
  6. ) );
  7. ?>

⇑ top of page ⇑

item_prevnext_links()

Minimum params and sample from photoblog shown >> chasing $params <<

  1. <?php
  2. // prev/next links in single post mode
  3.     'template' => '$prev$$next$',
  4.     'prev_start' => '',
  5.     'prev_text' => '&laquo; $title$',
  6.     'prev_end' => '',
  7.     'prev_no_item' => '',
  8.     'next_start' => '',
  9.     'next_text' => '$title$ &raquo;',
  10.     'next_end' => '',
  11.     'next_no_item' => '',
  12.     'block_start' => '',
  13.     'block_end' => '',
  14. ) );
  15. ?>

⇑ top of page ⇑

locale_restore_previous()

locale_restore_previous() accepts no parameters.

  1. <?php
  2. locale_restore_previous()// restores previous locale
  3. ?>

⇑ top of page ⇑

mainlist_get_item()

This function has no $params to chase :(

  1. <?php
  2. // loop through as long as we have an Item...
  3. while$Item mainlist_get_item() )
  4. {
  5.     // good times with Item goes here :)
  6. }
  7. ?>

⇑ top of page ⇑

mainlist_page_links()

Minimum params with defaults shown >> chasing $params <<

  1. <?php
  2. // prev/next links on multi-post pages
  3.     'block_start' => '<p class="center">',
  4.     'block_end' => '</p>',
  5.     'block_single' => '',
  6.     'links_format' => '$prev$ $first$ $list_prev$ $list$ $list_next$ $last$ $next$',
  7.     'page_url' => '',
  8.     'prev_text' => '&lt;&lt;',
  9.     'next_text' => '&gt;&gt;',
  10.     'no_prev_text' => '',
  11.     'no_next_text' => '',
  12.     'list_prev_text' => '...',
  13.     'list_next_text' => '...',
  14.     'list_span' => 11,
  15.     'scroll_list_range' => 5,
  16. ) );
  17. ?>

⇑ top of page ⇑

messages()

Defaults for both params shown >>> can't figure out how to chase $params :(

  1. <?php
  2. // messages generated from actions
  3. messagesarray(
  4.     'block_start' => '<div class="action_messages">',
  5.     'block_end' => '</div>',
  6. ) );
  7. ?>

⇑ top of page ⇑

request_title()

Minimum params with defaults shown >> chasing $params <<

  1. <?php
  2. // title for the current request
  3. request_titlearray(
  4.     'auto_pilot' => 'none',
  5.     'title_before' => '',
  6.     'title_after' => '',
  7.     'title_none' => '',
  8.     'title_single_disp' => true,
  9.     'title_single_before' => '#',
  10.     'title_single_after' => '#',
  11.     'title_page_disp' => true,
  12.     'title_page_before' => '#',
  13.     'title_page_after' => '#',
  14.     'glue' => ' - ',
  15.     'format' => 'htmlbody',
  16.     'arcdir_text' => T_('Archive Directory'),
  17.     'catdir_text' => T_('Category Directory'),
  18.     'comments_text' => T_('Latest Comments'),
  19.     'credits_text' => T_('Software Credits'),
  20.     'feedback-popup_text' => T_('Feedback'),
  21.     'mediaidx_text' => T_('Photo Index'),
  22.     'msgform_text' => T_('Send an Email Message'),
  23.     'profile_text' => T_('User Profile'),
  24.     'subs_text' => T_('Subscriptions'),
  25.     'user_text' => T_('User'),
  26. ) );
  27. ?>

⇑ top of page ⇑

t-tags for the <head> section

add_js_for_toolbar()

add_js_for_toolbar() accepts no parameters.

  1. <?php
  2. add_js_for_toolbar()// registers javascripts for the navbar
  3. ?>

⇑ top of page ⇑


header_content_type()

header_content_type() accepts $type (default: 'text/html') and $charset (default: '#' for $io_charset)

  1. <?php
  2. header_content_type()// sets charset
  3. ?>

⇑ top of page ⇑


include_headlines()

include_headlines() accepts no parameters.

  1. <?php
  2. include_headlines()// output collected <head> lines
  3. ?>

⇑ top of page ⇑


meta_generator_tag()

meta_generator_tag() accepts no parameters.

  1. <?php
  2. meta_generator_tag()// for QP's stats
  3. ?>

⇑ top of page ⇑


robots_tag()

robots_tag() accepts no parameters.

  1. <?php
  2. robots_tag()// robots meta tag
  3. ?>

⇑ top of page ⇑


template_base_tag()

template_base_tag() accepts no parameters.

  1. <?php
  2. template_base_tag()// for css and img includes
  3. ?>

⇑ top of page ⇑


template_content_meta()

template_content_meta() accepts only $type (default: 'text/html').

  1. <?php
  2. template_content_meta()// Content-Type meta tag
  3. ?>

⇑ top of page ⇑


template_description_tag()

template_description_tag() accepts no parameters.

  1. <?php
  2. template_description_tag()// description meta tag
  3. ?>

⇑ top of page ⇑


template_keywords_tag()

template_keywords_tag() accepts no parameters.

  1. <?php
  2. template_keywords_tag()// keywords meta tag
  3. ?>

⇑ top of page ⇑


Prev Up Next
Item->method() info/samples Templates Tutorials Miscellaneous->method() info/samples