summaryrefslogtreecommitdiffstats
path: root/vendor/ipl/orm/src/Behaviors.php
blob: 5c54350260ea7f7a37b7ad9acc4c693b649aa409 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
<?php

namespace ipl\Orm;

use ArrayIterator;
use ipl\Orm\Contract\PersistBehavior;
use ipl\Orm\Contract\PropertyBehavior;
use ipl\Orm\Contract\RetrieveBehavior;
use ipl\Orm\Contract\RewriteColumnBehavior;
use ipl\Orm\Contract\RewriteFilterBehavior;
use ipl\Orm\Contract\RewritePathBehavior;
use ipl\Stdlib\Filter;
use IteratorAggregate;
use Traversable;

class Behaviors implements IteratorAggregate
{
    /** @var array Registered behaviors */
    protected $behaviors = [];

    /** @var RetrieveBehavior[] Registered retrieve behaviors */
    protected $retrieveBehaviors = [];

    /** @var PersistBehavior[] Registered persist behaviors */
    protected $persistBehaviors = [];

    /** @var PropertyBehavior[] Registered property behaviors */
    protected $propertyBehaviors = [];

    /** @var RewriteFilterBehavior[] Registered rewrite filter behaviors */
    protected $rewriteFilterBehaviors = [];

    /** @var RewriteColumnBehavior[] Registered rewrite column behaviors */
    protected $rewriteColumnBehaviors = [];

    /** @var RewritePathBehavior[] Registered rewrite path behaviors */
    protected $rewritePathBehaviors = [];

    /**
     * Add a behavior
     *
     * @param PersistBehavior|PropertyBehavior|RetrieveBehavior|RewriteFilterBehavior $behavior
     */
    public function add(Behavior $behavior)
    {
        $this->behaviors[] = $behavior;

        if ($behavior instanceof PropertyBehavior) {
            $this->retrieveBehaviors[] = $behavior;
            $this->persistBehaviors[] = $behavior;
            $this->propertyBehaviors[] = $behavior;
        } else {
            if ($behavior instanceof RetrieveBehavior) {
                $this->retrieveBehaviors[] = $behavior;
            }

            if ($behavior instanceof PersistBehavior) {
                $this->persistBehaviors[] = $behavior;
            }
        }

        if ($behavior instanceof RewriteFilterBehavior) {
            $this->rewriteFilterBehaviors[] = $behavior;
        }

        if ($behavior instanceof RewriteColumnBehavior) {
            $this->rewriteColumnBehaviors[] = $behavior;
        }

        if ($behavior instanceof RewritePathBehavior) {
            $this->rewritePathBehaviors[] = $behavior;
        }
    }

    /**
     * Iterate registered behaviors
     *
     * @return ArrayIterator
     */
    public function getIterator(): Traversable
    {
        return new ArrayIterator($this->behaviors);
    }

    /**
     * Apply all retrieve behaviors on the given model
     *
     * @param Model $model
     */
    public function retrieve(Model $model)
    {
        foreach ($this->retrieveBehaviors as $behavior) {
            $behavior->retrieve($model);
        }
    }

    /**
     * Apply all persist behaviors on the given model
     *
     * @param Model $model
     */
    public function persist(Model $model)
    {
        foreach ($this->persistBehaviors as $behavior) {
            $behavior->persist($model);
        }
    }

    /**
     * Transform the retrieved key's value by use of all property behaviors
     *
     * @param mixed  $value
     * @param string $key
     *
     * @return mixed
     */
    public function retrieveProperty($value, $key)
    {
        foreach ($this->propertyBehaviors as $behavior) {
            $value = $behavior->retrieveProperty($value, $key);
        }

        return $value;
    }

    /**
     * Transform the to be persisted key's value by use of all property behaviors
     *
     * @param mixed  $value
     * @param string $key
     *
     * @return mixed
     */
    public function persistProperty($value, $key)
    {
        foreach ($this->propertyBehaviors as $behavior) {
            $value = $behavior->persistProperty($value, $key);
        }

        return $value;
    }

    /**
     * Rewrite the given filter condition
     *
     * @param Filter\Condition $condition
     * @param string           $relation Absolute path (with a trailing dot) of the model
     *
     * @return Filter\Rule|null
     */
    public function rewriteCondition(Filter\Condition $condition, $relation = null)
    {
        $filter = null;
        foreach ($this->rewriteFilterBehaviors as $behavior) {
            $replacement = $behavior->rewriteCondition($filter ?: $condition, $relation);
            if ($replacement !== null) {
                $filter = $replacement;
            }
        }

        return $filter;
    }

    /**
     * Rewrite the given relation path
     *
     * @param string $path
     * @param string $relation Absolute path of the model
     *
     * @return string|null
     */
    public function rewritePath($path, $relation = null)
    {
        $newPath = null;
        foreach ($this->rewritePathBehaviors as $behavior) {
            $replacement = $behavior->rewritePath($newPath ?: $path, $relation);
            if ($replacement !== null) {
                $newPath = $replacement;
            }
        }

        return $newPath;
    }

    /**
     * Rewrite the given column
     *
     * @param string $column
     * @param string $relation Absolute path of the model
     *
     * @return mixed
     */
    public function rewriteColumn($column, $relation = null)
    {
        $newColumn = null;
        foreach ($this->rewriteColumnBehaviors as $behavior) {
            $replacement = $behavior->rewriteColumn($newColumn ?: $column, $relation);
            if ($replacement !== null) {
                $newColumn = $replacement;
            }
        }

        return $newColumn;
    }

    /**
     * Rewrite the given column definition
     *
     * @param ColumnDefinition $def
     * @param string $relation Absolute path of the model
     *
     * @return void
     */
    public function rewriteColumnDefinition(ColumnDefinition $def, string $relation): void
    {
        foreach ($this->rewriteColumnBehaviors as $behavior) {
            $behavior->rewriteColumnDefinition($def, $relation);
        }
    }

    /**
     * Get whether the given column is selectable
     *
     * @param string $column
     *
     * @return bool
     */
    public function isSelectableColumn(string $column): bool
    {
        foreach ($this->rewriteColumnBehaviors as $behavior) {
            if ($behavior->isSelectableColumn($column)) {
                return true;
            }
        }

        return false;
    }
}