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

namespace ipl\Orm;

use IteratorAggregate;
use Traversable;

class Defaults implements IteratorAggregate
{
    /** @var array<string, mixed> Registered defaults */
    protected $defaults = [];

    /**
     * Iterate over the defaults
     *
     * @return Traversable
     */
    public function getIterator(): Traversable
    {
        foreach ($this->defaults as $column => $default) {
            yield $column => $default;
        }
    }

    /**
     * Add a default for the given property
     *
     * @param string $property
     * @param mixed $default If it's a closure, its interface is assumed to be
     *                       ({@see Model} $subject, string $propertyName)
     *
     * @return $this
     */
    public function add(string $property, $default): self
    {
        $this->defaults[$property] = $default;

        return $this;
    }

    /**
     * Get whether a default for the given property exists
     *
     * @param string $property
     *
     * @return bool
     */
    public function has(string $property): bool
    {
        return array_key_exists($property, $this->defaults);
    }
}