1 | <?php |
||
2 | |||
3 | /** |
||
4 | * Platine ORM |
||
5 | * |
||
6 | * Platine ORM provides a flexible and powerful ORM implementing a data-mapper pattern. |
||
7 | * |
||
8 | * This content is released under the MIT License (MIT) |
||
9 | * |
||
10 | * Copyright (c) 2020 Platine ORM |
||
11 | * |
||
12 | * Permission is hereby granted, free of charge, to any person obtaining a copy |
||
13 | * of this software and associated documentation files (the "Software"), to deal |
||
14 | * in the Software without restriction, including without limitation the rights |
||
15 | * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell |
||
16 | * copies of the Software, and to permit persons to whom the Software is |
||
17 | * furnished to do so, subject to the following conditions: |
||
18 | * |
||
19 | * The above copyright notice and this permission notice shall be included in all |
||
20 | * copies or substantial portions of the Software. |
||
21 | * |
||
22 | * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR |
||
23 | * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, |
||
24 | * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE |
||
25 | * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER |
||
26 | * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, |
||
27 | * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE |
||
28 | * SOFTWARE. |
||
29 | */ |
||
30 | |||
31 | /** |
||
32 | * @file Relation.php |
||
33 | * |
||
34 | * The Relation class |
||
35 | * |
||
36 | * @package Platine\Orm\Relation |
||
37 | * @author Platine Developers Team |
||
38 | * @copyright Copyright (c) 2020 |
||
39 | * @license http://opensource.org/licenses/MIT MIT License |
||
40 | * @link https://www.platine-php.com |
||
41 | * @version 1.0.0 |
||
42 | * @filesource |
||
43 | */ |
||
44 | |||
45 | declare(strict_types=1); |
||
46 | |||
47 | namespace Platine\Orm\Relation; |
||
48 | |||
49 | use Platine\Orm\Entity; |
||
50 | use Platine\Orm\EntityManager; |
||
51 | use Platine\Orm\Mapper\DataMapper; |
||
52 | use Platine\Orm\Mapper\EntityMapper; |
||
53 | |||
54 | /** |
||
55 | * @class Relation |
||
56 | * @package Platine\Orm\Relation |
||
57 | * @template TEntity as Entity |
||
58 | */ |
||
59 | abstract class Relation |
||
60 | { |
||
61 | /** |
||
62 | * Query callback |
||
63 | * @var callable|null |
||
64 | */ |
||
65 | protected $queryCallback = null; |
||
66 | |||
67 | /** |
||
68 | * Create new instance |
||
69 | * @param class-string<TEntity> $entityClass |
||
0 ignored issues
–
show
Documentation
Bug
introduced
by
![]() |
|||
70 | * @param ForeignKey|null $foreignKey |
||
71 | */ |
||
72 | public function __construct( |
||
73 | protected string $entityClass, |
||
74 | protected ?ForeignKey $foreignKey = null |
||
75 | ) { |
||
76 | } |
||
77 | |||
78 | /** |
||
79 | * Set query callback |
||
80 | * @param callable $callback |
||
81 | * @return Relation<TEntity> |
||
82 | */ |
||
83 | public function query(callable $callback): self |
||
84 | { |
||
85 | $this->queryCallback = $callback; |
||
86 | |||
87 | return $this; |
||
88 | } |
||
89 | |||
90 | /** |
||
91 | * @param EntityManager<TEntity> $manager |
||
92 | * @param EntityMapper<TEntity> $owner |
||
93 | * @param array<string, mixed> $options the loader options |
||
94 | * |
||
95 | * @return mixed |
||
96 | */ |
||
97 | abstract public function getLoader( |
||
98 | EntityManager $manager, |
||
99 | EntityMapper $owner, |
||
100 | array $options |
||
101 | ): mixed; |
||
102 | |||
103 | /** |
||
104 | * @param DataMapper<TEntity> $mapper |
||
105 | * @param callable|null $callback |
||
106 | * |
||
107 | * @return TEntity|array<TEntity>|null |
||
0 ignored issues
–
show
The type
Platine\Orm\Relation\TEntity was not found. Maybe you did not declare it correctly or list all dependencies?
The issue could also be caused by a filter entry in the build configuration.
If the path has been excluded in your configuration, e.g. filter:
dependency_paths: ["lib/*"]
For further information see https://scrutinizer-ci.com/docs/tools/php/php-scrutinizer/#list-dependency-paths ![]() |
|||
108 | */ |
||
109 | abstract public function getResult( |
||
110 | DataMapper $mapper, |
||
111 | ?callable $callback = null |
||
112 | ): Entity|array|null; |
||
113 | } |
||
114 |