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: 
<?php

    namespace CzProject\SqlSchema;


    class Column
    {
        const OPTION_UNSIGNED = 'UNSIGNED';
        const OPTION_ZEROFILL = 'ZEROFILL';

        /** @var string */
        private $name;

        /** @var string */
        private $type;

        /** @var array */
        private $parameters = array();

        /** @var array */
        private $options = array();

        /** @var bool */
        private $nullable = FALSE;

        /** @var bool */
        private $autoIncrement = FALSE;

        /** @var scalar|NULL */
        private $defaultValue;

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


        /**
         * @param  string
         * @param  string|NULL
         * @param  array|string|NULL
         * @param  array  [OPTION => VALUE, OPTION2]
         */
        public function __construct($name, $type, array $parameters = NULL, array $options = array())
        {
            $this->name = $name;
            $this->setType($type);
            $this->setParameters($parameters);
            $this->setOptions($options);
        }


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


        /**
         * @param  string
         * @return self
         */
        public function setType($type)
        {
            $this->type = $type;
            return $this;
        }


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


        /**
         * @param  string|array|NULL
         * @return self
         */
        public function setParameters($parameters)
        {
            if ($parameters === NULL) {
                $parameters = array();

            } elseif (!is_array($parameters)) {
                $parameters = array($parameters);
            }

            $this->parameters = $parameters;
            return $this;
        }


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


        /**
         * @param  string
         * @param  scalar|NULL
         * @return self
         */
        public function addOption($option, $value = NULL)
        {
            $this->options[$option] = $value;
            return $this;
        }


        /**
         * @param  array
         * @return self
         */
        public function setOptions(array $options)
        {
            $this->options = array();

            foreach ($options as $k => $v) {
                if (is_int($k)) {
                    $this->options[$v] = NULL;

                } else {
                    $this->options[$k] = $v;
                }
            }

            return $this;
        }


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


        /**
         * @return array
         */
        public function hasOption($name)
        {
            return array_key_exists($name, $this->options);
        }


        /**
         * @param  bool
         * @return self
         */
        public function setNullable($nullable = TRUE)
        {
            $this->nullable = $nullable;
            return $this;
        }


        /**
         * @return bool
         */
        public function isNullable()
        {
            return $this->nullable;
        }


        /**
         * @param  bool
         * @return self
         */
        public function setAutoIncrement($autoIncrement = TRUE)
        {
            $this->autoIncrement = $autoIncrement;
            return $this;
        }


        /**
         * @return bool
         */
        public function isAutoIncrement()
        {
            return $this->autoIncrement;
        }


        /**
         * @param  scalar|NULL
         * @return self
         */
        public function setDefaultValue($defaultValue)
        {
            $this->defaultValue = $defaultValue;
            return $this;
        }


        /**
         * @return scalar|NULL
         */
        public function getDefaultValue()
        {
            return $this->defaultValue;
        }


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


        /**
         * @return string|NULL
         */
        public function getComment()
        {
            return $this->comment;
        }
    }
czproject/sql-schema v2.1.0 API documentation API documentation generated by ApiGen