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