Smarty
[ class tree: Smarty ] [ index: Smarty ] [ all elements ]

Procedural File: function.biticon.php

Source Location: /themes/smartyplugins/function.biticon.php



Page Details:

Smarty plugin



Tags:









biticon_first_match [line 17]

Icon biticon_first_match( string $pDir, array $pFilename)

biticon_first_match



Tags:

return:  name with extension on success, FALSE on failure
access:  public


Parameters

string   $pDir   Directory in which we want to search for the icon
array   $pFilename   Icon name without the extension
[ Top ]



biticon_get_cache_file [line 282]

full biticon_get_cache_file( array $pParams)

will get the path to the cache files based on the stuff in $pParams



Tags:

return:  path to cachefile
access:  public


Parameters

array   $pParams  
[ Top ]



biticon_output [line 48]

Full biticon_output( $pParams, string $pFile, boolean $pParams['url'], string $pParams['iexplain'], string $pParams['iforce'], string 4)

Turn collected information into an html image



Tags:

return:  <img> on success
access:  public


Parameters

boolean   $pParams['url']   set to TRUE if you only want the url and nothing else
string   $pParams['iexplain']   Explanation of what the icon represents
string   $pParams['iforce']   takes following optins: icon, icon_text, text - will override system settings
string   $pFile   Path to icon file
string   4   iforce override site-wide setting how to display icons (can be set to 'icon', 'text' or 'icon_text')
   $pParams  
[ Top ]



biticon_read_cache [line 243]

cached biticon_read_cache( array $pParams)

biticon_cache



Tags:

return:  icon string on sucess, FALSE on failure
access:  public


Parameters

array   $pParams  
[ Top ]



biticon_write_cache [line 263]

TRUE biticon_write_cache( array $pParams, $pCacheString)

biticon_write_cache



Tags:

return:  on success, FALSE on failure
access:  public


Parameters

array   $pParams  
   $pCacheString  
[ Top ]



smarty_function_biticon [line 113]

final smarty_function_biticon( $pParams, &$gBitSmarty, [ $pCheckSmall = FALSE], array $pParams['ipath'], array $pParams['iname'], array $pParams['ipackage'], array $gBitSmarty)

smarty_function_biticon



Tags:

return:  <img>
access:  public


Parameters

array   $pParams['ipath']   subdirectory within icon directory
array   $pParams['iname']   name of the icon without extension
array   $pParams['ipackage']   package the icon should be searched for - if it's part of an icon theme, this should be set to 'icons'
array   $gBitSmarty   Referenced object
   $pParams  
   &$gBitSmarty  
   $pCheckSmall  
[ Top ]



Documentation generated on Wed, 29 Jul 2015 13:56:36 +0000 by phpDocumentor 1.5.0-lsces