Rebuilding our Foundation

@jessicamauerhan | Madison PHP | https://joind.in/16022
Rebuilding Our Foundation
How We Used Symfony To
Rewrite Our Application

● Project History
● Problems and Goals
● Why Symfony?
● Rapid Development
of Quality Code
● Doctrine DBAL / ORM
Topics
● Automated Testing
● Sonata Admin Bundle
● Creating an API with
Symfony
● Dependency Injection
● Current Project
Status
2

● Learning Management System
● Content Production
● E-Commerce
● Business to Business (B2B)
Application Summary
3

Problematic History
● Broken Admin Panel
● No Documentation of Basic Processes
● Frontend Site Worked, Progress Stalled
● Complex Logic not Documented
4

Business Goals
● Add Missing Admin Panel Functionality
● Add New Features Without Breaking Existing Features
● Avoid Downtime
5

Technical Goals
● Maintainable Code
● Quality Code
● Documentation
● Rapid Development
● Easy Deployment
● Zero Regressions Per Release
6

Why Symfony?
● Community
○ Third Party Code Integration
○ Blazing Trails
○ Popularity
○ Support
7

Why Symfony?
● Technology
○ Dependency Injection & Decoupling
○ Unit Testing
○ Functional Testing
○ Behavior Testing
8

Rapid Development of Quality Code
● Version Control: Git
● Development Workflow
9

Image sourced from Atlassian: https://www.atlassian.com/git/tutorials/comparing-
workflows/gitflow-workflow
Licensed under the Creative Commons Attribution 2.5 Australia License.
10

● Development Workflow: Gitflow
● Code Style Guide: PSR-2
11

● Code Quality Rules
12

PHP Mess Detector
$ php composer require "phpmd/phpmd" --dev
$ php composer install --no-dev
13

PHP Mess Detector Rules
<?xml version="1.0"?>
<ruleset name="Code Quality"
xmlns="http://pmd.sf.net/ruleset/1.0.0"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://pmd.sf.net/ruleset/1.0.0
http://pmd.sf.net/ruleset_xml_schema.xsd"
xsi:noNamespaceSchemaLocation="
http://pmd.sf.net/ruleset_xml_schema.xsd">
<description>Custom Code Quality Rules</description>

<rule ref="rulesets/cleancode.xml"/>
<rule ref="rulesets/naming.xml/ShortVariable">
<properties>
<property name="minimum" value="4"/>
</properties>
</rule>
</ruleset>
14

● Version Control
● Code Quality Rules: PHP Mess Detector
● Code Quality Enforcement
15

Git Pre-Commit Code Quality Hook
#!/usr/bin/env php
<?php
require __DIR__ . '/../../vendor/autoload.php';
use SymfonyComponentConsoleApplication;
class CodeQualityTool extends Application
{
private $projectRoot;
const PHP_FILES_IN_SRC = '/^src/(.*)(.php)$/';
const PHP_FILES_IN_APPLICATION = '/^application/(.*)(.php)$/';
public function __construct()
{
$this->projectRoot = realpath(__DIR__ . DIRECTORY_SEPARATOR . '..'
. DIRECTORY_SEPARATOR . '..' . DIRECTORY_SEPARATOR);
parent::__construct('Code Quality Tool', '1.0.0');
}
}
16

private function extractCommitedFiles()
{
$files = [];
$output = [];
exec("git diff --cached --name-status --diff-filter=ACM", $output);
foreach ($output as $line) {
$filename = trim(substr($line, 1));
$isAppFile = preg_match(self::PHP_FILES_IN_APPLICATION, $filename);
$isSrcFile = preg_match(self::PHP_FILES_IN_SRC, $filename);
if ($isAppFile || $isSrcFile) {
$files[] = $filename;
}
}
return $files;
}
17

private function checkPhpMd($files)
{
$succeed = true;
foreach ($files as $file) {
$processArgs = ['bin/phpmd', $file, 'text', 'phpmd-rules.xml'];
$processBuilder = new ProcessBuilder($processArgs);
$processBuilder->setWorkingDirectory($this->projectRoot);
$process = $processBuilder->getProcess();
$process->run();
if (!$process->isSuccessful()) {
$this->output->writeln($file);
$this->output->writeln($process->getErrorOutput());
$this->output->writeln($process->getOutput());
$succeed = false;
}
}
return $succeed;
}
18

public function doRun(InputInterface $input, OutputInterface $output) {
$this->input = $input;
$this->output = $output;
$output->writeln('<info>Fetching files</info>');
$files = $this->extractCommitedFiles();
$info = '<info>Checking for messy code with PHPMD</info>';
$output->writeln($info);
if (!$this->checkPhpMd($files)) {
throw new Exception(sprintf('There are PHPMD violations!'));
}
}
19

● Code Quality Rules: PHP Mess Detector
● Code Quality Enforcement: Git Hooks
20

Doctrine
21

Doctrine DBAL / ORM
● Database Abstraction Layer (DBAL)
○ Database Vendor Agnostic
○ Query Builder
● Object Relational Mapper (ORM)
○ Maps Objects to Tables, Properties to Fields
○ Object Relationships
○ DQL - it's like SQL for your Objects
22

Generating Entity Classes (Annotations)
$ php app/console doctrine:mapping:import --force AcmeBlogBundle xml
$ php app/console doctrine:mapping:convert annotation ./src
$ php app/console doctrine:generate:entities AcmeBlogBundle
23

Annotated Entity Class
<?php
namespace AcmeBlogBundleEntity;
use DoctrineORMMapping as ORM;
/**
* AcmeBlogBundleEntityBlogComment
*
* @ORMTable(name="blog_comment")
* @ORMEntity
*/
class BlogComment
{
/**
* @var integer $id
* @ORMColumn(name="id", type="bigint")
* @ORMId
* @ORMGeneratedValue(strategy="IDENTITY")
*/
private $id;
/**
* @var string $author
* @ORMColumn(name="author", type="string", length=100, nullable=false)
*/
private $author;
}
24

Other Doctrine Tools
● Doctrine Migrations
● Data Fixtures Library
25

Introducing Automated Tests
26

$ php composer require "behat/behat" --dev
Installing Behat
27

Writing Features for Existing Code
● Write Feature
● Run Test
○ Test Passes - Double Check
○ Test Fails
■ Described Feature Wrong
■ Mistake in Test Code
■ Feature is Broken
28

New Symfony Development
29

Installing Symfony Framework
30

Installing Symfony Framework
31

Merging Symfony Framework with Existing Code
● Install Separately
● Move Directories
● Combine composer.json
○ scripts
○ extra
○ autoload
32

Generate App Bundle
33

Generate App Bundle
C:wampwwwtest>php appconsole generate:bundle
Welcome to the Symfony2 bundle generator
Your application code must be written in bundles. This command helps
you generate them easily.
Each bundle is hosted under a namespace (like Acme/Bundle/BlogBundle).
The namespace should begin with a "vendor" name like your company name, your
project name, or your client name, followed by one or more optional category
sub-namespaces, and it should end with the bundle name itself
(which must have Bundle as a suffix).
See http://symfony.com/doc/current/cookbook/bundles/best_practices.html#index-1
for more details on bundle naming conventions.
Use / instead of for the namespace delimiter to avoid any problem.
Bundle namespace: Demo/AppBundle
34

Generate App Bundle
In your code, a bundle is often referenced by its name. It can be the
concatenation of all namespace parts but it's really up to you to come
up with a unique name (a good practice is to start with the vendor name).
Based on the namespace, we suggest DemoAppBundle.
Bundle name [DemoAppBundle]: AppBundle
35

The bundle can be generated anywhere. The suggested default directory uses the
standard conventions.
Target directory [C:wampwwwtest/src]:
Determine the format to use for the generated configuration.
Configuration format (yml, xml, php, or annotation): annotation
To help you get started faster, the command can generate some code snippets for
you.
Do you want to generate the whole directory structure [no]? yes
Generate App Bundle
36

Generate App Bundle
Summary before generation
You are going to generate a "DemoAppBundleAppBundle" bundle
in "C:wampwwwtest/src/" using the "annotation" format.
Do you confirm generation [yes]?
Bundle generation
Generating the bundle code: OK
Checking that the bundle is autoloaded: OK
Confirm automatic update of your Kernel [yes]?
Enabling the bundle inside the Kernel: OK
Confirm automatic update of the Routing [yes]?
Importing the bundle routing resource: OK
You can now start using the generated code!
37

Sonata Admin
38

@jessicamauerhan | Madison PHP | https://joind.in/16022 39

@jessicamauerhan | Madison PHP | https://joind.in/16022 40

$ php composer require "sonata-project/admin-bundle"
$ php composer require "sonata-project/doctrine-orm-admin-bundle"
Install Sonata Admin
41

//AppKernel.php
public function registerBundles()
{
return [
//...
new SymfonyBundleSecurityBundleSecurityBundle(),
new SonataCoreBundleSonataCoreBundle(),
new SonataBlockBundleSonataBlockBundle(),
new KnpBundleMenuBundleKnpMenuBundle(),
new SonataDoctrineORMAdminBundleSonataDoctrineORMAdminBundle(),
new SonataAdminBundleSonataAdminBundle()
];
}
Enable Sonata Admin Bundle
42

Configure Sonata Admin Bundle
#appconfig.yml
sonata_block:
default_contexts: [cms]
blocks:
sonata.admin.block.admin_list:
contexts: [admin]
43

#approuting.yml
admin:
resource: '@SonataAdminBundle/Resources/config/routing/sonata_admin.xml'
prefix: /admin
_sonata_admin:
resource: .
type: sonata_admin
prefix: /admin
Sonata Admin Bundle Routing
44

$ php app/console assets:install web
$ php app/console cache:clear
Configure Sonata Admin Bundle
45

<?php
namespace DemoAppBundleAdmin;
use SonataAdminBundleAdminAdmin;
use SonataAdminBundleFormFormMapper;
use SonataAdminBundleDatagridListMapper;
use SonataAdminBundleDatagridDatagridMapper;
class CourseAdmin extends Admin
{
protected function configureFormFields(FormMapper $formMapper){}
protected function configureListFields(ListMapper $listMapper){}
protected function configureDatagridFilters(DatagridMapper
$datagridMapper){}
}
Admin Class
46

Admin Class - Create/Edit Form
// Fields to be shown on create/edit forms
protected function configureFormFields(FormMapper $formMapper)
{
$formMapper
->add('title', 'text', ['label' => 'Course Title'])
->add('author', 'entity', ['class' =>
'DemoAppBundleEntityUser'])
->add('description', null, ['required' => false])
->add('categories')
->add('cost');
}
47

Admin Class - List
// Fields to be shown on lists
protected function configureListFields(ListMapper $listMapper)
{
$listMapper
->addIdentifier('title')
->add('author')
->add('cost')
->add('categories');
}
48

Admin Class - Datagrid Filters
// Fields to be shown on filter forms
protected function configureDatagridFilters(DatagridMapper
$datagridMapper)
{
$datagridMapper
->add('title')
->add('author')
->add('categories');
}
49

Admin Service
# Demo/AppBundle/Resources/config/admin.yml
services:
sonata.admin.course:
class: DemoAppBundleAdminCourseAdmin
tags:
- { name: sonata.admin, manager_type: orm, group:
"Course Management", label: "Courses" }
arguments:
- ~
- DemoAppBundleEntityCourse
- ~
calls:
- [ setTranslationDomain, [AppBundle]]
50

Admin Services - Add to Config
# app/config/config.yml
imports:
- { resource: parameters.yml }
- { resource: security.yml }
- { resource: services.yml }
- { resource: @AppBundle/Resources/config/admin.yml }
51

Done!
52

Optimization
53

Symfony Debug Toolbar
54

Symfony Profiler
55

Admin Class - Custom Query (List)
public function createQuery($context = 'list')
{
$queryBuilder = $this->getModelManager()
->getEntityManager('modelsCourse')
->createQueryBuilder();
$queryBuilder->select('course', 'categories')
->from('modelsCourse', 'course')
->leftJoin('course.categories', 'categories');
$proxyQuery = new ProxyQuery($queryBuilder);
return $proxyQuery;
}
56

Admin Class - Custom Query (Edit)
Page)public function getObject($id)
{
$dql = "SELECT course, categories
FROM modelsCourse course
LEFT JOIN course.categories categories
WHERE course.id = :id";
$query = $this->getModelManager()
->getEntityManager('modelsCourse')
->createQuery($dql);
$query->setParameter('id', $id);
$course = $query->getOneOrNullResult();
return $course;
}
57

API
58

Install FOS Rest Bundle
$ php composer require "friendsofsymfony/rest-bundle"
$ php composer require "jms/serializer-bundle"
$ php composer require "nelmio/api-doc-bundle"
59

Enable FOS Rest Bundle and Serializer Bundle
//AppKernel.php
public function registerBundles()
{
return [
// ...
new FOSRestBundleRestBundle(),
new JMSSerializerBundleJMSSerializerBundle(),
new NelmioApiDocBundleNelmioApiDocBundle()
];
}
60

Configuration
# app/config/routing.yml
NelmioApiDocBundle:
resource: "@NelmioApiDocBundle/Resources/config/routing.yml"
prefix: /api/doc
# app/config/config.yml
nelmio_api_doc: ~
framework:
templating:
engines: ['twig']
61

API Controller
<?php
namespace DemoAppBundleController;
use FOSRestBundleControllerFOSRestController;
use FOSRestBundleControllerAnnotationsGet;
class UsersController extends FOSRestController
{
/**
* @Get("/users/")
*/
public function getUsersAction()
{
$data = $this->getDoctrine()->getRepository('modelsUser')->findAll();
$view = $this->view($data, 200)
->setTemplate("AppBundle:Basic:json.twig")
->setTemplateVar('users');
return $this->handleView($view);
}
}
62

JSON Twig Tpl
{% spaceless %}{% if json is defined %}
{{ json|json_encode()|raw }}
{% else %}
[]
{% endif %}{% endspaceless %}
63

Add Doc Blocks with Annotation to
API Controller
<?php
use ...
{
/**
* @Get("/users/")
* @ApiDoc(
* resource=true,
* description="List of Users",
* output="modelsUser"
* )
*/
{
}
}
64

Dependency
Injection
Service
Location
Configure
Dependencies
Outside of Class
Class Requests
Dependencies
From Container
65

Service Location
<?php
namespace DemoAppBundleCommand;
use SymfonyBundleFrameworkBundleCommandContainerAwareCommand;
use SymfonyComponentConsoleInputInputInterface;
use SymfonyComponentConsoleOutputOutputInterface;
use DemoAppBundleFactoryMessageFactory;
class UserExportCommand extends ContainerAwareCommand
{
protected function execute(InputInterface $input, OutputInterface $output)
{
$rootDir = $this->getContainer()->getParameter('kernel.root_dir');
$users = $this->getContainer()->getDoctrine()
->getRepository('modelsUser')->findAll();
$messageFactory = new MessageFactory();
foreach ($users as $user) {
$emailMessage = $this->getMessageFactory()->generate($user);
/** More Processing Logic Here */
}
}
}
66

services:
appbundle.message.factory:
class: DemoAppBundleFactoryMessageFactory
Defining Services
67

services:
appbundle.repositories.user:
class: DemoAppBundleEntityRepositoriesUserRepository
factory_service: doctrine.orm.entity_manager
factory_method: getRepository
arguments:
- 'modelsUser'
Defining Services
68

services:
appbundle.repositories.user:
class: DemoAppBundleEntityRepositoriesUserRepository
factory_service: doctrine.orm.entity_manager
factory_method: getRepository
arguments:
- 'modelsUser'
appbundle.command.user_export:
class: DemoAppBundleCommandUserExportCommand
calls:
- [ setMessageFactory, ["@appbundle.message.factory"]]
- [ setUserRepository, ["@appbundle.repositories.user"]]
- [ setRootDir, ["%kernel.root_dir%"]]
Defining Services
69

Dependency Injection
<?php
namespace DemoAppBundleCommand;
use SymfonyComponentConsoleInputInputInterface;
use SymfonyComponentConsoleOutputOutputInterface;
use DemoAppBundleFactoryMessageFactory;
use SymfonyComponentConsoleCommandCommand;
class UserExportCommand extends Command
{
protected $messageFactory;
protected $rootDir;
protected $userRepository;
}
70

<?php
//..
{
//..
public function setMessageFactory($messageFactory)
{
$this->messageFactory = $messageFactory;
}
public function setRootDir($rootDir)
{
$this->rootDir = $rootDir;
}
public function setUserRepository($userRepository)
{
$this->userRepository = $userRepository;
}
71

<?php
//..
{
//..
public function getMessageFactory()
{
return $this->messageFactory;
}
public function getRootDir()
{
return $this->rootDir;
}
public function getUserRepository()
{
return $this->userRepository;
}
72

73
<?php
//..
{
//..
protected function execute(InputInterface $input, OutputInterface $output)
{
$users = $this->getUserRepository()->findAll();
/** Processing Logic */
foreach ($users as $user) {
$emailMessage = $this->getMessageFactory()->generate($user);
/** More Processing Logic Here */
}
}
}

Controller Using Service Location
74
<?php
use FOSRestBundleControllerFOSRestController;
use FOSRestBundleControllerAnnotationsGet;
{
/**
* @Get("/users/")
*/
{
}
}

services:
appbundle.controllers.users_controller:
class: DemoAppBundleControllerUsersController
calls:
- [ setUserRepository, ["@appbundle.repositories.user"]]
Defining A Controller As A Service
75

Controller using Dependency Injection
76
/**
* @Route(service="appbundle.controllers.users_controller")
*/
{
protected $userRepository;
public function setUserRepository($userRepository)
{
$this->userRepository = $userRepository;
}
/**
* @Get("/users/")
*/
{
$data = $this->userRepository->findAll();
}
}

Current Project
Status
It's stable!
● New Symfony based Admin
was launched after about 9
months (thanks developers!)
● Had a few bugs, took about 3
more months to be stable
● Over past year, close to 0
regressions (Thanks Behat!)
● Very limited downtime
(Thanks Amazon, Elastic
Beanstalk, Aurora!)
77

Technical Goals
Happy Developers!
● Maintainable Code: Check
● Quality Code: Check
● Documentation: Check
● Rapid Development: Oh Yeah
● Easy Deployment: So Easy!
● Zero Regressions: Close
Enough!
78

Resources
Gitflow: https://github.com/nvie/gitflow
PSR-2: http://www.php-fig.org/psr/psr-2/
PHPMD: http://phpmd.org/
Pre-commit hook: https://gist.github.com/jmauerhan/d18e7c232acb3986134d
Doctrine: http://www.doctrine-project.org/
Doctrine Migrations Bundle: http://symfony.com/doc/current/bundles/DoctrineMigrationsBundle/index.html
Doctrine Data Fixtures Bundle: http://symfony.com/doc/current/bundles/DoctrineFixturesBundle/index.html
Behat: http://docs.behat.org/en/v2.5/
XDebug Wizard: http://xdebug.org/wizard.php
Sonata Project: https://sonata-project.org/bundles/admin/2-3/doc/index.html
FOS Rest Bundle: http://symfony.com/doc/master/bundles/FOSRestBundle/index.html
Nelmio API Doc Bundle: https://github.com/nelmio/NelmioApiDocBundle/blob/master/Resources/doc/index.md
80

Rebuilding our Foundation

Recommended

Recommended

More Related Content

What's hot

What's hot (20)

Viewers also liked

Viewers also liked (13)

Similar to Rebuilding our Foundation

Similar to Rebuilding our Foundation (20)

More from Jessica Mauerhan

More from Jessica Mauerhan (7)

Recently uploaded

Recently uploaded (20)

Rebuilding our Foundation