symfony API

sfWidgetFormSelectCheckbox 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:

sfWidgetFormSelectCheckbox represents an array of checkboxes.

Inheritence

sfWidgetFormSelectCheckbox  <  sfWidgetFormChoiceBase < sfWidgetForm < sfWidget

Method Summary

Methods inherited from sfWidgetFormChoiceBase

configure , getChoices , __clone

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) Browse code

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

    Constructor.


    Available options:

    * label_separator: The separator to use between the input checkbox and the label
    * class: The class to use for the main

      tag
      * separator: The separator to use between each input checkbox
      * formatter: A callable to call to format the checkbox choices
      The formatter callable receives the widget and the array of inputs as arguments
      * template: The template to use when grouping option in groups (%group% %options%)

    • formatChoices () Browse code

    • formatter () Browse code

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

      $name The element name
      $value The value selected 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