Write Plugins for symfony (Symfony Camp 2007)
5 likes2,053 views
This document provides instructions on how to write plugins for the Symfony framework. It discusses plugin directory structure, adding web assets, models, configuration, modules, and publishing plugins on symfony-project.com. The goal is to allow developers to package and share reusable Symfony extensions.
![Symfony Camp 2007 www.symfony-project.com fabien.potencier@sensio.com www.sensiolabs.com
Add some Model Classes
• config/schema.[xml|yml]
<database name="propel"
package="plugins.fpPropelSimplePlugin.lib.model" ...>
propel:
_attributes:
package: plugins.fpPropelSimplePlugin.lib.model
• You can have foreign keys between plugins and
the main application](https://image.slidesharecdn.com/symfony-camp-2007-write-plugins-090909074432-phpapp02/85/Write-Plugins-for-symfony-Symfony-Camp-2007-7-320.jpg)
Write Plugins for symfony (Symfony Camp 2007)
- 1. Symfony Camp 2007 www.symfony-project.com [email protected] www.sensiolabs.com symfony Write Plugins Fabien Potencier http://www.symfony-project.com/ http://www.sensiolabs.com/
- 2. Symfony Camp 2007 www.symfony-project.com [email protected] www.sensiolabs.com What is a Plugin? • Directory structure convention •Classes •Filters •Mixins •Helpers •Configuration •Tasks •Modules •Schemas •Model Extensions •Fixtures •Web Assets
- 3. Symfony Camp 2007 www.symfony-project.com [email protected] www.sensiolabs.com What for? •To contribute back a symfony extension •Another way to package your code •To share code between projects Portability
- 4. Symfony Camp 2007 www.symfony-project.com [email protected] www.sensiolabs.com Let’s build a plugin
- 5. Symfony Camp 2007 www.symfony-project.com [email protected] www.sensiolabs.com Plugin Creation • Choose a name – Choose a prefix (sf is only for Official Plugins) - Your initials for example – If it depends on Propel or Doctrine, add it to the prefix – Choose a main name – Add the « Plugin » suffix • For our simple plugin: fpPropelSimplePlugin • Create a folder plugins/fpPropelSimplePlugin
- 6. Symfony Camp 2007 www.symfony-project.com [email protected] www.sensiolabs.com Add some Web Assets • Put assets in a web/ folder – web/js – web/css – web/images • symfony plugin-install … – Creates a symlink on *nix – Copies all files on Windows in the web/fpPropelSimplePlugin folder plugins/fpPropelSimplePlugin/web/images/test.png > http://localhost/fpPropelSimplePlugin/images/test.png
- 7. Symfony Camp 2007 www.symfony-project.com [email protected] www.sensiolabs.com Add some Model Classes • config/schema.[xml|yml] <database name="propel" package="plugins.fpPropelSimplePlugin.lib.model" ...> propel: _attributes: package: plugins.fpPropelSimplePlugin.lib.model • You can have foreign keys between plugins and the main application
- 8. Symfony Camp 2007 www.symfony-project.com [email protected] www.sensiolabs.com Example sfSimpleBlogPlugin
- 9. Symfony Camp 2007 www.symfony-project.com [email protected] www.sensiolabs.com Add some Configuration • Make your plugin customizable – apps/APP/config/app.yml – Prefix with the plugin name – sfConfig::get(‘app_fpPropelSimplePlugin_XXX’); • config/config.php – Do whatever configuration you want
- 10. Symfony Camp 2007 www.symfony-project.com [email protected] www.sensiolabs.com Example • sfGuardPlugin config/config.php apps/APP/config/app.yml
- 11. Symfony Camp 2007 www.symfony-project.com [email protected] www.sensiolabs.com Propel Behaviors • sfPropelParanoidBehaviorPlugin config/config.php
- 12. Symfony Camp 2007 www.symfony-project.com [email protected] www.sensiolabs.com Add some Modules • Same structure as a « normal » module – You can move module from your application to the modules/ plugin folder – But you must « enable » it in settings.yml
- 13. Symfony Camp 2007 www.symfony-project.com [email protected] www.sensiolabs.com Example • sfGuardPlugin: Admin Generated modules • sfSimpleCMSPlugin – Actions inheritance – Templates inheritance
- 14. Symfony Camp 2007 www.symfony-project.com [email protected] www.sensiolabs.com Don’t Reinvent the Wheel • Don’t add a security mechanism – Rely on symfony built-in credentials – Use other plugins (sfGuardPlugin) • Don’t add a media library – Use sfMediaLibraryPlugin • Don’t create yet another plugin to do client side validation – Try to enhance existing ones – Contact the main author to discuss your enhancements
- 15. Symfony Camp 2007 www.symfony-project.com [email protected] www.sensiolabs.com Add a LICENSE file • Choose an Open-Source license – MIT – BSD – LGPL – GPL – … • Add a LICENSE file in the root folder
- 16. Symfony Camp 2007 www.symfony-project.com [email protected] www.sensiolabs.com Add a README file • README structure – Installation – Configuration – Customization – Known Limitations – Todo List – Change Log • Trac Wiki Format
- 17. Symfony Camp 2007 www.symfony-project.com [email protected] www.sensiolabs.com Package a Plugin • A symfony Plugin package is a PEAR package • Add a package.xml – Name – Description – Summary – Author(s) – Version – Stability – Dependencies
- 18. Symfony Camp 2007 www.symfony-project.com [email protected] www.sensiolabs.com
- 19. Symfony Camp 2007 www.symfony-project.com [email protected] www.sensiolabs.com Publish It • For private usage – Host it somewhere symfony plugin-install http://plugins.xxx.com/fpPropelSimplePlugin-1.0.0.tgz • Host it on symfony-project.com – Must be released under an Open-Source license – The community helps you fix bugs and enhance it – Fame
- 20. Symfony Camp 2007 www.symfony-project.com [email protected] www.sensiolabs.com On symfony-project.com • Create a trac account • Create a new Wiki page named after your plugin name • Attach the PEAR package • Ask Fabien for SVN access • Spread the word… post on the mailing-list & the forum
- 21. Symfony Camp 2007 www.symfony-project.com [email protected] www.sensiolabs.com Next symfony Workshops En français : Paris, France - Dec 05, 2007 In English : Paris, France - Feb 13, 2008 More info on www.sensiolabs.com
- 22. Symfony Camp 2007 www.symfony-project.com [email protected] www.sensiolabs.com Join Us • Sensio Labs is recruiting in France – project managers – web developers • You have a passion for the web? – Web Developer : You have a minimum of 3 years experience in web development with Open-Source projects and you wish to participate to development of Web 2.0 sites using the best frameworks available. – Project Manager : You have more than 5 years experience as a developer and/or a project manager and you want to manage complex Web projects for prestigious clients.
- 23. Symfony Camp 2007 www.symfony-project.com [email protected] www.sensiolabs.com SENSIO S.A. 26, rue Salomon de Rothschild 92 286 Suresnes Cedex FRANCE Tél. : +33 1 40 99 80 80 Fax : +33 1 40 99 83 34 Contact Fabien Potencier [email protected] http://www.sensiolabs.com/ http://www.symfony-project.com/