php-optional/src/GenericOptional.php at main · petrknap/php-optional · 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
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
<?php

declare(strict_types=1);

namespace PetrKnap\Optional;

/**
 * Provides type hints for generic {@see Optional}
 *
 * @template-covariant T of mixed type of non-null value
 *
 * @phpstan-require-extends Optional
 */
trait GenericOptional
{
    /**
     * @return self<T>
     */
    public static function empty(): self
    {
        /** @var self<T> */
        return parent::empty();
    }

    /**
     * @template U of T
     *
     * @param U $value
     *
     * @return self<U>
     */
    public static function of(mixed $value): self // @phpstan-ignore generics.notSubtype
    {
        /** @var self<U> */
        return parent::of($value); // @phpstan-ignore generics.notSubtype, argument.type, argument.templateType
    }

    /**
     * @template U of T
     *
     * @param U|false $value
     *
     * @return self<U>
     */
    public static function ofFalsable(mixed $value): self // @phpstan-ignore generics.notSubtype
    {
        /** @var self<U> */
        return parent::ofFalsable($value); // @phpstan-ignore generics.notSubtype, argument.type, argument.templateType
    }

    /**
     * @template U of T
     *
     * @param U|null $value
     *
     * @return self<U>
     */
    public static function ofNullable(mixed $value): self // @phpstan-ignore generics.notSubtype
    {
        /** @var self<U> */
        return parent::ofNullable($value); // @phpstan-ignore generics.notSubtype, argument.type, argument.templateType
    }

    /**
     * @template U of T
     *
     * @param iterable<U> $value
     *
     * @return self<U>
     */
    public static function ofSingle(iterable $value): self // @phpstan-ignore generics.notSubtype
    {
        /** @var self<U> */
        return parent::ofSingle($value); // @phpstan-ignore generics.notSubtype, argument.type, argument.templateType
    }

    /**
     * @return self<T>
     */
    public function filter(callable $predicate): self // @phpstan-ignore generics.notSubtype
    {
        /** @var self<T> */
        return parent::filter($predicate); // @phpstan-ignore generics.notSubtype, argument.type, argument.templateType
    }
}