Mission Impossible: Symfony components in Drupal 7

Slide 1

Slide 1 text

18 Mar 2015

Slide 2

Slide 2 text

@super_marek

Slide 3

Slide 3 text

Slide 4

Slide 4 text

#Symfony_Live @SensioLabsUK

Slide 5

Slide 5 text

No content

Slide 6

Slide 6 text

No content

Slide 7

Slide 7 text

Background Magento platform: - old version - full of custom modifications - basic CMS platform - limited budget

Slide 8

Slide 8 text

Requirement CMS - manage corporate website - manage other brands’ websites - build seasonal microsites - integrate with Magento store

Slide 9

Slide 9 text

http://photobucket.com/user/marcrobinsone/media/Drupal%20Comics/marcrobinsonegmailcom__drupalNinja.png.html

Slide 10

Slide 10 text

Why Drupal? - open source CMS - easy to install and manage - most required functionality available out of the box - easy to extend - easy to theme - limited budget

Slide 11

Slide 11 text

Why Drupal 7? - Drupal 8 is not stable yet!

Slide 12

Slide 12 text

No content

Slide 13

Slide 13 text

No content

Slide 14

Slide 14 text

What is Symfony?

Slide 15

Slide 15 text

is a powerful framework

Slide 16

Slide 16 text

Doctrine ORM Twig

Slide 17

Slide 17 text

set of decoupled components

Slide 18

Slide 18 text

No content

Slide 19

Slide 19 text

No content

Slide 20

Slide 20 text

symfony/dependency-injection symfony/config dependency injection

Slide 21

Slide 21 text

Dependency Injection - a standardised and centralised way of constructing objects in our application

Slide 22

Slide 22 text

Kernel public function boot() { $this->container = new ContainerBuilder(); $this->container->compile(); }

Slide 23

Slide 23 text

Slide 24

Slide 24 text

Kernel public function boot() { $this->container = new ContainerBuilder(); $loader = new YamlFileLoader($this->container, new FileLocator('app/config')); $loader->load('parameters.yml'); $loader = new XmlFileLoader($this->container, new FileLocator('app/config')); $loader->load('services.xml'); $this->container->compile(); }

Slide 25

Slide 25 text

Slide 26

Slide 26 text

Kernel public function boot() { $this->container = $this->buildContainer(); } /** * @return ContainerBuilder */ private function buildContainer() { $container = new ContainerBuilder(); $loader = new YamlFileLoader($container, new FileLocator('app/config')); $loader->load('parameters.yml'); $loader = new XmlFileLoader($container, new FileLocator('app/config')); $loader->load('services.xml'); $container->registerExtension(new ApplicationExtension()); $container->compile(); return $container; }

Slide 27

Slide 27 text

Kernel public function boot() { if (file_exists($this->cachedContainerFileName)) { require $this->cachedContainerFileName; $this->container = new ProjectServiceContainer(); } else { $container = $this->buildContainer(); $dumper = new PhpDumper($container); file_put_contents($this->cachedContainerFileName, $dumper->dump()); $this->container = $container; } }

Slide 28

Slide 28 text

Kernel public function boot() { if (file_exists($this->cachedContainerFileName)) { require $this->cachedContainerFileName; $this->container = new ProjectServiceContainer(); } else { $container = $this->buildContainer(); if ('dev' !== $container->getParameter('environment')) { $dumper = new PhpDumper($container); file_put_contents($this->cachedContainerFileName, $dumper->dump()); } $this->container = $container; } }

Slide 29

Slide 29 text

parameters.yml application: database: name: acme-dev username: acme-dev password: S0m3R4nD0mP455 host: localhost port: ~ soap_client: wsdl: https://api.store.local/v1/?wsdl http_auth_username: acme-dev http_auth_password: S0m3R4nD0mP455 username: acme-dev-user api_key: R4nD0mAp1K3y product_hydrator: product_url_snippet: http://store.local/product/{sku} product_image_url: http://store.local/media/catalog/product/uploads/

Slide 30

Slide 30 text

services.xml

Slide 31

Slide 31 text

symfony/console console commands

Slide 32

Slide 32 text

Import Handler class ImportAndPersistActionHandler { /** * @param ProductImporter $importer * @param ProductPersister $persister */ public function __construct(ProductImporter $importer, ProductPersister $persister) { $this->importer = $importer; $this->persister = $persister; } public function importAndPersistProducts() { $productsList = $this->importer->importProducts(); $this->persister->saveAll($productsList); } }

Slide 33

Slide 33 text

Console command class ImportAndPersistCommand extends Command { public function __construct(ImportAndPersistActionHandler $action) { $this->action = $action; parent::__construct(); } protected function configure() { $this->setName('products:import'); } protected function execute(InputInterface $input, OutputInterface $output) { $startTime = microtime(true); $this->action->importAndPersistProducts(); $output->writeln( sprintf("Products import completed in %1.02fs.", microtime(true) - $startTime) ); } }

Slide 34

Slide 34 text

app/console #!/usr/bin/php boot(); $application = new Application(); $application->addCommands([ $kernel->getContainer()->get('acme.command.import_products'), $kernel->getContainer()->get('acme.command.delete_products'), $kernel->getContainer()->get('acme.command.depot_locate'), ]); $application->run();

Slide 35

Slide 35 text

symfony/filesystem persisting products

Slide 36

Slide 36 text

XML Writer class ProductXmlWriter implements ProductPersister { /** * @param Filesystem $filesystem * @param string $fileName */ public function __construct(Filesystem $filesystem, string $fileName) { $this->filesystem = $filesystem; $this->fileName = $fileName; } /** * @param ProductList $productList */ public function saveAll(ProductList $productList) { $this->filesystem->dumpFile($this->fileName, $this->renderXml($productList)); } }

Slide 37

Slide 37 text

Why write XML? - fetching data from Magento and dumping it into xml file is quick - xml can be imported by Drupal’s feed importer

Slide 38

Slide 38 text

Why it didn’t work? - Feed importer was damn slow - 10k products imported in 4.5h - Scheduling import with Elysia Cron module was flaky - Scheduled feed importer would add products all over again - resources hungry!

Slide 39

Slide 39 text

Direct save to the db class DatabaseProductPersister implements ProductPersister { private $repository; /** * @param ProductRepository $repository */ public function __construct(ProductRepository $repository) { $this->repository = $repository; } public function saveAll(ProductList $productList) { foreach ($productList as $product) { $this->repository->save($product); } } }

Slide 40

Slide 40 text

Why direct save to the db? - Drupal promises data structure won’t ever change - It’s fast - 40k products in 2 minutes - It works!

Slide 41

Slide 41 text

composer.json "require": { "php": ">=5.4.0", "symfony/console": "~2.5", "drush/drush": "7.*@dev", "symfony/finder": "~2.5", "symfony/dependency-injection": "~2.5", "symfony/config": "~2.5", "symfony/filesystem": "~2.6", "doctrine/dbal": "~2.5", "rhumsaa/uuid": "~2.8" },

Slide 42

Slide 42 text

container.php boot(); $conf['di_container'] = $kernel->getContainer();

Slide 43

Slide 43 text

database.php $databases = [ 'default' => [ 'default' => [ 'database' => $conf['di_container']->getParameter('database.name'), 'username' => $conf['di_container']->getParameter('database.username'), 'password' => $conf['di_container']->getParameter('database.password'), 'host' => $conf['di_container']->getParameter('database.host'), 'port' => $conf['di_container']->getParameter('database.port'), 'driver' => 'mysql', 'prefix' => '', ], ], ];

Slide 44

Slide 44 text

settings.php

Slide 45

Slide 45 text

depot_locator.module function get_depot_json($postcode) { global $conf; $depotEntity = $conf['di_container'] ->get('acme.depot_locator')->locateDepot($postcode); $depot = $depotEntity->toArray(); set_depot_cookies($depot); return ['depot' => $depot]; }