1: <?php declare(strict_types = 1);
2:
3: namespace PHPStan\Type\Accessory;
4:
5: use PHPStan\Php\PhpVersion;
6: use PHPStan\PhpDocParser\Ast\Type\IdentifierTypeNode;
7: use PHPStan\PhpDocParser\Ast\Type\TypeNode;
8: use PHPStan\TrinaryLogic;
9: use PHPStan\Type\AcceptsResult;
10: use PHPStan\Type\BenevolentUnionType;
11: use PHPStan\Type\BooleanType;
12: use PHPStan\Type\CompoundType;
13: use PHPStan\Type\Constant\ConstantArrayType;
14: use PHPStan\Type\Constant\ConstantIntegerType;
15: use PHPStan\Type\ErrorType;
16: use PHPStan\Type\FloatType;
17: use PHPStan\Type\GeneralizePrecision;
18: use PHPStan\Type\IntegerType;
19: use PHPStan\Type\IntersectionType;
20: use PHPStan\Type\MixedType;
21: use PHPStan\Type\ObjectWithoutClassType;
22: use PHPStan\Type\StringType;
23: use PHPStan\Type\Traits\MaybeCallableTypeTrait;
24: use PHPStan\Type\Traits\NonArrayTypeTrait;
25: use PHPStan\Type\Traits\NonGenericTypeTrait;
26: use PHPStan\Type\Traits\NonIterableTypeTrait;
27: use PHPStan\Type\Traits\NonObjectTypeTrait;
28: use PHPStan\Type\Traits\NonRemoveableTypeTrait;
29: use PHPStan\Type\Traits\UndecidedComparisonCompoundTypeTrait;
30: use PHPStan\Type\Type;
31: use PHPStan\Type\UnionType;
32: use PHPStan\Type\VerbosityLevel;
33:
34: class AccessoryLiteralStringType implements CompoundType, AccessoryType
35: {
36:
37: use MaybeCallableTypeTrait;
38: use NonArrayTypeTrait;
39: use NonObjectTypeTrait;
40: use NonIterableTypeTrait;
41: use UndecidedComparisonCompoundTypeTrait;
42: use NonGenericTypeTrait;
43: use NonRemoveableTypeTrait;
44:
45: /** @api */
46: public function __construct()
47: {
48: }
49:
50: public function getReferencedClasses(): array
51: {
52: return [];
53: }
54:
55: public function getObjectClassNames(): array
56: {
57: return [];
58: }
59:
60: public function getObjectClassReflections(): array
61: {
62: return [];
63: }
64:
65: public function getConstantStrings(): array
66: {
67: return [];
68: }
69:
70: public function accepts(Type $type, bool $strictTypes): TrinaryLogic
71: {
72: return $this->acceptsWithReason($type, $strictTypes)->result;
73: }
74:
75: public function acceptsWithReason(Type $type, bool $strictTypes): AcceptsResult
76: {
77: if ($type instanceof MixedType) {
78: return AcceptsResult::createNo();
79: }
80: if ($type instanceof CompoundType) {
81: return $type->isAcceptedWithReasonBy($this, $strictTypes);
82: }
83:
84: return new AcceptsResult($type->isLiteralString(), []);
85: }
86:
87: public function isSuperTypeOf(Type $type): TrinaryLogic
88: {
89: if ($type instanceof CompoundType) {
90: return $type->isSubTypeOf($this);
91: }
92:
93: if ($this->equals($type)) {
94: return TrinaryLogic::createYes();
95: }
96:
97: return $type->isLiteralString();
98: }
99:
100: public function isSubTypeOf(Type $otherType): TrinaryLogic
101: {
102: if ($otherType instanceof UnionType || $otherType instanceof IntersectionType) {
103: return $otherType->isSuperTypeOf($this);
104: }
105:
106: return $otherType->isLiteralString()
107: ->and($otherType instanceof self ? TrinaryLogic::createYes() : TrinaryLogic::createMaybe());
108: }
109:
110: public function isAcceptedBy(Type $acceptingType, bool $strictTypes): TrinaryLogic
111: {
112: return $this->isAcceptedWithReasonBy($acceptingType, $strictTypes)->result;
113: }
114:
115: public function isAcceptedWithReasonBy(Type $acceptingType, bool $strictTypes): AcceptsResult
116: {
117: return new AcceptsResult($this->isSubTypeOf($acceptingType), []);
118: }
119:
120: public function equals(Type $type): bool
121: {
122: return $type instanceof self;
123: }
124:
125: public function describe(VerbosityLevel $level): string
126: {
127: return 'literal-string';
128: }
129:
130: public function isOffsetAccessible(): TrinaryLogic
131: {
132: return TrinaryLogic::createYes();
133: }
134:
135: public function hasOffsetValueType(Type $offsetType): TrinaryLogic
136: {
137: return $offsetType->isInteger()->and(TrinaryLogic::createMaybe());
138: }
139:
140: public function getOffsetValueType(Type $offsetType): Type
141: {
142: if ($this->hasOffsetValueType($offsetType)->no()) {
143: return new ErrorType();
144: }
145:
146: return new StringType();
147: }
148:
149: public function setOffsetValueType(?Type $offsetType, Type $valueType, bool $unionValues = true): Type
150: {
151: return $this;
152: }
153:
154: public function setExistingOffsetValueType(Type $offsetType, Type $valueType): Type
155: {
156: return $this;
157: }
158:
159: public function unsetOffset(Type $offsetType): Type
160: {
161: return new ErrorType();
162: }
163:
164: public function toNumber(): Type
165: {
166: return new ErrorType();
167: }
168:
169: public function toInteger(): Type
170: {
171: return new IntegerType();
172: }
173:
174: public function toFloat(): Type
175: {
176: return new FloatType();
177: }
178:
179: public function toString(): Type
180: {
181: return $this;
182: }
183:
184: public function toBoolean(): BooleanType
185: {
186: return new BooleanType();
187: }
188:
189: public function toArray(): Type
190: {
191: return new ConstantArrayType(
192: [new ConstantIntegerType(0)],
193: [$this],
194: [1],
195: [],
196: TrinaryLogic::createYes(),
197: );
198: }
199:
200: public function toArrayKey(): Type
201: {
202: return $this;
203: }
204:
205: public function isNull(): TrinaryLogic
206: {
207: return TrinaryLogic::createNo();
208: }
209:
210: public function isConstantValue(): TrinaryLogic
211: {
212: return TrinaryLogic::createMaybe();
213: }
214:
215: public function isConstantScalarValue(): TrinaryLogic
216: {
217: return TrinaryLogic::createMaybe();
218: }
219:
220: public function getConstantScalarTypes(): array
221: {
222: return [];
223: }
224:
225: public function getConstantScalarValues(): array
226: {
227: return [];
228: }
229:
230: public function isTrue(): TrinaryLogic
231: {
232: return TrinaryLogic::createNo();
233: }
234:
235: public function isFalse(): TrinaryLogic
236: {
237: return TrinaryLogic::createNo();
238: }
239:
240: public function isBoolean(): TrinaryLogic
241: {
242: return TrinaryLogic::createNo();
243: }
244:
245: public function isFloat(): TrinaryLogic
246: {
247: return TrinaryLogic::createNo();
248: }
249:
250: public function isInteger(): TrinaryLogic
251: {
252: return TrinaryLogic::createNo();
253: }
254:
255: public function isString(): TrinaryLogic
256: {
257: return TrinaryLogic::createYes();
258: }
259:
260: public function isNumericString(): TrinaryLogic
261: {
262: return TrinaryLogic::createMaybe();
263: }
264:
265: public function isNonEmptyString(): TrinaryLogic
266: {
267: return TrinaryLogic::createMaybe();
268: }
269:
270: public function isNonFalsyString(): TrinaryLogic
271: {
272: return TrinaryLogic::createMaybe();
273: }
274:
275: public function isLiteralString(): TrinaryLogic
276: {
277: return TrinaryLogic::createYes();
278: }
279:
280: public function isClassStringType(): TrinaryLogic
281: {
282: return TrinaryLogic::createMaybe();
283: }
284:
285: public function getClassStringObjectType(): Type
286: {
287: return new ObjectWithoutClassType();
288: }
289:
290: public function getObjectTypeOrClassStringObjectType(): Type
291: {
292: return new ObjectWithoutClassType();
293: }
294:
295: public function hasMethod(string $methodName): TrinaryLogic
296: {
297: return TrinaryLogic::createMaybe();
298: }
299:
300: public function isVoid(): TrinaryLogic
301: {
302: return TrinaryLogic::createNo();
303: }
304:
305: public function isScalar(): TrinaryLogic
306: {
307: return TrinaryLogic::createYes();
308: }
309:
310: public function looseCompare(Type $type, PhpVersion $phpVersion): BooleanType
311: {
312: return new BooleanType();
313: }
314:
315: public function traverse(callable $cb): Type
316: {
317: return $this;
318: }
319:
320: public function traverseSimultaneously(Type $right, callable $cb): Type
321: {
322: return $this;
323: }
324:
325: public function generalize(GeneralizePrecision $precision): Type
326: {
327: return new StringType();
328: }
329:
330: public static function __set_state(array $properties): Type
331: {
332: return new self();
333: }
334:
335: public function exponentiate(Type $exponent): Type
336: {
337: return new BenevolentUnionType([
338: new FloatType(),
339: new IntegerType(),
340: ]);
341: }
342:
343: public function getFiniteTypes(): array
344: {
345: return [];
346: }
347:
348: public function toPhpDocNode(): TypeNode
349: {
350: return new IdentifierTypeNode('literal-string');
351: }
352:
353: }
354: