File: EnumIsImmutable.php

package info (click to toggle)
php-enum 4.7.1-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 556 kB
  • sloc: php: 3,481; xml: 15; makefile: 8
file content (163 lines) | stat: -rw-r--r-- 3,703 bytes parent folder | download
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
<?php

declare(strict_types=1);

namespace MabeEnumStaticAnalysis;

/**
 * This is a static analysis fixture to verify that the API signature
 * of an enum allows for pure operations. Almost all methods will seem to be
 * redundant or trivial: that's normal, we're just verifying the
 * transitivity of immutable type signatures.
 *
 * Please note that this does not guarantee that the internals of the enum
 * library are pure/safe, but just that the declared API to the outside world
 * is seen as immutable.
 */
final class EnumIsImmutable
{
    /** @psalm-pure */
    public static function stringCastIsPure(): string
    {
        return DummyEnum::a()
            ->__toString();
    }

    /**
     * @psalm-return never-return
     * @psalm-pure
     */
    public static function sleepIsPure(): void
    {
        DummyEnum::a()->__sleep();
    }

    /**
     * @psalm-return never-return
     * @psalm-pure
     */
    public static function wakeUpIsPure(): void
    {
        DummyEnum::a()->__wakeup();
    }

    /**
     * @phpstan-return string
     * @psalm-return non-empty-string
     * @psalm-pure
     */
    public static function nameRetrievalIsPure(): string
    {
        return DummyEnum::a()->getName();
    }

    /**
     * @return null|bool|int|float|string|array<int|string, mixed>
     *
     * @psalm-pure
     */
    public static function valueRetrievalIsPure()
    {
        return DummyEnum::a()->getValue();
    }

    /** @psalm-pure */
    public static function getIsPure(): DummyEnum
    {
        return DummyEnum::get(DummyEnum::A);
    }

    /** @psalm-pure */
    public static function ordinalRetrievalIsPure(): int
    {
        return DummyEnum::a()
            ->getOrdinal();
    }

    /** @psalm-pure */
    public static function comparisonIsPure(): bool
    {
        return DummyEnum::a()->is(DummyEnum::b());
    }

    /** @psalm-pure */
    public static function byValueIsPure(): DummyEnum
    {
        return DummyEnum::byValue('A_VALUE');
    }

    /** @psalm-pure */
    public static function byNameIsPure(): DummyEnum
    {
        return DummyEnum::byValue('A');
    }

    /** @psalm-pure */
    public static function byOrdinalIsPure(): DummyEnum
    {
        return DummyEnum::byOrdinal(1);
    }

    /**
     * @phpstan-return array<int, DummyEnum>
     * @psalm-return list<DummyEnum>
     * @psalm-pure
     */
    public static function getEnumeratorsIsPure(): array
    {
        return DummyEnum::getEnumerators();
    }

    /**
     * @phpstan-return array<int, null|bool|int|float|string|array<int|string, mixed>>
     * @psalm-return list<null|bool|int|float|string|array>
     * @psalm-pure
     */
    public static function getValuesIsPure(): array
    {
        return DummyEnum::getValues();
    }

    /**
     * @phpstan-return array<int, string>
     * @psalm-return list<non-empty-string>
     * @psalm-pure
     */
    public static function getNamesIsPure(): array
    {
        return DummyEnum::getNames();
    }

    /**
     * @psalm-return list<int>
     * @psalm-pure
     */
    public static function getOrdinalsIsPure(): array
    {
        return DummyEnum::getOrdinals();
    }

    /** @psalm-pure */
    public static function hasIsPure(): bool
    {
        return DummyEnum::has('a');
    }

    /** @psalm-pure */
    public static function hasValueIsPure(): bool
    {
        return DummyEnum::hasValue('A_VALUE');
    }

    /** @psalm-pure */
    public static function hasNameIsPure(): bool
    {
        return DummyEnum::hasName('A');
    }

    /** @psalm-pure */
    public static function callStaticIsPure(): DummyEnum
    {
        return DummyEnum::__callStatic('a', []);
    }
}