myaac/system/libs/pot/OTS_Base_DB.php
Slawomir Boczek 3f6ff3a332
Feature migrations up/down (#270)
* Migrations up down

* Add forum model

* Syntactic sugar for db structure changes

* Refactor migrations with $up & $down

* Fix migrations upgrade and downgrade

+ Add option to disable auto migrate

* Add migrate:to command

Usage: php aac migrate:to x (x - database version)

* Show error when mail is not enabled

* Fixes regarding to init.php

* Add migrate command to manually upgrade db, incase auto migrate is disabled

* Fixed rest of the migrations

* Limit max version of database

* Don't allow minus number

* Option to clear specified plugin settings by name

* Version is required

* Fix PHPStan errors

* Unset $up after migration, to prevent executing same migration twice

* Add database version to output

* This is not needed

* Update 5.php

* Set database_auto_migrate on install

* Set blank & color only if current db version supports it

* Fix duplicate function declaration
2024-11-22 15:29:23 +01:00

298 lines
6.5 KiB
PHP

<?php
/**#@+
* @version 0.1.3
* @since 0.1.3
*/
/**
* @package POT
* @author Wrzasq <wrzasq@gmail.com>
* @copyright 2007 (C) by Wrzasq
* @license http://www.gnu.org/licenses/lgpl-3.0.txt GNU Lesser General Public License, Version 3
*/
/**
* Base class for all database drivers.
*
* <p>
* It defines additional rotines required by database driver for POT using default SQL standard-compliant method.
* </p>
*
* @package POT
*/
abstract class OTS_Base_DB extends PDO implements IOTS_DB
{
use OTS_DB_PDOQuery;
/**
* Tables prefix.
*
* @var string
*/
protected $prefix = '';
/**
* Query counter
*
* @var int
*/
private $queries = 0;
protected $logged = false;
private $log = '';
/**
* Query-quoted field name.
*
* @param string $name Field name.
* @return string Quoted name.
*/
public function fieldName($name)
{
return '"' . $name . '"';
}
public function fieldNames()
{
$ret = '';
foreach(func_get_args() as $v) {
$ret .= $this->fieldName($v) . ',';
}
$ret[strlen($ret) - 1] = '';
return $ret;
}
/**
* Query-quoted table name.
*
* @param string $name Table name.
* @return string Quoted name.
*/
public function tableName($name)
{
return $this->fieldName($this->prefix . $name);
}
private function doQuery(...$args)
{
$this->queries++;
if($this->logged) {
$startTime = microtime(true);
}
$ret = parent::query(...$args);
if($this->logged) {
$totalTime = microtime(true) - $startTime;
$this->log .= round($totalTime, 4) . ' ms - ' . $args[0] . PHP_EOL;
}
return $ret;
}
public function select($table, $where = [], $limit = null)
{
$fields = array_keys($where);
$values = array_values($where);
$query = 'SELECT * FROM ' . $this->tableName($table);
if (!empty($where)) {
$query .= ' WHERE (';
$count = count($fields);
for ($i = 0; $i < $count; $i++) {
$query .= $this->fieldName($fields[$i]) . ' = ' . $this->quote($values[$i]) . ' AND ';
}
$query = substr($query, 0, -4);
$query .= ')';
}
if (isset($limit))
$query .=' LIMIT '.$limit.';';
else
$query .=';';
$query = $this->query($query);
$rowCount = $query->rowCount();
if ($rowCount <= 0) return false;
else if ($rowCount == 1) {
return $query->fetch();
}
return $query->fetchAll();
}
public function insert($table, $data)
{
$fields = array_keys($data);
$values = array_values($data);
$query = 'INSERT INTO ' . $this->tableName($table) . ' (';
foreach ($fields as $field) {
$query.= $this->fieldName($field).',';
}
$query = substr($query, 0, -1);
$query .= ') VALUES (';
foreach ($values as $value) {
if ($value === null) {
$query .= 'NULL,';
}
else {
$query .= $this->quote($value).',';
}
}
$query = substr($query, 0, -1);
$query .= ')';
$this->exec($query);
return true;
}
public function replace($table, $data)
{
$fields = array_keys($data);
$values = array_values($data);
$query = 'REPLACE INTO '.$this->tableName($table).' (';
foreach ($fields as $field)
$query.= $this->fieldName($field).',';
$query = substr($query, 0, -1);
$query.= ') VALUES (';
foreach ($values as $value)
if ($value === null)
$query.= 'NULL,';
else
$query.= $this->quote($value).',';
$query = substr($query, 0, -1);
$query .= ')';
$this->query($query);
return true;
}
public function update($table, $data, $where, $limit = 1)
{
$fields = array_keys($data);
$values = array_values($data);
$query = 'UPDATE '.$this->tableName($table).' SET ';
$count = count($fields);
for ($i = 0; $i < $count; $i++) {
$value = 'NULL';
if ($values[$i] !== null) {
$value = $this->quote($values[$i]);
}
$query.= $this->fieldName($fields[$i]).' = '.$value.', ';
}
$query = substr($query, 0, -2);
$query.=' WHERE (';
$fields = array_keys($where);
$values = array_values($where);
$count = count($fields);
for ($i = 0; $i < $count; $i++)
$query.= $this->fieldName($fields[$i]).' = '.$this->quote($values[$i]).' AND ';
$query = substr($query, 0, -4);
if (isset($limit))
$query .=') LIMIT '.$limit.';';
else
$query .=');';
$this->exec($query);
return true;
}
public function delete($table, $data, $limit = 1)
{
$fields = array_keys($data);
$values = array_values($data);
$query = 'DELETE FROM ' . $this->tableName($table) . ' WHERE (';
$count = count($fields);
for ($i = 0; $i < $count; $i++) {
$query .= $this->fieldName($fields[$i]) . ' = ' . $this->quote($values[$i]) . ' AND ';
}
$query = substr($query, 0, -4);
if ($limit > 0) {
$query.=') LIMIT '.$limit.';';
}
else {
$query.=');';
}
$this->exec($query);
return true;
}
public function addColumn($table, $column, $definition): void {
$this->exec('ALTER TABLE ' . $this->tableName($table) . ' ADD ' . $this->fieldName($column) . ' ' . $definition . ';');
}
public function modifyColumn($table, $column, $definition): void {
$this->exec('ALTER TABLE ' . $this->tableName($table) . ' MODIFY ' . $this->fieldName($column) . ' ' . $definition . ';');
}
public function changeColumn($table, $from, $to, $definition): void {
$this->exec('ALTER TABLE ' . $this->tableName($table) . ' CHANGE ' . $this->fieldName($from) . ' ' . $this->fieldName($to) . ' ' . $definition . ';');
}
public function dropColumn($table, $column): void {
$this->exec('ALTER TABLE ' . $this->tableName($table) . ' DROP COLUMN ' . $this->fieldName($column) . ';');
}
public function renameTable($from, $to): void {
$this->exec('RENAME TABLE ' . $this->tableName($from) . ' TO ' . $this->tableName($to) . ';');
}
public function dropTable($table, $ifExists = true): void {
$this->exec('DROP TABLE ' . ($ifExists ? 'IF EXISTS' : '') . ' ' . $this->tableName($table) . ';');
}
/**
* LIMIT/OFFSET clause for queries.
*
* @param int|bool $limit Limit of rows to be affected by query (false if no limit).
* @param int|bool $offset Number of rows to be skipped before applying query effects (false if no offset).
* @return string LIMIT/OFFSET SQL clause for query.
*/
public function limit($limit = false, $offset = false)
{
// by default this is empty part
$sql = '';
if($limit !== false)
{
$sql = ' LIMIT ' . $limit;
// OFFSET has no effect if there is no LIMIT
if($offset !== false)
{
$sql .= ' OFFSET ' . $offset;
}
}
return $sql;
}
public function queries() {
return $this->queries;
}
public function getLog() {
return $this->log;
}
}
/**#@-*/