PHP Interface Storm\Core\Relational\ITable

Author: Elliot Levin ([email protected])

Mostrar archivo Open project: timetoogo/penumbra Interface Usage Examples

Public Methods

Method	Description
GetColumn ( string $Name ) : Storm\Core\Relational\IColumn \| null
GetColumnByIdentifier ( string $Identifier ) : Storm\Core\Relational\IColumn \| null
GetColumnIdentifiers ( ) : string[]
GetColumns ( ) : Storm\Core\Relational\IColumn[]	Gets the table columns, indexed by their respective column name.
GetColumnsByIdentifier ( ) : Storm\Core\Relational\IColumn[]
GetDepedencyOrderBetween ( $DependencyMode, Storm\Core\Relational\ITable $OtherTable ) : integer
GetDiscardingOrderBetween ( Storm\Core\Relational\ITable $OtherTable ) : integer
GetName ( ) : string
GetPersistingOrderBetween ( Storm\Core\Relational\ITable $OtherTable ) : integer
GetPrimaryKeyColumnIdentifiers ( ) : string[]
GetPrimaryKeyColumns ( ) : Storm\Core\Relational\IColumn[]	Gets the table columns which are primary keys, indexed by their respective column name.
GetPrimaryKeyColumnsByIdentifier ( ) : Storm\Core\Relational\IColumn[]
GetToManyRelations ( ) : Storm\Core\Relational\IToManyRelation[]
GetToOneRelations ( ) : Storm\Core\Relational\IToOneRelation[]
HasColumn ( string $Name ) : boolean
HasPrimaryKey ( string $Name ) : boolean
InitializeRelatedStructure ( Database $Database ) : void	Initializes the related structure of the table.
InitializeRelations ( Database $Database ) : void	Initializes the relations of the table.
InitializeStructure ( Database $Database ) : void	Initializes the columns of the table.
Is ( Storm\Core\Relational\ITable $Table )
PrimaryKey ( array $Data = [] ) : PrimaryKey	Get a primary key of this table
Row ( array $Data = [] ) : Row	Get a row of this table

Method Details

GetColumn() public method

public GetColumn ( string $Name ) : Storm\Core\Relational\IColumn \| null
$Name	string	The column name
return	Storm\Core\Relational\IColumn \| null

GetColumnByIdentifier() public method

public GetColumnByIdentifier ( string $Identifier ) : Storm\Core\Relational\IColumn \| null
$Identifier	string	The column identifier
return	Storm\Core\Relational\IColumn \| null

GetColumnIdentifiers() public method

public GetColumnIdentifiers ( ) : string[]
return	string[]

GetColumns() public method

Gets the table columns, indexed by their respective column name.

public GetColumns ( ) : Storm\Core\Relational\IColumn[]
return	Storm\Core\Relational\IColumn[]

GetColumnsByIdentifier() public method

public GetColumnsByIdentifier ( ) : Storm\Core\Relational\IColumn[]
return	Storm\Core\Relational\IColumn[]

GetDepedencyOrderBetween() public method

public GetDepedencyOrderBetween ( $DependencyMode, Storm\Core\Relational\ITable $OtherTable ) : integer
$OtherTable	Storm\Core\Relational\ITable	The other table
return	integer	The dependency order

GetDiscardingOrderBetween() public method

public GetDiscardingOrderBetween ( Storm\Core\Relational\ITable $OtherTable ) : integer
$OtherTable	Storm\Core\Relational\ITable	The other table
return	integer	The dependency order

GetName() public method

public GetName ( ) : string
return	string

GetPersistingOrderBetween() public method

public GetPersistingOrderBetween ( Storm\Core\Relational\ITable $OtherTable ) : integer
$OtherTable	Storm\Core\Relational\ITable	The other table
return	integer	The dependency order

GetPrimaryKeyColumnIdentifiers() public method

public GetPrimaryKeyColumnIdentifiers ( ) : string[]
return	string[]

GetPrimaryKeyColumns() public method

Gets the table columns which are primary keys, indexed by their respective column name.

public GetPrimaryKeyColumns ( ) : Storm\Core\Relational\IColumn[]
return	Storm\Core\Relational\IColumn[]

GetPrimaryKeyColumnsByIdentifier() public method

public GetPrimaryKeyColumnsByIdentifier ( ) : Storm\Core\Relational\IColumn[]
return	Storm\Core\Relational\IColumn[]

GetToManyRelations() public method

public GetToManyRelations ( ) : Storm\Core\Relational\IToManyRelation[]
return	Storm\Core\Relational\IToManyRelation[]

GetToOneRelations() public method

public GetToOneRelations ( ) : Storm\Core\Relational\IToOneRelation[]
return	Storm\Core\Relational\IToOneRelation[]

HasColumn() public method

public HasColumn ( string $Name ) : boolean
$Name	string	The column name
return	boolean

HasPrimaryKey() public method

public HasPrimaryKey ( string $Name ) : boolean
$Name	string	The column name
return	boolean

InitializeRelatedStructure() public method

Initializes the related structure of the table.

public InitializeRelatedStructure ( Database $Database ) : void
$Database	Database	The parent database
return	void

InitializeRelations() public method

Initializes the relations of the table.

public InitializeRelations ( Database $Database ) : void
$Database	Database	The parent database
return	void

InitializeStructure() public method

Initializes the columns of the table.

public InitializeStructure ( Database $Database ) : void
$Database	Database	The parent database
return	void

Is() public method

public Is ( Storm\Core\Relational\ITable $Table )
$Table	Storm\Core\Relational\ITable

PrimaryKey() public method

Get a primary key of this table

public PrimaryKey ( array $Data = [] ) : PrimaryKey
$Data	array	The column data
return	PrimaryKey	The row

Row() public method

Get a row of this table

public Row ( array $Data = [] ) : Row
$Data	array	The column data
return	Row	The row