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

    namespace CzProject\SqlGenerator\Statements;

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


    class IndexColumnDefinition implements IStatement
    {
        const ASC = 'ASC';
        const DESC = 'DESC';

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

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

        /** @var int|NULL */
        private $length;


        /**
         * @param  string
         * @param  string
         * @param  int|NULL
         */
        public function __construct($name, $order = self::ASC, $length = NULL)
        {
            $this->name = $name;
            $this->setOrder($order);
            $this->length = $length;
        }


        /**
         * @param  string
         * @return self
         */
        private function setOrder($order)
        {
            $order = (string) $order;

            if ($order !== self::ASC && $order !== self::DESC) {
                throw new OutOfRangeException("Order type '$order' not found.");
            }

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


        /**
         * @return string
         */
        public function toSql(IDriver $driver)
        {
            $output = $driver->escapeIdentifier($this->name);

            if ($this->length !== NULL) {
                $output .= ' (' . $this->length . ')';
            }

            if ($this->order !== self::ASC) {
                $output .= ' ' . $this->order;
            }

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