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

    namespace CzProject\SqlSchema;


    class ForeignKey
    {
        const ACTION_RESTRICT = 'RESTRICT';
        const ACTION_NO_ACTION = 'NO ACTION';
        const ACTION_CASCADE = 'CASCADE';
        const ACTION_SET_NULL = 'SET NULL';

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

        /** @var string[] */
        private $columns = array();

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

        /** @var string[] */
        private $targetColumns;

        /** @var string */
        private $onUpdateAction = self::ACTION_RESTRICT;

        /** @var string */
        private $onDeleteAction = self::ACTION_RESTRICT;


        /**
         * @param  string
         * @param  string[]|string
         * @param  string
         * @param  string[]|string
         */
        public function __construct($name, $columns = array(), $targetTable, $targetColumns = array())
        {
            $this->name = $name;
            $this->setTargetTable($targetTable);

            if (!is_array($columns)) {
                $columns = array($columns);
            }

            foreach ($columns as $column) {
                $this->addColumn($column);
            }

            if (!is_array($targetColumns)) {
                $targetColumns = array($targetColumns);
            }

            foreach ($targetColumns as $targetColumn) {
                $this->addTargetColumn($targetColumn);
            }
        }


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


        /**
         * @param  string
         * @return self
         */
        public function addColumn($column)
        {
            return $this->columns[] = $column;
        }


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


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


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


        /**
         * @param  string
         * @return self
         */
        public function addTargetColumn($targetColumn)
        {
            return $this->targetColumns[] = $targetColumn;
        }


        /**
         * @return string[]
         */
        public function getTargetColumns()
        {
            return $this->targetColumns;
        }


        /**
         * @param  int
         * @return self
         */
        public function setOnUpdateAction($onUpdateAction)
        {
            if (!$this->validateAction($onUpdateAction)) {
                throw new OutOfRangeException("Action '$onUpdateAction' is invalid.");
            }

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


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


        /**
         * @param  int
         * @return self
         */
        public function setOnDeleteAction($onDeleteAction)
        {
            if (!$this->validateAction($onDeleteAction)) {
                throw new OutOfRangeException("Action '$onDeleteAction' is invalid.");
            }

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


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


        /**
         * @param  string
         * @return bool
         */
        private function validateAction($action)
        {
            return $action === self::ACTION_RESTRICT
                || $action === self::ACTION_NO_ACTION
                || $action === self::ACTION_CASCADE
                || $action === self::ACTION_SET_NULL;
        }
    }
czproject/sql-schema v2.1.0 API documentation API documentation generated by ApiGen