0 追蹤者

類別 yii\behaviors\AttributesBehavior

所有類別 | 屬性 | 方法
繼承yii\behaviors\AttributesBehavior » yii\base\Behavior » yii\base\BaseObject
實作yii\base\Configurable
自版本起可用2.0.13
原始碼 https://github.com/yiisoft/yii2/blob/master/framework/behaviors/AttributesBehavior.php

AttributesBehavior 會在特定事件發生時，自動將指定的值賦予 ActiveRecord 物件的一個或多個屬性。

若要使用 AttributesBehavior，請配置 $attributes 屬性，該屬性應指定需要更新的屬性列表，以及應觸發更新的相應事件。然後使用 PHP 可調用項配置封閉陣列的值，其回傳值將用於賦值給目前的屬性。例如：

use yii\behaviors\AttributesBehavior;

public function behaviors()
{
    return [
        [
            'class' => AttributesBehavior::class,
            'attributes' => [
                'attribute1' => [
                    ActiveRecord::EVENT_BEFORE_INSERT => new Expression('NOW()'),
                    ActiveRecord::EVENT_BEFORE_UPDATE => \Yii::$app->formatter->asDatetime('2017-07-13'),
                ],
                'attribute2' => [
                    ActiveRecord::EVENT_BEFORE_VALIDATE => [$this, 'storeAttributes'],
                    ActiveRecord::EVENT_AFTER_VALIDATE => [$this, 'restoreAttributes'],
                ],
                'attribute3' => [
                    ActiveRecord::EVENT_BEFORE_VALIDATE => $fn2 = [$this, 'getAttribute2'],
                    ActiveRecord::EVENT_AFTER_VALIDATE => $fn2,
                ],
                'attribute4' => [
                    ActiveRecord::EVENT_BEFORE_DELETE => function ($event, $attribute) {
                        static::disabled() || $event->isValid = false;
                    },
                ],
            ],
        ],
    ];
}

由於屬性值將由此行為自動設定，因此它們通常不是使用者輸入，因此不應進行驗證，即它們不應出現在模型的 rules() 方法中。

公共屬性

隱藏繼承的屬性

屬性 類型 描述 定義於
$attributes 陣列 要自動填入透過封閉陣列指定的值的屬性列表。 yii\behaviors\AttributesBehavior
$order 陣列 要自動填入事件的屬性順序列表。 yii\behaviors\AttributesBehavior
$owner yii\base\Component|null 此行為的所有者 yii\base\Behavior
$preserveNonEmptyValues 布林值 是否保留非空的屬性值。 yii\behaviors\AttributesBehavior
$skipUpdateOnClean 布林值 當 $owner 未被修改時，是否跳過此行為 yii\behaviors\AttributesBehavior

公共方法

隱藏繼承的方法

方法 描述 定義於
__call() 調用非類別方法的具名方法。 yii\base\BaseObject
__construct() 建構子。 yii\base\BaseObject
__get() 回傳物件屬性的值。 yii\base\BaseObject
__isset() 檢查屬性是否已設定，即已定義且非 null。 yii\base\BaseObject
__set() 設定物件屬性的值。 yii\base\BaseObject
__unset() 將物件屬性設定為 null。 yii\base\BaseObject
attach() 將行為物件附加到元件。 yii\base\Behavior
canGetProperty() 回傳一個值，指示屬性是否可讀取。 yii\base\BaseObject
canSetProperty() 回傳一個值，指示屬性是否可設定。 yii\base\BaseObject
className() 回傳此類別的完整限定名稱。 yii\base\BaseObject
detach() 從元件中分離行為物件。 yii\base\Behavior
evaluateAttributes() 評估屬性值並將其賦值給目前的屬性。 yii\behaviors\AttributesBehavior
events() 為 $owner 的事件宣告事件處理器。 yii\behaviors\AttributesBehavior
hasMethod() 回傳一個值，指示是否已定義方法。 yii\base\BaseObject
hasProperty() 傳回值，指出是否已定義屬性。 yii\base\BaseObject
init() 初始化物件。 yii\base\BaseObject

保護方法

隱藏繼承的方法

方法 描述 定義於
getValue() 傳回目前屬性的值。 yii\behaviors\AttributesBehavior

屬性詳細資訊

隱藏繼承的屬性

$attributes 公開屬性

要自動填入透過封閉陣列指定之值的屬性清單。陣列的鍵是要在其上更新事件的 ActiveRecord 屬性，而陣列的值是相應事件的陣列。對於此封閉陣列：陣列的鍵是要在其上更新屬性的 ActiveRecord 事件，而陣列的值將會指派給目前的屬性。這可以是匿名函式、陣列格式的可呼叫項（例如 [$this, 'methodName']）、代表資料庫運算式的 Expression 物件（例如 new Expression('NOW()')）、純量、字串或任意值。如果是前者，則函式的傳回值將會指派給屬性。

[
  'attribute1' => [
      ActiveRecord::EVENT_BEFORE_INSERT => new Expression('NOW()'),
      ActiveRecord::EVENT_BEFORE_UPDATE => \Yii::$app->formatter->asDatetime('2017-07-13'),
  ],
  'attribute2' => [
      ActiveRecord::EVENT_BEFORE_VALIDATE => [$this, 'storeAttributes'],
      ActiveRecord::EVENT_AFTER_VALIDATE => [$this, 'restoreAttributes'],
  ],
  'attribute3' => [
      ActiveRecord::EVENT_BEFORE_VALIDATE => $fn2 = [$this, 'getAttribute2'],
      ActiveRecord::EVENT_AFTER_VALIDATE => $fn2,
  ],
  'attribute4' => [
      ActiveRecord::EVENT_BEFORE_DELETE => function ($event, $attribute) {
          static::disabled() || $event->isValid = false;
      },
  ],
]
public array $attributes = []
$order 公開屬性

要自動填入事件的屬性順序清單。陣列的鍵是要在其上更新屬性的 ActiveRecord 事件，而陣列的值代表對應的屬性順序。其餘屬性會在最後處理。如果此屬性的 $attributes 未指定此事件，則會忽略它

[
    ActiveRecord::EVENT_BEFORE_VALIDATE => ['attribute1', 'attribute2'],
    ActiveRecord::EVENT_AFTER_VALIDATE => ['attribute2', 'attribute1'],
]
public array $order = []
$preserveNonEmptyValues 公開屬性

是否保留非空的屬性值。

public boolean $preserveNonEmptyValues = false
$skipUpdateOnClean 公開屬性

當 $owner 未被修改時，是否跳過此行為

public boolean $skipUpdateOnClean = true

方法詳細資訊

隱藏繼承的方法

__call() 公開方法

定義於： yii\base\BaseObject::__call()

調用非類別方法的具名方法。

請勿直接呼叫此方法，因為它是 PHP 魔術方法，會在叫用未知方法時隱含地呼叫。

public mixed __call ( $name, $params )
$name 字串

方法名稱
$params 陣列

方法參數
return 混合

方法傳回值
throws yii\base\UnknownMethodException

當呼叫未知方法時

 

                public function __call($name, $params)
{
    throw new UnknownMethodException('Calling unknown method: ' . get_class($this) . "::$name()");
}
__construct() 公開方法

定義於： yii\base\BaseObject::__construct()

建構子。

預設實作會執行兩件事

  • 使用給定的組態 $config 初始化物件。
  • 呼叫 init()。

如果子類別中覆寫了此方法，建議

  • 建構子的最後一個參數是組態陣列，就像此處的 $config 一樣。
  • 在建構子結尾呼叫父類別實作。
public void __construct ( $config = [] )
$config 陣列

將用於初始化物件屬性的名稱-值配對

 

                public function __construct($config = [])
{
    if (!empty($config)) {
        Yii::configure($this, $config);
    }
    $this->init();
}
__get() 公開方法

定義於： yii\base\BaseObject::__get()

回傳物件屬性的值。

請勿直接呼叫此方法，因為它是 PHP 魔術方法，會在執行 $value = $object->property; 時隱含地呼叫。

另請參閱 __set()。

public mixed __get ( $name )
$name 字串

屬性名稱
return 混合

屬性值
throws yii\base\UnknownPropertyException

如果未定義屬性
throws yii\base\InvalidCallException

如果屬性為唯寫

 

                public function __get($name)
{
    $getter = 'get' . $name;
    if (method_exists($this, $getter)) {
        return $this->$getter();
    } elseif (method_exists($this, 'set' . $name)) {
        throw new InvalidCallException('Getting write-only property: ' . get_class($this) . '::' . $name);
    }
    throw new UnknownPropertyException('Getting unknown property: ' . get_class($this) . '::' . $name);
}
__isset() 公開方法

定義於： yii\base\BaseObject::__isset()

檢查屬性是否已設定，即已定義且非 null。

請勿直接呼叫此方法，因為它是 PHP 魔術方法，會在執行 isset($object->property) 時隱含地呼叫。

請注意，如果未定義屬性，將會傳回 false。

另請參閱 https://php.dev.org.tw/manual/en/function.isset.php。

public boolean __isset ( $name )
$name 字串

屬性名稱或事件名稱
return 布林值

具名的屬性是否已設定 (非 null)。

 

                public function __isset($name)
{
    $getter = 'get' . $name;
    if (method_exists($this, $getter)) {
        return $this->$getter() !== null;
    }
    return false;
}
__set() 公開方法

定義於： yii\base\BaseObject::__set()

設定物件屬性的值。

請勿直接呼叫此方法，因為它是 PHP 魔術方法，會在執行 $object->property = $value; 時隱含地呼叫。

另請參閱 __get()。

public void __set ( $name, $value )
$name 字串

屬性名稱或事件名稱
$value 混合

屬性值
throws yii\base\UnknownPropertyException

如果未定義屬性
throws yii\base\InvalidCallException

如果屬性為唯讀

 

                public function __set($name, $value)
{
    $setter = 'set' . $name;
    if (method_exists($this, $setter)) {
        $this->$setter($value);
    } elseif (method_exists($this, 'get' . $name)) {
        throw new InvalidCallException('Setting read-only property: ' . get_class($this) . '::' . $name);
    } else {
        throw new UnknownPropertyException('Setting unknown property: ' . get_class($this) . '::' . $name);
    }
}
__unset() 公開方法

定義於： yii\base\BaseObject::__unset()

將物件屬性設定為 null。

請勿直接呼叫此方法，因為它是 PHP 魔術方法，會在執行 unset($object->property) 時隱含地呼叫。

請注意，如果未定義屬性，此方法將不會執行任何動作。如果屬性為唯讀，則會擲回例外。

另請參閱 https://php.dev.org.tw/manual/en/function.unset.php。

public void __unset ( $name )
$name 字串

屬性名稱
throws yii\base\InvalidCallException

如果屬性為唯讀。

 

                public function __unset($name)
{
    $setter = 'set' . $name;
    if (method_exists($this, $setter)) {
        $this->$setter(null);
    } elseif (method_exists($this, 'get' . $name)) {
        throw new InvalidCallException('Unsetting read-only property: ' . get_class($this) . '::' . $name);
    }
}
attach() 公開方法

定義於： yii\base\Behavior::attach()

將行為物件附加到元件。

預設實作會設定 $owner 屬性，並附加在 events() 中宣告的事件處理常式。如果您覆寫此方法，請務必呼叫父類別實作。

public void attach ( $owner )
$owner yii\base\Component

此行為要附加到的元件。

 

                public function attach($owner)
{
    $this->owner = $owner;
    foreach ($this->events() as $event => $handler) {
        $this->_attachedEvents[$event] = $handler;
        $owner->on($event, is_string($handler) ? [$this, $handler] : $handler);
    }
}
canGetProperty() 公開方法

定義於： yii\base\BaseObject::canGetProperty()

回傳一個值，指示屬性是否可讀取。

如果符合以下條件，屬性是可讀取的

  • 類別具有與指定名稱相關聯的 getter 方法（在此情況下，屬性名稱不區分大小寫）；
  • 類別具有具有指定名稱的成員變數（當 $checkVars 為 true 時）；

另請參閱 canSetProperty()。

public boolean canGetProperty ( $name, $checkVars = true )
$name 字串

屬性名稱
$checkVars 布林值

是否將成員變數視為屬性
return 布林值

屬性是否可讀取

 

                public function canGetProperty($name, $checkVars = true)
{
    return method_exists($this, 'get' . $name) || $checkVars && property_exists($this, $name);
}
canSetProperty() 公開方法

定義於： yii\base\BaseObject::canSetProperty()

回傳一個值，指示屬性是否可設定。

如果符合以下條件，屬性是可寫入的

  • 類別具有與指定名稱相關聯的 setter 方法（在此情況下，屬性名稱不區分大小寫）；
  • 類別具有具有指定名稱的成員變數（當 $checkVars 為 true 時）；

另請參閱 canGetProperty()。

public boolean canSetProperty ( $name, $checkVars = true )
$name 字串

屬性名稱
$checkVars 布林值

是否將成員變數視為屬性
return 布林值

屬性是否可寫入

 

                public function canSetProperty($name, $checkVars = true)
{
    return method_exists($this, 'set' . $name) || $checkVars && property_exists($this, $name);
}
className() 公開靜態方法
自 2.0.14 版起已淘汰。在 PHP >=5.5 上，請改用 ::class。

定義於： yii\base\BaseObject::className()

回傳此類別的完整限定名稱。

public static string className ( )
return 字串

此類別的完整名稱。

 

                public static function className()
{
    return get_called_class();
}
detach() 公開方法

定義於： yii\base\Behavior::detach()

從元件中分離行為物件。

預設實作會取消設定 $owner 屬性，並分離在 events() 中宣告的事件處理常式。如果您覆寫此方法，請務必呼叫父類別實作。

public void detach ( )

                public function detach()
{
    if ($this->owner) {
        foreach ($this->_attachedEvents as $event => $handler) {
            $this->owner->off($event, is_string($handler) ? [$this, $handler] : $handler);
        }
        $this->_attachedEvents = [];
        $this->owner = null;
    }
}
evaluateAttributes() 公開方法

評估屬性值並將其賦值給目前的屬性。

public void evaluateAttributes ( $event )
$event yii\base\Event 

                public function evaluateAttributes($event)
{
    if (
        $this->skipUpdateOnClean
        && $event->name === ActiveRecord::EVENT_BEFORE_UPDATE
        && empty($this->owner->dirtyAttributes)
    ) {
        return;
    }
    $attributes = array_keys(array_filter($this->attributes, function ($carry) use ($event) {
        return array_key_exists($event->name, $carry);
    }));
    if (!empty($this->order[$event->name])) {
        $attributes = array_merge(
            array_intersect((array) $this->order[$event->name], $attributes),
            array_diff($attributes, (array) $this->order[$event->name])
        );
    }
    foreach ($attributes as $attribute) {
        if ($this->preserveNonEmptyValues && !empty($this->owner->$attribute)) {
            continue;
        }
        $this->owner->$attribute = $this->getValue($attribute, $event);
    }
}
events() 公開方法

為 $owner 的事件宣告事件處理器。

子類別可以覆寫此方法，以宣告應附加到 $owner 元件事件的 PHP 回呼。

當行為附加到擁有者時，回呼將會附加到 $owner 的事件；當行為從元件分離時，回呼將會從事件中分離。

回呼可以是下列任何一種

  • 此行為中的方法：'handleClick'，相當於 [$this, 'handleClick']
  • 物件方法：[$object, 'handleClick']
  • 靜態方法：['Page', 'handleClick']
  • 匿名函式：function ($event) { ... }

以下是一個範例

[
    Model::EVENT_BEFORE_VALIDATE => 'myBeforeValidate',
    Model::EVENT_AFTER_VALIDATE => 'myAfterValidate',
]
public array events ( )
return 陣列

事件（陣列鍵）和對應的事件處理常式方法（陣列值）。

 

                public function events()
{
    return array_fill_keys(
        array_reduce($this->attributes, function ($carry, $item) {
            return array_merge($carry, array_keys($item));
        }, []),
        'evaluateAttributes'
    );
}
getValue() 保護方法

傳回目前屬性的值。

此方法由 evaluateAttributes() 呼叫。其傳回值將會指派給對應於觸發事件的目標屬性。

protected mixed getValue ( $attribute, $event )
$attribute 字串

目標屬性名稱
$event yii\base\Event

觸發目前屬性更新的事件。
return 混合

屬性值

 

                protected function getValue($attribute, $event)
{
    if (!isset($this->attributes[$attribute][$event->name])) {
        return null;
    }
    $value = $this->attributes[$attribute][$event->name];
    if ($value instanceof Closure || (is_array($value) && is_callable($value))) {
        return $value($event, $attribute);
    }
    return $value;
}
hasMethod() 公開方法

定義於： yii\base\BaseObject::hasMethod()

回傳一個值，指示是否已定義方法。

預設實作是對 php 函式 method_exists() 的呼叫。當您實作 php 魔術方法 __call() 時，您可以覆寫此方法。

public boolean hasMethod ( $name )
$name 字串

方法名稱
return 布林值

是否已定義方法

 

                public function hasMethod($name)
{
    return method_exists($this, $name);
}
hasProperty() 公開方法

定義於： yii\base\BaseObject::hasProperty()

傳回值，指出是否已定義屬性。

如果符合以下條件，則定義了屬性

  • 類別具有與指定名稱相關聯的 getter 或 setter 方法（在此情況下，屬性名稱不區分大小寫）；
  • 類別具有具有指定名稱的成員變數（當 $checkVars 為 true 時）；

另請參閱

public boolean hasProperty ( $name, $checkVars = true )
$name 字串

屬性名稱
$checkVars 布林值

是否將成員變數視為屬性
return 布林值

是否已定義屬性

 

                public function hasProperty($name, $checkVars = true)
{
    return $this->canGetProperty($name, $checkVars) || $this->canSetProperty($name, false);
}
init() 公開方法

定義於： yii\base\BaseObject::init()

初始化物件。

在物件以給定組態初始化之後，會在建構子的結尾叫用此方法。

public void init ( )

                public function init()
{
}