Documentation

RelationshipInterface
in

Relationship class for "has one" relationships

Tags
category

Pop

author

Nick Sagona, III nick@popphp.org

copyright

Copyright (c) 2009-2026 Nick Sagona, III

license

https://www.popphp.org/license New BSD License

version
7.0.0

Table of Contents

Methods

getEagerRelationships()  : array<string|int, mixed>
Get eager relationships
getEmptyRelationshipValue()  : mixed
Get the value to use when no eager-loaded result exists for a given leaf record
getForeignKey()  : string|array<string|int, mixed>|null
Get foreign key
getForeignTable()  : string|null
Get foreign table
getOptions()  : array<string|int, mixed>|null
Get options

Methods

getEagerRelationships()

Get eager relationships

public getEagerRelationships(array<string|int, mixed> $ids) : array<string|int, mixed>
Parameters
$ids : array<string|int, mixed>
Tags
throws
Exception
Return values
array<string|int, mixed>

getEmptyRelationshipValue()

Get the value to use when no eager-loaded result exists for a given leaf record

public getEmptyRelationshipValue() : mixed

getForeignKey()

Get foreign key

public getForeignKey() : string|array<string|int, mixed>|null
Return values
string|array<string|int, mixed>|null

getForeignTable()

Get foreign table

public getForeignTable() : string|null
Return values
string|null

getOptions()

Get options

public getOptions() : array<string|int, mixed>|null
Return values
array<string|int, mixed>|null

        
On this page

Search results