Support more dynamics $flags arg in preg_split

Author: staabm

src/Type/Php/PregSplitDynamicReturnTypeExtension.php

@@ -2,17 +2,12 @@
 
 namespace PHPStan\Type\Php;
 
-use PhpParser\Node\Arg;
-use PhpParser\Node\Expr;
-use PhpParser\Node\Expr\BinaryOp\BitwiseOr;
 use PhpParser\Node\Expr\FuncCall;
-use PhpParser\Node\Name;
 use PHPStan\Analyser\Scope;
 use PHPStan\Reflection\FunctionReflection;
 use PHPStan\Reflection\ParametersAcceptorSelector;
-use PHPStan\Reflection\ReflectionProvider;
-use PHPStan\ShouldNotHappenException;
 use PHPStan\Type\ArrayType;
+use PHPStan\Type\BitwiseFlagHelper;
 use PHPStan\Type\Constant\ConstantArrayType;
 use PHPStan\Type\Constant\ConstantBooleanType;
 use PHPStan\Type\Constant\ConstantIntegerType;
@@ -22,28 +17,27 @@
 use PHPStan\Type\StringType;
 use PHPStan\Type\Type;
 use PHPStan\Type\TypeCombinator;
-use function sprintf;
 use function strtolower;
 
 class PregSplitDynamicReturnTypeExtension implements DynamicFunctionReturnTypeExtension
 {
 
-	public function __construct(private ReflectionProvider $reflectionProvider)
+	public function __construct(
+		private BitwiseFlagHelper $bitwiseFlagAnalyser,
+	)
 	{
 	}
 
-
 	public function isFunctionSupported(FunctionReflection $functionReflection): bool
 	{
 		return strtolower($functionReflection->getName()) === 'preg_split';
 	}
 
-
 	public function getTypeFromFunctionCall(FunctionReflection $functionReflection, FuncCall $functionCall, Scope $scope): Type
 	{
 		$flagsArg = $functionCall->getArgs()[3] ?? null;
 
-		if ($this->hasFlag($this->getConstant('PREG_SPLIT_OFFSET_CAPTURE'), $flagsArg, $scope)) {
+		if ($flagsArg !== null && $this->bitwiseFlagAnalyser->bitwiseOrContainsConstant($flagsArg->value, $scope, 'PREG_SPLIT_OFFSET_CAPTURE')->yes()) {
 			$type = new ArrayType(
 				new IntegerType(),
 				new ConstantArrayType([new ConstantIntegerType(0), new ConstantIntegerType(1)], [new StringType(), IntegerRangeType::fromInterval(0, null)]),
@@ -54,39 +48,4 @@ public function getTypeFromFunctionCall(FunctionReflection $functionReflection,
 		return ParametersAcceptorSelector::selectSingle($functionReflection->getVariants())->getReturnType();
 	}
 
-
-	private function hasFlag(int $flag, ?Arg $arg, Scope $scope): bool
-	{
-		if ($arg === null) {
-			return false;
-		}
-
-		return $this->isConstantFlag($flag, $arg->value, $scope);
-	}
-
-	private function isConstantFlag(int $flag, Expr $expression, Scope $scope): bool
-	{
-		if ($expression instanceof BitwiseOr) {
-			$left = $expression->left;
-			$right = $expression->right;
-
-			return $this->isConstantFlag($flag, $left, $scope) || $this->isConstantFlag($flag, $right, $scope);
-		}
-
-		$type = $scope->getType($expression);
-		return $type instanceof ConstantIntegerType && ($type->getValue() & $flag) === $flag;
-	}
-
-
-	private function getConstant(string $constantName): int
-	{
-		$constant = $this->reflectionProvider->getConstant(new Name($constantName), null);
-		$valueType = $constant->getValueType();
-		if (!$valueType instanceof ConstantIntegerType) {
-			throw new ShouldNotHappenException(sprintf('Constant %s does not have integer type.', $constantName));
-		}
-
-		return $valueType->getValue();
-	}
-
 }

tests/PHPStan/Analyser/data/preg_split.php

@@ -27,4 +27,19 @@ public static function splitWithOffset($pattern, $subject, $limit = -1, $flags =
 
 		assertType('array<int, array{string, int<0, max>}>|false', preg_split($pattern, $subject, $limit, PREG_SPLIT_OFFSET_CAPTURE | $flags | PREG_SPLIT_NO_EMPTY));
 	}
+
+	/**
+	 * @param string $pattern
+	 * @param string $subject
+	 * @param int $limit
+	 */
+	public static function dynamicFlags($pattern, $subject, $limit = -1) {
+		$flags = PREG_SPLIT_OFFSET_CAPTURE;
+
+		if ($subject === '1-2-3') {
+			$flags |= PREG_SPLIT_NO_EMPTY;
+		}
+
+		assertType('array<int, array{string, int<0, max>}>|false', preg_split($pattern, $subject, $limit, $flags));
+	}
 }