1. class
  2. Simply
  3. \
  4. Database
  5. \
  6. Relationship

Relationship

class Relationship (View source)

Represents a relationship between two schemas.

Methods

__construct(string $name, Schema $schema, array $fields, Schema $referencedSchema, array $referencedFields, bool $unique)

Relationship constructor.

string
getName()

Returns the name of the relationship.

Schema
getSchema()

Returns the referring schema.

array
getFields()

Returns the referring fields.

Schema
getReferencedSchema()

Returns the referenced schema.

array
getReferencedFields()

Returns referenced fields.

bool
isUniqueRelationship()

Tells if the relationship is unique or not.

Relationship
getReverseRelationship()

Returns the reverse relationship.

void
fillRelationship(array $records, array $referencedRecords)

Fills this relationship for the given records from the list of given records.

void
fillSingleRecord(Record $record, Record $referencedRecord)

Fills this unique relationship for a single record.

Details

at line 45
__construct(string $name, Schema $schema, array $fields, Schema $referencedSchema, array $referencedFields, bool $unique)

Relationship constructor.

Parameters

string $name Name of the relationship
Schema $schema The referring schema
array $fields The referring fields
Schema $referencedSchema The referenced schema
array $referencedFields The referenced fields
bool $unique Whether the relationship can only reference a single record or not

at line 81
string getName()

Returns the name of the relationship.

Return Value

string Name of the relationship

at line 90
Schema getSchema()

Returns the referring schema.

Return Value

Schema The referring schema

at line 99
array getFields()

Returns the referring fields.

Return Value

array The referring fields

at line 108
Schema getReferencedSchema()

Returns the referenced schema.

Return Value

Schema The referenced schema

at line 117
array getReferencedFields()

Returns referenced fields.

Return Value

array The referenced fields

at line 126
bool isUniqueRelationship()

Tells if the relationship is unique or not.

Return Value

bool True if the relationship can only refer to a single record, false otherwise

at line 135
Relationship getReverseRelationship()

Returns the reverse relationship.

Return Value

Relationship The reverse relationship

at line 182
void fillRelationship(array $records, array $referencedRecords)

Fills this relationship for the given records from the list of given records.

Parameters

array $records The records to fill
array $referencedRecords All the records referenced by the list of records to fill

Return Value

void

at line 264
void fillSingleRecord(Record $record, Record $referencedRecord)

Fills this unique relationship for a single record.

Parameters

Record $record The record to fill
Record $referencedRecord The referenced record

Return Value

void