Documentation

rex_sql_foreign_key
in package

Class to represent sql foreign keys.

Tags
author

gharlan

Table of Contents

Constants

CASCADE  = 'CASCADE'
NO_ACTION  = 'NO ACTION'
RESTRICT  = 'RESTRICT'
SET_NULL  = 'SET NULL'

Methods

__construct()  : mixed
equals()  : bool
getColumns()  : array<string, string>
getName()  : string
getOnDelete()  : self::RESTRICT|self::NO_ACTION|self::CASCADE|self::SET_NULL
getOnUpdate()  : self::RESTRICT|self::NO_ACTION|self::CASCADE|self::SET_NULL
getTable()  : string
isModified()  : bool
setColumns()  : $this
setModified()  : $this
setName()  : $this
setOnDelete()  : $this
setOnUpdate()  : $this
setTable()  : $this

Constants

Methods

__construct()

public __construct(string $name, string $table, array<string, string> $columns[, self::RESTRICT|self::NO_ACTION|self::CASCADE|self::SET_NULL $onUpdate = self::RESTRICT ][, self::RESTRICT|self::NO_ACTION|self::CASCADE|self::SET_NULL $onDelete = self::RESTRICT ]) : mixed
Parameters
$name : string
$table : string
$columns : array<string, string>

Mapping of locale column to column in foreign table

$onUpdate : self::RESTRICT|self::NO_ACTION|self::CASCADE|self::SET_NULL = self::RESTRICT
$onDelete : self::RESTRICT|self::NO_ACTION|self::CASCADE|self::SET_NULL = self::RESTRICT

equals()

public equals(self $index) : bool
Parameters
$index : self
Return values
bool

getColumns()

public getColumns() : array<string, string>
Return values
array<string, string>

getName()

public getName() : string
Return values
string

getOnDelete()

public getOnDelete() : self::RESTRICT|self::NO_ACTION|self::CASCADE|self::SET_NULL
Return values
self::RESTRICT|self::NO_ACTION|self::CASCADE|self::SET_NULL

getOnUpdate()

public getOnUpdate() : self::RESTRICT|self::NO_ACTION|self::CASCADE|self::SET_NULL
Return values
self::RESTRICT|self::NO_ACTION|self::CASCADE|self::SET_NULL

getTable()

public getTable() : string
Return values
string

isModified()

public isModified() : bool
Return values
bool

setColumns()

public setColumns(array<string, string> $columns) : $this
Parameters
$columns : array<string, string>

Mapping of locale column to column in foreign table

Return values
$this

setModified()

public setModified(bool $modified) : $this
Parameters
$modified : bool
Return values
$this

setName()

public setName(string $name) : $this
Parameters
$name : string
Return values
$this

setOnDelete()

public setOnDelete(self::RESTRICT|self::NO_ACTION|self::CASCADE|self::SET_NULL $onDelete) : $this
Parameters
$onDelete : self::RESTRICT|self::NO_ACTION|self::CASCADE|self::SET_NULL
Return values
$this

setOnUpdate()

public setOnUpdate(self::RESTRICT|self::NO_ACTION|self::CASCADE|self::SET_NULL $onUpdate) : $this
Parameters
$onUpdate : self::RESTRICT|self::NO_ACTION|self::CASCADE|self::SET_NULL
Return values
$this

setTable()

public setTable(string $table) : $this
Parameters
$table : string
Return values
$this 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results