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

Procedural File: function.search.php

Source Location: /system/Theme/plugins/function.search.php



Page Details:

Zikula Application Framework



Tags:

version:  $Id: function.search.php 24342 2008-06-06 12:03:14Z markwest $
copyright:  (c) 2004, Zikula Development Team
link:  http://www.zikula.org
filesource:  Source Code for this file
license:  GNU/GPL








smarty_function_search [line 53]

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

Smarty function to display a search form

Available parameters:

  • active a comma-separated list of modules to be searched.
  • bool the boolean operation to be performed (AND or OR)
  • label the label to show before the search box
  • button the text to be displayed on the search button
  • size the size of the input box
  • value the default value of the input box
  • search_accesskey the access key of the Search box
  • search_tabindex the tabindex of the Search box (defaults to 0)
  • search_class the CSS class to assign to the Search box
  • button_accesskey the access key of the Search button
  • button_class the CSS class to assign to the Search button
  • button_tabindex the tabindex of the Search button (defaults to 0)
  • class the CSS class to assign to the form
  • js use javascript to automatically clear the default value (defaults to true)
Example <!--[search]-->

<!--[pnml name="_SEARCH" assign="search_label"]--> <!--[search active="faqs, stories" label=$search_label class="pnsearchform"]-->

Note IE (incorrectly) treats a form as a block element rather than an inline element. This, if you want the search box to display as expected on IE, you should use a custom CSS class to style the search box (use the class parameter of this plugin), and add display: inline; to this class in your style sheet.




Tags:

return:  the search box
author:  Jörg Napp
author:  Mark West
since:  23/10/03


Parameters

array   $params   All attributes passed to this function from the template
object   &$smarty   Reference to the Smarty object
[ Top ]



Documentation generated on Fri, 18 Jul 2008 21:46:15 +0200 by phpDocumentor 1.4.1