Skip to main content Link Menu Expand (external link) Document Search Copy Copied
Perique Docs

Foreign_Key

Table Builder

» Schema

» Index

» Foreign_Key

» Examples

__construct( string $column, ?string $keyname = null )

  • @param string $column The column this Foreign_Key applies to
  • @param string∣null $keyname Sets a custom keyname to the Foreign_Key

Creates a new Foreign_Key for a defined column, with an optional keyname. If the keyname is not passed, will be set at fk_{column_name}

$index = new Foreign_Key('id', 'id_key');

// When used as part of a schema definition.
$schema = new Schema('table', function(Schema $schema): void{
    $schema->column('id')....
    $schema->foreign_key('id', 'id_fk')   // Pass through to constructor
        ->...; 
});

get_column(): string

  • @return string The column the Foreign Key is assigned to.

Returns the set column, used in constructor.

$key = new Foreign_Key('column-a'); 
$key->get_column();                 // 'column-a'

get_keyname(): string

  • @return string The Foreign_Key keyname

Returns the keyname, either defualt or defined.

$f_key = new Foreign_Key('id', 'id_key'); // Defined keyname
$f_key = new Foreign_Key('user');         // Defualt keyname (fk_{colmn_name})

$f_key->get_keyname(); // 'id_key;
$f_key->get_keyname(); // 'fk_user;

reference_table( string $reference_table ): Foreign_Key

  • @param string $reference_table The table which this is referencing.
  • @return Foreign_Key

Sets which table is used as the reference for this column.

$schema = new Schema('table', function(Schema $schema): void{
    ....
    $schema->column('external')....
    
    $schema->foreign_key('something_external') 
        ->reference_table('my_other_table')
        ->....; 
});

get_reference_table(): ?string

  • @return string∣null The set reference_table, or null if not set.

Gets the table that is used in the Foreign_Key reference data. If this has not been set, it will return null and should throw an exception if passed to a builder without being defined.

This is maninly used internally within a Builder

$f_key = new Foreign_Key('id', 'id_key') 
    ->reference_table('my_other_table')
    ->....; 

$f_key->get_reference_table(); // 'my_other_table'

reference_column( string $reference_column ): Foreign_Key

  • @param string $reference_column Column on reference tablet to use.
  • @return Foreign_Key

Once you have set your remote table, its just a case of referencing the column to be used.

$schema = new Schema('table', function(Schema $schema): void{
    ....
    $schema->column('external')....
    
    $schema->foreign_key('something_external') 
        ->reference_table('my_other_table')
        ->reference_column('column_a'); 
});

get_reference_column(): ?string

  • @return string∣null The set reference_column, or null if not set.

Gets the columns that is used in the Foreign_Key reference data. If this has not been set, it will return null and should throw an exception if passed to a builder without being defined.

This is maninly used internally within a Builder

$f_key = new Foreign_Key('id', 'id_key') 
    ->reference_table('my_other_table')
    ->reference_column('column_a'); 

$f_key->get_reference_column(); // 'column_a'

reference( string $reference_table, string $reference_column ): ?string

  • @param string $reference_table The table which this is referencing.
  • @param string $reference_column Column on reference tablet to use.
  • @return Foreign_Key

Sets both the reference_table and reference_column in a single call.

$f_key = new Foreign_Key('id', 'id_key') 
    ->reference('my_other_table', 'column_a');

on_update( string $action ): Foreign_Key

  • @param string $action The action to be carried out.
  • @return Foreign_Key

Allow the setting of the ON_UPDATE event whenever working with data as part of the relationship.

$schema = new Schema('table', function(Schema $schema): void{
    ....
    $schema->column('external')....
    
    $schema->foreign_key('something_external') 
        ->reference_table('my_other_table')
        ->reference_column('column_a')
        ->on_update('CASCADE'); 
});

get_on_update(): ?string

  • @return string The defined on_update operation, if

Get the set action to carry on an update of the reference data. Reurns a blank string if not set.

$f_key = new Foreign_Key('id', 'id_key') 
    ->reference_table('my_other_table')
    ->reference_column('column_a')
    ->on_update('CASCADE');

$f_key->get_on_update(); // 'CASCADE'

on_delete( string $action ): Foreign_Key

  • @param string $action The action to be carried out on reference data delete.
  • @return Foreign_Key

Allow the setting of the ON_DELETE event whenever working with data as part of the relationship.

$schema = new Schema('table', function(Schema $schema): void{
    ....
    $schema->column('external')....
    
    $schema->foreign_key('something_external') 
        ->reference_table('my_other_table')
        ->reference_column('column_a')
        ->on_delete('CASCADE'); 
});

get_on_delete(): ?string

  • @return string The defined on_delete operation, if

Get the set action to carry on an update of the reference data. Reurns a blank string if not set.

$f_key = new Foreign_Key('id', 'id_key') 
    ->reference_table('my_other_table')
    ->reference_column('column_a')
    ->on_delete('CASCADE');

$f_key->get_on_delete(); // 'CASCADE'

export(): object

  • @return object Returns a simple object representation of the internal state.
$f_key = new Foreign_Key('id', 'id_key') 
    ->reference_table('my_other_table')
    ->reference_column('column_a')
    ->on_update('CASCADE')
    ->on_delete('CASCADE');

$f_key->export(); 
/**
 {
    "keyname"          : "id_key",
    "column"           : "id",
    "reference_column" : "my_other_table",
    "reference_table"  : "column_a",
    "on_update"        : "CASCADE",
    "on_delete"        : "CASCADE"
 }
*/