Chris@0: <?php
Chris@0: 
Chris@0: namespace Drupal\Tests;
Chris@0: 
Chris@0: use Symfony\Component\HttpFoundation\Request;
Chris@0: 
Chris@0: trait XdebugRequestTrait {
Chris@0: 
Chris@0:   /**
Chris@0:    * Adds xdebug cookies, from request setup.
Chris@0:    *
Chris@0:    * In order to debug web tests you need to either set a cookie, have the
Chris@0:    * Xdebug session in the URL or set an environment variable in case of CLI
Chris@0:    * requests. If the developer listens to connection on the parent site, by
Chris@0:    * default the cookie is not forwarded to the client side, so you cannot
Chris@0:    * debug the code running on the child site. In order to make debuggers work
Chris@0:    * this bit of information is forwarded. Make sure that the debugger listens
Chris@0:    * to at least three external connections.
Chris@0:    *
Chris@0:    * @param \Symfony\Component\HttpFoundation\Request $request
Chris@0:    *   The request.
Chris@0:    *
Chris@0:    * @return array
Chris@0:    *   The extracted cookies.
Chris@0:    */
Chris@0:   protected function extractCookiesFromRequest(Request $request) {
Chris@0:     $cookie_params = $request->cookies;
Chris@0:     $cookies = [];
Chris@0:     if ($cookie_params->has('XDEBUG_SESSION')) {
Chris@0:       $cookies['XDEBUG_SESSION'][] = $cookie_params->get('XDEBUG_SESSION');
Chris@0:     }
Chris@0:     // For CLI requests, the information is stored in $_SERVER.
Chris@0:     $server = $request->server;
Chris@0:     if ($server->has('XDEBUG_CONFIG')) {
Chris@0:       // $_SERVER['XDEBUG_CONFIG'] has the form "key1=value1 key2=value2 ...".
Chris@0:       $pairs = explode(' ', $server->get('XDEBUG_CONFIG'));
Chris@0:       foreach ($pairs as $pair) {
Chris@0:         list($key, $value) = explode('=', $pair);
Chris@0:         // Account for key-value pairs being separated by multiple spaces.
Chris@0:         if (trim($key, ' ') == 'idekey') {
Chris@0:           $cookies['XDEBUG_SESSION'][] = trim($value, ' ');
Chris@0:         }
Chris@0:       }
Chris@0:     }
Chris@0:     return $cookies;
Chris@0:   }
Chris@0: 
Chris@0: }