Peyote
Back to top  

A class to allow table altering.

package Peyote
author Dave Widmer

 Methods

__construct() 

__construct(string $table) 

Parameters

$table

string

The table name

addColumn() 

addColumn(string | \Peyote\Column $column) : \Peyote\Alter

Parameters

$column

string\Peyote\Column

The column name or Peyote column

Returns

\Peyote\Alter$this

addIndex() 

addIndex(string $column, string $type) : \Peyote\Alter

Parameters

$column

string

The column name to add as a key

$type

string

The type of key to add

Returns

\Peyote\Alter$this

addPrimaryKey() 

addPrimaryKey(string $column) : \Peyote\Alter

Parameters

$column

string

The columns name

Returns

\Peyote\Alter

{@inheritDoc}

compile() 

Exceptions

\Peyote\Exception

dropColumn() 

dropColumn(string $column) : \Peyote\Alter

Parameters

$column

string

The column name

Returns

\Peyote\Alter$this

dropIndex() 

dropIndex(string $index, $type) : \Peyote\Alter

Parameters

$index

string

The index

$type

Returns

\Peyote\Alter$this

dropPrimaryKey() 

dropPrimaryKey() : \Peyote\Alter

Returns

\Peyote\Alter$this

getConditions() 

getConditions() : array

Returns

arrayA list of alter conditions

getTable() 

getTable() : string

Returns

string

setTable() 

setTable(string $table) : \Peyote\Alter

Parameters

$table

string

The table name to drop.

Returns

\Peyote\Alter

 Properties

 

$conditions

$conditions : array

 

$table

$table : string