Create DeleteLinkEnum

Signed-off-by: Kamil Tekiela <tekiela246@gmail.com>
phpmyadmin · Mar 22, 2023 · d698bdf · d698bdf
1 parent 6b7286f
commit d698bdf
Show file tree

Hide file tree

Showing 6 changed files with 61 additions and 53 deletions.
diff --git a/libraries/classes/Display/DeleteLinkEnum.php b/libraries/classes/Display/DeleteLinkEnum.php
@@ -0,0 +1,12 @@
+<?php
+
+declare(strict_types=1);
+
+namespace PhpMyAdmin\Display;
+
+enum DeleteLinkEnum
+{
+    case NO_DELETE;
+    case DELETE_ROW;
+    case KILL_PROCESS;
+}
diff --git a/libraries/classes/Display/DisplayParts.php b/libraries/classes/Display/DisplayParts.php
@@ -7,14 +7,9 @@
 /** @psalm-immutable */
 final class DisplayParts
 {
-    public const NO_DELETE = 0;
-    public const DELETE_ROW = 1;
-    public const KILL_PROCESS = 2;
-
-    /** @psalm-param self::NO_DELETE|self::DELETE_ROW|self::KILL_PROCESS $deleteLink */
     private function __construct(
         public readonly bool $hasEditLink,
-        public readonly int $deleteLink,
+        public readonly DeleteLinkEnum $deleteLink,
         public readonly bool $hasSortLink,
         public readonly bool $hasNavigationBar,
         public readonly bool $hasBookmarkForm,
@@ -27,7 +22,7 @@ private function __construct(
      * @param array<string, bool|int> $parts
      * @psalm-param array{
      *     hasEditLink?: bool,
-     *     deleteLink?: self::NO_DELETE|self::DELETE_ROW|self::KILL_PROCESS,
+     *     deleteLink?: DeleteLinkEnum,
      *     hasSortLink?: bool,
      *     hasNavigationBar?: bool,
      *     hasBookmarkForm?: bool,
@@ -39,7 +34,7 @@ public static function fromArray(array $parts): self
     {
         return new self(
             $parts['hasEditLink'] ?? false,
-            $parts['deleteLink'] ?? self::NO_DELETE,
+            $parts['deleteLink'] ?? DeleteLinkEnum::NO_DELETE,
             $parts['hasSortLink'] ?? false,
             $parts['hasNavigationBar'] ?? false,
             $parts['hasBookmarkForm'] ?? false,
@@ -52,7 +47,7 @@ public static function fromArray(array $parts): self
      * @param array<string, bool|int> $parts
      * @psalm-param array{
      *     hasEditLink?: bool,
-     *     deleteLink?: self::NO_DELETE|self::DELETE_ROW|self::KILL_PROCESS,
+     *     deleteLink?: DeleteLinkEnum,
      *     hasSortLink?: bool,
      *     hasNavigationBar?: bool,
      *     hasBookmarkForm?: bool,

diff --git a/libraries/classes/Display/Results.php b/libraries/classes/Display/Results.php
@@ -449,7 +449,7 @@ private function setDisplayPartsForPrintView(DisplayParts $displayParts): Displa
     {
         return $displayParts->with([
             'hasEditLink' => false,
-            'deleteLink' => DisplayParts::NO_DELETE,
+            'deleteLink' => DeleteLinkEnum::NO_DELETE,
             'hasSortLink' => false,
             'hasNavigationBar' => false,
             'hasBookmarkForm' => false,
@@ -479,7 +479,7 @@ private function setDisplayPartsForShow(DisplayParts $displayParts): DisplayPart
 
         return $displayParts->with([
             'hasEditLink' => false,
-            'deleteLink' => $bIsProcessList ? DisplayParts::KILL_PROCESS : DisplayParts::NO_DELETE,
+            'deleteLink' => $bIsProcessList ? DeleteLinkEnum::KILL_PROCESS : DeleteLinkEnum::NO_DELETE,
             'hasSortLink' => false,
             'hasNavigationBar' => false,
             'hasBookmarkForm' => true,
@@ -498,7 +498,7 @@ private function setDisplayPartsForNonData(DisplayParts $displayParts): DisplayP
         // contains a "PROC ANALYSE" part
         return $displayParts->with([
             'hasEditLink' => false,
-            'deleteLink' => DisplayParts::NO_DELETE,
+            'deleteLink' => DeleteLinkEnum::NO_DELETE,
             'hasSortLink' => false,
             'hasNavigationBar' => false,
             'hasBookmarkForm' => true,
@@ -520,7 +520,7 @@ private function setDisplayPartsForSelect(DisplayParts $displayParts): DisplayPa
         $hasPrintLink = $displayParts->hasPrintLink;
 
         for ($i = 0; $i < $numberOfColumns; $i++) {
-            $isLink = $hasEditLink || $deleteLink !== DisplayParts::NO_DELETE || $displayParts->hasSortLink;
+            $isLink = $hasEditLink || $deleteLink !== DeleteLinkEnum::NO_DELETE || $displayParts->hasSortLink;
 
             // Displays edit/delete/sort/insert links?
             if (
@@ -531,7 +531,7 @@ private function setDisplayPartsForSelect(DisplayParts $displayParts): DisplayPa
             ) {
                 // don't display links
                 $hasEditLink = false;
-                $deleteLink = DisplayParts::NO_DELETE;
+                $deleteLink = DeleteLinkEnum::NO_DELETE;
                 break;
             }
 
@@ -547,7 +547,7 @@ private function setDisplayPartsForSelect(DisplayParts $displayParts): DisplayPa
         if ($previousTable == '') { // no table for any of the columns
             // don't display links
             $hasEditLink = false;
-            $deleteLink = DisplayParts::NO_DELETE;
+            $deleteLink = DeleteLinkEnum::NO_DELETE;
         }
 
         return $displayParts->with([
@@ -943,7 +943,7 @@ private function getTableHeaders(
         // 1. Set $colspan and generate html with full/partial
         // text button or link
         $colspan = $displayParts->hasEditLink
-            && $displayParts->deleteLink !== DisplayParts::NO_DELETE ? ' colspan="4"' : '';
+            && $displayParts->deleteLink !== DeleteLinkEnum::NO_DELETE ? ' colspan="4"' : '';
         $buttonHtml = $this->getFieldVisibilityParams($displayParts, $fullOrPartialTextLink, $colspan);
 
         // 2. Displays the fields' name
@@ -974,8 +974,8 @@ private function getTableHeaders(
         return [
             'column_order' => $columnOrder,
             'options' => $optionsBlock,
-            'has_bulk_actions_form' => $displayParts->deleteLink === DisplayParts::DELETE_ROW
-                || $displayParts->deleteLink === DisplayParts::KILL_PROCESS,
+            'has_bulk_actions_form' => $displayParts->deleteLink === DeleteLinkEnum::DELETE_ROW
+                || $displayParts->deleteLink === DeleteLinkEnum::KILL_PROCESS,
             'button' => $buttonHtml,
             'table_headers_for_columns' => $tableHeadersForColumns,
             'column_at_right_side' => $columnAtRightSide,
@@ -1091,15 +1091,15 @@ private function getFieldVisibilityParams(
         // 1. Displays the full/partial text button (part 1)...
         $buttonHtml = '<thead><tr>' . "\n";
 
-        $emptyPreCondition = $displayParts->hasEditLink && $displayParts->deleteLink !== DisplayParts::NO_DELETE;
+        $emptyPreCondition = $displayParts->hasEditLink && $displayParts->deleteLink !== DeleteLinkEnum::NO_DELETE;
 
         $leftOrBoth = $GLOBALS['cfg']['RowActionLinks'] === self::POSITION_LEFT
                    || $GLOBALS['cfg']['RowActionLinks'] === self::POSITION_BOTH;
 
         //     ... before the result table
         if (
             ! $displayParts->hasEditLink
-            && $displayParts->deleteLink === DisplayParts::NO_DELETE
+            && $displayParts->deleteLink === DeleteLinkEnum::NO_DELETE
             && $displayParts->hasTextButton
         ) {
             $displayParams['emptypre'] = 0;
@@ -1113,7 +1113,7 @@ private function getFieldVisibilityParams(
                 . '>' . $fullOrPartialTextLink . '</th>';
         } elseif (
             $leftOrBoth
-            && ($displayParts->hasEditLink || $displayParts->deleteLink !== DisplayParts::NO_DELETE)
+            && ($displayParts->hasEditLink || $displayParts->deleteLink !== DeleteLinkEnum::NO_DELETE)
         ) {
             //     ... elseif no button, displays empty(ies) col(s) if required
 
@@ -1765,11 +1765,11 @@ private function getColumnAtRightSide(
         if (
             ($GLOBALS['cfg']['RowActionLinks'] === self::POSITION_RIGHT)
             || ($GLOBALS['cfg']['RowActionLinks'] === self::POSITION_BOTH)
-            && ($displayParts->hasEditLink || $displayParts->deleteLink !== DisplayParts::NO_DELETE)
+            && ($displayParts->hasEditLink || $displayParts->deleteLink !== DeleteLinkEnum::NO_DELETE)
             && $displayParts->hasTextButton
         ) {
             $displayParams['emptyafter'] = $displayParts->hasEditLink
-                && $displayParts->deleteLink !== DisplayParts::NO_DELETE ? 4 : 1;
+                && $displayParts->deleteLink !== DeleteLinkEnum::NO_DELETE ? 4 : 1;
 
             $rightColumnHtml .= "\n"
                 . '<th class="column_action d-print-none"' . $colspan . '>'
@@ -1779,14 +1779,14 @@ private function getColumnAtRightSide(
             ($GLOBALS['cfg']['RowActionLinks'] === self::POSITION_LEFT)
             || ($GLOBALS['cfg']['RowActionLinks'] === self::POSITION_BOTH)
             && (! $displayParts->hasEditLink
-            && $displayParts->deleteLink === DisplayParts::NO_DELETE)
+            && $displayParts->deleteLink === DeleteLinkEnum::NO_DELETE)
             && (! isset($GLOBALS['is_header_sent']) || ! $GLOBALS['is_header_sent'])
         ) {
             //     ... elseif no button, displays empty columns if required
             // (unless coming from Browse mode print view)
 
             $displayParams['emptyafter'] = $displayParts->hasEditLink
-                && $displayParts->deleteLink !== DisplayParts::NO_DELETE ? 4 : 1;
+                && $displayParts->deleteLink !== DeleteLinkEnum::NO_DELETE ? 4 : 1;
 
             $rightColumnHtml .= "\n" . '<td class="d-print-none"' . $colspan
                 . '></td>';
@@ -2035,7 +2035,7 @@ private function getTableBody(
 
             if (
                 $displayParts->hasEditLink
-                || ($displayParts->deleteLink !== DisplayParts::NO_DELETE)
+                || ($displayParts->deleteLink !== DeleteLinkEnum::NO_DELETE)
             ) {
                 $expressions = [];
 
@@ -2091,7 +2091,7 @@ private function getTableBody(
                 ) {
                     $tableBodyHtml .= $this->template->render('display/results/checkbox_and_links', [
                         'position' => self::POSITION_LEFT,
-                        'has_checkbox' => $deleteUrl && $displayParts->deleteLink !== DisplayParts::KILL_PROCESS,
+                        'has_checkbox' => $deleteUrl && $displayParts->deleteLink !== DeleteLinkEnum::KILL_PROCESS,
                         'edit' => [
                             'url' => $editUrl,
                             'params' => $editCopyUrlParams + ['default_action' => 'update'],
@@ -2114,7 +2114,7 @@ private function getTableBody(
                 } elseif ($GLOBALS['cfg']['RowActionLinks'] === self::POSITION_NONE) {
                     $tableBodyHtml .= $this->template->render('display/results/checkbox_and_links', [
                         'position' => self::POSITION_NONE,
-                        'has_checkbox' => $deleteUrl && $displayParts->deleteLink !== DisplayParts::KILL_PROCESS,
+                        'has_checkbox' => $deleteUrl && $displayParts->deleteLink !== DeleteLinkEnum::KILL_PROCESS,
                         'edit' => [
                             'url' => $editUrl,
                             'params' => $editCopyUrlParams + ['default_action' => 'update'],
@@ -2156,13 +2156,13 @@ private function getTableBody(
             // 3. Displays the modify/delete links on the right if required
             if (
                 ($displayParts->hasEditLink
-                    || $displayParts->deleteLink !== DisplayParts::NO_DELETE)
+                    || $displayParts->deleteLink !== DeleteLinkEnum::NO_DELETE)
                 && ($GLOBALS['cfg']['RowActionLinks'] === self::POSITION_RIGHT
                     || $GLOBALS['cfg']['RowActionLinks'] === self::POSITION_BOTH)
             ) {
                 $tableBodyHtml .= $this->template->render('display/results/checkbox_and_links', [
                     'position' => self::POSITION_RIGHT,
-                    'has_checkbox' => $deleteUrl && $displayParts->deleteLink !== DisplayParts::KILL_PROCESS,
+                    'has_checkbox' => $deleteUrl && $displayParts->deleteLink !== DeleteLinkEnum::KILL_PROCESS,
                     'edit' => [
                         'url' => $editUrl,
                         'params' => $editCopyUrlParams + ['default_action' => 'update'],
@@ -2776,7 +2776,6 @@ private function getModifiedLinks(
      * @param bool   $clauseIsUnique the unique condition of clause
      * @param string $urlSqlQuery    the analyzed sql query
      * @param int    $processId      Process ID
-     * @psalm-param DisplayParts::NO_DELETE|DisplayParts::DELETE_ROW|DisplayParts::KILL_PROCESS $deleteLink
      *
      * @return array  $del_url, $del_str, $js_conf
      * @psalm-return array{?string, ?string, ?string}
@@ -2785,12 +2784,12 @@ private function getDeleteAndKillLinks(
         string $whereClause,
         bool $clauseIsUnique,
         string $urlSqlQuery,
-        int $deleteLink,
+        DeleteLinkEnum $deleteLink,
         int $processId,
     ): array {
         $goto = $this->properties['goto'];
 
-        if ($deleteLink === DisplayParts::DELETE_ROW) { // delete row case
+        if ($deleteLink === DeleteLinkEnum::DELETE_ROW) { // delete row case
             $urlParams = [
                 'db' => $this->properties['db'],
                 'table' => $this->properties['table'],
@@ -2820,7 +2819,7 @@ private function getDeleteAndKillLinks(
                 . ($clauseIsUnique ? '' : ' LIMIT 1');
 
             $deleteString = $this->getActionLinkContent('b_drop', __('Delete'));
-        } elseif ($deleteLink === DisplayParts::KILL_PROCESS) { // kill process case
+        } elseif ($deleteLink === DeleteLinkEnum::KILL_PROCESS) { // kill process case
             $urlParams = [
                 'db' => $this->properties['db'],
                 'table' => $this->properties['table'],
@@ -3568,7 +3567,7 @@ public function getTable(
             'navigation' => $navigation,
             'headers' => $headers,
             'body' => $body,
-            'has_bulk_links' => $displayParts->deleteLink === DisplayParts::DELETE_ROW,
+            'has_bulk_links' => $displayParts->deleteLink === DeleteLinkEnum::DELETE_ROW,
             'has_export_button' => $this->hasExportButton($statementInfo, $displayParts->deleteLink),
             'clause_is_unique' => $isClauseUnique,
             'operations' => $operations,
@@ -3876,14 +3875,13 @@ private function setParamForLinkForeignKeyRelatedTables(array $map): array
      * @see     getTable()
      *
      * @param ResultInterface $dtResult the link id associated to the query which results have to be displayed
-     * @psalm-param DisplayParts::NO_DELETE|DisplayParts::DELETE_ROW|DisplayParts::KILL_PROCESS $deleteLink
      */
     private function isClauseUnique(
         ResultInterface $dtResult,
         StatementInfo $statementInfo,
-        int $deleteLink,
+        DeleteLinkEnum $deleteLink,
     ): bool {
-        if ($deleteLink !== DisplayParts::DELETE_ROW) {
+        if ($deleteLink !== DeleteLinkEnum::DELETE_ROW) {
             return false;
         }
 
@@ -3916,9 +3914,9 @@ private function isClauseUnique(
         return $clauseIsUnique;
     }
 
-    private function hasExportButton(StatementInfo $statementInfo, int $deleteLink): bool
+    private function hasExportButton(StatementInfo $statementInfo, DeleteLinkEnum $deleteLink): bool
     {
-        return $deleteLink === DisplayParts::DELETE_ROW && $statementInfo->queryType === 'SELECT';
+        return $deleteLink === DeleteLinkEnum::DELETE_ROW && $statementInfo->queryType === 'SELECT';
     }
 
     /**

diff --git a/libraries/classes/Sql.php b/libraries/classes/Sql.php
@@ -9,6 +9,7 @@
 use PhpMyAdmin\ConfigStorage\RelationCleanup;
 use PhpMyAdmin\Dbal\DatabaseName;
 use PhpMyAdmin\Dbal\ResultInterface;
+use PhpMyAdmin\Display\DeleteLinkEnum;
 use PhpMyAdmin\Display\DisplayParts;
 use PhpMyAdmin\Display\Results as DisplayResults;
 use PhpMyAdmin\Html\Generator;
@@ -1005,7 +1006,7 @@ private function getQueryResponseForNoResultsReturned(
 
         $displayParts = DisplayParts::fromArray([
             'hasEditLink' => false,
-            'deleteLink' => DisplayParts::NO_DELETE,
+            'deleteLink' => DeleteLinkEnum::NO_DELETE,
             'hasSortLink' => true,
             'hasNavigationBar' => false,
             'hasBookmarkForm' => true,
@@ -1171,7 +1172,7 @@ private function getHtmlForSqlQueryResultsTable(
 
                     $displayParts = DisplayParts::fromArray([
                         'hasEditLink' => false,
-                        'deleteLink' => DisplayParts::NO_DELETE,
+                        'deleteLink' => DeleteLinkEnum::NO_DELETE,
                         'hasSortLink' => true,
                         'hasNavigationBar' => true,
                         'hasBookmarkForm' => true,
@@ -1400,7 +1401,7 @@ private function getQueryResponseForResultsReturned(
 
         $displayParts = DisplayParts::fromArray([
             'hasEditLink' => true,
-            'deleteLink' => DisplayParts::DELETE_ROW,
+            'deleteLink' => DeleteLinkEnum::DELETE_ROW,
             'hasSortLink' => true,
             'hasNavigationBar' => true,
             'hasBookmarkForm' => true,
@@ -1411,7 +1412,7 @@ private function getQueryResponseForResultsReturned(
         if (! $editable) {
             $displayParts = DisplayParts::fromArray([
                 'hasEditLink' => false,
-                'deleteLink' => DisplayParts::NO_DELETE,
+                'deleteLink' => DeleteLinkEnum::NO_DELETE,
                 'hasSortLink' => true,
                 'hasNavigationBar' => true,
                 'hasBookmarkForm' => true,
@@ -1423,7 +1424,7 @@ private function getQueryResponseForResultsReturned(
         if (isset($_POST['printview']) && $_POST['printview'] == '1') {
             $displayParts = DisplayParts::fromArray([
                 'hasEditLink' => false,
-                'deleteLink' => DisplayParts::NO_DELETE,
+                'deleteLink' => DeleteLinkEnum::NO_DELETE,
                 'hasSortLink' => false,
                 'hasNavigationBar' => false,
                 'hasBookmarkForm' => false,