symfony API

sfWidgetFormInputCheckbox Class

You are currently browsing
the website for symfony 1

Visit the Symfony2 website


« Back to API menu

1.3 API OpenSearch

Packages

You are currently browsing the symfony API for the 1.3 version. Switch to:

sfWidgetFormInputCheckbox represents an HTML checkbox tag.

Inheritence

sfWidgetFormInputCheckbox  <  sfWidgetFormInput < sfWidgetForm < sfWidget

Method Summary

  • configure($attributes)
    @param array $options An array of options
  • string render($name, $value, $attributes, $errors)
    Renders the widget.
  • __construct($options, $attributes)
    Constructor.

Methods inherited from sfWidgetFormInput

configure , render

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 ($attributes) Browse code

    $attributes An array of default HTML attributes

    @param array $options An array of options

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

    $name The element name
    $value The this widget is checked if value is not null
    $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

  • __construct ($options, $attributes) Browse code

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

    Constructor.


    Available options:

    - value_attribute_value: The "value" attribute value to set for the checkbox