Overview

Namespaces

  • CzProject
    • SqlSchema

Classes

  • Column
  • ForeignKey
  • Index
  • IndexColumn
  • Schema
  • Table

Exceptions

  • DuplicateException
  • EmptyException
  • Exception
  • OutOfRangeException
  • StaticClassException
  • Overview
  • Namespace
  • Class

Class Table

Namespace: CzProject\SqlSchema
Located at Table.php
Methods summary
public
# __construct( string $name )

Parameters

$name
public string
# getName( )

Returns

string
public CzProject\SqlSchema\Table
# setComment( string|null $comment )

Parameters

$comment

Returns

CzProject\SqlSchema\Table
public string|null
# getComment( )

Returns

string|null
public CzProject\SqlSchema\Table
# setOption( string $name, string $value )

Parameters

$name
$value

Returns

CzProject\SqlSchema\Table
public array
# getOptions( )

Returns

array
public CzProject\SqlSchema\Column
# addColumn( string|CzProject\SqlSchema\Column $name, string|null $type = NULL, array|string|null $parameters = NULL, array $options = array() )

Parameters

$name
$type
$parameters
$options
=> NULL

Returns

CzProject\SqlSchema\Column
public CzProject\SqlSchema\Column|null
# getColumn( string $name )

Parameters

$name

Returns

CzProject\SqlSchema\Column|null
public CzProject\SqlSchema\Column[]
# getColumns( )

Returns

CzProject\SqlSchema\Column[]
public CzProject\SqlSchema\Index
# addIndex( string|CzProject\SqlSchema\Index|null $name, string $type = Index::TYPE_INDEX, string[]|string $columns = array() )

Parameters

$name
$type
$columns

Returns

CzProject\SqlSchema\Index
public CzProject\SqlSchema\Index|null
# getIndex( string $name )

Parameters

$name

Returns

CzProject\SqlSchema\Index|null
public CzProject\SqlSchema\Index[]
# getIndexes( )

Returns

CzProject\SqlSchema\Index[]
public CzProject\SqlSchema\ForeignKey
# addForeignKey( string|CzProject\SqlSchema\ForeignKey $name, string[]|string $columns = array(), string $targetTable = NULL, string[]|string $targetColumns = array() )

Parameters

$name
$columns
$targetTable
$targetColumns

Returns

CzProject\SqlSchema\ForeignKey
public CzProject\SqlSchema\ForeignKey|null
# getForeignKey( string $name )

Parameters

$name

Returns

CzProject\SqlSchema\ForeignKey|null
public CzProject\SqlSchema\ForeignKey[]
# getForeignKeys( )

Returns

CzProject\SqlSchema\ForeignKey[]
public
# validate( )

Throws

CzProject\SqlSchema\Exception
czproject/sql-schema v1.0.0 API documentation API documentation generated by ApiGen