1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132
|
<?php
/**
* Database query class for ALTER TABLE queries
*
* This file is part of Zoph.
*
* Zoph is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation; either version 2 of the License, or
* (at your option) any later version.
*
* Zoph is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
* You should have received a copy of the GNU General Public License
* along with Zoph; if not, write to the Free Software
* Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
*
* @package Zoph
* @author Jeroen Roos
*/
namespace db;
use db\exception\hasAlterationException as dbAlterTableHasAlterationException;
use db\exception\hasNoAlterationException as dbAlterTableHasNoAlterationException;
use db\exception\unsupportedEngineException as dbAlterTableUnsupportedEngineException;
/**
* The alter object is used to create ALTER TABLE queries
*
* ALTER TABLE has quite a few options, for now the following are planned:
*
* ADD COLUMN column_name column_definition [ FIRST | AFTER column ]
* DROP COLUMN column_name
* MODIFY COLUMN column_name column_definition [ FIRST | AFTER column ]
* CHANGE COLUMN column_name new_column_name column_definition [ FIRST | AFTER column ]
*
* in the future, ADD / DROP / RENAME INDEX and RENAME will probably be added, others when needed.
*
* MySQL allows multiple alterations in a single command, this class will not.
*
* @package Zoph
* @author Jeroen Roos
*/
class alter extends query {
/** @var array Supported MySQL/Mariadb engines */
private static $engines = array("MyISAM", "InnoDB");
/** @var string alteration [ ADD | MODIFY | CHANGE | DROP ] for this query */
private $alteration;
/** @var string after [ FIRST | AFTER <col> ] for this query */
private $after="";
/**
* Create INSERT query
* @return string SQL query
*/
public function __toString() {
$sql = "ALTER TABLE " . $this->table;
if (empty($this->alteration)) {
throw new dbAlterTableHasNoAlterationException();
}
$sql .= " " . $this->alteration . $this->after;
return $sql . ";";
}
public function addColumn(column $column) : alter {
if (!empty($this->alteration)) {
throw new dbAlterTableHasAlterationException();
}
$this->alteration = "ADD COLUMN " . (string) $column;
return $this;
}
public function modifyColumn(column $column) : alter {
if (!empty($this->alteration)) {
throw new dbAlterTableHasAlterationException();
}
$this->alteration = "MODIFY COLUMN " . (string) $column;
return $this;
}
public function changeColumn(string $col, column $column) : alter {
if (!empty($this->alteration)) {
throw new dbAlterTableHasAlterationException();
}
$this->alteration = "CHANGE COLUMN " . $col . " " . (string) $column;
return $this;
}
public function dropColumn(string $col, bool $ifExists = false) : alter {
if (!empty($this->alteration)) {
throw new dbAlterTableHasAlterationException();
}
$this->alteration = "DROP COLUMN " . ($ifExists ? "IF EXISTS " : "") . $col;
return $this;
}
public function first() : alter {
$this->after = " FIRST";
return $this;
}
public function after(string $col) : alter {
$this->after = " AFTER " . $col;
return $this;
}
/**
* Change MySQL/MariaDB Engine
* @see alter::$engines for supported engines
* @param string engine
* @return alter for concatenation of methods
*/
public function setEngine(string $engine) : alter {
if (in_array($engine, static::$engines)) {
if (!empty($this->alteration)) {
throw new dbAlterTableHasAlterationException();
}
$this->alteration="ENGINE = \"" . $engine . "\"";
} else {
throw new dbAlterTableUnsupportedEngineException("Unknown database engine: " . $engine);
}
return $this;
}
}
|