symfony API

sfAdminGenerator Class

« Back to API menu

action

addon

cache

config

controller

countable

database

debug

exception

filter

generator

helper

i18n

log

request

response

storage

test

user

util

validator

view

You are currently browsing the symfony documentation for the 1.0 version. Switch to:

Admin generator.

Inheritence

sfPropelCrudGenerator  <  sfAdminGenerator  <  sfCrudGenerator < sfGenerator

Method Summary

  • string getButtonToAction($actionName, $params, $pk_link = false)
    Returns HTML code for an action button.
  • string addCredentialCondition($content, $params = array())
    Wraps content with a credential condition.
  • string getColumnEditTag($column, $params = array())
    Returns HTML code for a column in edit mode.
  • string getColumnListTag($column, $params = array())
    Returns HTML code for a column in list mode.
  • mixed getValueFromKey($key, $default = null)
    Gets the value for a given key.
  • array getColumnCategories($paramName)
    Returns all column categories.
  • string getHelpAsIcon($column, $type = &apos;&apos;)
    Returns HTML code for a help icon.
  • string getColumnFilterTag($column, $params = array())
    Returns HTML code for a column in filter mode.
  • string getHelp($column, $type = &apos;&apos;)
    Returns HTML code for a help text.
  • string replaceConstants($value)
    Replaces constants in a string.
  • escapeString($string, 1)
    Escapes a string.
  • string getI18NString($key, $default = null, $withEcho = true)
    Wraps a content for I18N.
  • mixed getParameterValue($key, $default = null)
    Gets a parameter value.
  • mixed getFieldParameterValue($key, $type = &apos;&apos;, $default = null)
    Gets a field parameter value.
  • array splitFlag($text)
    Gets modifier flags from a column name.
  • string getLinkToAction($actionName, $params, $pk_link = false)
    Returns HTML code for an action link.
  • array getColumns($paramName, $category = &apos;NONE&apos;)
    Gets sfAdminColumn objects for a given category.

Methods inherited from sfCrudGenerator

getRelatedClassName , getObjectTagParams , getColumnListTag , getPrimaryKeyUrlParams , getPluralName , getRetrieveByPkParamsForAction , getCrudColumnEditTag , getRetrieveByPkParamsForGetOrCreate , getColumnGetter , getPHPObjectHelper , getTableMap , loadMapBuilderClasses , getPeerClassName , getMethodParamsForGetOrCreate , loadPrimaryKeys , generate , getClassName , getPrimaryKeyIsSet , setScaffoldingClassName , getSingularName , getTestPksForGetOrCreate , getPrimaryKey , getMap

Methods inherited from sfGenerator

__call , generatePhpFiles , getModuleName , setTheme , initialize , setGeneratorClass , setGeneratedModuleName , getGeneratorManager , replacePhpMarks , generate , getGeneratedModuleName , evalTemplate , getTheme , setModuleName , getGeneratorClass

Method Details

  • (string) getButtonToAction ($actionName, $params, $pk_link = false)

    $actionName The action name
    $params The parameters
    $pk_link Whether to add a primary key link or not

    Returns HTML code for an action button.

    returns HTML code

  • (string) addCredentialCondition ($content, $params = array())

    $content The content
    $params The parameters

    Wraps content with a credential condition.

    returns HTML code

  • (string) getColumnEditTag ($column, $params = array())

    $column The column name
    $params The parameters

    Returns HTML code for a column in edit mode.

    returns HTML code

  • (string) getColumnListTag ($column, $params = array())

    $column The column name
    $params The parameters

    Returns HTML code for a column in list mode.

    returns HTML code

  • (mixed) getValueFromKey ($key, $default = null)

    $key The key name
    $default The default value

    Gets the value for a given key.

    returns The key value

  • (array) getColumnCategories ($paramName)

    $paramName The parameter name

    Returns all column categories.

    returns The column categories

  • (string) getHelpAsIcon ($column, $type = &apos;&apos;)

    $column The column name
    $type The field type (list, edit)

    Returns HTML code for a help icon.

    returns HTML code

  • (string) getColumnFilterTag ($column, $params = array())

    $column The column name
    $params The parameters

    Returns HTML code for a column in filter mode.

    returns HTML code

  • (string) getHelp ($column, $type = &apos;&apos;)

    $column The column name
    $type The field type (list, edit)

    Returns HTML code for a help text.

    returns HTML code

  • (string) replaceConstants ($value)

    Replaces constants in a string.

  • escapeString ($string, 1)

    Escapes a string.

  • (string) getI18NString ($key, $default = null, $withEcho = true)

    $key The key name
    $default The defaul value

    Wraps a content for I18N.

    returns HTML code

  • (mixed) getParameterValue ($key, $default = null)

    $key The key name
    $default The default value

    Gets a parameter value.

    returns The parameter value

  • (mixed) getFieldParameterValue ($key, $type = &apos;&apos;, $default = null)

    $key The key name
    $type The type (list, edit)
    $default The default value

    Gets a field parameter value.

    returns The parameter value

  • (array) splitFlag ($text)

    $text The column name

    Gets modifier flags from a column name.

    returns An array of detected flags

  • (string) getLinkToAction ($actionName, $params, $pk_link = false)

    $actionName The action name
    $params The parameters
    $pk_link Whether to add a primary key link or not

    Returns HTML code for an action link.

    returns HTML code

  • (array) getColumns ($paramName, $category = &apos;NONE&apos;)

    $paramName The parameter name

    Gets sfAdminColumn objects for a given category.

    returns sfAdminColumn array