phpDocumentor pivotx
[ class tree: pivotx ] [ index: pivotx ] [ all elements ]

Procedural File: module_smarty.php

Source Location: /modules/module_smarty.php

Page Details
Classes
Class Description
PivotxSmarty PivotX specific for Smarty
Includes
require_once (dirname(dirname(__FILE__))."/lamer_protection.php") [line 17]
[ Top ]

require_once ($pivotx_path."modules/smarty/Smarty.class.php") [line 20]
[ Top ]


Functions
dbGetSecure  [line 5562]

void dbGetSecure( $tpl_name, &$smarty_obj  )
Parameters:
   $tpl_name: 
   &$smarty_obj: 

API Tags:
See:  $smarty->register_resource


[ Top ]
dbGetTemplate  [line 5540]

void dbGetTemplate( $tpl_name, &$tpl_source, &$smarty_obj  )
Parameters:
   $tpl_name: 
   &$tpl_source: 
   &$smarty_obj: 

API Tags:
See:  $smarty->register_resource


[ Top ]
dbGetTimestamp  [line 5555]

void dbGetTimestamp( $tpl_name, &$tpl_timestamp, &$smarty_obj  )
Parameters:
   $tpl_name: 
   &$tpl_timestamp: 
   &$smarty_obj: 

API Tags:
See:  $smarty->register_resource


[ Top ]
dbGetTrusted  [line 5571]

void dbGetTrusted( $tpl_name, &$smarty_obj  )
Parameters:
   $tpl_name: 
   &$smarty_obj: 

API Tags:
See:  $smarty->register_resource


[ Top ]
pivotxCacheHandler  [line 5590]

void pivotxCacheHandler( $action, &$smarty_obj, &$cache_content, [ $tpl_file = null], [ $cache_id = null], [ $compile_id = null], [ $exp_time = null]  )

Handle Caching.

Note: Most of the hooks related to caching are called from module_parser.php, parseTemplate(). This is because this function is a smarty callback, and gets called multiple times for each page (separately for each include as wel as recursive templates like [[body]], [[introduction]] and other block level tags) The only exceptions is clear_cache(), for which we _do_ handle the hooks here.

Parameters:
   $action: 
   &$smarty_obj: 
   &$cache_content: 
   $tpl_file: 
   $cache_id: 
   $compile_id: 
   $exp_time: 

API Tags:
See:  http://www.smarty.net/manual/en/section.template.cache.handler.func.php


[ Top ]
smarty_adminentrylist  [line 5166]

array smarty_adminentrylist( array $params, &$smarty  )

Get a filtered list of entries with a pager - assign the list, filter and pager to smarty variables

The $params array can have the following keys

  • 'full': Determines if the returned entries should be full (contain all fields), the default, or be reduced. (true/false)
  • 'show': Amount of entries to read.
  • 'offset': The offset from the beginning of the filtered and sorted/ordered array.
  • 'cats': Filter entries by category/ies.
  • 'extrafields': Filter entries by extrafields.
  • 'user': Filter entries by user(s).
  • 'status': Filter entries by status.
  • 'order': Select random, asc(ending) or des(cending).
  • 'orderby': Default is date, but any entry field (e.g. code/uid) can be used.
  • 'date': A date range - day, month or year.
  • 'start'/'end': A start/end date.
'cats', 'extrafields' and 'user' can either be (comma separated) strings or arrays.

Parameters:
array   $params: 
   &$smarty: 


[ Top ]
smarty_archive_list  [line 263]

string smarty_archive_list( array $params, &$smarty, object $smarty  )

Inserts a linked list to the archives for a given weblog.

Parameters:
array   $params: 
object   $smarty: 
   &$smarty: 


[ Top ]
smarty_atombutton  [line 372]

string smarty_atombutton( )

Insert a button with a link to the Atom XML feed.



[ Top ]
smarty_backtrace  [line 402]

void smarty_backtrace( array $params, &$smarty, object $smarty  )

Print a backtrace of called functions from smarty templates

Parameters:
array   $params: 
object   $smarty: 
   &$smarty: 


[ Top ]
smarty_block_nocache  [line 1305]

void smarty_block_nocache( $param, $content, &$smarty  )

Outputs it's content without caching.

Parameters:
   $param: 
   $content: 
   &$smarty: 


[ Top ]
smarty_body  [line 475]

void smarty_body( array $params, &$smarty, object $smarty  )

Smarty tag for [[ body ]].

Parameters:
array   $params: 
object   $smarty: 
   &$smarty: 


[ Top ]
smarty_button  [line 504]

string smarty_button( array $params, string $text, &$smarty, object $smarty  )

Creates a button with the given text.

Parameters:
array   $params: 
string   $text: 
object   $smarty: 
   &$smarty: 


[ Top ]
smarty_cached_include  [line 572]

string smarty_cached_include( array $params, &$smarty, object $smarty  )

Smarty tag for [[cached_include]].

Works just like [[include]], but is able to cache the result for the time 'cache' (minutes).

Parameters 'assign' and 'file' work just like with include.

Parameters:
array   $params: 
object   $smarty: 
   &$smarty: 


[ Top ]
smarty_category  [line 663]

string smarty_category( array $params, &$smarty, object $smarty  )

List the names of the current entry's categories or just the names of the selected categories. Optionally links them to the matching pages with entries in that category.

Entries from the current entry is selected unless the 'name' parameter is set. You can use the 'ignore' parameter and the 'only' parameter to restrict the categories listed. 'name', 'ignore' and 'only' takes a comma separated list of category names. Finally, you can specify the separator between the categories with the 'sep' parameter.

Parameters:
array   $params: 
object   $smarty: 
   &$smarty: 


[ Top ]
smarty_category_link  [line 763]

string smarty_category_link( array $params, &$smarty, object $smarty  )

Create a link to a given category.

Parameters:
array   $params: 
object   $smarty: 
   &$smarty: 


[ Top ]
smarty_category_list  [line 779]

string smarty_category_list( array $params, &$smarty, object $smarty  )

Inserts a list of links to the different categories in the current weblog.

Parameters:
array   $params: 
object   $smarty: 
   &$smarty: 


[ Top ]
smarty_chaptername  [line 4304]

void smarty_chaptername( array $params, &$smarty, object $smarty  )

Smarty tag for [[ chaptername ]].

Parameters:
array   $params: 
object   $smarty: 
   &$smarty: 


[ Top ]
smarty_charset  [line 894]

string smarty_charset( )

Outputs the current charset of the weblog / page

This function always return 'utf-8' since we chosen that as the only charset.



[ Top ]
smarty_commcount  [line 904]

string smarty_commcount( $params, &$smarty  )

Outputs a text string with the number of comments for the current entry whether it is in a subweblog or on an entry page.

Parameters:
   $params: 
   &$smarty: 


[ Top ]
smarty_commentform  [line 952]

string smarty_commentform( $params, &$smarty, string $template  )

Displays a commentform if commenting is allowed and remote IP isn't blocked, as long as we are in a subweblog or on an entry page.

Parameters:
string   $template: 
   $params: 
   &$smarty: 


[ Top ]
smarty_commentlink  [line 1007]

void smarty_commentlink( $params, &$smarty  )
Parameters:
   $params: 
   &$smarty: 


[ Top ]
smarty_comments  [line 1057]

void smarty_comments( $params, $format, &$smarty  )

Outputs the list of comments for an entry based on the supplied format whether it is in a subweblog or on an entry page.

Parameters:
   $params: 
   $format: 
   &$smarty: 


[ Top ]
smarty_content  [line 1499]

string smarty_content( $params, &$smarty  )

Replace the [[ content ]] tag in the 'extra template' with the desired content from $smarty

Parameters:
   $params: 
   &$smarty: 


[ Top ]
smarty_count  [line 1516]

string smarty_count( array $params  )

Smarty function to count the elements on which the modifier is applied.

Parameters:
array   $params: 


[ Top ]
smarty_date  [line 1541]

string smarty_date( array $params, &$smarty, object $smarty  )

Output the current date, or the date given in $params['date'].

The result is formatted according to $params['format'].

if $params['use'] is set, we use that date to display, you can use 'date', 'publish_date', 'edit_date', or an other variable that is known from within the smarty scope, as long as it uses the mysql date format. (ie: 2007-06-11 22:10:45)

Parameters:
array   $params: 
object   $smarty: 
   &$smarty: 


[ Top ]
smarty_download  [line 2307]

void smarty_download( $params, string $filename, string $icon, string $text, string $title  )

Smarty tag to insert a link to a downloadable file.

  [[download:filename:icon:text:title]]

Parameters:
string   $filename: 
string   $icon:  Insert a suitable icon if set to "icon"
string   $text:  The text of the download link.
string   $title:  The text of the title attribue of the link.
   $params: 


[ Top ]
smarty_editlink  [line 1588]

void smarty_editlink( $params, &$smarty  )
Parameters:
   $params: 
   &$smarty: 


[ Top ]
smarty_emotpopup  [line 1619]

string smarty_emotpopup( array $params  )

Insert a link to open the emoticons reference window

Parameters:
array   $params: 


[ Top ]
smarty_entrylink  [line 1702]

string smarty_entrylink( array $params, &$smarty, object $smarty  )

This function is here to provide backwards compatibility for the [[ entrylink ]] tag.

In your templates you should use [[ link hrefonly=1 ]] to get the same results.

THIS FUNCTION IS DEPRECATED, and will be removed eventually!!

Parameters:
array   $params: 
object   $smarty: 
   &$smarty: 

API Tags:
See:  smarty_link()


[ Top ]
smarty_explode  [line 1667]

string smarty_explode( string $params, &$smarty, object $smarty  )

Return an exploded version of $params['string'], using $params['glue'] as the separator for each item.

If return is set, it will return the results as that smarty variable. Otherwise, it will just output the results.

Example: [[ explode string="this, is, a, string" glue=", " return=explodedstring ]] [[ print_r var=$explodedstring ]]

Parameters:
string   $params: 
object   $smarty: 
   &$smarty: 


[ Top ]
smarty_extensions_dir  [line 3591]

string smarty_extensions_dir( )

Returns the local absolute URL to the extensions directory.



[ Top ]
smarty_extensions_url  [line 3603]

string smarty_extensions_url( )

Returns the global absolute URL to the extensions directory.



[ Top ]
smarty_feed  [line 1733]

string smarty_feed( array $params, string $text, &$smarty, object $smarty  )

Fetches an RSS or Atom feed, and displays it on a page.

Example:

 [[ feed url="http://api.flickr.com/services/feeds/[email protected]&lang=en-us&format=rss_200"
   amount=8 dateformat="%dayname% %day% %monthname%" allowtags="" ]]
 

%title%

%description% (%date%)

[[ /feed ]]

In addition to the standard formatting tags (%title%, %link%, %description%, %content%, %author%, %date%, and %id%), you can use any key defined in feed (by using %keyname%). Upto two-level arrays with keys are supported (as "%keyname->subkeyname->subsubkeyname%")

Parameters:
array   $params: 
string   $text: 
object   $smarty: 
   &$smarty: 


[ Top ]
smarty_filedescription  [line 1888]

string smarty_filedescription( array $params, &$smarty, object $smarty  )

Gets the description of a file, to display in the template editor screens

Parameters:
array   $params: 
object   $smarty: 
   &$smarty: 


[ Top ]
smarty_getentry  [line 2012]

void smarty_getentry( $params, &$smarty  )

Gets a single entry, referenced by it's 'uid'. Set it in the templates,

so it can be used like [[ $var.title ]]

Parameters:
   $params: 
   &$smarty: 


[ Top ]
smarty_getpage  [line 2116]

string smarty_getpage( $params, &$smarty  )

Gets a single page, referenced by it's 'uri'. Set it in the templates, so it can be used like [[ $page.title ]]

Parameters:
   $params: 
   &$smarty: 

API Tags:
See:  smarty_resetpage()


[ Top ]
smarty_getpagelist  [line 2063]

string smarty_getpagelist( array $params, &$smarty, object $smarty  )

Retrieves a list of pages. Useful in combination with [[getpage]]. You can use this

To get an array with the URIs of all pages in a chapter, and then iterate through them with [[getpage]]. See this example in the documentation: http://book.pivotx.net/?page=app-b#anchor-getpagelist

You can use the 'onlychapter' attribute to choose a chapter to get the pages from. If omitted, it will return all pages.

The 'var' attribute determines the var in the template that will have the results. Defaults to 'pageslist'. Note: do _not_ include the $ in the var name: var=pagelist is correct, var=$pagelist is not. This is because the 'var' attribute is used a string to set the variable, if you use $pagelist, the _value_ of $pagelist is used, instead of the string 'pagelist'

Parameters:
array   $params: 
object   $smarty: 
   &$smarty: 


[ Top ]
smarty_home  [line 2165]

string smarty_home( )

Returns the local absolute URL to the home/start page of the website.



[ Top ]
smarty_hook  [line 1857]

mixed smarty_hook( array $params, &$smarty, object $smarty  )

Executes a hook, from within a template

Parameters:
array   $params: 
object   $smarty: 
   &$smarty: 


[ Top ]
smarty_id_anchor  [line 2178]

string smarty_id_anchor( array $params, &$smarty, object $smarty  )

Inserts an anchor for the current entry (needed for permalink).

Parameters:
array   $params: 
object   $smarty: 
   &$smarty: 


[ Top ]
smarty_image  [line 2228]

string smarty_image( array $params, object $smarty  )

Smarty tag to insert an image.

  [[image file="somedirectory/somefile.jpg" ]]

Valid parameters are "file", "alt", "align", "class", "id", "width" and "height". The inserted image will have CSS class "pivotx-image" unless the "class" parameter is set.

Parameters:
array   $params: 
object   $smarty: 


[ Top ]
smarty_implode  [line 2391]

string smarty_implode( array $params, &$smarty, object $smarty  )

Return an imploded version of $params['array'], using $params['glue'] in between each item.

If 'return' is set, it will return the results as a smarty variable with that name.

Parameters:
array   $params: 
object   $smarty: 
   &$smarty: 


[ Top ]
smarty_introduction  [line 2423]

void smarty_introduction( array $params, &$smarty, object $smarty  )

Smarty tag for [[ introduction ]].

Parameters:
array   $params: 
object   $smarty: 
   &$smarty: 


[ Top ]
smarty_lang  [line 2445]

string smarty_lang( array $params  )

Output the language code for the current weblog/language.

The optional $type argument can be either 'html' or 'xml'. The output will then be suitable to use in templates, in the html tag, to set the correct language. (If you are using XHTML 1.0, which is the default for PivotX, you should use both [[lang type='html']] and [[lang type='xml']].)

Parameters:
array   $params: 

API Tags:
Usedby:  snippet_lang()


[ Top ]
smarty_latest_comments  [line 2485]

string smarty_latest_comments( array $params  )

Create a piece of HTML with links to the latest comments.

Parameters:
array   $params: 


[ Top ]
smarty_link  [line 2596]

string smarty_link( array $params, &$smarty, object $smarty  )

Create a link to an entry, a page or weblog.

Parameters:
array   $params: 
object   $smarty: 
   &$smarty: 

API Tags:
Usedby:  snippet_encrypt_mail()


[ Top ]
smarty_link_list  [line 2967]

string smarty_link_list( array $params, &$smarty, object $smarty  )

Insert the _sub_link_list.html sub-template. Test for older versions as well.

Parameters:
array   $params: 
object   $smarty: 
   &$smarty: 


[ Top ]
smarty_live_title  [line 4543]

void smarty_live_title( array $params, &$smarty, object $smarty  )

Outputs a "live" title depending on the type of page displayed.

Parameters:
array   $params: 
object   $smarty: 
   &$smarty: 


[ Top ]
smarty_log_dir  [line 3004]

string smarty_log_dir( )

Returns the local absolute URL to the (current) weblog.



[ Top ]
smarty_log_url  [line 3016]

string smarty_log_url( )

Returns the global absolute URL to the (current) weblog.

$param string $weblog



[ Top ]
smarty_message  [line 3029]

string smarty_message( array $params  )

Displays as message from PivotX to the user (normally when posting comments).

Parameters:
array   $params: 


[ Top ]
smarty_moderate_message  [line 3055]

void smarty_moderate_message( $params  )

Displays a message when the moderation queue is enabled.

Parameters:
   $params: 


[ Top ]
smarty_more  [line 2195]

string smarty_more( array $params, &$smarty, object $smarty  )

Returns the link to the body (more-link) for the current entry (if there is a body).

Parameters:
array   $params: 
object   $smarty: 
   &$smarty: 


[ Top ]
smarty_nextentry  [line 3080]

string smarty_nextentry( array $params  )

Link to the next entry

Parameters:
array   $params: 


[ Top ]
smarty_nextpage  [line 3148]

string smarty_nextpage( array $params, &$smarty  )

Link to the next page in containing chapter

Parameters:
array   $params: 
   &$smarty: 


[ Top ]
smarty_pagelist  [line 3231]

void smarty_pagelist( $params, &$smarty  )

Inserts a list of pages

Parameters:
   $params: 
   &$smarty: 


[ Top ]
smarty_paging  [line 3402]

string smarty_paging( array $params, &$smarty, object $smarty  )

Creates a way to navigate between pages.

Parameters:
array   $params: 
object   $smarty: 
   &$smarty: 


[ Top ]
smarty_parse  [line 3489]

string smarty_parse( string $html  )

Modifier to parse (as Smarty/PivotX template) a given tag or variable

example: [[ $page.introduction|parse ]] [[ body|parse ]] <- note that this second example is not very useful, as 'body' is already parsed.

Parameters:
string   $html: 


[ Top ]
smarty_permalink  [line 3526]

string smarty_permalink( array $params, &$smarty, object $smarty  )

Creates a permanent link to the current entry (in the archives).

Parameters:
array   $params: 
object   $smarty: 
   &$smarty: 


[ Top ]
smarty_pivotxbutton  [line 3503]

string smarty_pivotxbutton( )

Inserts a nice button with a link to the pivotx website.



[ Top ]
smarty_pivotx_dir  [line 3555]

string smarty_pivotx_dir( )

Returns the local absolute URL to the pivotx directory.



[ Top ]
smarty_pivotx_path  [line 3567]

string smarty_pivotx_path( )

Returns the local path to the pivotx directory.



[ Top ]
smarty_pivotx_url  [line 3579]

string smarty_pivotx_url( )

Returns the global absolute URL to the pivotx directory.



[ Top ]
smarty_popup  [line 3619]

void smarty_popup( array $params, &$smarty, object $smarty  )

Smarty tag to insert a popup to an image..

First we check if we can use Jquery and whether extensions/thickbox/ is present. If so, we use Thickbox. If not, we use the 'old style' popup.

Parameters:
array   $params: 
object   $smarty: 
   &$smarty: 


[ Top ]
smarty_previousentry  [line 3706]

string smarty_previousentry( array $params  )

Link to the previous entry

Parameters:
array   $params: 


[ Top ]
smarty_previouspage  [line 3771]

string smarty_previouspage( array $params, &$smarty  )

Link to the previous page in the containing chapter.

Parameters:
array   $params: 
   &$smarty: 


[ Top ]
smarty_print_r  [line 3858]

void smarty_print_r( array $params, &$smarty, object $smarty  )

Print_r a variable/array from smarty templates

Parameters:
array   $params: 
object   $smarty: 
   &$smarty: 


[ Top ]
smarty_registered  [line 3879]

string smarty_registered( array $params  )

Returns the text 'registered' if the current visitor is (logged in and) registered.

Useful in templates to set special classes for (logged in) registered visitors.

Parameters:
array   $params: 


[ Top ]
smarty_register_as_visitor_link  [line 3900]

string smarty_register_as_visitor_link( array $params  )

Returns a link to the "comment user"/"registered visitor" page (with the correct weblog selection).

It takes three (optional) smarty parameters - 'weblog', 'linktext' and 'linktext_logged_in'.

Parameters:
array   $params: 


[ Top ]
smarty_remember  [line 3927]

string smarty_remember( array $params, &$smarty, object $smarty  )

Inserts previously filled fields for commenting. They can come from either a previous submit (when previewing, or when an error in the form occurred) or from the cookie.

Parameters:
array   $params: 
object   $smarty: 
   &$smarty: 


[ Top ]
smarty_resetpage  [line 4035]

string; smarty_resetpage( $params, &$smarty  )

Resets the [[ $page ]] variable back to what it was, before it was set by [[ getpage ]].

Parameters:
   $params: 
   &$smarty: 

API Tags:
See:  smarty_getpage()


[ Top ]
smarty_rssbutton  [line 4059]

string smarty_rssbutton( )

Insert a button with a link to the RSS XML feed.



[ Top ]
smarty_search  [line 4088]

string smarty_search( array $params, &$smarty, object $smarty  )

Displays the search-box

Parameters:
array   $params: 
object   $smarty: 
   &$smarty: 


[ Top ]
smarty_searchheading  [line 1312]

void smarty_searchheading( $params, &$smarty  )
Parameters:
   $params: 
   &$smarty: 


[ Top ]
smarty_searchresults  [line 1347]

void smarty_searchresults( $params, $format, &$smarty  )
Parameters:
   $params: 
   $format: 
   &$smarty: 


[ Top ]
smarty_self  [line 4160]

string smarty_self( array $params  )

Returns a link to the current page.

Parameters:
array   $params: 


[ Top ]
smarty_sitedescription  [line 4202]

string smarty_sitedescription( )

Returns the sitedescription for the PivotX installation.



[ Top ]
smarty_sitename  [line 4187]

string smarty_sitename( )

Returns the sitename for the PivotX installation.



[ Top ]
smarty_spamquiz  [line 4217]

string smarty_spamquiz( $params, &$smarty  )

Returns the HTML for the SpamQuiz (that should go inside the comment form).

Parameters:
   $params: 
   &$smarty: 


[ Top ]
smarty_subtitle  [line 4282]

void smarty_subtitle( array $params, &$smarty, object $smarty  )

Smarty tag for [[ subtitle ]].

Parameters:
array   $params: 
object   $smarty: 
   &$smarty: 


[ Top ]
smarty_tagcloud  [line 4321]

string smarty_tagcloud( array $params  )

Display a small tagcloud.

Parameters:
array   $params: 


[ Top ]
smarty_tags  [line 4410]

string smarty_tags( $params, &$smarty, string $text, string $sep  )

Get a concise list of the entry's tags or (for the MySQL database backend only) the page's tags.

Parameters:
string   $text:  The output format. The default value is "Used tags: %tags%". (or the localised version thereof)
string   $sep:  The separator between the tags. The default value is ", ".
   $params: 
   &$smarty: 

API Tags:
Return:  The text to display.
Usedby:  snippet_tags()


[ Top ]
smarty_template_dir  [line 4457]

string smarty_template_dir( array $params, &$smarty  )

Returns the local absolute URL to the template directory.

Parameters:
array   $params: 
   &$smarty: 


[ Top ]
smarty_textilepopup  [line 4480]

string smarty_textilepopup( )

Adds the textile editor thingamajig to the comments form. It's somewhat confusingly called [[ textilepopup ]] for backwards compatibility.



[ Top ]
smarty_title  [line 4522]

void smarty_title( array $params, &$smarty, object $smarty  )

Smarty tag for [[ title ]].

Parameters:
array   $params: 
object   $smarty: 
   &$smarty: 


[ Top ]
smarty_trackbacklink  [line 4557]

void smarty_trackbacklink( $params, &$smarty  )

Makes a link to the trackbacks on the current entry.

Parameters:
   $params: 
   &$smarty: 


[ Top ]
smarty_trackbacks  [line 1394]

void smarty_trackbacks( $params, $format, &$smarty  )

Outputs the list of trackbacks for an entry based on the supplied format whether it is in a subweblog or on an entry page.

Parameters:
   $params: 
   $format: 
   &$smarty: 


[ Top ]
smarty_trackcount  [line 4665]

void smarty_trackcount( $params, &$smarty  )

Outputs a text string with the number of trackbacks for the current entry whether it is in a subweblog or on an entry page.

Parameters:
   $params: 
   &$smarty: 


[ Top ]
smarty_tracklink  [line 4606]

void smarty_tracklink( $params, &$smarty  )

Inserts the trackback URL for the current entry.

The classes "pivotx-tracklink-text" and "pivotx-tracklink-url" can be used to style the output.

Parameters:
   $params: 
   &$smarty: 


[ Top ]
smarty_tracknames  [line 4701]

void smarty_tracknames( )

Inserts a list of the names of people who left a trackback to the current entry.



[ Top ]
smarty_tt  [line 4719]

string smarty_tt( $params, string $tag, string $link, string $template  )

Display a Tag, as used in the introduction or body

Parameters:
string   $tag: 
string   $link: 
string   $template: 
   $params: 


[ Top ]
smarty_uid  [line 4765]

string smarty_uid( array $params, &$smarty, object $smarty  )

Returns the uid for the current entry

Parameters:
array   $params: 
object   $smarty: 
   &$smarty: 


[ Top ]
smarty_upload_dir  [line 4779]

string smarty_upload_dir( )

Returns the local absolute URL to the upload directory.



[ Top ]
smarty_user  [line 4798]

string smarty_user( array $params, &$smarty, object $smarty  )

Returns information about the author of the current entry or page.

It takes one optional parameter "field" to select what information to return. There is one special value "emailtonick" that will produce an encoded link to the email address.

Parameters:
array   $params: 
object   $smarty: 
   &$smarty: 


[ Top ]
smarty_user_list  [line 4836]

string smarty_user_list( array $params  )

Returns a list of user.

Parameters:
array   $params: 


[ Top ]
smarty_via  [line 4918]

string smarty_via( array $params, &$smarty  )

Returns the 'via' information from the extended entry form as a link with a title.

Parameters:
array   $params: 
   &$smarty: 


[ Top ]
smarty_weblog  [line 4957]

string smarty_weblog( array $params, string $format, &$smarty, object $smarty  )

Returns the text for a (sub)weblog.

The subweblog tag is a block tag, which means that it always has to have an accompanying closing subweblog tag. What's inside the tag is used to render the entries in that weblog. In fact, the contents can be seen as the template that is used for each entry. PivotX loops over the entries, and renders each one, using this 'sub template'.

Parameters:
array   $params: 
string   $format: 
object   $smarty: 
   &$smarty: 


[ Top ]
smarty_weblogid  [line 5056]

string smarty_weblogid( )

Returns the ID of the current weblog.



[ Top ]
smarty_weblogsubtitle  [line 5073]

string smarty_weblogsubtitle( array $params  )

Returns the subtitle (payoff) of the current weblog. It takes one optional parameter "strip" which if equal to one, will remove all HTML tags from the output.

Parameters:
array   $params: 


[ Top ]
smarty_weblogtitle  [line 5094]

string smarty_weblogtitle( array $params  )

Returns the title (name) of the current weblog. It takes one optional parameter "strip" which if equal to one, will remove all HTML tags from the output.

Parameters:
array   $params: 


[ Top ]
smarty_weblog_list  [line 4987]

string smarty_weblog_list( array $params, &$smarty, object $smarty  )

Inserts a linked list to the the different weblogs.

Parameters:
array   $params: 
object   $smarty: 
   &$smarty: 


[ Top ]
smarty_widgets  [line 5117]

string smarty_widgets( array $params, &$smarty, object $smarty  )

Inserts a block with the enabled widgets.

Parameters:
array   $params: 
object   $smarty: 
   &$smarty: 


[ Top ]
smarty_yesno  [line 5135]

string smarty_yesno( array $params, &$smarty, object $smarty  )

Return localised 'yes' or 'no' dependant on $params['value']

Parameters:
array   $params: 
object   $smarty: 
   &$smarty: 


[ Top ]
tag_exists  [line 5526]

void tag_exists( $tagname  )

Check if a given string is available as smarty tag.

Example: [[ if tag_exists('gallery') ]] (gallery extension is available) [[/if]]

Parameters:
   $tagname: 


[ Top ]
_smarty_link_author  [line 2738]

void _smarty_link_author( $params, &$smarty  )

Helper function for smarty_link()

Parameters:
   $params: 
   &$smarty: 

API Tags:
See:  smarty_link()


[ Top ]
_smarty_link_category  [line 2686]

void _smarty_link_category( $params, &$smarty  )

Helper function for smarty_link()

Parameters:
   $params: 
   &$smarty: 

API Tags:
See:  smarty_link()


[ Top ]
_smarty_link_entry  [line 2888]

void _smarty_link_entry( $params, &$smarty  )

Helper function for smarty_link()

Parameters:
   $params: 
   &$smarty: 

API Tags:
See:  smarty_link()


[ Top ]
_smarty_link_mail  [line 2777]

void _smarty_link_mail( $params, &$smarty  )

Helper function for smarty_link()

Parameters:
   $params: 
   &$smarty: 

API Tags:
See:  smarty_link()


[ Top ]
_smarty_link_page  [line 2795]

void _smarty_link_page( $params, &$smarty  )

Helper function for smarty_link()

Parameters:
   $params: 
   &$smarty: 

API Tags:
See:  smarty_link()


[ Top ]
_smarty_link_weblog  [line 2848]

void _smarty_link_weblog( $params, &$smarty  )

Helper function for smarty_link()

Parameters:
   $params: 
   &$smarty: 

API Tags:
See:  smarty_link()


[ Top ]


Documentation generated on Tue, 05 Sep 2017 01:06:09 +0200 by phpDocumentor 1.4.3