How To Fix A Bug In Drupal 8.Dev

Transcription

1 Drupal 8 Configuration system for coders and site builders

2 who am I? Kristof De co-founder of eps & kaas co-maintainer of Field API Original creator of Display Suite

3

4 Outline What s the problem How did we solve it Simple static settings Configuration entities Deployment - with demo Configuration schema Context, events and overrides

5 What problems are we trying to solve? Dev admin/config/foo Setting 1 Setting 2 text label node/4 TEST test test test test test test test test test test test test test test Variable soup Save Live admin/config/foo Setting 1 old text Setting 2 label Save node/4 Welcome This is real content on the live site that end users are viewing Database Database

6 What problems are we trying to solve? Dev Live admin/config/foo node/4 admin/config/foo node/4 Setting 1 Setting 2 text label Save TEST test test test test test test test test test test test test test test Setting 1 Setting 2 old text label Save Welcome This is real content on the live site that end users are viewing Database Database Danger! Want to bring over configuration changes from dev, but not overwrite live content!

7 What problems are we trying to solve? variable_set()/variable_get() napkins db_select()/db_update()/ db_delete() hook_update_n() drush fu $conf[...]; ctools_export_object()/ ctools_export_load_object()

8 The solution Files using the YAML specification Active and staging directory Cached in the database using a standard cache interface Config directory changed via settings.php This is all pluggable

9 The anatomy of a configuration file

10 system.site.yml

11 system.site.yml

12 system.site.yml

13 system.site.yml name: 'Configuration management' mail: slogan: 'makes Drupal 8 cex -y' page: 403: '' 404: '' front: node

14 The API Drupal::config() ->get() ->set() ->save()

15 Accessing data

16 $site_name = Drupal::config('system.site')->get('name'); name: 'Configuration management' mail: admin@example.com slogan: 'makes Drupal 8 cex -y' page: 403: '' 404: '' front: node

17 $page_data = Drupal::config('system.site')->get('page'); name: 'Configuration management' mail: admin@example.com slogan: 'makes Drupal 8 cex -y' page: 403: '' 404: '' front: node

18 $frontpage = Drupal::config('system.site')- >get('page.front'); name: 'Configuration management' mail: admin@example.com slogan: 'makes Drupal 8 cex -y' page: 403: '' 404: '' front: node

19 $all_the_data = Drupal::config('system.site')->get(); name: 'Configuration management' mail: admin@example.com slogan: 'makes Drupal 8 cex -y' page: 403: '' 404: '' front: node

20 Saving data

21 Drupal::config('system.site') ->set('name', 'CMI is good') ->save(); name: 'CMI is good' mail: slogan: 'makes Drupal 8 cex -y' page: 403: '' 404: '' front: node

22 Drupal::config('system.site') ->set('name', 'CMI is great') ->set('page', array( 403 => 'access-denied', 404 => 'not-found', front => 'user', )) ->save(); name: 'CMI is great' mail: slogan: 'makes Drupal 8 cex -y' page: 403: access-denied 404: not-found front: user

23

24 simple settings system_settings_form is dead create your own submit callback you are responsible for saving configuration ship with default configuration file

25 {language} {field_config} {date_format_type} {filter_format} {field_config_instance} {date_format_locale} {node_type} {role_permission} {role} {date_formats} {system} {variable} {filter}

26 Config all the things!

27 Config entities

28 /** Saturday 16 * November The 13category ID. use Drupal\Core\Config\Entity\ConfigEntityBase; use Drupal\Core\Annotation\Plugin; use Drupal\Core\Annotation\Translation; /** * Defines the contact category entity. * * id = "contact_category", * label * module = "contact", * controllers = { * controller_class = "Drupal\contact\CategoryStorageController", * list = "Drupal\contact\CategoryListController", * form = { * "add" = "Drupal\contact\CategoryFormController" * "edit" = "Drupal\contact\CategoryFormController" * } * } * uri_callback = "contact_category_uri", * config_prefix = "contact.category", * entity_keys = { * "id" = "id", * "label" = "label", * "uuid" = "uuid" * } * ) */ class Category extends ConfigEntityBase implements CategoryInterface {

29 /** Saturday 16 * November The 13category ID. use Drupal\Core\Config\Entity\ConfigEntityBase; use Drupal\Core\Annotation\Plugin; use Drupal\Core\Annotation\Translation; /** * Defines the contact category entity. * * id = "contact_category", * label * module = "contact", * controllers = { * controller_class = "Drupal\contact\CategoryStorageController", * list = "Drupal\contact\CategoryListController", * form = { * "add" = "Drupal\contact\CategoryFormController" * "edit" = "Drupal\contact\CategoryFormController" * } * } * uri_callback = "contact_category_uri", * config_prefix = "contact.category", * entity_keys = { * "id" = "id", * "label" = "label", * "uuid" = "uuid" * } * ) */ class Category extends ConfigEntityBase implements CategoryInterface {

30 namespace Drupal\contact\Plugin\Core\Entity; use Drupal\Core\Config\Entity\ConfigEntityBase; use Drupal\Core\Annotation\Plugin; use Drupal\Core\Annotation\Translation; /** * Defines the contact category entity. * * id = "contact_category", * label * module = "contact", * controllers = { * controller_class = "Drupal\Core\Config\Entity\ConfigStorageController", * list = "Drupal\contact\CategoryListController", * form = { * "add" = "Drupal\contact\CategoryFormController" * } * }, * uri_callback = "contact_category_uri", * config_prefix = "contact.category", * entity_keys = { * "id" = "id", * "label" = "label", * "uuid" = "uuid" * } * ) */ class Category extends ConfigEntityBase implements ContactInterface { /** * The category ID.

31 /** Saturday 16 * November The 13category ID. use Drupal\Core\Config\Entity\ConfigEntityBase; use Drupal\Core\Annotation\Plugin; use Drupal\Core\Annotation\Translation; /** * Defines the contact category entity. * * id = "contact_category", * label * module = "contact", * controllers = { * controller_class = "Drupal\Core\Config\Entity\ConfigStorageController", * list = "Drupal\contact\CategoryListController", * form = { * "add" = "Drupal\contact\CategoryFormController" * "edit" = "Drupal\contact\CategoryFormController" * } * } * uri_callback = "contact_category_uri", * config_prefix = "contact.category", * entity_keys = { * "id" = "id", * "label" = "label", * "uuid" = "uuid" * } * ) */ class Category extends ConfigEntityBase implements ContactInterface {

32 */ class Category extends ConfigEntityBase { } /** * The category ID. */ public $id; /** * The category UUID. */ public $uuid; /** * The category label. */ public $label; /** * List of recipient addresses. */ public $recipients = array(); /** * An auto-reply message to send to the message author. */ public $reply = ''; /** * Weight of this category (used for sorting). */ public $weight = 0;

33 contact.category.feedback.yml id: feedback uuid: de77e4f3-f94b-41a5-ad05-5c32fa08444f label: 'Website feedback' recipients: - '' reply: '' weight: '0' langcode: und

34 (config) entity API entity_load entity_save $object->any_method()

35 Deployment

36 Development environment 1 Database Active Directory

37 Development environment 1 Database Active Directory

38 Development environment 1 Database 2 Active Directory

39 Production environment admin/config/development/sync Database 3 Staging Directory Active Directory

40 Production environment 4 admin/config/development/sync Database 3 Staging Directory Active Directory

41 Demo time Full import / export Single import / export No partial imports supported on CLI!

42 Drush integration

43 Advanced workflows use git pre-commit hooks with defined config directories in settings.php

44 Don t hack core

45 Don t hack active config

46 State API Only useful for this environment? Use state(). Drupal::state()->set('update.last_check', $now); //... $last_check = Drupal::state()->get('update.last_check')?: 0;

47 Configuration schema

48 system.maintenance.yml enabled: '0' message: is currently under maintenance. We should be back shortly. Thank you for your patience.'

49 system.schema.yml system.maintenance: type: mapping label: 'Maintenance mode' mapping: "enabled": type: boolean label: "Put site into maintenance mode" "message": type: text label: "Message to display when in maintenance mode"

50 Basic scalar types from typed data boolean: label: 'Boolean' class: '\Drupal\Core\TypedData\Type\Boolean' label: ' ' class: '\Drupal\Core\TypedData\Type\ ' integer: label: 'Integer' class: '\Drupal\Core\TypedData\Type\Integer' string: label: 'String' class: '\Drupal\Core\TypedData\Type\String' uri: label: 'Uri' class: '\Drupal\Core\TypedData\Type\Uri'

51 Basic data types for configuration undefined: label: 'Undefined' class: '\Drupal\Core\Config\Schema\Property' mapping: label: Mapping class: '\Drupal\Core\Config\Schema\Mapping' sequence: label: Sequence class: '\Drupal\Core\Config\Schema\Sequence'

52 Simple extended data types # Human readable string that must be plain text and editable with a text field. label: type: string label: 'Label' translatable: true # Internal Drupal path path: type: string label: 'Path' # Human readable string that can contain multiple lines of text or HTML. text: type: string label: 'Text' translatable: true

53 Complex extended data type # Mail text with subject and body parts. mail: type: mapping label: "Mail" mapping: "subject": type: text label: "Subject" "body": type: text label: "Body"

54 Config inspector module

55 Context system, Events & Overrides

56 Global overrides global $conf; $conf['system.maintenance']['message'] = 'Sorry, our site is down now.';

57 Global overrides class ConfigGlobalOverrideSubscriber implements EventSubscriberInterface { static function getsubscribedevents() { $events['config.init'][] = array('configinit', 30); return $events; } public function configinit(configevent $event) { global $conf; } } $config = $event->getconfig(); if (isset($conf[$config->getname()])) { $config->setoverride($conf[$config->getname()]); }

58 Break out of contexts // Enter the override-free context, so we can ensure no overrides are applied. config_context_enter('config.context.free'); // Get system site maintenance message text from the original config. $message = config('system.maintenance')->get('message'); // Leave the override-free context. config_context_leave();

59 Get into contexts // Enter a user specific context. $context = config_context_enter("drupal\\user\\userconfigcontext"); // Set the account to use on the context. $context->setaccount($account); $mail_config = Drupal::config('user.mail'); // Do stuff... config_context_leave();

60 Language overrides block.block.bartik.login.yml id: bartik.login uuid: 7012ebfd ef-b... weight: '0' status: '1' langcode: en region: sidebar_first plugin: user_login_block settings: label: 'User login' module: user label_display: visible cache: '-1'... locale.hu.block.block.bartik.login.yml settings: label: 'Belépés' locale.nl.block.block.bartik.login.yml settings: label: 'Inloggen'

61 recap and advice key names/properties should have meaning Use config entities instead of tables Use getters/setters/methods on entities Include config schema (translation!) Upgrade functions available in update.inc

62 Please try it out! #drupal-cmi - Dedicated IRC channel docs - help along -

63 - Discussion - Issues - Core announcements #drupal-cmi - Dedicated IRC channel

64 Questions?

65