libraries/SubPartition.php

   1 <?php
   2 /* vim: set expandtab sw=4 ts=4 sts=4: */
   3 /**
   4  * Library for extracting information about the sub-partitions
   5  *
   6  * @package PhpMyAdmin
   7  */
   8 namespace PMA\libraries;
   9
  10 /**
  11  * Represents a sub partition of a table
  12  *
  13  * @package PhpMyAdmin
  14  */
  15 class SubPartition
  16 {
  17     /**
  18      * @var string the database
  19      */
  20     protected $db;
  21     /**
  22      * @var string the table
  23      */
  24     protected $table;
  25     /**
  26      * @var string partition name
  27      */
  28     protected $name;
  29     /**
  30      * @var integer ordinal
  31      */
  32     protected $ordinal;
  33     /**
  34      * @var string partition method
  35      */
  36     protected $method;
  37     /**
  38      * @var string partition expression
  39      */
  40     protected $expression;
  41     /**
  42      * @var integer no of table rows in the partition
  43      */
  44     protected $rows;
  45     /**
  46      * @var integer data length
  47      */
  48     protected $dataLength;
  49     /**
  50      * @var integer index length
  51      */
  52     protected $indexLength;
  53     /**
  54      * @var string partition comment
  55      */
  56     protected $comment;
  57
  58     /**
  59      * Constructs a partition
  60      *
  61      * @param array $row fetched row from information_schema.PARTITIONS
  62      */
  63     public function __construct($row)
  64     {
  65         $this->db = $row['TABLE_SCHEMA'];
  66         $this->table = $row['TABLE_NAME'];
  67         $this->loadData($row);
  68     }
  69
  70     /**
  71      * Loads data from the fetched row from information_schema.PARTITIONS
  72      *
  73      * @param array $row fetched row
  74      *
  75      * @return void
  76      */
  77     protected function loadData($row)
  78     {
  79         $this->name = $row['SUBPARTITION_NAME'];
  80         $this->ordinal = $row['SUBPARTITION_ORDINAL_POSITION'];
  81         $this->method = $row['SUBPARTITION_METHOD'];
  82         $this->expression = $row['SUBPARTITION_EXPRESSION'];
  83         $this->loadCommonData($row);
  84     }
  85
  86     /**
  87      * Loads some data that is common to both partitions and sub partitions
  88      *
  89      * @param array $row fetched row
  90      *
  91      * @return void
  92      */
  93     protected function loadCommonData($row)
  94     {
  95         $this->rows = $row['TABLE_ROWS'];
  96         $this->dataLength = $row['DATA_LENGTH'];
  97         $this->indexLength = $row['INDEX_LENGTH'];
  98         $this->comment = $row['PARTITION_COMMENT'];
  99     }
 100
 101     /**
 102      * Return the partition name
 103      *
 104      * @return string partition name
 105      */
 106     public function getName()
 107     {
 108         return $this->name;
 109     }
 110
 111     /**
 112      * Return the ordinal of the partition
 113      *
 114      * @return number the ordinal
 115      */
 116     public function getOrdinal()
 117     {
 118         return $this->ordinal;
 119     }
 120
 121     /**
 122      * Returns the partition method
 123      *
 124      * @return string partition method
 125      */
 126     public function getMethod()
 127     {
 128         return $this->method;
 129     }
 130
 131     /**
 132      * Returns the partition expression
 133      *
 134      * @return string partition expression
 135      */
 136     public function getExpression()
 137     {
 138         return $this->expression;
 139     }
 140
 141     /**
 142      * Returns the number of data rows
 143      *
 144      * @return integer number of rows
 145      */
 146     public function getRows()
 147     {
 148         return $this->rows;
 149     }
 150
 151     /**
 152      * Returns the data length
 153      *
 154      * @return integer data length
 155      */
 156     public function getDataLength()
 157     {
 158         return $this->dataLength;
 159     }
 160
 161     /**
 162      * Returns the index length
 163      *
 164      * @return integer index length
 165      */
 166     public function getIndexLength()
 167     {
 168         return $this->indexLength;
 169     }
 170
 171     /**
 172      * Returns the partition comment
 173      *
 174      * @return string partition comment
 175      */
 176     public function getComment()
 177     {
 178         return $this->comment;
 179     }
 180 }