# UnknownBehaviorOption

> Represents an option of a behavior configuration that the created yii\base\Behavior can't assign, as found by yii2\extensions\phpstan\rules\BehaviorDefinitionResolver.

[API reference](/docs/api/index.md) › [PHPStan](/docs/extensions/phpstan/reference/index.md) › [rules](/docs/extensions/phpstan/reference/rules/index.md) › UnknownBehaviorOption

| final readonly class | `yii2\extensions\phpstan\rules\UnknownBehaviorOption` |
| --- | --- |
| Source | [`src/rules/UnknownBehaviorOption.php`](https://github.com/yii2-extensions/phpstan/blob/main/src/rules/UnknownBehaviorOption.php#L16) |

Represents an option of a behavior configuration that the created [`Behavior`](/docs/api/yii/base/behavior/index.md) can't assign, as found by
[`BehaviorDefinitionResolver`](/docs/extensions/phpstan/reference/rules/behaviordefinitionresolver/index.md).

## Properties

| Property | Type | Description | Defined by |
| --- | --- | --- | --- |
| <span id="property-behaviorClass"></span>`$behaviorClass` readonly constructor | `string` | Behavior class that Yii creates, as PHPStan displays it. | `UnknownBehaviorOption` |
| <span id="property-calledClass"></span>`$calledClass` readonly constructor | `string\|null` | Class through which `createObject()` is called, for an `as` option, or `null`. Default: `null`. | `UnknownBehaviorOption` |
| <span id="property-line"></span>`$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. | `UnknownBehaviorOption` |
| <span id="property-method"></span>`$method` readonly constructor | `string` | Method that supplies the configuration: `behaviors`, `attachBehavior`, `attachBehaviors` or `createObject`. | `UnknownBehaviorOption` |
| <span id="property-name"></span>`$name` readonly constructor | `int\|string\|null` | 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`. | `UnknownBehaviorOption` |
| <span id="property-option"></span>`$option` readonly constructor | `string` | Name of the option that the behavior class can't assign. | `UnknownBehaviorOption` |
| <span id="property-owner"></span>`$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. | `UnknownBehaviorOption` |

## Methods

| Method | Description | Defined by |
| --- | --- | --- |
| [`__construct()`](#method-__construct) | Stores an unassignable behavior option and its diagnostic location. | `UnknownBehaviorOption` |
| [`message()`](#method-message) | Returns the diagnostic message, naming the behavior, its owner and source, the behavior class and the option. | `UnknownBehaviorOption` |

## Method details

### __construct() <span id="method-__construct"></span>

```php
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**

| 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\|string\|null` | 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 that the behavior class can't assign. |
| `$calledClass` | `string\|null` | Class through which `createObject()` is called, for an `as` option, or `null`. |

### message() <span id="method-message"></span>

```php
public function message(): string
```

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

**Returns**

`string`