Symfony2 tutorial geared towards Midgard developers

1. Symfony2 for Midgard Developers

2. Symfony2 is becoming the
de-facto web framework for PHP 5.3

3. Drupal

4. Zend Framework

5. Midgard MVC

6. MidCOM

7. The PHP world is starting to unite around Symfony2

11. Under MIT License
Copyright (c) 2004-2011 Fabien Potencier
Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation
files (the "Software"), to deal in the Software without
restriction, including without limitation the rights to use,
copy, modify, merge, publish, distribute, sublicense, and/or
sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following
conditions:
The above copyright notice and this permission notice shall
be included in all copies or substantial portions of the
Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY
KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE
WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE
AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
OTHER DEALINGS IN THE SOFTWARE.

12. Symfony 2.0 was released on July 28 2011

14. Symfony2 is a collection of standalone PHP components
bundled together into a single framework

15. You can choose what to take, and what to not use

16. ✔ Authentication and Authorization
✔ Forms and Validation
✔ Templating
✔ Logging
✔ Asset Management
✔ Routing
✔ Internationalization
✔ Console Tasks
✔ Caching

17. Dependency Injection means you can change
any of these to another implementation

18. <?php
$this->container->get('security.context')->isGranted(
'READ', $object)
The actual service checking this could be
MidCOM-style ACL, or simple "allow authenticated
users to do anything" check.

19. PHP 5.3 and namespaces

20. Midgard MVC & MidCOM
<?php
class example_mycomponent_controllers_some
{
Symfony2
<?php
namespace ExampleMyBundleController;
use SymfonyFrameworkWebBundleController;
class SomeController extends Controller
{

21. is the new _

22. With namespaces all projects can share one autoloader.

23. <?php
$crRoot = realpath(__DIR__ . '/..');
// register the autoloaders
require "{$crRoot}/SplClassLoader.php";
// Tell where Midgard stuff is
$midgardAutoloader = new SplClassLoader('Midgard', "{$crRoot}/src");
$midgardAutoloader->register();
// Tell where code from some other project is
$phpcrAutoloader = new SplClassLoader('PHPCR', "{$crRoot}/lib/PHPCR/src");
$phpcrAutoloader->register();

24. Time to get the hands dirty

25. You'll need:
• PHP 5.3
• php5-midgard2
• PEAR installer
• Git

26. Symfony2 Standard Edition

27. http://symfony.com/download

29. $ php app/check.php
********************************
* *
* Symfony requirements check *
* *
********************************
php.ini used by PHP: /etc/php5/cli/php.ini
** Mandatory requirements **
OK Checking that PHP version is at least 5.3.2 (5.3.5-1ubuntu7.2 installed)
OK Checking that the "date.timezone" setting is set
OK Checking that app/cache/ directory is writable
...

30. Dependencies are defined in the deps file
[AsseticBundle]
git=http://github.com/symfony/AsseticBundle.git
target=/bundles/Symfony/Bundle/AsseticBundle
version=v1.0.0RC2

31. Now you could just use the web dir
stuff in your regular web server.

32. However, we'll be using AppServer-in-PHP
$ pear channel-discover pear.indeyets.pp.ru
$ pear install indeyets/aip

33. Add AiP integration as dependency
[AppServerBundle]
git=http://github.com/bergie/MidgardAppServerBundle.git
target=Midgard/AppServerBundle
Install with $ php bin/vendors install --reinstall

34. Copy aip.yaml.example from
vendor/Midgard/AppServerBundle
to the app dir as aip.yaml

35. Add Midgard namespace to autoloader
$loader->registerNamespaces(array(
...
'Midgard' => __DIR__.'/../vendor',

36. Start AiP aip app app/aip.yaml
Go to http://localhost:8001

37. Now, to write some code!
$ php app/console generate:bundle
Let Symfony2 create a Acme/ExampleBundle for you.

38. src/Acme/ExampleBundle

39. http://localhost:8001/hello/World

40. src/Acme/ExampleBundle/Controller/DefaultController.php
<?php
namespace AcmeExampleBundleController;
use SymfonyBundleFrameworkBundleControllerController;
use SensioBundleFrameworkExtraBundleConfigurationRoute;
use SensioBundleFrameworkExtraBundleConfigurationTemplate;
class DefaultController extends Controller
{
/**
* @Route("/hello/{name}")
* @Template()
*/
public function indexAction($name)
{
return array('name' => $name);
}
}

41. src/Acme/ExampleBundle/Resources/views/Default/index.html.twig
Hello {{ name }}!

42. How did this template get loaded?
/**
* @Template()
*/
...
return array('name' => $name);
⇒ Defaults to Bundle/Resources/views/Controller/action.html.twig
We could also do:
return $this->render(
'AcmeExampleBundle:Default:index.html.twig',
array('name' => $name)
);

43. Page generation process:
1. Match the URL to a route (/hello/{name})
/hello/World ⇒ /hello/{name}
2. Instantiate Controller
new AcmeExampleBundleControllerDefaultController
3. Run action method with arguments
->indexAction('World')
3. Controller returns a Response
Hello World!

44. Templating in Symfony2

45. Twig is the default templating engine for Symfony2

48. In Midgard you only define the elements you want to override
In Twig you define a new root element that inherits and then
overrides.

49. src/Acme/ExampleBundle/Resources/views/Default/index.html.twig
{% extends 'AcmeDemoBundle::layout.html.twig' %}
{% block content %}
Hello {{ name }}!
{% endblock %}

50. http://localhost:8001/hello/World

51. You can also use other templating engines
TAL, PHP, MidCOM, ...
http://symfony.com/doc/2.0/cookbook/templating/PHP.html

52. Exercise:
Create your own base layout template
Make the route's template inherit that

53. Routing in Symfony2

54. Registering routes with PHP
app/config/routing.yml
AcmeExampleBundle:
resource: "@AcmeExampleBundle/Controller/"
type: annotation
prefix: /
In Controller action methods:
/**
* @Route("/hello/{name}")
*/

55. Registering routes with YAML
AcmeExampleBundle:
resource: "@AcmeExampleBundle/Resources/config/routing.yml"
prefix: /example
src/Acme/ExampleBundle/Resources/config/routing.yml
hello_user:
pattern: /hello/{name}
defaults: { _controller: AcmeExampleBundle:Default:index}
(format is NamespaceBundle:Controller:action)

56. $ php app/console router:debug
[router] Current routes
Name Method Pattern
_welcome ANY /
_demo_login ANY /demo/secured/login
_security_check ANY /demo/secured/login_check
_demo_logout ANY /demo/secured/logout
...
_configurator_final ANY /_configurator/final
acme_example_default_index ANY /example/hello/{name}

57. Supporting other output formats
/**
* @Route("/hello/{name}.{_format}", defaults={"_format"="html"})
*/
http://localhost:8001/hello/World and
http://localhost:8001/hello/World.html
will both work

58. src/Acme/ExampleBundle/Resources/views/Default/index.json.twig
{% set arr = { 'name': name } %}
{{ arr | json_encode | raw }}

59. http://localhost:8001/hello/World.json

60. Exercise:
Create two routes
• One with no parameters
• One with two parameters
• Provide a default value for parameter

61. Using Midgard inside Symfony2

62. Add Midgard ConnectionBundle as dependency
[MidgardConnectionBundle]
git=git://github.com/bergie/MidgardConnectionBundle.git
target=Midgard/ConnectionBundle
Install with $ php bin/vendors install
Enable in app/AppKernel.php
$bundles = array(
...
new MidgardConnectionBundleMidgardConnectionBundle()
);

63. Configure Midgard connection
app/config/config.yml
midgard_connection:
type: SQLite
name: midgard2
databasedir: "%kernel.root_dir%"
logfile: "%kernel.root_dir%/logs/midgard2.log"
loglevel: debug
blobdir: "%kernel.root_dir%/blobs"
sharedir: "/usr/share/midgard2"

64. Now you can create a database
$ php app/console midgard:connection:init

65. Using Midgard in controllers
src/Acme/ExampleBundle/Controller/DefaultController.php
/**
* @Route("/hello/{name}.{_format}", defaults={"_format"="html"})
* @Template()
*/
public function indexAction($name)
{
$qb = new midgard_query_builder('midgard_person');
$qb->add_constraint('firstname', '=', 'Midgard');
$persons = $qb->execute();
return array('name' => $persons[0]->firstname);
}

66. Hello, Midgard!

67. Exercise:
Create a route displaying all person
objects in the Midgard database

68. MidCOM components inside Symfony2

69. Warning: Here be Dragons

70. Add Midgard MidcomCompatBundle as dependency
[MidcomCompatBundle]
git=git://github.com/bergie/MidgardMidcomCompatBundle.git
target=Midgard/MidcomCompatBundle
Install with $ php bin/vendors install
Enable in app/AppKernel.php
$bundles = array(
...
new MidgardMidcomCompatBundleMidgardMidcomCompatBundle()
);

71. Install Flack's version of MidCOM
$ git clone https://github.com/flack/openpsa.git
Copy schemas from openpsa/schemas to MgdSchema dir
app/config/config.yml
midgard_midcom_compat:
root: "%kernel.root_dir%/../openpsa/lib"
framework:
templating: { engines: ['twig', 'midcom'] }
Run $ php app/console midgard:connection:init

72. Enable component in app/AppKernel.php
$bundles = array(
...
new MidgardMidcomCompatBundleBundleComponentBundle(
'net.nehmer.blog')
);
Add a component to routing configuration:
NetNehmerBlog:
resource: "net.nehmer.blog"
type: midcom
prefix: /blog

73. http://localhost:8001/blog/

74. Loading a layout for your MidCOM views
app/config/config.yml
midgard_midcom_compat:
layout: "MidgardMidcomCompatBundle::layout.html.twig"

75. Some areas to follow:
• Symfony CMF: node-based routing, etc
• PHPCR: standard content repository APIs
• MidCOM and Midgard MVC compat work

76. Photos:
http://www.flickr.com/photos/bfs_man/4939624151/
http://www.flickr.com/photos/jeremyhiebert/5105804864/
http://www.flickr.com/photos/donkeyhotey/5527263186/
http://www.flickr.com/photos/eustaquio/2750429774/
http://www.flickr.com/photos/hatwar/5022365448/
http://www.flickr.com/photos/jordanfischer/72510316/
http://www.flickr.com/photos/bellatrix6/130907944/
Inspiration:
http://www.slideshare.net/weaverryan/handson-with-the-symfony2-framework