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\Comment
  • 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
  • CzProject\SqlGenerator\Statements\SqlCommand

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

    namespace CzProject\SqlGenerator\Statements;

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


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

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

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

        /** @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->targetTable = $targetTable;

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

            foreach ($columns as $column) {
                $this->columns[] = $column;
            }

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

            foreach ($targetColumns as $targetColumn) {
                $this->targetColumns[] = $targetColumn;
            }
        }


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

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


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

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


        /**
         * @return string
         */
        public function toSql(IDriver $driver)
        {
            $output = 'CONSTRAINT ' . $driver->escapeIdentifier($this->name);
            $output .= ' FOREIGN KEY (';
            $output .= implode(', ', array_map(array($driver, 'escapeIdentifier'), $this->columns));
            $output .= ') REFERENCES ' . $driver->escapeIdentifier($this->targetTable) . ' (';
            $output .= implode(', ', array_map(array($driver, 'escapeIdentifier'), $this->targetColumns));
            $output .= ')';
            $output .= ' ON DELETE ' . $this->onDeleteAction;
            $output .= ' ON UPDATE ' . $this->onUpdateAction;
            return $output;
        }


        /**
         * @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-generator v1.2.2 API documentation API documentation generated by ApiGen