tests/unit/Stubs/ResponseRenderer.php

   1 <?php
   2 /**
   3  * Fake response stub for testing purposes
   4  *
   5  * It will concatenate HTML and JSON for given calls to addHTML and addJSON
   6  * respectively, what make it easy to determine whether the output is correct in test
   7  * suite. Feel free to modify for any future test needs.
   8  */
   9
  10 declare(strict_types=1);
  11
  12 namespace PhpMyAdmin\Tests\Stubs;
  13
  14 use PhpMyAdmin\Bookmarks\BookmarkRepository;
  15 use PhpMyAdmin\Config;
  16 use PhpMyAdmin\ConfigStorage\Relation;
  17 use PhpMyAdmin\Console;
  18 use PhpMyAdmin\Current;
  19 use PhpMyAdmin\Dbal\DatabaseInterface;
  20 use PhpMyAdmin\Error\ErrorHandler;
  21 use PhpMyAdmin\Footer;
  22 use PhpMyAdmin\Header;
  23 use PhpMyAdmin\Http\Factory\ResponseFactory;
  24 use PhpMyAdmin\Http\Response;
  25 use PhpMyAdmin\Message;
  26 use PhpMyAdmin\Template;
  27
  28 use function is_array;
  29 use function json_encode;
  30
  31 class ResponseRenderer extends \PhpMyAdmin\ResponseRenderer
  32 {
  33     /**
  34      * HTML data to be used in the response
  35      */
  36     protected string $htmlString = '';
  37
  38     /**
  39      * An array of JSON key-value pairs
  40      * to be sent back for ajax requests
  41      *
  42      * @var mixed[]
  43      */
  44     protected array $json = [];
  45
  46     /**
  47      * Creates a new class instance
  48      */
  49     public function __construct()
  50     {
  51         Current::$lang = 'en';
  52         $config = Config::getInstance();
  53         $config->selectedServer['pmadb'] = 'phpmyadmin';
  54         $template = new Template($config);
  55         $dummyDbi = new DbiDummy();
  56         $dummyDbi->addSelectDb('phpmyadmin');
  57         $dbi = DatabaseInterface::getInstanceForTest($dummyDbi, $config);
  58         $relation = new Relation($dbi);
  59         $console = new Console($relation, $template, new BookmarkRepository($dbi, $relation));
  60
  61         parent::__construct(
  62             $config,
  63             $template,
  64             new Header($template, $console, $config),
  65             new Footer($template, $config),
  66             ErrorHandler::getInstance(),
  67             $dbi,
  68             ResponseFactory::create(),
  69         );
  70     }
  71
  72     /**
  73      * Append HTML code to the response stub
  74      */
  75     public function addHTML(string $content): void
  76     {
  77         $this->htmlString .= $content;
  78     }
  79
  80     /**
  81      * Add JSON code to the response stub
  82      *
  83      * @param array-key|array<array-key, mixed> $json  Either a key (string) or an array or key-value pairs
  84      * @param mixed|null                        $value Null, if passing an array in $json otherwise
  85      *                                                 it's a string value to the key
  86      */
  87     public function addJSON(string|int|array $json, mixed $value = null): void
  88     {
  89         if (is_array($json)) {
  90             foreach ($json as $key => $value) {
  91                 $this->addJSON($key, $value);
  92             }
  93         } elseif ($value instanceof Message) {
  94             $this->json[$json] = $value->getDisplay();
  95         } else {
  96             $this->json[$json] = $value;
  97         }
  98     }
  99
 100     /**
 101      * Return the final concatenated HTML string
 102      */
 103     public function getHTMLResult(): string
 104     {
 105         return $this->htmlString;
 106     }
 107
 108     /**
 109      * Return the final JSON array
 110      *
 111      * @return mixed[]
 112      */
 113     public function getJSONResult(): array
 114     {
 115         return $this->json;
 116     }
 117
 118     /**
 119      * Current I choose to return PhpMyAdmin\Header object directly because
 120      * our test has nothing about the Scripts and PhpMyAdmin\Header class.
 121      */
 122     public function getHeader(): Header
 123     {
 124         return $this->header;
 125     }
 126
 127     /**
 128      * Set the status of an ajax response,
 129      * whether it is a success or an error
 130      *
 131      * @param bool $state Whether the request was successfully processed
 132      */
 133     public function setRequestStatus(bool $state): void
 134     {
 135         $this->isSuccess = $state;
 136     }
 137
 138     /**
 139      * Get the status of an ajax response.
 140      */
 141     public function hasSuccessState(): bool
 142     {
 143         return $this->isSuccess;
 144     }
 145
 146     /**
 147      * This function is used to clear all data to this
 148      * stub after any operations.
 149      */
 150     public function clear(): void
 151     {
 152         $this->isSuccess = true;
 153         $this->json = [];
 154         $this->htmlString = '';
 155     }
 156
 157     /**
 158      * Set the ajax flag to indicate whether
 159      * we are servicing an ajax request
 160      *
 161      * @param bool $isAjax Whether we are servicing an ajax request
 162      */
 163     public function setAjax(bool $isAjax): void
 164     {
 165         $this->isAjax = $isAjax;
 166     }
 167
 168     /**
 169      * Returns true or false depending on whether
 170      * we are servicing an ajax request
 171      */
 172     public function isAjax(): bool
 173     {
 174         return $this->isAjax;
 175     }
 176
 177     public function getResponse(): Response
 178     {
 179         return $this->response;
 180     }
 181
 182     public function response(): Response
 183     {
 184         if ($this->isAjax()) {
 185             $json = $this->getJSONResult();
 186             if ($this->isSuccess) {
 187                 $json['success'] = true;
 188             } else {
 189                 $json['success'] = false;
 190                 $json['error'] = $json['message'];
 191                 unset($json['message']);
 192             }
 193
 194             $output = (string) json_encode($json);
 195         } else {
 196             $output = $this->getHTMLResult();
 197         }
 198
 199         $this->response->getBody()->write($output);
 200
 201         return $this->response;
 202     }
 203 }