www.aleph1.co.uk Git - yaffs-website/blob - web/modules/contrib/twig_xdebug/README.txt

   1 CONTENTS OF THIS FILE
   2 ---------------------
   3
   4  * Introduction
   5  * Requirements
   6  * Installation
   7  * Alternate Installation
   8
   9 INTRODUCTION
  10 ------------
  11
  12 This module enables you to use Xdebug breakpoints with Twig templates.
  13
  14 To use it, insert {{ breakpoint() }} into your template. When the processor
  15 reaches that point, it makes a call to a Twig extension where xdebug_break() is
  16 implemented.
  17
  18 The breakpoint will open in a file (BreakpointExtension.php) outside your Twig
  19 template, but you'll be able to inspect any variables available at the
  20 breakpoint in the template. The key values you'll see at the breakpoint are:
  21
  22  - $context         These are the variables available to use in the template.
  23  - $environment     This is information about the Twig environment, including
  24                     available functions.
  25  - $arguments       If you supply an argument to breakpoint (e.g
  26                     {{ breakpoint(fields) }}), it'll be viewable here.
  27
  28 REQUIREMENTS
  29 ------------
  30
  31 This module requires the Composer package ajgl/breakpoint-twig-extension:
  32
  33 https://packagist.org/packages/ajgl/breakpoint-twig-extension
  34
  35 INSTALLATION
  36 ------------
  37
  38 On Drupal 8.1.x, install the module using CLI:
  39
  40  1. Add the Drupal Packagist repository (if you haven't already):
  41
  42   $ composer config repositories.drupal composer https://packages.drupal.org/8
  43
  44  2. Require and install the module and its dependencies:
  45
  46   $ composer require drupal/twig_xdebug
  47
  48 ALTERNATE INSTALLATION
  49 ----------------------
  50
  51 On Drupal 8.1.x, install the module manually:
  52
  53  1. Add the git repository to your composer.json:
  54
  55     "repositories": {
  56          ... other repos (if any) ...
  57          "drupal": {
  58              "type": "composer",
  59              "url": "https://packages.drupal.org/8"
  60          }
  61      }
  62
  63  2. Require the module in your composer.json:
  64
  65      "require": {
  66          ... other packages ...
  67          "drupal/twig_xdebug": "8.*"
  68      },
  69
  70  3. Install the module and its dependencies:
  71
  72   $ composer update drupal/twig_xdebug
  73
  74
  75 On Drupal 8.0.x, install the module using composer_manager:
  76
  77  1. Download twig_xdebug
  78
  79   $ drush dl twig_xdebug
  80
  81  2. Download composer_manager
  82
  83   $ drush dl composer_manager
  84
  85   Note: You don't have to enable composer_manager to use it.
  86
  87  3. Run the composer_manager init script
  88
  89   $ php modules/contrib/composer_manager/scripts/init.php
  90
  91  4. Rebuild your composer.json file
  92
  93   $ composer drupal-rebuild
  94
  95  5. Update to install dependencies
  96
  97   $ composer update drupal/twig_xdebug
  98
  99 Learn more about using composer_manager here:
 100
 101 https://www.drupal.org/node/2405811
 102