symfony API

sfWidgetFormInputCheckbox Class

You are currently browsing
the website for symfony 1

Visit the Symfony2 website

« Back to API menu

1.1 API OpenSearch


You are currently browsing the symfony API for the 1.1 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.

sfWidgetFormInputCheckbox represents an HTML checkbox tag.


sfWidgetFormInputCheckbox  <  sfWidgetFormInput < sfWidgetForm < sfWidget

Method Summary

  • configure($attributes)
    @param array $options An array of options
  • string render($value, $attributes, $errors)
    @param string $name The element name
  • __construct($options, $attributes)

Methods inherited from sfWidgetFormInput

configure , render

Methods inherited from sfWidgetForm

fixFormId , generateId , generateTwoCharsRange , getIdFormat , isHidden , needsMultipartForm , renderContentTag , renderTag , setHidden , setIdFormat , __construct

Methods inherited from sfWidget

addOption , addRequiredOption , attributesToHtml , attributesToHtmlCallback , configure , escapeOnce , fixDoubleEscape , getAttribute , getAttributes , getCharset , getOption , getOptions , getRequiredOptions , 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 ($value, $attributes, $errors) Browse code

    $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

    @param string $name The element name

    returns An HTML tag string

  • __construct ($options, $attributes) Browse code

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


    Available options:

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