libraries/classes/Config/Settings/Transformations.php

   1 <?php
   2
   3 declare(strict_types=1);
   4
   5 namespace PhpMyAdmin\Config\Settings;
   6
   7 use function in_array;
   8 use function is_array;
   9
  10 // phpcs:disable Squiz.NamingConventions.ValidVariableName.MemberNotCamelCaps
  11
  12 /**
  13  * @psalm-immutable
  14  */
  15 final class Transformations
  16 {
  17     /**
  18      * Default transformations for Substring
  19      *
  20      * @var array<int, int|string>
  21      * @psalm-var array{0: int, 1: 'all'|int, 2: string}
  22      */
  23     public $Substring = [0, 'all', '…'];
  24
  25     /**
  26      * Default transformations for Bool2Text
  27      *
  28      * @var string[]
  29      * @psalm-var array{0: string, 1: string}
  30      */
  31     public $Bool2Text = ['T', 'F'];
  32
  33     /**
  34      * Default transformations for External
  35      *
  36      * @var array<int, int|string>
  37      * @psalm-var array{0: int, 1: string, 2: int, 3: int}
  38      */
  39     public $External = [0, '-f /dev/null -i -wrap -q', 1, 1];
  40
  41     /**
  42      * Default transformations for PreApPend
  43      *
  44      * @var string[]
  45      * @psalm-var array{0: string, 1: string}
  46      */
  47     public $PreApPend = ['', ''];
  48
  49     /**
  50      * Default transformations for Hex
  51      *
  52      * @var string[]
  53      * @psalm-var array{0: string}
  54      */
  55     public $Hex = ['2'];
  56
  57     /**
  58      * Default transformations for DateFormat
  59      *
  60      * @var array<int, int|string>
  61      * @psalm-var array{0: int, 1: string, 2: 'local'|'utc'}
  62      */
  63     public $DateFormat = [0, '', 'local'];
  64
  65     /**
  66      * Default transformations for Inline
  67      *
  68      * @var array<(int|string), (int|string|array<string, string>|null)>
  69      * @psalm-var array{0: string|int, 1: string|int, wrapper_link: string|null, wrapper_params: array<string, string>}
  70      */
  71     public $Inline = ['100', 100, 'wrapper_link' => null, 'wrapper_params' => []];
  72
  73     /**
  74      * Default transformations for TextImageLink
  75      *
  76      * @var array<int, int|string|null>
  77      * @psalm-var array{0: string|null, 1: int, 2: int}
  78      */
  79     public $TextImageLink = [null, 100, 50];
  80
  81     /**
  82      * Default transformations for TextLink
  83      *
  84      * @var array<int, string|null>
  85      * @psalm-var array{0: string|null, 1: string|null, 2: string|null}
  86      */
  87     public $TextLink = [null, null, null];
  88
  89     /**
  90      * @param array<int|string, mixed> $transformations
  91      */
  92     public function __construct(array $transformations = [])
  93     {
  94         if (isset($transformations['Substring']) && is_array($transformations['Substring'])) {
  95             if (isset($transformations['Substring'][0])) {
  96                 $this->Substring[0] = (int) $transformations['Substring'][0];
  97             }
  98
  99             if (isset($transformations['Substring'][1]) && $transformations['Substring'][1] !== 'all') {
 100                 $this->Substring[1] = (int) $transformations['Substring'][1];
 101             }
 102
 103             if (isset($transformations['Substring'][2])) {
 104                 $this->Substring[2] = (string) $transformations['Substring'][2];
 105             }
 106         }
 107
 108         if (isset($transformations['Bool2Text']) && is_array($transformations['Bool2Text'])) {
 109             if (isset($transformations['Bool2Text'][0])) {
 110                 $this->Bool2Text[0] = (string) $transformations['Bool2Text'][0];
 111             }
 112
 113             if (isset($transformations['Bool2Text'][1])) {
 114                 $this->Bool2Text[1] = (string) $transformations['Bool2Text'][1];
 115             }
 116         }
 117
 118         if (isset($transformations['External']) && is_array($transformations['External'])) {
 119             if (isset($transformations['External'][0])) {
 120                 $this->External[0] = (int) $transformations['External'][0];
 121             }
 122
 123             if (isset($transformations['External'][1])) {
 124                 $this->External[1] = (string) $transformations['External'][1];
 125             }
 126
 127             if (isset($transformations['External'][2])) {
 128                 $this->External[2] = (int) $transformations['External'][2];
 129             }
 130
 131             if (isset($transformations['External'][3])) {
 132                 $this->External[3] = (int) $transformations['External'][3];
 133             }
 134         }
 135
 136         if (isset($transformations['PreApPend']) && is_array($transformations['PreApPend'])) {
 137             if (isset($transformations['PreApPend'][0])) {
 138                 $this->PreApPend[0] = (string) $transformations['PreApPend'][0];
 139             }
 140
 141             if (isset($transformations['PreApPend'][1])) {
 142                 $this->PreApPend[1] = (string) $transformations['PreApPend'][1];
 143             }
 144         }
 145
 146         if (isset($transformations['Hex']) && is_array($transformations['Hex'])) {
 147             if (isset($transformations['Hex'][0])) {
 148                 $this->Hex[0] = (string) $transformations['Hex'][0];
 149             }
 150         }
 151
 152         if (isset($transformations['DateFormat']) && is_array($transformations['DateFormat'])) {
 153             if (isset($transformations['DateFormat'][0])) {
 154                 $this->DateFormat[0] = (int) $transformations['DateFormat'][0];
 155             }
 156
 157             if (isset($transformations['DateFormat'][1])) {
 158                 $this->DateFormat[1] = (string) $transformations['DateFormat'][1];
 159             }
 160
 161             if (
 162                 isset($transformations['DateFormat'][2])
 163                 && in_array($transformations['DateFormat'][2], ['local', 'utc'], true)
 164             ) {
 165                 $this->DateFormat[2] = $transformations['DateFormat'][2];
 166             }
 167         }
 168
 169         if (isset($transformations['Inline']) && is_array($transformations['Inline'])) {
 170             if (isset($transformations['Inline'][0])) {
 171                 $this->Inline[0] = (int) $transformations['Inline'][0];
 172             }
 173
 174             if (isset($transformations['Inline'][1])) {
 175                 $this->Inline[1] = (int) $transformations['Inline'][1];
 176             }
 177
 178             if (isset($transformations['Inline']['wrapper_link'])) {
 179                 $this->Inline['wrapper_link'] = (string) $transformations['Inline']['wrapper_link'];
 180             }
 181
 182             if (
 183                 isset($transformations['Inline']['wrapper_params'])
 184                 && is_array($transformations['Inline']['wrapper_params'])
 185             ) {
 186                 /**
 187                  * @var int|string $key
 188                  * @var mixed      $value
 189                  */
 190                 foreach ($transformations['Inline']['wrapper_params'] as $key => $value) {
 191                     $this->Inline['wrapper_params'][(string) $key] = (string) $value;
 192                 }
 193             }
 194         }
 195
 196         if (isset($transformations['TextImageLink']) && is_array($transformations['TextImageLink'])) {
 197             if (isset($transformations['TextImageLink'][0])) {
 198                 $this->TextImageLink[0] = (string) $transformations['TextImageLink'][0];
 199             }
 200
 201             if (isset($transformations['TextImageLink'][1])) {
 202                 $this->TextImageLink[1] = (int) $transformations['TextImageLink'][1];
 203             }
 204
 205             if (isset($transformations['TextImageLink'][2])) {
 206                 $this->TextImageLink[2] = (int) $transformations['TextImageLink'][2];
 207             }
 208         }
 209
 210         if (! isset($transformations['TextLink']) || ! is_array($transformations['TextLink'])) {
 211             return;
 212         }
 213
 214         if (isset($transformations['TextLink'][0])) {
 215             $this->TextLink[0] = (string) $transformations['TextLink'][0];
 216         }
 217
 218         if (isset($transformations['TextLink'][1])) {
 219             $this->TextLink[1] = (string) $transformations['TextLink'][1];
 220         }
 221
 222         if (! isset($transformations['TextLink'][2])) {
 223             return;
 224         }
 225
 226         $this->TextLink[2] = (string) $transformations['TextLink'][2];
 227     }
 228 }