ekino / drupal-bundle
Integrate Symfony2 with Drupal
Installs: 526
Dependents: 0
Suggesters: 0
Security: 0
Stars: 72
Watchers: 33
Forks: 20
Open Issues: 4
Type:symfony-bundle
Requires
- php: >=5.5.9
- doctrine/common: ^2.6
- doctrine/orm: ^2.5
- friendsofsymfony/user-bundle: ^2.1
- psr/log: ^1.1
- symfony/config: ^3.4
- symfony/dependency-injection: ^3.4
- symfony/event-dispatcher: ^3.4
- symfony/http-foundation: ^3.4
- symfony/http-kernel: ^3.4
- symfony/security-core: ^3.4
- twig/twig: ^1.42
Requires (Dev)
- phpunit/phpunit: ^4.8
- symfony/phpunit-bridge: ^4.3
This package is auto-updated.
Last update: 2024-11-07 01:59:17 UTC
README
Requires at least Drush 5.0 for compatibility with Symfony console.
The bundle tries to deeply integrate Symfony2 with Drupal and Drupal with Symfony2. Of course this is done without altering the Drupal's core.
When this bundle is activated, the Symfony2 console will have the Drupal libraries autoloaded. So, it makes possible the use of Drupal libraries from your Symfony2 command.
Install
Download the symfony2 sandbox and the Drupal code
Install the files to have the following structure
Symfony Sandbox Root
- app
- vendor
- src
- web (Drupal source code)
The web
directory must be the document root and contains the Drupal source code.
Update the index.php
file
This file "share" the container with Drupal so it is possible to reuse Symfony2's services from within Drupal. The initialization process is always handled by Symfony2.
<?php require_once __DIR__.'/../app/bootstrap.php.cache'; require_once __DIR__.'/../app/AppKernel.php'; //require_once __DIR__.'/../app/bootstrap_cache.php.cache'; //require_once __DIR__.'/../app/AppCache.php'; use Symfony\Component\HttpFoundation\Request; $kernel = new AppKernel('dev', true); // $kernel->loadClassCache(); $kernel->boot(); // make the Symfony container available from Drupal file global $container; $container = $kernel->getContainer(); $request = Request::createFromGlobals(); $response = $kernel->handle($request); $response->send(); $kernel->terminate($request, $response);
Install the related Drupal module
The module can be downloaded from the following url: https://github.com/ekino/ekino_drupal_symfony2
Configuration
Edit the Symfony config.yml
file and add the following lines:
parameters:
session.flashbag.class: Ekino\Bundle\DrupalBundle\Port\DrupalFlashBag
session.attribute_bag.class: Ekino\Bundle\DrupalBundle\Port\DrupalAttributeBag
framework:
# ... configuration options
session:
# ... configuration options
storage_id: ekino.drupal.session.storage
ekino_drupal:
root: %kernel.root_dir%/../web
logger: ekino.drupal.logger.watchdog
strategy_id: ekino.drupal.delivery_strategy.symfony
# attach a security token to the following provider keys
provider_keys: [main, admin]
# not required
entity_repositories:
# 3 equivalent examples of configuration:
- { bundle: page }
- { type: node, bundle: page }
- { type: node, bundle: page, class: Ekino\Bundle\DrupalBundle\Entity\EntityRepository }
# you can also define an entity repository:
- { type: node, class: Application\Ekino\Bundle\DrupalBundle\Entity\Node\NodeRepository }
# switch to true if you want to prefix the name of Symfony tables
table_prefix:
enabled: false
prefix: symfony__
exclude: [users]
# optional
session:
refresh_cookie_lifetime: true # default value: false
# declare 2 required mapping definition used by Drupal
doctrine:
dbal:
driver: %database_driver%
dbname: %database_name%
user: %database_user%
host: %database_host%
port: %database_port%
password: %database_password%
charset: UTF8
mapping_types:
longblob: object
blob: object
# Tips: this allows Doctrine to consider only tables starting with
# "symfony__" during a migration generation.
# Think to add Doctrine migrations table here or configure it in
# the doctrine_migrations section (table_name)
schema_filter: ~^(symfony__|migration_versions)~
The bundle comes with 3 delivery strategies:
- ekino.drupal.delivery_strategy.background: Drupal never returns the response, Symfony does
- ekino.drupal.delivery_strategy.drupal: Drupal always returns the response, even if the page is 404
- ekino.drupal.delivery_strategy.symfony: Drupal returns the response only if the page is not 404
The (optional) section entity_repositories
allows you to easy interact with
Drupal API to retrieve contents and handle it from Symfony code.
The configuration offers default values:
- default entity type is
node
- default repository class is
Ekino\Bundle\DrupalBundle\Entity\EntityRepository
, feel free to configure yours
Update Queries
UPDATE users SET `emailCanonical` = `mail`, `usernameCanonical` = `name`, `roles` = 'b:0;';
Usage
Symfony components can be used from within Drupal:
<?php function drupal_foo_function() { $result = symfony_service('reusage_service')->foo(); // do some stuff with $result }
Security
You can secure a Symfony route with a Drupal permission, with prefix PERMISSION_DRUPAL_. Like it:
security: role_hierarchy: # ... firewalls: # ... access_control: - { path: ^/symfony/admin, role: PERMISSION_DRUPAL_ACCESS_ADMINISTRATION_PAGES }
The PERMISSION_DRUPAL_ACCESS_ADMINISTRATION_PAGES is translate in "access administration pages" and used with user_access and global Drupal user.
If you want use you "personal access" permission, use role PERMISSION_DRUPAL_PERSONAL_ACCESS for example.
Limitations
- It is not possible to use Symfony native class to manage session as Drupal initializes its own session handler and there is no way to change this.
- requests must be served through the index.php as it is the default value in the .htaccess file and there is no way to change the default script in Drupal
Preview
If installation is completed successfully, the welcome page looks like:
You can note the Web Debug Toolbar of Symfony at the bottom ;-).