Code Coverage
 
Lines
Functions and Methods
Classes and Traits
Total
n/a
0 / 0
n/a
0 / 0
CRAP
n/a
0 / 0
1<?php
2/**
3 * Pop PHP Framework (http://www.popphp.org/)
4 *
5 * @link       https://github.com/popphp/popphp-framework
6 * @author     Nick Sagona, III <dev@nolainteractive.com>
7 * @copyright  Copyright (c) 2009-2024 NOLA Interactive, LLC. (http://www.nolainteractive.com)
8 * @license    http://www.popphp.org/license     New BSD License
9 */
10
11/**
12 * @namespace
13 */
14namespace Pop\Db\Record\Relationships;
15
16/**
17 * Relationship class for "has one" relationships
18 *
19 * @category   Pop
20 * @package    Pop\Db
21 * @author     Nick Sagona, III <dev@nolainteractive.com>
22 * @copyright  Copyright (c) 2009-2024 NOLA Interactive, LLC. (http://www.nolainteractive.com)
23 * @license    http://www.popphp.org/license     New BSD License
24 * @version    6.5.0
25 */
26interface RelationshipInterface
27{
28
29    /**
30     * Get foreign table
31     *
32     * @return string|null
33     */
34    public function getForeignTable(): string|null;
35
36    /**
37     * Get foreign key
38     *
39     * @return string|null
40     */
41    public function getForeignKey(): string|null;
42
43    /**
44     * Get options
45     *
46     * @return array|null
47     */
48    public function getOptions(): array|null;
49
50    /**
51     * Get eager relationships
52     *
53     * @param  array $ids
54     * @throws Exception
55     * @return array
56     */
57    public function getEagerRelationships(array $ids): array;
58
59}