symfony API

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

Model generator field.

Method Summary

  • mixed getConfig($key, $default, $escaped)
    Returns the configuration value for a given key.
  • string getFlag()
    Gets the flag associated with the field.
  • string getName()
    Returns the name of the field.
  • mixed getRenderer()
    Gets the list renderer for the field.
  • array getRendererArguments()
    Gets the list renderer arguments for the field.
  • string getType()
    Returns the type of the field.
  • boolean isComponent()
    Returns true if the column is a component.
  • boolean isLink()
    Returns true if the column has a link.
  • boolean isPartial()
    Returns true if the column is a partial.
  • boolean isReal()
    Returns true if the column maps a database column.
  • setComponent($boolean)
    Sets or unsets the component flag.
  • setFlag($flag)
    Sets a flag.
  • setLink($boolean)
    Sets or unsets the link flag.
  • setPartial($boolean)
    Sets or unsets the partial flag.
  • setRenderer($renderer)
    Sets the list renderer for the field.
  • setRendererArguments($arguments)
    Sets the list renderer arguments for the field.
  • splitFieldWithFlag()
  • __construct($name, $config)
    Constructor.

Method Details

  • (mixed) getConfig ($key, $default, $escaped) Browse code

    $key A key string
    $default The default value if the key does not exist
    $escaped Whether to escape single quote (false by default)

    Returns the configuration value for a given key.


    If the key is null, the method returns all the configuration array.

    returns The configuration value associated with the key

  • (string) getFlag () Browse code

    Gets the flag associated with the field.


    The flag will be

    * = for a link
    * _ for a partial
    * ~ for a component

    returns The flag

  • (string) getName () Browse code

    Returns the name of the field.

    returns The field name

  • (mixed) getRenderer () Browse code

    Gets the list renderer for the field.

    returns A PHP callable

  • (array) getRendererArguments () Browse code

    Gets the list renderer arguments for the field.

    returns An array of arguments to pass to the renderer

  • (string) getType () Browse code

    Returns the type of the field.

    returns The field type

  • (boolean) isComponent () Browse code

    Returns true if the column is a component.

    returns true if the column is a component, false otherwise

  • (boolean) isLink () Browse code

    Returns true if the column has a link.

    returns true if the column has a link, false otherwise

  • (boolean) isPartial () Browse code

    Returns true if the column is a partial.

    returns true if the column is a partial, false otherwise

  • (boolean) isReal () Browse code

    Returns true if the column maps a database column.

    returns true if the column maps a database column, false otherwise

  • setComponent ($boolean) Browse code

    $boolean true if the field is a component, false otherwise

    Sets or unsets the component flag.

  • setFlag ($flag) Browse code

    $flag The flag

    Sets a flag.


    The flag can be =, _, or ~.

  • setLink ($boolean) Browse code

    $boolean true if the field is a link, false otherwise

    Sets or unsets the link flag.

  • setPartial ($boolean) Browse code

    $boolean true if the field is a partial, false otherwise

    Sets or unsets the partial flag.

  • setRenderer ($renderer) Browse code

    $renderer A PHP callable

    Sets the list renderer for the field.

  • setRendererArguments ($arguments) Browse code

    $arguments An array of arguments to pass to the renderer

    Sets the list renderer arguments for the field.

  • splitFieldWithFlag () Browse code

  • __construct ($name, $config) Browse code

    $name The field name
    $config The configuration for this field

    Constructor.