Symfony wiki

This is the symfony community wiki. It contains user-contributed documentation, tutorials and resources. For updates about the symfony core, you can browse the source, check the last changes or see the bug reports. Contributions and comments are welcome.

Contributing

• HowToContributeToSymfony: The page you must read if you want to contribute to symfony

Plugins

• SymfonyPlugins - List of all available plugins
• OfficialProposedPlugins - List of all proposed official plugins for symfony for discussion

Symfony in your language

Localized resources are available in several languages:

• ?? (Chinese)
• Deutsch
• Español
• Français
• Italiano
• ??? (Japanese)
• Polski
• Português do Brasil
• Româna
• Russian
• Ukrainian
• Ceština
• Nederlands
• Ti?ng Vi?t (Vietnamese)
• Indonesian (Bahasa Indonesia)
• Magyar
• ??????
• Suomi
• ??? (Korean)

The askeet tutorial has built-in translations. If you want to add another translation or contribute to ongoing efforts, read the documentation contributors guide.

Symfony communities exist in many languages. Check the existing localized mailing-lists and Localized IRC channels.

The wiki also contains old (and outdated) translations of the documentation: My first project, symfony Book.

FAQ and Howtos

• Cheat Sheets
• Code snippets
• Upgrade from 1.1 to the 1.2 Beta
• Upgrade from 1.0 to 1.1
• Frequently Asked Questions
• Model/Database
  • ApplyingCustomJoinsInDoSelect - Write your own doSelect* method to join any tables you like
  • ApplyingCustomJoinsUsingHelper - A helper class that saves you from writing doSelect* methods
  • ComparingPropelAndDoctrine - Concise overview of the 2 major symfony ORM choices.
  • CompletelyRemovePropel - How to completely remove any db abstraction from Symfony
  • ConvertPropelSchemaToDoctrineSchema - How to convert propel schema to doctrine schema
  • DBDesigner2PropelTool - Download version of a php DBDesigner2Propel conversion tool for local use.
  • HowToApplyTransformationsToSchema - Custom pake task used to apply XSL transformations to schema.xml
  • HowtoBuildASchemaWithoutVendorInfo - How to generate an XML data model without DBMS-specific vendor information.
  • HowToCallVariablePropelMethod - How to call a propel method when the method name is variable
  • HowtoCrossTables - Building admin_generated crosstables (hashtables) with symfony and DBDesigner 4
  • HowToExtendPropelPluginModel - Extend model of plugins using Propel ORM, resolve autoloading problems
  • HowToHandleHierarchicalDataWithPropel - How to handle a tree using propel models ( preorder tree traversal algorithm )
  • HowToRetrieveaCreoleConnection - How to retrieve a Creole connection.
  • HowtoSelectDistinct - How to make a function to SELECT DISTINCT in the xxxPeer class.
  • HowtoUseDbDesigner4XML - Applying an XSL transform to DbDesigner 4 XML to get propel schema.xml
  • HowToUseSqLite - How to configure the data layer to use SQLite.
  • PropelCriteriaDocs - How to use Propel criteria objects and methods
  • Transactions - How to insert multiple items with one transaction (increases performance with lots of inserts)
  • HowToPatchSymfony1.1ToThePostgreSQLWorkingMultipleSchemas - Apply the patch for the symfony 1.1 work with multiple schemas of PostgreSQL
  • SymfonyYamlMyqlWorkbenchPlugin - Export symfony 1.1 YAML format directly from Mysql Workbench
  • ConvertingPropelProjectToDoctrine - howto for converting propel projects into doctrine (in progress)

• I18n and Multilinguism
  • HowToGenerateI18NFiles - How to generate internationalization files from your sources/generator and validator
  • HowToHandlei18nDbFieldsWithAdminGenerator - How to handle i18n db fields with the Admin Generator
  • HowToHandlei18nDbFieldsWithAdminGeneratorMethod2 - How to handle i18n db fields with the Admin Generator Method 2
  • HowToHandlei18nDbFieldsWithAdminGenerator1.2 - How to handle i18n db fields with Admin generator for symfony 1.2
  • HowToPatchTablesForI18nFromGeneratedSchema - How to patch the reverse-engineered database using a simple Pake task that modifies the YAML file to use I18n-specific markers
  • HowToUseI18NWithGettext - How to use gettext i18N with symfony
  • HowToUse18NOverMysql - How to store your translations in a MySQL database
  • moreI18n - Propel and I18n, Improve performance.

• Configuration
  • HowToCacheCustomConfiguration - How to use caching in custom configuration files
  • HowtoChooseApplicationAndEnvironmentBasedOnDomain - How to choose Application and Environment based on domain name
  • HowToPlanConfigurationPlacement - How to plan (best practices) configuration settings placement in your project.
  • HowtoWriteYamlDynamically - How to write YAML configuration files programatically.
  • HowToHandleCrossAppsConfigurationFiles - How to manage and cache your own cross-apps/global YAML configuration files
  • HowToDoMultipleSitesWithSingleCore - Used when multiple distinct domains use the same configuration
  • HowToConnectToMSSQLServer - How to connect and use MSSQL Server with symfony 1.2

• Add-ons
  • HowToUseFCKeditor - How to use fckeditor with working image upload?
  • LuceneInSymfony - How to use the Lucene search engine from the Zend libraries in a symfony application (tutorial update and Lucene plugin)
  • ReplacingPropelWithEZPDO - How to replace Symfony's default Propel installation with ezPDO
  • sfChecklistsHelper - The checklists from www.c82.net/samples/checklist-samples.html as a symfony helper plugin
  • sfDoctrinePlugin - Integration of the doctrine ORM
  • UploadProgress - Simple upload progress bar with jquery/apc.rfc1867
  • sfGuardPluginExtraDocumentation (Es) (pt_BR) - How to use the sfGuardPlugin - a beginners guide

• CAPTCHA
  • HowToCaptcha - How to implement a CAPTCHA image
  • How to add a captcha field in Symfony 1.1 - Possibly (should) work with Symfony 1.2.

• AJAX and JavaScript
  • AjaxAndJSON - Another way to play with Ajax, json and multiple updates at a time
  • AjaxInteractions - Approach to using Ajax within Web Applications
  • How to initialize Javascript with JSON - How to initialize Javascript vars from action (use JsonHelper.php)
  • sfDojo - Integration of dojo toolkit on Symfony

• Lime Testing
  • HowToSaveLimeTestsInXUnitFormatAndIntegrateThemWithCruiseControl - How to save Lime tests in xUnit format and integrate them with Cruise
  • LimeFunctionalTestingHints - Some hints to help you with the tricky bits
  • LimeTestingFramework - Information and examples of the new Lime testing framework (for reference before official docs are created)

• User Management
  • Step by step how to do email login using Symfony 1.2, Propel, sfGuardPlugin
  • Step by step how to do email login using Symfony 1.0, Propel, sfGuardPlugin

• Forms
  • HowToRenameFileAfterUpload - How to rename a file after uploading it and optionally include the saved object's properties as part of the filename.
  • HowToCreateReadOnlyField - Several methods to create a read-only field
  • EmbeddedForms - Creating and editing Embedded Forms

• Miscellaneous
  • Build Scalable Web 2.0 Sites with Ubuntu, Symfony, and Lighttpd - Making a website scalable using Ubuntu, Lighttpd, MySQL, PHP, eAccelerated, SQLite, and Memched while developing with Symfony.
  • CAS for authentication - Use CAS (Central Authentication System) to provide authentication
  • DatabaseFileStorageSystem - Describes a complete system for storing files in a database, caching them to enhance performance, and serving the files with nice URLs (project download available)
  • HowtoAddHTTPAuthSupport
  • HowToExportTabularData - How to export tabular data to a spreadsheet.
  • HowToExtendTheAdminGenerator - Tutorial that shows how to extend the admin generator for you own needs with a concrete example (batch deletion for 1.0) (extending sfActions, sfPropelGenerator)
  • HowtoSortAdminGeneratorListByForeignTableName - Your table contains foreign keys referencing other tables. The built-in "sort by" feature of the admin generator sorts these by ID, not by the name field in the foreign table. The filter pulldown menus have the same problem. This article presents simple and effective ways to sort alphabetically by the name field of any foreign table your table contains references to.
  • HowtoAddCustomFilterCriteria - How to add custom criteria to an admin generator filter. This is essential if you need criteria based on a secondary table joined with the table you are administering (for instance, sfGuardUserGroup...)
  • HowToHandleSameCodeInAComponentAndAnAction - describes how one should handle code which is used in a component in an action
  • HowToIncludeASpecialStylesheet - How to include a stylesheet depending on the user's browsers
  • HowToIntegrateWordPressAndBbPressWithSymfony - integrating WordPress? and bbPress into a symfony core
  • HowtoMultipleSFProjectsLocal - Using multiple symfony projects on a local machine
  • HowtoServeStaticContent - How to provide static content using partials.
  • HowToUseTheSubversionIdTag - How to get Subversion file version information in your files.
  • Performance Optimization - Techniques for speeding up, optimizing, and scaling your symfony application.
  • SSLRedirectionFilter - How to automatically redirect users requesting secure actions to your SSL server, and back again afterwards.
  • Symfony interactive shell - An IRB-like symfony interactive shell; access Propel objects, symfony classes etc right from the shell prompt
  • formatDateHowTo - A reference for the very usefull format_date symfony helper (view layer)

Installing symfony

Because many people have had problems using pear for installation, the officialy recommended way of installing symfony is using a svn export/checkout, or extracting a package.

• General
  • Official Installation instructions for all supported versions
  • Installing Multiple Versions Of Symfony
  • Installing Symfony In a sub-directory
  • Installing symfony with safe_mode enabled
  • Installing Symfony In a sub-directory with CentOS 5 and Plesk 10

• Linux
  • Installation Symfony on Ubuntu "Dapper Drake"
  • Installer symfony sur UBUNTU 7.04 "Feisty Fawn" (French)
  • Installing Symfony on SUSE 10.0
  • Install Symfony over lighttpd with php5-fastcgi

• OS X
  • How to get your environment on Intel MacOsX platform
  • Installing Symfony on Mac OSX with PHP binary from Entropy
  • Installing Symfony without PEAR on MacOSX: & *NIX, too ...
  • Setting up a osX Development Environment for Symfony

• Windows
  • How a beginner got it working with XAMPP on Windows
  • Installer symfony sur XP avec XAMPP (French)
  • How to install PEAR on windows with WAMP
  • How to install Symfony on windows with WAMP
  • Setting up Symfony for IIS
  • Setting up a Windows XP Development Environment for Symfony
  • Setting up a vhost to separate