WidgetInvalidOptionTypeRule
API reference › PHPStan › rules › WidgetInvalidOptionTypeRule
Reports Widget::widget() and Widget::begin() option values that the property or setter Yii assigns them
to never accepts.
A value is reported only when PHP’s weak type coercion can’t convert it to the native type of the public property or
of the first setter parameter. PHPDoc types are not consulted. A value that may be an Instance reference is
also checked as the object or null that the container may resolve it to before the assignment. The class and
__class keys with which Yii::createObject() selects the class are never checked; inside a constructor argument
used as the configuration they are checked like any other option.
Rule for PHPStan rule contract.
WidgetConfigurationResolver for the calls and classes the rule analyses.
CreateObjectConfigurationResolver::rejectedOptions() for the type semantics.
Methods
Section titled “Methods”| Method | Description | Defined by |
|---|---|---|
__construct() | Initializes the rule with class reflection and the analysis configuration. | WidgetInvalidOptionTypeRule |
getNodeType() | Returns the node class this rule analyses. | WidgetInvalidOptionTypeRule |
processNode() | Returns one error per distinct option whose value the created widget never accepts. | WidgetInvalidOptionTypeRule |
Method details
Section titled “Method details”__construct()
Section titled “__construct() ”public function __construct(PHPStan\Reflection\ReflectionProvider $reflectionProvider, yii2\extensions\phpstan\ServiceMap $serviceMap)Initializes the rule with class reflection and the analysis configuration.
Parameters
| Parameter | Type | Description |
|---|---|---|
$reflectionProvider | PHPStan\ | Provides class reflection for the called and created classes. |
$serviceMap | yii2\ | Service and component map for Yii Application static analysis. |
getNodeType()
Section titled “getNodeType() ”public function getNodeType(): class-string<PhpParser\Node\Expr\StaticCall>Returns the node class this rule analyses.
Returns
class-string<PhpParser\Node\Expr\StaticCall>
processNode()
Section titled “processNode() ”public function processNode(PhpParser\Node\Expr\StaticCall $node, PHPStan\Analyser\DependencyTracker&PHPStan\Analyser\Scope $scope): list<PHPStan\Rules\IdentifierRuleError>Returns one error per distinct option whose value the created widget never accepts.
Parameters
| Parameter | Type | Description |
|---|---|---|
$node | PhpParser\ | Static call to inspect. |
$scope | PHPStan\ | Current PHPStan analysis scope. |
Returns
list<PHPStan\Rules\IdentifierRuleError>: Errors reported at the first key of each option, or at the call line when the configuration doesn’t locate the key.