symfony API

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 API for the 1.0 version. Switch to:

action

  • sfAction: sfAction executes all the logic for the current request.
  • sfActions: sfActions executes all the logic for the current request.
  • sfActionStack: sfActionStack keeps a list of all requested actions and provides accessor methods for retrieving individual entries.
  • sfActionStackEntry: sfActionStackEntry represents information relating to a single sfAction request during a single HTTP request.
  • sfComponent: sfComponent.
  • sfComponents: sfComponents.

addon

cache

  • sfCache: sfCache is an abstract class for all cache classes in symfony.
  • sfFileCache: Cache class that stores content in files.
  • sfFunctionCache: This class can be used to cache the result and output of functions/methods.
  • sfProcessCache: sfProcessCache stores content in memory if you run a PHP accelerator.
  • sfSQLiteCache: Cache class that stores content in a sqlite database.

config

  • sfAutoloadConfigHandler:
  • sfCacheConfigHandler: sfCacheConfigHandler allows you to configure cache.
  • sfCompileConfigHandler: sfCompileConfigHandler gathers multiple files and puts them into a single file.
  • sfConfig: sfConfig stores all configuration information for a symfony application.
  • sfConfigCache: sfConfigCache allows you to customize the format of a configuration file to make it easy-to-use, yet still provide a PHP formatted result for direct inclusion into your modules.
  • sfConfigHandler: sfConfigHandler allows a developer to create a custom formatted configuration file pertaining to any information they like and still have it auto-generate PHP code.
  • sfDatabaseConfigHandler: sfDatabaseConfigHandler allows you to setup database connections in a configuration file that will be created for you automatically upon first request.
  • sfDefineEnvironmentConfigHandler:
  • sfFactoryConfigHandler: sfFactoryConfigHandler allows you to specify which factory implementation the system will use.
  • sfFilterConfigHandler: sfFilterConfigHandler allows you to register filters with the system.
  • sfGeneratorConfigHandler: sfGeneratorConfigHandler.
  • sfLoggingConfigHandler: sfLoggingConfigHandler allows you to configure logging and register loggers with the system.
  • sfPhpConfigHandler: sfPhpConfigHandler allows you to override php.ini configuration at runtime.
  • sfRootConfigHandler: sfRootConfigHandler allows you to specify configuration handlers for the application or on a module level.
  • sfRoutingConfigHandler:
  • sfSecurityConfigHandler: sfSecurityConfigHandler allows you to configure action security.
  • sfSimpleYamlConfigHandler: sfSimpleYamlConfigHandler allows you to load simple configuration files formatted as YAML.
  • sfValidatorConfigHandler: sfValidatorConfigHandler allows you to register validators with the system.
  • sfViewConfigHandler: sfViewConfigHandler allows you to configure views.
  • sfYamlConfigHandler: sfYamlConfigHandler is a base class for YAML (.yml) configuration handlers. This class provides a central location for parsing YAML files and detecting required categories.

controller

  • sfConsoleController:
  • sfController: sfController directs application flow.
  • sfFrontWebController: sfFrontWebController allows you to centralize your entry point in your web application, but at the same time allow for any module and action combination to be requested.
  • sfRouting: sfRouting class controls the creation of URLs and parses URLs. It maps an array of parameters to URLs definition.
  • sfWebController: sfWebController provides web specific methods to sfController such as, url redirection.

countable

database

  • sfDatabase: sfDatabase is a base abstraction class that allows you to setup any type of database connection via a configuration file.
  • sfDatabaseManager: sfDatabaseManager allows you to setup your database connectivity before the request is handled. This eliminates the need for a filter to manage database connections.
  • sfMySQLDatabase: sfMySQLDatabase provides connectivity for the MySQL brand database.
  • sfPDODatabase: sfPDODatabase provides connectivity for the PDO database abstraction layer.
  • sfPostgreSQLDatabase: sfPostgreSQLDatabase provides connectivity for the PostgreSQL brand database.
  • sfPropelDatabase: A symfony database driver for Propel, derived from the native Creole driver.
  • sfPropelDataRetriever: sfGenerator is the abstract base class for all generators.

debug

  • sfDebug: sfDebug provides some method to help debugging a symfony application.
  • sfWebDebug: sfWebDebug creates debug information for easy debugging in the browser.

exception

  • sfActionException: sfActionException is thrown when an error occurs in an action.
  • sfAutoloadException: sfAutoloadException is thrown when a class that has been required cannot be loaded.
  • sfCacheException: sfCacheException is thrown when ConfigCache fails to execute properly.
  • sfConfigurationException: sfConfigurationException is thrown when the framework finds an error in a configuration setting.
  • sfContextException: sfContextException is thrown when an instance of the context has not been created.
  • sfControllerException: sfControllerException is thrown when a requested Controller implementation doesn't exist.
  • sfDatabaseException: sfDatabaseException is thrown when a database related error occurs.
  • sfError404Exception: sfError404Exception is thrown when a 404 error occurs in an action.
  • sfException: sfException is the base class for all symfony related exceptions and provides an additional method for printing up a detailed view of an exception.
  • sfFactoryException: sfFactoryException is thrown when an error occurs while attempting to create a new factory implementation instance.
  • sfFileException: sfFileException is thrown when an error occurs while moving an uploaded file.
  • sfFilterException: sfFilterException is thrown when an error occurs while attempting to initialize or execute a filter.
  • sfForwardException: sfForwardException is thrown when an error occurs while attempting to forward the request.
  • sfInitializationException: sfInitializationException is thrown when an initialization procedure fails.
  • sfParseException: sfParseException is thrown when a parsing procedure fails to complete successfully.
  • sfRenderException: sfRenderException is thrown when a view's pre-render check fails.
  • sfSecurityException: sfSecurityException is thrown when a security related error occurs.
  • sfStopException: sfStopException is thrown when you want to stop action flow.
  • sfStorageException: sfStorageException is thrown when a requested sfStorage implementation doesn't exist or data cannot be read from or written to the storage.
  • sfValidatorException: sfValidatorException is thrown when an error occurs in a validator.
  • sfViewException: sfViewException is thrown when an error occurs in a view.

filter

  • sfBasicSecurityFilter: sfBasicSecurityFilter checks security by calling the getCredential() method of the action. Once the credential has been acquired, sfBasicSecurityFilter verifies the user has the same credential by calling the hasCredential() method of SecurityUser.
  • sfCacheFilter: sfCacheFilter deals with page caching and action caching.
  • sfCommonFilter: sfCommonFilter automatically adds javascripts and stylesheets information in the sfResponse content.
  • sfExecutionFilter: sfExecutionFilter is the last filter registered for each filter chain. This filter does all action and view execution.
  • sfFillInFormFilter: sfFillInFormFilter fills in forms.
  • sfFilter: sfFilter provides a way for you to intercept incoming requests or outgoing responses.
  • sfFilterChain: sfFilterChain manages registered filters for a specific context.
  • sfFlashFilter: sfFlashFilter removes flash attributes from the session.
  • sfRenderingFilter: sfRenderingFilter is the last filter registered for each filter chain. This filter does the rendering.
  • sfSecurityFilter: sfSecurityFilter provides a base class that classifies a filter as one that handles security.
  • sfWebDebugFilter:

generator

helper

i18n

log

request

  • sfConsoleRequest:
  • sfRequest: sfRequest provides methods for manipulating client request information such as attributes, errors and parameters. It is also possible to manipulate the request method originally sent by the user.
  • sfWebRequest: sfWebRequest class.

response

  • sfConsoleResponse: sfConsoleResponse provides methods for manipulating client response in cli environment.
  • sfResponse: sfResponse provides methods for manipulating client response information such as headers, cookies and content.
  • sfWebResponse: sfWebResponse class.

storage

  • sfMySQLSessionStorage: Provides support for session storage using a MySQL brand database.
  • sfPDOSessionStorage: Provides support for session storage using a PDO database abstraction layer.
  • sfPostgreSQLSessionStorage: Provides support for session storage using a PostgreSQL brand database.
  • sfSessionStorage: sfSessionStorage allows you to store persistent symfony data in the user session.
  • sfSessionTestStorage: sfSessionTestStorage is a fake sfSessionStorage implementation to allow easy testing.
  • sfStorage: sfStorage allows you to customize the way symfony stores its persistent data.

test

  • sfTestBrowser: sfTestBrowser simulates a fake browser which can test a symfony application.

user

  • sfBasicSecurityUser: sfBasicSecurityUser will handle any type of data as a credential.
  • sfSecurityUser: sfSecurityUser interface provides advanced security manipulation methods.
  • sfUser: sfUser wraps a client session and provides accessor methods for user attributes. It also makes storing and retrieving multiple page form data rather easy by allowing user attributes to be stored in namespaces, which help organize data.

util

  • sfBrowser: sfBrowser simulates a fake browser which can surf a symfony application.
  • sfContext: sfContext provides information about the current application context, such as the module and action names and the module directory. References to the current controller, request, and user implementation instances are also provided.
  • sfCore: core symfony class.
  • sfDomCssSelector: sfDomCssSelector allows to navigate a DOM with CSS selector.
  • sfFakeRenderingFilter: sfFilter provides a way for you to intercept incoming requests or outgoing responses.
  • sfFillInForm:
  • sfFinder: Allow to build rules to find files and directories.
  • sfGlobToRegex: Match globbing patterns against text.
  • sfInflector:
  • sfLoader: sfLoader is a class which contains the logic to look for files/classes in symfony.
  • sfMixer: sfMixer implements mixins and hooks.
  • sfNumberCompare: Numeric comparisons.
  • sfParameterHolder: sfParameterHolder provides a base class for managing parameters.
  • sfPropelManyToMany:
  • sfTimer: sfTimer class allows to time some PHP code.
  • sfTimerManager: sfTimerManager is a container for sfTimer objects.
  • sfToolkit: sfToolkit provides basic utility methods.
  • sfYaml: sfYaml class.

validator

  • sfCallbackValidator: sfCallbackValidator allows you to use a custom callback function or method to validate the input. The function should return true on valid and false on invalid and should be callable using is_callable().
  • sfCompareValidator: sfCompareValidator checks the equality of two different request parameters.
  • sfDateValidator: sfDateValidator verifies a parameter is of a date format.
  • sfEmailValidator: sfEmailValidator verifies a parameter contains a value that qualifies as an email address.
  • sfFileValidator: sfFileValidator allows you to apply constraints to file upload.
  • sfHtmlValidator:
  • sfNumberValidator: sfNumberValidator verifies a parameter is a number and allows you to apply size constraints.
  • sfPropelUniqueValidator: sfPropelUniqueValidator validates that the uniqueness of a column.
  • sfRegexValidator: sfRegexValidator allows you to match a value against a regular expression pattern.
  • sfStringValidator: sfStringValidator allows you to apply string-related constraints to a parameter.
  • sfUrlValidator: sfUrlValidator verifies a parameter contains a value that qualifies as a valid URL.
  • sfValidator: sfValidator allows you to apply constraints to user entered parameters.
  • sfValidatorManager: sfValidatorManager provides management for request parameters and their associated validators.

view