symfony API

sfWidgetFormFilterInput Class

You are currently browsing
the website for symfony 1

Visit the Symfony2 website


« Back to API menu

Packages

You are currently browsing the symfony API for the 1.4 version. Switch to:
This version of symfony is not maintained anymore.
If some of your projects still use this version, consider upgrading as soon as possible.

sfWidgetFormFilterInput represents an HTML input tag used for filtering text.

Inheritence

sfWidgetFormFilterInput  <  sfWidgetForm < sfWidget

Method Summary

  • configure($options, $attributes)
    Constructor.
  • string render($name, $value, $attributes, $errors)
    Renders the widget.

Methods inherited from sfWidgetForm

fixFormId , generateId , generateTwoCharsRange , getDefault , getIdFormat , getLabel , getParent , isHidden , needsMultipartForm , renderContentTag , renderTag , setDefault , setHidden , setIdFormat , setLabel , setParent , translate , translateAll , __construct

Methods inherited from sfWidget

addOption , addRequiredOption , attributesToHtml , attributesToHtmlCallback , configure , escapeOnce , fixDoubleEscape , getAttribute , getAttributes , getCharset , getJavaScripts , getOption , getOptions , getRequiredOptions , getStylesheets , hasOption , isXhtml , render , renderContentTag , renderTag , setAttribute , setAttributes , setCharset , setOption , setOptions , setXhtml , __construct

Method Details

  • configure ($options, $attributes)

    $options An array of options
    $attributes An array of default HTML attributes

    Constructor.


    Available options:

    * with_empty: Whether to add the empty checkbox (true by default)
    * empty_label: The label to use when using an empty checkbox
    * template: The template to use to render the widget
    Available placeholders: %input%, %empty_checkbox%, %empty_label%

  • (string) render ($name, $value, $attributes, $errors)

    $name The element name
    $value The value displayed in this widget
    $attributes An array of HTML attributes to be merged with the default HTML attributes
    $errors An array of errors for the field

    Renders the widget.

    returns An HTML tag string