Skip to content
PHP Ecosystem
Explore

UnknownBehaviorOption

API reference › PHPStan › rules › UnknownBehaviorOption

final readonly classyii2\extensions\phpstan\rules\UnknownBehaviorOption
Sourcesrc/rules/UnknownBehaviorOption.php

Represents an option of a behavior configuration that the created Behavior can’t assign, as found by BehaviorDefinitionResolver.

PropertyTypeDescriptionDefined by
$behaviorClass readonly constructorstringBehavior class that Yii creates, as PHPStan displays it.UnknownBehaviorOption
$calledClass readonly constructorstring|nullClass through which createObject() is called, for an as option, or null. Default: null.UnknownBehaviorOption
$line readonly constructorintLine to report: the option key, else the list item, the definition argument, the as option, the return statement or the call.UnknownBehaviorOption
$method readonly constructorstringMethod that supplies the configuration: behaviors, attachBehavior, attachBehaviors or createObject.UnknownBehaviorOption
$name readonly constructorint|string|nullBehavior 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.UnknownBehaviorOption
$option readonly constructorstringName of the option that the behavior class can’t assign.UnknownBehaviorOption
$owner readonly constructorstringClass whose behaviors() returns the configuration, receiver type of the attach call, or component created by createObject(), as PHPStan displays it.UnknownBehaviorOption
MethodDescriptionDefined by
__construct()Stores an unassignable behavior option and its diagnostic location.UnknownBehaviorOption
message()Returns the diagnostic message, naming the behavior, its owner and source, the behavior class and the option.UnknownBehaviorOption
public function __construct(string $owner, string $method, int|string|null $name, int $line, string $behaviorClass, string $option, string|null $calledClass = null)

Stores an unassignable behavior option and its diagnostic location.

Parameters

ParameterTypeDescription
$ownerstringClass whose behaviors() returns the configuration, receiver type of the attach call, or component created by createObject(), as PHPStan displays it.
$methodstringMethod that supplies the configuration: behaviors, attachBehavior, attachBehaviors or createObject.
$nameint|string|nullBehavior 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.
$lineintLine to report: the option key, else the list item, the definition argument, the as option, the return statement or the call.
$behaviorClassstringBehavior class that Yii creates, as PHPStan displays it.
$optionstringName of the option that the behavior class can’t assign.
$calledClassstring|nullClass through which createObject() is called, for an as option, or null.
public function message(): string

Returns the diagnostic message, naming the behavior, its owner and source, the behavior class and the option.

Returns

string