src/Partitioning/SubPartition.php

   1 <?php
   2 /**
   3  * Library for extracting information about the sub-partitions
   4  */
   5
   6 declare(strict_types=1);
   7
   8 namespace PhpMyAdmin\Partitioning;
   9
  10 /**
  11  * Represents a sub partition of a table
  12  */
  13 class SubPartition
  14 {
  15     protected string|null $name = null;
  16     protected int|null $ordinal = null;
  17     protected string|null $method = null;
  18     protected string|null $expression = null;
  19     protected int $rows = 0;
  20     protected int $dataLength = 0;
  21     protected int $indexLength = 0;
  22     protected string $comment = '';
  23
  24     /**
  25      * Constructs a partition
  26      *
  27      * @param mixed[] $row fetched row from information_schema.PARTITIONS
  28      */
  29     public function __construct(array $row)
  30     {
  31         $this->name = $row['SUBPARTITION_NAME'];
  32         $this->ordinal = $row['SUBPARTITION_ORDINAL_POSITION'] !== null
  33             ? (int) $row['SUBPARTITION_ORDINAL_POSITION'] : null;
  34         $this->method = $row['SUBPARTITION_METHOD'];
  35         $this->expression = $row['SUBPARTITION_EXPRESSION'];
  36         $this->loadCommonData($row);
  37     }
  38
  39     /**
  40      * Loads some data that is common to both partitions and sub partitions
  41      *
  42      * @param mixed[] $row fetched row
  43      */
  44     protected function loadCommonData(array $row): void
  45     {
  46         $this->rows = (int) $row['TABLE_ROWS'];
  47         $this->dataLength = (int) $row['DATA_LENGTH'];
  48         $this->indexLength = (int) $row['INDEX_LENGTH'];
  49         $this->comment = $row['PARTITION_COMMENT'];
  50     }
  51
  52     /**
  53      * Return the partition name
  54      */
  55     public function getName(): string|null
  56     {
  57         return $this->name;
  58     }
  59
  60     /**
  61      * Return the ordinal of the partition
  62      */
  63     public function getOrdinal(): int|null
  64     {
  65         return $this->ordinal;
  66     }
  67
  68     /**
  69      * Returns the partition method
  70      */
  71     public function getMethod(): string|null
  72     {
  73         return $this->method;
  74     }
  75
  76     /**
  77      * Returns the partition expression
  78      */
  79     public function getExpression(): string|null
  80     {
  81         return $this->expression;
  82     }
  83
  84     /**
  85      * Returns the number of data rows
  86      */
  87     public function getRows(): int
  88     {
  89         return $this->rows;
  90     }
  91
  92     /**
  93      * Returns the data length
  94      */
  95     public function getDataLength(): int
  96     {
  97         return $this->dataLength;
  98     }
  99
 100     /**
 101      * Returns the index length
 102      */
 103     public function getIndexLength(): int
 104     {
 105         return $this->indexLength;
 106     }
 107
 108     /**
 109      * Returns the partition comment
 110      */
 111     public function getComment(): string
 112     {
 113         return $this->comment;
 114     }
 115 }