1#@!#!123s

: / usr / local / psa / admin / plib / modules / wp-toolkit / vendor / robmorgan / phinx / src / Phinx / Db /
Filename : Table.php
back
<?php

/**
 * MIT License
 * For full license information, please view the LICENSE file that was distributed with this source code.
 */
namespace WPToolkitDependenciesIsolationPrefix\Phinx\Db;

use InvalidArgumentException;
use WPToolkitDependenciesIsolationPrefix\Phinx\Db\Action\AddColumn;
use WPToolkitDependenciesIsolationPrefix\Phinx\Db\Action\AddForeignKey;
use WPToolkitDependenciesIsolationPrefix\Phinx\Db\Action\AddIndex;
use WPToolkitDependenciesIsolationPrefix\Phinx\Db\Action\ChangeColumn;
use WPToolkitDependenciesIsolationPrefix\Phinx\Db\Action\ChangeComment;
use WPToolkitDependenciesIsolationPrefix\Phinx\Db\Action\ChangePrimaryKey;
use WPToolkitDependenciesIsolationPrefix\Phinx\Db\Action\CreateTable;
use WPToolkitDependenciesIsolationPrefix\Phinx\Db\Action\DropForeignKey;
use WPToolkitDependenciesIsolationPrefix\Phinx\Db\Action\DropIndex;
use WPToolkitDependenciesIsolationPrefix\Phinx\Db\Action\DropTable;
use WPToolkitDependenciesIsolationPrefix\Phinx\Db\Action\RemoveColumn;
use WPToolkitDependenciesIsolationPrefix\Phinx\Db\Action\RenameColumn;
use WPToolkitDependenciesIsolationPrefix\Phinx\Db\Action\RenameTable;
use WPToolkitDependenciesIsolationPrefix\Phinx\Db\Adapter\AdapterInterface;
use WPToolkitDependenciesIsolationPrefix\Phinx\Db\Plan\Intent;
use WPToolkitDependenciesIsolationPrefix\Phinx\Db\Plan\Plan;
use WPToolkitDependenciesIsolationPrefix\Phinx\Db\Table\Column;
use WPToolkitDependenciesIsolationPrefix\Phinx\Db\Table\Table as TableValue;
use WPToolkitDependenciesIsolationPrefix\Phinx\Util\Literal;
use RuntimeException;
/**
 * This object is based loosely on: https://api.rubyonrails.org/classes/ActiveRecord/ConnectionAdapters/Table.html.
 */
class Table
{
    /**
     * @var \Phinx\Db\Table\Table
     */
    protected $table;
    /**
     * @var \Phinx\Db\Adapter\AdapterInterface|null
     */
    protected $adapter;
    /**
     * @var \Phinx\Db\Plan\Intent
     */
    protected $actions;
    /**
     * @var array
     */
    protected $data = [];
    /**
     * @param string $name Table Name
     * @param array<string, mixed> $options Options
     * @param \Phinx\Db\Adapter\AdapterInterface|null $adapter Database Adapter
     */
    public function __construct(string $name, array $options = [], ?AdapterInterface $adapter = null)
    {
        $this->table = new TableValue($name, $options);
        $this->actions = new Intent();
        if ($adapter !== null) {
            $this->setAdapter($adapter);
        }
    }
    /**
     * Gets the table name.
     *
     * @return string
     */
    public function getName() : string
    {
        return $this->table->getName();
    }
    /**
     * Gets the table options.
     *
     * @return array<string, mixed>
     */
    public function getOptions() : array
    {
        return $this->table->getOptions();
    }
    /**
     * Gets the table name and options as an object
     *
     * @return \Phinx\Db\Table\Table
     */
    public function getTable() : TableValue
    {
        return $this->table;
    }
    /**
     * Sets the database adapter.
     *
     * @param \Phinx\Db\Adapter\AdapterInterface $adapter Database Adapter
     * @return $this
     */
    public function setAdapter(AdapterInterface $adapter)
    {
        $this->adapter = $adapter;
        return $this;
    }
    /**
     * Gets the database adapter.
     *
     * @throws \RuntimeException
     * @return \Phinx\Db\Adapter\AdapterInterface
     */
    public function getAdapter() : AdapterInterface
    {
        if (!$this->adapter) {
            throw new RuntimeException('There is no database adapter set yet, cannot proceed');
        }
        return $this->adapter;
    }
    /**
     * Does the table have pending actions?
     *
     * @return bool
     */
    public function hasPendingActions() : bool
    {
        return \count($this->actions->getActions()) > 0 || \count($this->data) > 0;
    }
    /**
     * Does the table exist?
     *
     * @return bool
     */
    public function exists() : bool
    {
        return $this->getAdapter()->hasTable($this->getName());
    }
    /**
     * Drops the database table.
     *
     * @return $this
     */
    public function drop()
    {
        $this->actions->addAction(new DropTable($this->table));
        return $this;
    }
    /**
     * Renames the database table.
     *
     * @param string $newTableName New Table Name
     * @return $this
     */
    public function rename(string $newTableName)
    {
        $this->actions->addAction(new RenameTable($this->table, $newTableName));
        return $this;
    }
    /**
     * Changes the primary key of the database table.
     *
     * @param string|string[]|null $columns Column name(s) to belong to the primary key, or null to drop the key
     * @return $this
     */
    public function changePrimaryKey($columns)
    {
        $this->actions->addAction(new ChangePrimaryKey($this->table, $columns));
        return $this;
    }
    /**
     * Checks to see if a primary key exists.
     *
     * @param string|string[] $columns Column(s)
     * @param string|null $constraint Constraint names
     * @return bool
     */
    public function hasPrimaryKey($columns, ?string $constraint = null) : bool
    {
        return $this->getAdapter()->hasPrimaryKey($this->getName(), $columns, $constraint);
    }
    /**
     * Changes the comment of the database table.
     *
     * @param string|null $comment New comment string, or null to drop the comment
     * @return $this
     */
    public function changeComment(?string $comment)
    {
        $this->actions->addAction(new ChangeComment($this->table, $comment));
        return $this;
    }
    /**
     * Gets an array of the table columns.
     *
     * @return \Phinx\Db\Table\Column[]
     */
    public function getColumns() : array
    {
        return $this->getAdapter()->getColumns($this->getName());
    }
    /**
     * Gets a table column if it exists.
     *
     * @param string $name Column name
     * @return \Phinx\Db\Table\Column|null
     */
    public function getColumn(string $name) : ?Column
    {
        $columns = \array_filter($this->getColumns(), function ($column) use($name) {
            return $column->getName() === $name;
        });
        return \array_pop($columns);
    }
    /**
     * Sets an array of data to be inserted.
     *
     * @param array $data Data
     * @return $this
     */
    public function setData(array $data)
    {
        $this->data = $data;
        return $this;
    }
    /**
     * Gets the data waiting to be inserted.
     *
     * @return array
     */
    public function getData() : array
    {
        return $this->data;
    }
    /**
     * Resets all of the pending data to be inserted
     *
     * @return void
     */
    public function resetData() : void
    {
        $this->setData([]);
    }
    /**
     * Resets all of the pending table changes.
     *
     * @return void
     */
    public function reset() : void
    {
        $this->actions = new Intent();
        $this->resetData();
    }
    /**
     * Add a table column.
     *
     * Type can be: string, text, integer, float, decimal, datetime, timestamp,
     * time, date, binary, boolean.
     *
     * Valid options can be: limit, default, null, precision or scale.
     *
     * @param string|\Phinx\Db\Table\Column $columnName Column Name
     * @param string|\Phinx\Util\Literal|null $type Column Type
     * @param array<string, mixed> $options Column Options
     * @throws \InvalidArgumentException
     * @return $this
     */
    public function addColumn($columnName, $type = null, array $options = [])
    {
        if ($columnName instanceof Column) {
            $action = new AddColumn($this->table, $columnName);
        } elseif ($type instanceof Literal) {
            $action = AddColumn::build($this->table, $columnName, $type, $options);
        } else {
            $action = new AddColumn($this->table, $this->getAdapter()->getColumnForType($columnName, $type, $options));
        }
        // Delegate to Adapters to check column type
        if (!$this->getAdapter()->isValidColumnType($action->getColumn())) {
            throw new InvalidArgumentException(\sprintf('An invalid column type "%s" was specified for column "%s".', $type, $action->getColumn()->getName()));
        }
        $this->actions->addAction($action);
        return $this;
    }
    /**
     * Remove a table column.
     *
     * @param string $columnName Column Name
     * @return $this
     */
    public function removeColumn(string $columnName)
    {
        $action = RemoveColumn::build($this->table, $columnName);
        $this->actions->addAction($action);
        return $this;
    }
    /**
     * Rename a table column.
     *
     * @param string $oldName Old Column Name
     * @param string $newName New Column Name
     * @return $this
     */
    public function renameColumn(string $oldName, string $newName)
    {
        $action = RenameColumn::build($this->table, $oldName, $newName);
        $this->actions->addAction($action);
        return $this;
    }
    /**
     * Change a table column type.
     *
     * @param string $columnName Column Name
     * @param string|\Phinx\Db\Table\Column|\Phinx\Util\Literal $newColumnType New Column Type
     * @param array<string, mixed> $options Options
     * @return $this
     */
    public function changeColumn(string $columnName, $newColumnType, array $options = [])
    {
        if ($newColumnType instanceof Column) {
            $action = new ChangeColumn($this->table, $columnName, $newColumnType);
        } else {
            $action = ChangeColumn::build($this->table, $columnName, $newColumnType, $options);
        }
        $this->actions->addAction($action);
        return $this;
    }
    /**
     * Checks to see if a column exists.
     *
     * @param string $columnName Column Name
     * @return bool
     */
    public function hasColumn(string $columnName) : bool
    {
        return $this->getAdapter()->hasColumn($this->getName(), $columnName);
    }
    /**
     * Add an index to a database table.
     *
     * In $options you can specify unique = true/false, and name (index name).
     *
     * @param string|array|\Phinx\Db\Table\Index $columns Table Column(s)
     * @param array<string, mixed> $options Index Options
     * @return $this
     */
    public function addIndex($columns, array $options = [])
    {
        $action = AddIndex::build($this->table, $columns, $options);
        $this->actions->addAction($action);
        return $this;
    }
    /**
     * Removes the given index from a table.
     *
     * @param string|string[] $columns Columns
     * @return $this
     */
    public function removeIndex($columns)
    {
        $action = DropIndex::build($this->table, \is_string($columns) ? [$columns] : $columns);
        $this->actions->addAction($action);
        return $this;
    }
    /**
     * Removes the given index identified by its name from a table.
     *
     * @param string $name Index name
     * @return $this
     */
    public function removeIndexByName(string $name)
    {
        $action = DropIndex::buildFromName($this->table, $name);
        $this->actions->addAction($action);
        return $this;
    }
    /**
     * Checks to see if an index exists.
     *
     * @param string|string[] $columns Columns
     * @return bool
     */
    public function hasIndex($columns) : bool
    {
        return $this->getAdapter()->hasIndex($this->getName(), $columns);
    }
    /**
     * Checks to see if an index specified by name exists.
     *
     * @param string $indexName Index name
     * @return bool
     */
    public function hasIndexByName($indexName) : bool
    {
        return $this->getAdapter()->hasIndexByName($this->getName(), $indexName);
    }
    /**
     * Add a foreign key to a database table.
     *
     * In $options you can specify on_delete|on_delete = cascade|no_action ..,
     * on_update, constraint = constraint name.
     *
     * @param string|string[] $columns Columns
     * @param string|\Phinx\Db\Table\Table $referencedTable Referenced Table
     * @param string|string[] $referencedColumns Referenced Columns
     * @param array<string, mixed> $options Options
     * @return $this
     */
    public function addForeignKey($columns, $referencedTable, $referencedColumns = ['id'], array $options = [])
    {
        $action = AddForeignKey::build($this->table, $columns, $referencedTable, $referencedColumns, $options);
        $this->actions->addAction($action);
        return $this;
    }
    /**
     * Add a foreign key to a database table with a given name.
     *
     * In $options you can specify on_delete|on_delete = cascade|no_action ..,
     * on_update, constraint = constraint name.
     *
     * @param string $name The constraint name
     * @param string|string[] $columns Columns
     * @param string|\Phinx\Db\Table\Table $referencedTable Referenced Table
     * @param string|string[] $referencedColumns Referenced Columns
     * @param array<string, mixed> $options Options
     * @return $this
     */
    public function addForeignKeyWithName(string $name, $columns, $referencedTable, $referencedColumns = ['id'], array $options = [])
    {
        $action = AddForeignKey::build($this->table, $columns, $referencedTable, $referencedColumns, $options, $name);
        $this->actions->addAction($action);
        return $this;
    }
    /**
     * Removes the given foreign key from the table.
     *
     * @param string|string[] $columns Column(s)
     * @param string|null $constraint Constraint names
     * @return $this
     */
    public function dropForeignKey($columns, ?string $constraint = null)
    {
        $action = DropForeignKey::build($this->table, $columns, $constraint);
        $this->actions->addAction($action);
        return $this;
    }
    /**
     * Checks to see if a foreign key exists.
     *
     * @param string|string[] $columns Column(s)
     * @param string|null $constraint Constraint names
     * @return bool
     */
    public function hasForeignKey($columns, ?string $constraint = null) : bool
    {
        return $this->getAdapter()->hasForeignKey($this->getName(), $columns, $constraint);
    }
    /**
     * Add timestamp columns created_at and updated_at to the table.
     *
     * @param string|false|null $createdAt Alternate name for the created_at column
     * @param string|false|null $updatedAt Alternate name for the updated_at column
     * @param bool $withTimezone Whether to set the timezone option on the added columns
     * @return $this
     */
    public function addTimestamps($createdAt = 'created_at', $updatedAt = 'updated_at', bool $withTimezone = \false)
    {
        $createdAt = $createdAt ?? 'created_at';
        $updatedAt = $updatedAt ?? 'updated_at';
        if (!$createdAt && !$updatedAt) {
            throw new \RuntimeException('Cannot set both created_at and updated_at columns to false');
        }
        if ($createdAt) {
            $this->addColumn($createdAt, 'timestamp', ['null' => \false, 'default' => 'CURRENT_TIMESTAMP', 'update' => '', 'timezone' => $withTimezone]);
        }
        if ($updatedAt) {
            $this->addColumn($updatedAt, 'timestamp', ['null' => \true, 'default' => null, 'update' => 'CURRENT_TIMESTAMP', 'timezone' => $withTimezone]);
        }
        return $this;
    }
    /**
     * Alias that always sets $withTimezone to true
     *
     * @see addTimestamps
     * @param string|false|null $createdAt Alternate name for the created_at column
     * @param string|false|null $updatedAt Alternate name for the updated_at column
     * @return $this
     */
    public function addTimestampsWithTimezone($createdAt = null, $updatedAt = null)
    {
        $this->addTimestamps($createdAt, $updatedAt, \true);
        return $this;
    }
    /**
     * Insert data into the table.
     *
     * @param array $data array of data in the form:
     *              array(
     *                  array("col1" => "value1", "col2" => "anotherValue1"),
     *                  array("col2" => "value2", "col2" => "anotherValue2"),
     *              )
     *              or array("col1" => "value1", "col2" => "anotherValue1")
     * @return $this
     */
    public function insert(array $data)
    {
        // handle array of array situations
        $keys = \array_keys($data);
        $firstKey = \array_shift($keys);
        if ($firstKey !== null && \is_array($data[$firstKey])) {
            foreach ($data as $row) {
                $this->data[] = $row;
            }
            return $this;
        }
        if (\count($data) > 0) {
            $this->data[] = $data;
        }
        return $this;
    }
    /**
     * Creates a table from the object instance.
     *
     * @return void
     */
    public function create() : void
    {
        $this->executeActions(\false);
        $this->saveData();
        $this->reset();
        // reset pending changes
    }
    /**
     * Updates a table from the object instance.
     *
     * @return void
     */
    public function update() : void
    {
        $this->executeActions(\true);
        $this->saveData();
        $this->reset();
        // reset pending changes
    }
    /**
     * Commit the pending data waiting for insertion.
     *
     * @return void
     */
    public function saveData() : void
    {
        $rows = $this->getData();
        if (empty($rows)) {
            return;
        }
        $bulk = \true;
        $row = \current($rows);
        $c = \array_keys($row);
        foreach ($this->getData() as $row) {
            $k = \array_keys($row);
            if ($k != $c) {
                $bulk = \false;
                break;
            }
        }
        if ($bulk) {
            $this->getAdapter()->bulkinsert($this->table, $this->getData());
        } else {
            foreach ($this->getData() as $row) {
                $this->getAdapter()->insert($this->table, $row);
            }
        }
        $this->resetData();
    }
    /**
     * Immediately truncates the table. This operation cannot be undone
     *
     * @return void
     */
    public function truncate() : void
    {
        $this->getAdapter()->truncateTable($this->getName());
    }
    /**
     * Commits the table changes.
     *
     * If the table doesn't exist it is created otherwise it is updated.
     *
     * @return void
     */
    public function save() : void
    {
        if ($this->exists()) {
            $this->update();
            // update the table
        } else {
            $this->create();
            // create the table
        }
    }
    /**
     * Executes all the pending actions for this table
     *
     * @param bool $exists Whether or not the table existed prior to executing this method
     * @return void
     */
    protected function executeActions(bool $exists) : void
    {
        // Renaming a table is tricky, specially when running a reversible migration
        // down. We will just assume the table already exists if the user commands a
        // table rename.
        if (!$exists) {
            foreach ($this->actions->getActions() as $action) {
                if ($action instanceof RenameTable) {
                    $exists = \true;
                    break;
                }
            }
        }
        // If the table does not exist, the last command in the chain needs to be
        // a CreateTable action.
        if (!$exists) {
            $this->actions->addAction(new CreateTable($this->table));
        }
        $plan = new Plan($this->actions);
        $plan->execute($this->getAdapter());
    }
}