symfony API

sfForm Class

You are currently browsing
the website for symfony 1

Visit the Symfony2 website


« Back to API menu

1.2 API OpenSearch

Packages

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

sfForm represents a form.

Inheritence

sfFormDoctrine, sfFormPropel  <  sfForm

Method Summary

  • addCSRFProtection($secret)
    Adds CSRF protection to the current form.
  • bind($taintedValues = null, $taintedFiles = null)
    Binds the form with input values.
  • configure()
    Configures the current form.
  • array convertFileInformation($taintedFiles)
    Converts uploaded file array to a format following the $_GET and $POST naming convention.
  • integer count()
    Returns the number of form fields (implements the Countable interface).
  • mixed current()
    Returns the current form field (implements the Iterator interface).
  • array deepArrayUnion($array1, $array2)
    Merges two arrays without reindexing numeric keys.
  • disableCSRFProtection()
    Disables CSRF protection for all forms.
  • embedForm($name, $form, $decorator = null)
    Embeds a sfForm into the current form.
  • embedFormForEach($name, $form, $n, $decorator = null, $innerDecorator = null, $options = array(), $attributes = array(), $labels = array())
    Embeds a sfForm into the current form n times.
  • enableCSRFProtection($secret = null)
    Enables CSRF protection for all forms.
  • fixPhpFilesArray($data)
  • string getCSRFFieldName()
    Gets the CSRF field name.
  • string getCSRFToken($secret = null)
    Returns a CSRF token, given a secret.
  • getDefault($name, 1)
    Gets a default value for a form field.
  • array getDefaults()
    Gets the default values for the form.
  • array getEmbeddedForms()
    Gets the list of embedded forms.
  • getErrorSchema()
    Gets the error schema associated with the form.
  • getFormFieldSchema()
    Returns a form field for the main widget schema.
  • array getGlobalErrors()
    Gets the global errors associated with the form.
  • array getJavaScripts()
    Gets the JavaScript paths associated with the form.
  • string getName()
    Returns the array name under which user data can retrieved.
  • getOption($name, $default = null, 2)
    Gets an option value.
  • array getStylesheets()
    Gets the stylesheet paths associated with the form.
  • array getTaintedValues()
    Returns the submitted tainted values.
  • Exception getToStringException()
    Gets the exception if one was thrown in the __toString() method.
  • getValidator($name)
    Gets a validator for the given field name.
  • getValidatorSchema()
    Gets the validator schema associated with this form.
  • string getValue($field)
    Returns a cleaned value by field name.
  • array getValues()
    Returns the array of cleaned values.
  • getWidget($name)
    Gets a widget for the given field name.
  • getWidgetSchema()
    Gets the widget schema associated with this form.
  • hasDefault($name, (Boolean) 1)
    Returns true if the form has a default value for a form field.
  • Boolean hasErrors()
    Returns true if the form has some errors.
  • Boolean hasGlobalErrors()
    Returns true if the form has some global errors.
  • boolean hasToStringException()
    Returns true if a form thrown an exception in the __toString() method
  • Boolean isBound()
    Returns true if the form is bound to input values.
  • isCSRFProtected()
  • Boolean isMultipart()
    Returns true if the form is multipart.
  • Boolean isValid()
    Returns true if the form is valid.
  • string key()
    Gets the key associated with the current form field (implements the Iterator interface).
  • mergeForm($form)
    Merges current form widget and validator schemas with the ones from the sfForm object passed as parameter. Please note it also merge defaults.
  • mergePostValidator($validator = null)
    Merges a validator with the current post validators.
  • mergePreValidator($validator = null)
    Merges a validator with the current pre validators.
  • next()
    Moves to the next form field (implements the Iterator interface).
  • Boolean offsetExists($name)
    Returns true if the bound field exists (implements the ArrayAccess interface).
  • offsetGet($name)
    Returns the form field associated with the name (implements the ArrayAccess interface).
  • offsetSet($offset, $value)
    Throws an exception saying that values cannot be set (implements the ArrayAccess interface).
  • offsetUnset($offset)
    Removes a field from the form.
  • string render($attributes = array())
    Renders the widget schema associated with this form.
  • string renderFormTag($url, $attributes = array())
    Renders the form tag.
  • string renderGlobalErrors()
    Renders global errors associated with this form.
  • string renderHiddenFields()
    Renders hidden form fields.
  • string renderUsing($formatterName, $attributes = array())
    Renders the widget schema using a specific form formatter
  • resetFormFields()
  • rewind()
    Resets the field names array to the beginning (implements the Iterator interface).
  • setCSRFFieldName($name)
    Sets the CSRF field name.
  • setDefault($name, $default)
    Sets a default value for a form field.
  • setDefaults($defaults)
    Sets the default values for the form.
  • setOption($name, $value)
    Sets an option value.
  • setToStringException($e)
    Sets an exception thrown by the __toString() method.
  • setup()
    Setups the current form.
  • setValidator($name, $validator)
    Set a validator for the given field name.
  • setValidators($validators)
    Sets the validators associated with this form.
  • setValidatorSchema($validatorSchema)
    Sets the validator schema associated with this form.
  • setWidget($name, $widget)
    Set a widget for the given field name.
  • setWidgets($widgets)
    Sets the widgets associated with this form.
  • setWidgetSchema($widgetSchema)
    Sets the widget schema associated with this form.
  • boolean valid()
    Returns true if the current form field is valid (implements the Iterator interface).
  • __clone()
  • __construct($defaults = array(), $options = array(), $CSRFSecret = null)
    Constructor.
  • string __toString()
    Returns a string representation of the form.

Method Details

  • addCSRFProtection ($secret) Browse code

    $secret The secret to use to compute the CSRF token

    Adds CSRF protection to the current form.

  • bind ($taintedValues = null, $taintedFiles = null) Browse code

    $taintedValues An array of input values
    $taintedFiles An array of uploaded files (in the $_FILES or $_GET format)

    Binds the form with input values.


    It triggers the validator schema validation.

  • configure () Browse code

    Configures the current form.

  • (array) convertFileInformation ($taintedFiles) Browse code

    $taintedFiles An array representing uploaded file information

    Converts uploaded file array to a format following the $_GET and $POST naming convention.


    It's safe to pass an already converted array, in which case this method just returns the original array unmodified.

    returns An array of re-ordered uploaded file information

  • (integer) count () Browse code

    Returns the number of form fields (implements the Countable interface).

    returns The number of embedded form fields

  • (mixed) current () Browse code

    Returns the current form field (implements the Iterator interface).

    returns The escaped value

  • (array) deepArrayUnion ($array1, $array2) Browse code

    $array1 An array to merge
    $array2 An array to merge

    Merges two arrays without reindexing numeric keys.

    returns The merged array

  • disableCSRFProtection () Browse code

    Disables CSRF protection for all forms.

  • embedForm ($name, $form, $decorator = null) Browse code

    $name The field name
    $form A sfForm instance
    $decorator A HTML decorator for the embedded form

    Embeds a sfForm into the current form.

  • embedFormForEach ($name, $form, $n, $decorator = null, $innerDecorator = null, $options = array(), $attributes = array(), $labels = array()) Browse code

    $name The field name
    $form A sfForm instance
    $n The number of times to embed the form
    $decorator A HTML decorator for the main form around embedded forms
    $innerDecorator A HTML decorator for each embedded form
    $options Options for schema
    $attributes Attributes for schema
    $labels Labels for schema

    Embeds a sfForm into the current form n times.

  • enableCSRFProtection ($secret = null) Browse code

    $secret A secret to use when computing the CSRF token

    Enables CSRF protection for all forms.


    The given secret will be used for all forms, except if you pass a secret in the constructor. Even if a secret is automatically generated if you don't provide a secret, you're strongly advised to provide one by yourself.

  • fixPhpFilesArray ($data) Browse code

    $data

  • (string) getCSRFFieldName () Browse code

    Gets the CSRF field name.

    returns The CSRF field name

  • (string) getCSRFToken ($secret = null) Browse code

    $secret The secret string to use (null to use the current secret)

    Returns a CSRF token, given a secret.


    If you want to change the algorithm used to compute the token, you can override this method.

    returns A token string

  • getDefault ($name, 1) Browse code

    $name The field name
    1 The default value

    Gets a default value for a form field.

  • (array) getDefaults () Browse code

    Gets the default values for the form.

    returns An array of default values

  • (array) getEmbeddedForms () Browse code

    Gets the list of embedded forms.

    returns An array of embedded forms

  • getErrorSchema () Browse code

    Gets the error schema associated with the form.

    returns A sfValidatorErrorSchema instance

  • getFormFieldSchema () Browse code

    Returns a form field for the main widget schema.

    returns A sfFormFieldSchema instance

  • (array) getGlobalErrors () Browse code

    Gets the global errors associated with the form.

    returns An array of global errors

  • (array) getJavaScripts () Browse code

    Gets the JavaScript paths associated with the form.

    returns An array of JavaScript paths

  • (string) getName () Browse code

    Returns the array name under which user data can retrieved.


    If the user data is not stored under an array, it returns null.

    returns The name

  • getOption ($name, $default = null, 2) Browse code

    $name The option name
    $default The default value (null by default)
    2 The default value

    Gets an option value.

  • (array) getStylesheets () Browse code

    Gets the stylesheet paths associated with the form.

    returns An array of stylesheet paths

  • (array) getTaintedValues () Browse code

    Returns the submitted tainted values.

    returns An array of tainted values

  • (Exception) getToStringException () Browse code

    Gets the exception if one was thrown in the __toString() method.


    This is a hack needed because PHP does not allow to throw exceptions in __toString() magic method.

  • getValidator ($name) Browse code

    $name The field name

    Gets a validator for the given field name.

    returns The validator

  • getValidatorSchema () Browse code

    Gets the validator schema associated with this form.

    returns A sfValidatorSchema instance

  • (string) getValue ($field) Browse code

    $field The name of the value required

    Returns a cleaned value by field name.


    If the form is not bound, it will return null.

    returns The cleaned value

  • (array) getValues () Browse code

    Returns the array of cleaned values.


    If the form is not bound, it returns an empty array.

    returns An array of cleaned values

  • getWidget ($name) Browse code

    $name The field name

    Gets a widget for the given field name.

    returns The widget

  • getWidgetSchema () Browse code

    Gets the widget schema associated with this form.

    returns A sfWidgetFormSchema instance

  • hasDefault ($name, (Boolean) 1) Browse code

    $name The field name
    1 true if the form has a default value for this field, false otherwise

    Returns true if the form has a default value for a form field.

  • (Boolean) hasErrors () Browse code

    Returns true if the form has some errors.


    It returns false if the form is not bound.

    returns true if the form has no errors, false otherwise

  • (Boolean) hasGlobalErrors () Browse code

    Returns true if the form has some global errors.

    returns true if the form has some global errors, false otherwise

  • (boolean) hasToStringException () Browse code

    Returns true if a form thrown an exception in the __toString() method


    This is a hack needed because PHP does not allow to throw exceptions in __toString() magic method.

  • (Boolean) isBound () Browse code

    Returns true if the form is bound to input values.

    returns true if the form is bound to input values, false otherwise

  • isCSRFProtected () Browse code

    returns if this form is CSRF protected

  • (Boolean) isMultipart () Browse code

    Returns true if the form is multipart.

    returns true if the form is multipart

  • (Boolean) isValid () Browse code

    Returns true if the form is valid.


    It returns false if the form is not bound.

    returns true if the form is valid, false otherwise

  • (string) key () Browse code

    Gets the key associated with the current form field (implements the Iterator interface).

    returns The key

  • mergeForm ($form) Browse code

    $form The sfForm instance to merge with current form

    Merges current form widget and validator schemas with the ones from the sfForm object passed as parameter. Please note it also merge defaults.

    throws LogicException If one of the form has already been bound

  • mergePostValidator ($validator = null) Browse code

    $validator A validator to be merged

    Merges a validator with the current post validators.

  • mergePreValidator ($validator = null) Browse code

    $validator A validator to be merged

    Merges a validator with the current pre validators.

  • next () Browse code

    Moves to the next form field (implements the Iterator interface).

  • (Boolean) offsetExists ($name) Browse code

    $name The name of the bound field

    Returns true if the bound field exists (implements the ArrayAccess interface).

    returns true if the widget exists, false otherwise

  • offsetGet ($name) Browse code

    $name The offset of the value to get

    Returns the form field associated with the name (implements the ArrayAccess interface).

    returns A form field instance

  • offsetSet ($offset, $value) Browse code

    $offset (ignored)
    $value (ignored)

    Throws an exception saying that values cannot be set (implements the ArrayAccess interface).

    throws LogicException

  • offsetUnset ($offset) Browse code

    $offset The field name

    Removes a field from the form.


    It removes the widget and the validator for the given field.

  • (string) render ($attributes = array()) Browse code

    $attributes An array of HTML attributes

    Renders the widget schema associated with this form.

    returns The rendered widget schema

  • (string) renderFormTag ($url, $attributes = array()) Browse code

    $url The URL for the action
    $attributes An array of HTML attributes

    Renders the form tag.


    This methods only renders the opening form tag. You need to close it after the form rendering.

    This method takes into account the multipart widgets and converts PUT and DELETE methods to a hidden field for later processing.

    returns An HTML representation of the opening form tag

  • (string) renderGlobalErrors () Browse code

    Renders global errors associated with this form.

    returns The rendered global errors

  • (string) renderHiddenFields () Browse code

    Renders hidden form fields.

  • (string) renderUsing ($formatterName, $attributes = array()) Browse code

    $formatterName The form formatter name
    $attributes An array of HTML attributes

    Renders the widget schema using a specific form formatter

    returns The rendered widget schema

  • resetFormFields () Browse code

  • rewind () Browse code

    Resets the field names array to the beginning (implements the Iterator interface).

  • setCSRFFieldName ($name) Browse code

    $name The CSRF field name

    Sets the CSRF field name.

  • setDefault ($name, $default) Browse code

    $name The field name
    $default The default value

    Sets a default value for a form field.

  • setDefaults ($defaults) Browse code

    $defaults An array of default values

    Sets the default values for the form.


    The default values are only used if the form is not bound.

  • setOption ($name, $value) Browse code

    $name The option name
    $value The default value

    Sets an option value.

  • setToStringException ($e) Browse code

    $e The exception thrown by __toString()

    Sets an exception thrown by the __toString() method.


    This is a hack needed because PHP does not allow to throw exceptions in __toString() magic method.

  • setup () Browse code

    Setups the current form.


    This method is overridden by generator.

    If you want to do something at initialization, you have to override the configure() method.

  • setValidator ($name, $validator) Browse code

    $name The field name
    $validator The validator

    Set a validator for the given field name.

  • setValidators ($validators) Browse code

    $validators An array of named validators

    Sets the validators associated with this form.

  • setValidatorSchema ($validatorSchema) Browse code

    $validatorSchema A sfValidatorSchema instance

    Sets the validator schema associated with this form.

  • setWidget ($name, $widget) Browse code

    $name The field name
    $widget The widget

    Set a widget for the given field name.

  • setWidgets ($widgets) Browse code

    $widgets An array of named widgets

    Sets the widgets associated with this form.

  • setWidgetSchema ($widgetSchema) Browse code

    $widgetSchema A sfWidgetFormSchema instance

    Sets the widget schema associated with this form.

  • (boolean) valid () Browse code

    Returns true if the current form field is valid (implements the Iterator interface).

    returns The validity of the current element; true if it is valid

  • __clone () Browse code

  • __construct ($defaults = array(), $options = array(), $CSRFSecret = null) Browse code

    $defaults An array of field default values
    $options An array of options
    $CSRFSecret A CSRF secret (false to disable CSRF protection, null to use the global CSRF secret)

    Constructor.

  • (string) __toString () Browse code

    Returns a string representation of the form.

    returns A string representation of the form