Overview

Namespaces

  • CzProject
    • SqlSchema

Classes

  • CzProject\SqlSchema\Column
  • CzProject\SqlSchema\ForeignKey
  • CzProject\SqlSchema\Index
  • CzProject\SqlSchema\IndexColumn
  • CzProject\SqlSchema\Schema
  • CzProject\SqlSchema\Table

Exceptions

  • CzProject\SqlSchema\DuplicateException
  • CzProject\SqlSchema\EmptyException
  • CzProject\SqlSchema\Exception
  • CzProject\SqlSchema\OutOfRangeException
  • CzProject\SqlSchema\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: 188: 189: 190: 191: 192: 193: 194: 195: 196: 197: 198: 199: 200: 201: 202: 203: 204: 205: 206: 207: 208: 209: 210: 211: 212: 213: 214: 215: 216: 217: 218: 219: 220: 221: 222: 223: 224: 225: 226: 227: 228: 229: 230: 231: 232: 233: 234: 235: 236: 237: 238: 239: 240: 241: 242: 243: 244: 245: 246: 247: 248: 249: 250: 251: 252: 253: 254: 255: 256: 257: 258: 
<?php

    namespace CzProject\SqlSchema;


    class Table
    {
        /** @var string */
        private $name;

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

        /** @var array  [name => Column] */
        private $columns = array();

        /** @var array  [name => Index] */
        private $indexes = array();

        /** @var array  [name => ForeignKey] */
        private $foreignKeys = array();

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


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


        /**
         * @return string
         */
        public function getName()
        {
            return $this->name;
        }


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


        /**
         * @return string|NULL
         */
        public function getComment()
        {
            return $this->comment;
        }


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


        /**
         * @return array
         */
        public function getOptions()
        {
            return $this->options;
        }


        /**
         * @param  string|Column
         * @param  string|NULL
         * @param  array|string|NULL
         * @param  array OPTION => NULL
         * @return Column
         */
        public function addColumn($name, $type = NULL, $parameters = NULL, array $options = array())
        {
            $column = NULL;

            if ($name instanceof Column) {
                $column = $name;
                $name = $column->getName();

            } else {
                $column = new Column($name, $type, $parameters, $options);
            }

            if (isset($this->columns[$name])) {
                throw new DuplicateException("Column '$name' in table '{$this->getName()}' already exists.");
            }

            return $this->columns[$name] = $column;
        }


        /**
         * @param  string
         * @return Column|NULL
         */
        public function getColumn($name)
        {
            if (isset($this->columns[$name])) {
                return $this->columns[$name];
            }
            return NULL;
        }


        /**
         * @return Column[]
         */
        public function getColumns()
        {
            return $this->columns;
        }


        /**
         * @param  string|Index|NULL
         * @param  string[]|string
         * @param  string
         * @return Index
         */
        public function addIndex($name, $columns = array(), $type = Index::TYPE_INDEX)
        {
            $index = NULL;

            if ($name instanceof Index) {
                $index = $name;
                $name = $index->getName();

            } else {
                $index = new Index($name, $columns, $type);
                $name = $index->getName();
            }

            if (isset($this->indexes[$name])) {
                throw new DuplicateException("Index '$name' in table '{$this->getName()}' already exists.");
            }

            return $this->indexes[$name] = $index;
        }


        /**
         * @param  string
         * @return Index|NULL
         */
        public function getIndex($name)
        {
            if (isset($this->indexes[$name])) {
                return $this->indexes[$name];
            }
            return NULL;
        }


        /**
         * @return Index[]
         */
        public function getIndexes()
        {
            return $this->indexes;
        }


        /**
         * @param  string|ForeignKey
         * @param  string[]|string
         * @param  string
         * @param  string[]|string
         * @return ForeignKey
         */
        public function addForeignKey($name, $columns = array(), $targetTable = NULL, $targetColumns = array())
        {
            $foreignKey = NULL;

            if ($name instanceof ForeignKey) {
                $foreignKey = $name;
                $name = $foreignKey->getName();

            } else {
                $foreignKey = new ForeignKey($name, $columns, $targetTable, $targetColumns);
                $name = $foreignKey->getName();
            }

            if (isset($this->foreignKeys[$name])) {
                throw new DuplicateException("Foreign key '$name' in table '{$this->getName()}' already exists.");
            }

            return $this->foreignKeys[$name] = $foreignKey;
        }


        /**
         * @param  string
         * @return ForeignKey|NULL
         */
        public function getForeignKey($name)
        {
            if (isset($this->foreignKeys[$name])) {
                return $this->foreignKeys[$name];
            }
            return NULL;
        }


        /**
         * @return ForeignKey[]
         */
        public function getForeignKeys()
        {
            return $this->foreignKeys;
        }


        /**
         * @throws Exception
         * @return void
         */
        public function validate()
        {
            $tableName = $this->getName();

            if (empty($this->columns)) {
                throw new EmptyException("Table '$tableName' hasn't columns.");
            }

            $hasPrimaryIndex = FALSE;

            foreach ($this->getIndexes() as $index) {
                if ($index->getType() === Index::TYPE_PRIMARY) {
                    if ($hasPrimaryIndex) {
                        throw new DuplicateException("Duplicated primary index in table '$tableName'.");
                    }
                    $hasPrimaryIndex = TRUE;
                }
            }
        }
    }
czproject/sql-schema v2.1.0 API documentation API documentation generated by ApiGen