Overview

Namespaces

  • CzProject
    • SqlGenerator
      • Drivers
      • Statements

Classes

  • CzProject\SqlGenerator\Drivers\MysqlDriver
  • CzProject\SqlGenerator\Helpers
  • CzProject\SqlGenerator\SqlDocument
  • CzProject\SqlGenerator\Statements\AddColumn
  • CzProject\SqlGenerator\Statements\AddForeignKey
  • CzProject\SqlGenerator\Statements\AddIndex
  • CzProject\SqlGenerator\Statements\AlterTable
  • CzProject\SqlGenerator\Statements\ColumnDefinition
  • CzProject\SqlGenerator\Statements\CreateTable
  • CzProject\SqlGenerator\Statements\DropColumn
  • CzProject\SqlGenerator\Statements\DropForeignKey
  • CzProject\SqlGenerator\Statements\DropIndex
  • CzProject\SqlGenerator\Statements\DropTable
  • CzProject\SqlGenerator\Statements\ForeignKeyDefinition
  • CzProject\SqlGenerator\Statements\IndexColumnDefinition
  • CzProject\SqlGenerator\Statements\IndexDefinition
  • CzProject\SqlGenerator\Statements\Insert
  • CzProject\SqlGenerator\Statements\ModifyColumn
  • CzProject\SqlGenerator\Statements\RenameTable

Interfaces

  • CzProject\SqlGenerator\IDriver
  • CzProject\SqlGenerator\IStatement

Exceptions

  • CzProject\SqlGenerator\DuplicateException
  • CzProject\SqlGenerator\Exception
  • CzProject\SqlGenerator\InvalidArgumentException
  • CzProject\SqlGenerator\NotImplementedException
  • CzProject\SqlGenerator\NotSupportedException
  • CzProject\SqlGenerator\OutOfRangeException
  • CzProject\SqlGenerator\StaticClassException
  • Overview
  • Namespace
  • Class
  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: 133: 134: 135: 136: 137: 138: 139: 140: 141: 142: 143: 144: 145: 146: 147: 148: 149: 150: 151: 152: 153: 154: 155: 156: 157: 158: 159: 160: 161: 162: 163: 164: 165: 166: 167: 168: 169: 170: 171: 172: 173: 174: 175: 176: 177: 178: 179: 180: 181: 182: 183: 184: 185: 186: 187: 
<?php

    namespace CzProject\SqlGenerator\Statements;

    use CzProject\SqlGenerator\DuplicateException;
    use CzProject\SqlGenerator\Helpers;
    use CzProject\SqlGenerator\IDriver;
    use CzProject\SqlGenerator\IStatement;


    class AlterTable implements IStatement
    {
        /** @var string */
        private $tableName;

        /** @var IStatement[] */
        private $statements = array();

        /** @var string|NULL */
        private $comment;

        /** @var array  [name => value] */
        private $options = array();


        /**
         * @param  string
         */
        public function __construct($tableName)
        {
            $this->tableName = $tableName;
        }


        /**
         * @param  string
         * @param  string
         * @param  array
         * @param  array  [name => value]
         * @return AddColumn
         */
        public function addColumn($name, $type, array $parameters = NULL, array $options = array())
        {
            return $this->statements[] = new AddColumn($name, $type, $parameters, $options);
        }


        /**
         * @param  string
         * @return DropColumn
         */
        public function dropColumn($column)
        {
            return $this->statements[] = new DropColumn($column);
        }


        /**
         * @param  string
         * @param  string
         * @param  array
         * @param  array  [name => value]
         * @return ModifyColumn
         */
        public function modifyColumn($name, $type, array $parameters = NULL, array $options = array())
        {
            return $this->statements[] = new ModifyColumn($name, $type, $parameters, $options);
        }


        /**
         * @param  string|NULL
         * @param  string
         * @return AddIndex
         */
        public function addIndex($name = NULL, $type)
        {
            return $this->statements[] = new AddIndex($name, $type);
        }


        /**
         * @param  string
         * @return DropIndex
         */
        public function dropIndex($index)
        {
            return $this->statements[] = new DropIndex($index);
        }


        /**
         * @param  string
         * @param  string[]|string
         * @param  string
         * @param  string[]|string
         * @return AddForeignKey
         */
        public function addForeignKey($name, $columns = array(), $targetTable, $targetColumns = array())
        {
            return $this->statements[] = new AddForeignKey($name, $columns, $targetTable, $targetColumns);
        }


        /**
         * @param  string
         * @return DropForeignKey
         */
        public function dropForeignKey($foreignKey)
        {
            return $this->statements[] = new DropForeignKey($foreignKey);
        }


        /**
         * @param  string|NULL
         * @return self
         */
        public function setComment($comment)
        {
            $this->comment = $comment;
            return $this;
        }


        /**
         * @param  string
         * @param  string
         * @return self
         */
        public function setOption($name, $value)
        {
            $this->options[$name] = $value;
            return $this;
        }


        /**
         * @return string
         */
        public function toSql(IDriver $driver)
        {
            if (empty($this->statements)) {
                return '';
            }

            $output = 'ALTER TABLE ' . $driver->escapeIdentifier($this->tableName) . "\n";
            $isFirst = TRUE;

            foreach ($this->statements as $statement) {
                if ($isFirst) {
                    $isFirst = FALSE;

                } else {
                    $output .= ",\n";
                }

                $output .= $statement->toSql($driver);
            }

            if (isset($this->comment)) {
                if ($isFirst) {
                    $isFirst = FALSE;

                } else {
                    $output .= ",\n";
                }

                $output .= 'COMMENT ' . $driver->escapeText($this->comment);
            }

            foreach ($this->options as $optionName => $optionValue) {
                if ($isFirst) {
                    $isFirst = FALSE;

                } else {
                    $output .= ",\n";
                }

                $output .= $optionName . '=' . $optionValue;
            }

            $output .= ';';
            return $output;
        }
    }
czproject/sql-generator v1.0.0 API documentation API documentation generated by ApiGen