summaryrefslogtreecommitdiffstats
path: root/vendor/ipl/orm/src/Contract/RewriteColumnBehavior.php
blob: b6f545bdd93f9db7a10ba6ad6e98e91bc76951ab (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
<?php

namespace ipl\Orm\Contract;

use ipl\Orm\ColumnDefinition;

interface RewriteColumnBehavior extends RewriteFilterBehavior
{
    /**
     * Rewrite the given column
     *
     * The result must be returned otherwise (NULL is returned) the original column is kept as is.
     *
     * @param mixed $column
     * @param ?string $relation The absolute path of the model. For reference only, don't include it in the result
     *
     * @return mixed
     */
    public function rewriteColumn($column, ?string $relation = null);

    /**
     * Get whether {@see rewriteColumn} might return an otherwise unknown column or expression
     *
     * @param string $name
     *
     * @return bool
     */
    public function isSelectableColumn(string $name): bool;

    /**
     * Rewrite the given column definition
     *
     * @param ColumnDefinition $def
     * @param string $relation The absolute path of the model. For reference only, don't include it in the result
     *
     * @return void
     */
    public function rewriteColumnDefinition(ColumnDefinition $def, string $relation): void;
}