symfony API

sfWidgetFormDate Class

You are currently browsing
the website for symfony 1

Visit the Symfony2 website

« Back to API menu


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.

sfWidgetFormDate represents a date widget.


sfWidgetFormI18nDate  <  sfWidgetFormDate  <  sfWidgetForm < sfWidget

Method Summary

  • configure($options, $attributes)
    Configures the current widget.
  • string render($name, $value, $attributes, $errors)
    Renders the widget.
  • string renderDayWidget($value, $options, $attributes)
    @param string $name
  • string renderMonthWidget($value, $options, $attributes)
    @param string $name
  • string renderYearWidget($value, $options, $attributes)
    @param string $name

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

    Configures the current widget.

    Available options:

    * format: The date format string (%month%/%day%/%year% by default)
    * years: An array of years for the year select tag (optional)
    Be careful that the keys must be the years, and the values what will be displayed to the user
    * months: An array of months for the month select tag (optional)
    * days: An array of days for the day select tag (optional)
    * can_be_empty: Whether the widget accept an empty value (true by default)
    * empty_values: An array of values to use for the empty value (empty string for year, month, and day by default)

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

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

  • (string) renderDayWidget ($value, $options, $attributes)

    @param string $name

    returns rendered widget

  • (string) renderMonthWidget ($value, $options, $attributes)

    @param string $name

    returns rendered widget

  • (string) renderYearWidget ($value, $options, $attributes)

    @param string $name

    returns rendered widget