CodeIgniter4/system/DataCaster/Cast/CastInterface.php at a0cb18521c3021862df059166e734ada5b3f889a · michalsn/CodeIgniter4 · GitHub

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
<?php

declare(strict_types=1);

/**
 * This file is part of CodeIgniter 4 framework.
 *
 * (c) CodeIgniter Foundation <[email protected]>
 *
 * For the full copyright and license information, please view
 * the LICENSE file that was distributed with this source code.
 */

namespace CodeIgniter\DataCaster\Cast;

interface CastInterface
{
    /**
     * Takes a value from DataSource, returns its value for PHP.
     *
     * @param mixed              $value  Data from database driver
     * @param array<int, string> $params Additional param
     * @param object|null        $helper Helper object. E.g., database connection
     *
     * @return mixed PHP native value
     */
    public static function get(
        mixed $value,
        array $params = [],
        ?object $helper = null,
    ): mixed;

    /**
     * Takes a PHP value, returns its value for DataSource.
     *
     * @param mixed              $value  PHP native value
     * @param array<int, string> $params Additional param
     * @param object|null        $helper Helper object. E.g., database connection
     *
     * @return mixed Data to pass to database driver
     */
    public static function set(
        mixed $value,
        array $params = [],
        ?object $helper = null,
    ): mixed;
}