InvalidBehaviorOptionType
API reference › PHPStan › rules › InvalidBehaviorOptionType
Represents an option of a behavior configuration whose value the created Behavior never accepts, as found by
BehaviorDefinitionResolver.
Properties
Section titled “Properties”| Property | Type | Description | Defined by |
|---|---|---|---|
$actualType readonly constructor | string | Native type of the value, as PHPStan describes it precisely. | InvalidBehaviorOptionType |
$behaviorClass readonly constructor | string | Behavior class that Yii creates, as PHPStan displays it. | InvalidBehaviorOptionType |
$calledClass readonly constructor | string| | Class through which createObject() is called, for an as option, or null. Default: null. | InvalidBehaviorOptionType |
$expectedType readonly constructor | string | Native type of that property or of the first setter parameter. | InvalidBehaviorOptionType |
$line readonly constructor | int | Line to report: the option key, else the list item, the definition argument, the as option, the return statement or the call. | InvalidBehaviorOptionType |
$member readonly constructor | string | Property or setter that Yii assigns the value to. | InvalidBehaviorOptionType |
$method readonly constructor | string | Method that supplies the configuration: behaviors, attachBehavior, attachBehaviors or createObject. | InvalidBehaviorOptionType |
$name readonly constructor | int| | Behavior name: a string for a named behavior, an int for an anonymous one, null when the name isn’t a single constant, or the as option name as written for createObject. | InvalidBehaviorOptionType |
$option readonly constructor | string | Name of the option whose value the behavior class never accepts. | InvalidBehaviorOptionType |
$owner readonly constructor | string | Class whose behaviors() returns the configuration, receiver type of the attach call, or component created by createObject(), as PHPStan displays it. | InvalidBehaviorOptionType |
Methods
Section titled “Methods”| Method | Description | Defined by |
|---|---|---|
__construct() | Stores a rejected behavior option, its actual and expected types and diagnostic location. | InvalidBehaviorOptionType |
message() | Returns the diagnostic message, naming the behavior, its owner and source, the behavior class, the option, the value type and the type that the property or setter accepts. | InvalidBehaviorOptionType |
Method details
Section titled “Method details”__construct()
Section titled “__construct() ”public function __construct(string $owner, string $method, int|string|null $name, int $line, string $behaviorClass, string $option, string $actualType, string $member, string $expectedType, string|null $calledClass = null)Stores a rejected behavior option, its actual and expected types and diagnostic location.
Parameters
| Parameter | Type | Description |
|---|---|---|
$owner | string | Class whose behaviors() returns the configuration, receiver type of the attach call, or component created by createObject(), as PHPStan displays it. |
$method | string | Method that supplies the configuration: behaviors, attachBehavior, attachBehaviors or createObject. |
$name | int| | Behavior name: a string for a named behavior, an int for an anonymous one, null when the name isn’t a single constant, or the as option name as written for createObject. |
$line | int | Line to report: the option key, else the list item, the definition argument, the as option, the return statement or the call. |
$behaviorClass | string | Behavior class that Yii creates, as PHPStan displays it. |
$option | string | Name of the option whose value the behavior class never accepts. |
$actualType | string | Native type of the value, as PHPStan describes it precisely. |
$member | string | Property or setter that Yii assigns the value to. |
$expectedType | string | Native type of that property or of the first setter parameter. |
$calledClass | string| | Class through which createObject() is called, for an as option, or null. |
message()
Section titled “message() ”public function message(): stringReturns the diagnostic message, naming the behavior, its owner and source, the behavior class, the option, the value type and the type that the property or setter accepts.
Returns
string