0 關注者

類別 yii\rest\Serializer

繼承關係yii\rest\Serializer » yii\base\Component » yii\base\BaseObject
實作yii\base\Configurable
自版本起可用2.0
原始碼 https://github.com/yiisoft/yii2/blob/master/framework/rest/Serializer.php

Serializer 將資源物件和集合轉換為陣列表示法。

Serializer 主要被 REST 控制器用於將不同的物件轉換為陣列表示法,以便它們可以進一步轉換為不同的格式,例如 JSON、XML,透過回應格式器。

預設實作將資源視為 yii\base\Model 物件,並將集合視為實作 yii\data\DataProviderInterface 的物件。 您可以覆寫 serialize() 以處理更多類型。

公開屬性

隱藏繼承的屬性

屬性 類型 描述 定義於
$behaviors yii\base\Behavior[] 附加到此組件的行為列表。 yii\base\Component
$collectionEnvelope string|null 用於在集合中傳回資源物件的信封名稱 (例如 items)。 yii\rest\Serializer
$currentPageHeader string 包含目前頁碼資訊 (從 1 開始) 的 HTTP 標頭名稱。 yii\rest\Serializer
$expandParam string 查詢參數的名稱,其中包含除了 $fieldsParam 中列出的欄位之外,還應為資源物件傳回哪些欄位的資訊。 yii\rest\Serializer
$fieldsParam string 查詢參數的名稱,其中包含應為 yii\base\Model 物件傳回哪些欄位的資訊。 yii\rest\Serializer
$linksEnvelope string 用於傳回連結物件的信封名稱 (例如 _links)。 yii\rest\Serializer
$metaEnvelope string 用於傳回分頁物件的信封名稱 (例如 _meta)。 yii\rest\Serializer
$pageCountHeader string 包含資料總頁數資訊的 HTTP 標頭名稱。 yii\rest\Serializer
$perPageHeader string 包含每頁資料項目數資訊的 HTTP 標頭名稱。 yii\rest\Serializer
$preserveKeys boolean 序列化集合資料時是否保留陣列鍵。 yii\rest\Serializer
$request yii\web\Request|null 目前的請求。 yii\rest\Serializer
$response yii\web\Response|null 要發送的回應。 yii\rest\Serializer
$totalCountHeader string 包含資料項目總數資訊的 HTTP 標頭名稱。 yii\rest\Serializer

Public Methods

Hide inherited methods

Method 描述 定義於
__call() 呼叫未定義為類別方法的具名方法。 yii\base\Component
__clone() 在通過複製現有物件建立物件後,會呼叫此方法。 yii\base\Component
__construct() 建構子。 yii\base\BaseObject
__get() 傳回組件屬性的值。 yii\base\Component
__isset() 檢查屬性是否已設定,即已定義且非 null。 yii\base\Component
__set() 設定組件屬性的值。 yii\base\Component
__unset() 將組件屬性設定為 null。 yii\base\Component
attachBehavior() 將行為附加到此組件。 yii\base\Component
attachBehaviors() 將行為列表附加到組件。 yii\base\Component
behaviors() 傳回此組件應表現為的行為列表。 yii\base\Component
canGetProperty() 傳回一個值,指示是否可以讀取屬性。 yii\base\Component
canSetProperty() 傳回一個值,指示是否可以設定屬性。 yii\base\Component
className() 傳回此類別的完整限定名稱。 yii\base\BaseObject
detachBehavior() 從組件分離行為。 yii\base\Component
detachBehaviors() 從組件分離所有行為。 yii\base\Component
ensureBehaviors() 確保在 behaviors() 中宣告的行為已附加到此組件。 yii\base\Component
getBehavior() 傳回具名的行為物件。 yii\base\Component
getBehaviors() 傳回附加到此組件的所有行為。 yii\base\Component
hasEventHandlers() 傳回一個值,指示是否有名為事件附加任何處理常式。 yii\base\Component
hasMethod() 傳回一個值,指示是否已定義方法。 yii\base\Component
hasProperty() 傳回一個值,指示是否為此組件定義了屬性。 yii\base\Component
init() 初始化物件。 yii\rest\Serializer
off() 從此組件分離現有的事件處理常式。 yii\base\Component
on() 將事件處理常式附加到事件。 yii\base\Component
serialize() 將給定的資料序列化為可以輕鬆轉換為其他格式的格式。 yii\rest\Serializer
trigger() 觸發事件。 yii\base\Component

Protected Methods

Hide inherited methods

Method 描述 定義於
addPaginationHeaders() 將關於分頁的 HTTP 標頭新增至回應。 yii\rest\Serializer
getRequestedFields() yii\rest\Serializer
serializeDataProvider() 序列化資料提供器。 yii\rest\Serializer
serializeModel() 序列化模型物件。 yii\rest\Serializer
serializeModelErrors() 序列化模型中的驗證錯誤。 yii\rest\Serializer
serializeModels() 序列化一組模型。 yii\rest\Serializer
serializePagination() 將分頁序列化為陣列。 yii\rest\Serializer

Property Details

隱藏繼承的屬性

$collectionEnvelope public property

用於在集合中傳回資源物件的信封名稱(例如 items)。這在服務資源集合時使用。當設定此項且啟用分頁時,序列化器將以以下格式傳回集合

[
    'items' => [...],  // assuming collectionEnvelope is "items"
    '_links' => {  // pagination links as returned by Pagination::getLinks()
        'self' => '...',
        'next' => '...',
        'last' => '...',
    },
    '_meta' => {  // meta information as returned by Pagination::toArray()
        'totalCount' => 100,
        'pageCount' => 5,
        'currentPage' => 1,
        'perPage' => 20,
    },
]

如果未設定此屬性,資源陣列將直接傳回,而不使用信封。可以從回應 HTTP 標頭存取如 _links_meta 中顯示的分頁資訊。

$currentPageHeader public property

包含目前頁碼資訊(從 1 開始)的 HTTP 標頭名稱。這在服務具有分頁的資源集合時使用。

public string $currentPageHeader 'X-Pagination-Current-Page'
$expandParam public property

查詢參數的名稱,其中包含除了 $fieldsParam 中列出的欄位之外,還應為資源物件傳回哪些欄位的資訊。

public string $expandParam 'expand'
$fieldsParam public property

查詢參數的名稱,其中包含關於應為 yii\base\Model 物件傳回哪些欄位的資訊。如果未提供或為空參數,將傳回由 yii\base\Model::fields() 定義的預設欄位集。

public string $fieldsParam 'fields'
$linksEnvelope public property (available since version 2.0.4)

用於傳回連結物件的信封名稱(例如 _links)。僅在設定 collectionEnvelope 時生效。

public string $linksEnvelope '_links'
$metaEnvelope public property (available since version 2.0.4)

用於傳回分頁物件的信封名稱(例如 _meta)。僅在設定 collectionEnvelope 時生效。

public string $metaEnvelope '_meta'
$pageCountHeader public property

包含資料總頁數資訊的 HTTP 標頭名稱。這在服務具有分頁的資源集合時使用。

public string $pageCountHeader 'X-Pagination-Page-Count'
$perPageHeader public property

包含每頁資料項目數資訊的 HTTP 標頭名稱。這在服務具有分頁的資源集合時使用。

public string $perPageHeader 'X-Pagination-Per-Page'
$preserveKeys public property (available since version 2.0.10)

在序列化集合資料時是否保留陣列鍵。將此項設定為 true 以允許將集合序列化為 JSON 物件,其中陣列鍵用於索引模型物件。預設值是將所有集合序列化為陣列,無論陣列如何索引。

另請參閱 serializeDataProvider()

public boolean $preserveKeys false
$request public property

目前的請求。如果未設定,將使用 request 應用程式組件。

$response public property

要發送的回應。如果未設定,將使用 response 應用程式組件。

$totalCountHeader public property

包含資料項目總數資訊的 HTTP 標頭名稱。這在服務具有分頁的資源集合時使用。

public string $totalCountHeader 'X-Pagination-Total-Count'

Method Details

Hide inherited methods

__call() public method

Defined in: yii\base\Component::__call()

呼叫未定義為類別方法的具名方法。

此方法將檢查是否有任何附加的行為具有具名方法,並在可用時執行它。

請勿直接呼叫此方法,因為它是 PHP 魔術方法,將在調用未知方法時隱式呼叫。

public mixed __call ( $name, $params )
$name string

方法名稱

$params array

方法參數

return mixed

方法傳回值

throws yii\base\UnknownMethodException

當呼叫未知方法時

                public function __call($name, $params)
{
    $this->ensureBehaviors();
    foreach ($this->_behaviors as $object) {
        if ($object->hasMethod($name)) {
            return call_user_func_array([$object, $name], $params);
        }
    }
    throw new UnknownMethodException('Calling unknown method: ' . get_class($this) . "::$name()");
}

            
__clone() public method

Defined in: yii\base\Component::__clone()

在通過複製現有物件建立物件後,會呼叫此方法。

它會移除所有行為,因為它們附加到舊物件。

public void __clone ( )

                public function __clone()
{
    $this->_events = [];
    $this->_eventWildcards = [];
    $this->_behaviors = null;
}

            
__construct() public method

Defined in: yii\base\BaseObject::__construct()

建構子。

預設實作執行兩件事

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

如果在子類別中覆寫此方法,建議

  • 建構子的最後一個參數是組態陣列,如這裡的 $config
  • 在建構子的結尾呼叫父級實作。
public void __construct ( $config = [] )
$config array

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

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

            
__get() public method

Defined in: yii\base\Component::__get()

傳回組件屬性的值。

此方法將依以下順序檢查並相應地執行操作

  • 由 getter 定義的屬性:傳回 getter 結果
  • 行為的屬性:傳回行為屬性值

請勿直接呼叫此方法,因為它是 PHP 魔術方法,將在執行 $value = $component->property; 時隱式呼叫。

另請參閱 __set()

public mixed __get ( $name )
$name string

屬性名稱

return mixed

屬性值或行為的屬性值

throws yii\base\UnknownPropertyException

如果未定義屬性

throws yii\base\InvalidCallException

如果屬性為唯寫。

                public function __get($name)
{
    $getter = 'get' . $name;
    if (method_exists($this, $getter)) {
        // read property, e.g. getName()
        return $this->$getter();
    }
    // behavior property
    $this->ensureBehaviors();
    foreach ($this->_behaviors as $behavior) {
        if ($behavior->canGetProperty($name)) {
            return $behavior->$name;
        }
    }
    if (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() public method

Defined in: yii\base\Component::__isset()

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

此方法將依以下順序檢查並相應地執行操作

  • 由 setter 定義的屬性:傳回屬性是否已設定
  • 行為的屬性:傳回屬性是否已設定
  • 對於不存在的屬性,傳回 false

請勿直接呼叫此方法,因為它是 PHP 魔術方法,將在執行 isset($component->property) 時隱式呼叫。

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

public boolean __isset ( $name )
$name string

屬性名稱或事件名稱

return boolean

具名屬性是否已設定

                public function __isset($name)
{
    $getter = 'get' . $name;
    if (method_exists($this, $getter)) {
        return $this->$getter() !== null;
    }
    // behavior property
    $this->ensureBehaviors();
    foreach ($this->_behaviors as $behavior) {
        if ($behavior->canGetProperty($name)) {
            return $behavior->$name !== null;
        }
    }
    return false;
}

            
__set() public method

Defined in: yii\base\Component::__set()

設定組件屬性的值。

此方法將依以下順序檢查並相應地執行操作

  • 由 setter 定義的屬性:設定屬性值
  • 格式為 "on xyz" 的事件:將處理常式附加到事件 "xyz"
  • 格式為 "as xyz" 的行為:附加名為 "xyz" 的行為
  • 行為的屬性:設定行為屬性值

請勿直接呼叫此方法,因為它是 PHP 魔術方法,將在執行 $component->property = $value; 時隱式呼叫。

另請參閱 __get()

public void __set ( $name, $value )
$name string

屬性名稱或事件名稱

$value mixed

屬性值

throws yii\base\UnknownPropertyException

如果未定義屬性

throws yii\base\InvalidCallException

如果屬性為唯讀。

                public function __set($name, $value)
{
    $setter = 'set' . $name;
    if (method_exists($this, $setter)) {
        // set property
        $this->$setter($value);
        return;
    } elseif (strncmp($name, 'on ', 3) === 0) {
        // on event: attach event handler
        $this->on(trim(substr($name, 3)), $value);
        return;
    } elseif (strncmp($name, 'as ', 3) === 0) {
        // as behavior: attach behavior
        $name = trim(substr($name, 3));
        $this->attachBehavior($name, $value instanceof Behavior ? $value : Yii::createObject($value));
        return;
    }
    // behavior property
    $this->ensureBehaviors();
    foreach ($this->_behaviors as $behavior) {
        if ($behavior->canSetProperty($name)) {
            $behavior->$name = $value;
            return;
        }
    }
    if (method_exists($this, 'get' . $name)) {
        throw new InvalidCallException('Setting read-only property: ' . get_class($this) . '::' . $name);
    }
    throw new UnknownPropertyException('Setting unknown property: ' . get_class($this) . '::' . $name);
}

            
__unset() public method

Defined in: yii\base\Component::__unset()

將組件屬性設定為 null。

此方法將依以下順序檢查並相應地執行操作

  • 由 setter 定義的屬性:將屬性值設定為 null
  • 行為的屬性:將屬性值設定為 null

請勿直接呼叫此方法,因為它是 PHP 魔術方法,將在執行 unset($component->property) 時隱式呼叫。

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

public void __unset ( $name )
$name string

屬性名稱

throws yii\base\InvalidCallException

如果屬性為唯讀。

                public function __unset($name)
{
    $setter = 'set' . $name;
    if (method_exists($this, $setter)) {
        $this->$setter(null);
        return;
    }
    // behavior property
    $this->ensureBehaviors();
    foreach ($this->_behaviors as $behavior) {
        if ($behavior->canSetProperty($name)) {
            $behavior->$name = null;
            return;
        }
    }
    throw new InvalidCallException('Unsetting an unknown or read-only property: ' . get_class($this) . '::' . $name);
}

            
addPaginationHeaders() protected method

將關於分頁的 HTTP 標頭新增至回應。

protected void addPaginationHeaders ( $pagination )
$pagination yii\data\Pagination

                protected function addPaginationHeaders($pagination)
{
    $links = [];
    foreach ($pagination->getLinks(true) as $rel => $url) {
        $links[] = "<$url>; rel=$rel";
    }
    $this->response->getHeaders()
        ->set($this->totalCountHeader, $pagination->totalCount)
        ->set($this->pageCountHeader, $pagination->getPageCount())
        ->set($this->currentPageHeader, $pagination->getPage() + 1)
        ->set($this->perPageHeader, $pagination->pageSize)
        ->set('Link', implode(', ', $links));
}

            
attachBehavior() public method

Defined in: yii\base\Component::attachBehavior()

將行為附加到此組件。

此方法將根據給定的組態建立行為物件。之後,將通過呼叫 yii\base\Behavior::attach() 方法將行為物件附加到此組件。

另請參閱 detachBehavior()

public yii\base\Behavior attachBehavior ( $name, $behavior )
$name string

行為的名稱。

$behavior string|array|yii\base\Behavior

行為組態。這可以是以下之一

return yii\base\Behavior

行為物件

                public function attachBehavior($name, $behavior)
{
    $this->ensureBehaviors();
    return $this->attachBehaviorInternal($name, $behavior);
}

            
attachBehaviors() public method

Defined in: yii\base\Component::attachBehaviors()

將行為列表附加到組件。

每個行為都由其名稱索引,並且應為 yii\base\Behavior 物件、指定行為類別的字串或用於建立行為的組態陣列。

另請參閱 attachBehavior()

public void attachBehaviors ( $behaviors )
$behaviors array

要附加到組件的行為列表

                public function attachBehaviors($behaviors)
{
    $this->ensureBehaviors();
    foreach ($behaviors as $name => $behavior) {
        $this->attachBehaviorInternal($name, $behavior);
    }
}

            
behaviors() public method

Defined in: yii\base\Component::behaviors()

傳回此組件應表現為的行為列表。

子類別可以覆寫此方法,以指定它們想要表現為的行為。

此方法的傳回值應為行為物件或組態的陣列,並由行為名稱索引。行為組態可以是指定行為類別的字串,也可以是以下結構的陣列

'behaviorName' => [
    'class' => 'BehaviorClass',
    'property1' => 'value1',
    'property2' => 'value2',
]

請注意,行為類別必須從 yii\base\Behavior 擴展。可以使用名稱或匿名方式附加行為。當名稱用作陣列鍵時,使用此名稱,稍後可以使用 getBehavior() 檢索行為,或使用 detachBehavior() 分離行為。匿名行為無法檢索或分離。

在此方法中宣告的行為將自動(按需)附加到組件。

public array behaviors ( )
return array

行為組態。

                public function behaviors()
{
    return [];
}

            
canGetProperty() public method

Defined in: yii\base\Component::canGetProperty()

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

如果滿足以下條件,則可以讀取屬性

  • 類別具有與指定名稱關聯的 getter 方法(在這種情況下,屬性名稱不區分大小寫);
  • 類別具有具有指定名稱的成員變數(當 $checkVars 為 true 時);
  • 附加的行為具有給定名稱的可讀屬性(當 $checkBehaviors 為 true 時)。

另請參閱 canSetProperty()

public boolean canGetProperty ( $name, $checkVars true, $checkBehaviors true )
$name string

屬性名稱

$checkVars boolean

是否將成員變數視為屬性

$checkBehaviors boolean

是否將行為的屬性視為此組件的屬性

return boolean

屬性是否可以讀取

                public function canGetProperty($name, $checkVars = true, $checkBehaviors = true)
{
    if (method_exists($this, 'get' . $name) || $checkVars && property_exists($this, $name)) {
        return true;
    } elseif ($checkBehaviors) {
        $this->ensureBehaviors();
        foreach ($this->_behaviors as $behavior) {
            if ($behavior->canGetProperty($name, $checkVars)) {
                return true;
            }
        }
    }
    return false;
}

            
canSetProperty() public method

Defined in: yii\base\Component::canSetProperty()

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

如果滿足以下條件,則可以寫入屬性

  • 類別具有與指定名稱關聯的 setter 方法(在這種情況下,屬性名稱不區分大小寫);
  • 類別具有具有指定名稱的成員變數(當 $checkVars 為 true 時);
  • 附加的行為具有給定名稱的可寫屬性(當 $checkBehaviors 為 true 時)。

另請參閱 canGetProperty()

public boolean canSetProperty ( $name, $checkVars true, $checkBehaviors true )
$name string

屬性名稱

$checkVars boolean

是否將成員變數視為屬性

$checkBehaviors boolean

是否將行為的屬性視為此組件的屬性

return boolean

屬性是否可以寫入

                public function canSetProperty($name, $checkVars = true, $checkBehaviors = true)
{
    if (method_exists($this, 'set' . $name) || $checkVars && property_exists($this, $name)) {
        return true;
    } elseif ($checkBehaviors) {
        $this->ensureBehaviors();
        foreach ($this->_behaviors as $behavior) {
            if ($behavior->canSetProperty($name, $checkVars)) {
                return true;
            }
        }
    }
    return false;
}

            
className() public static method
自 2.0.14 版本起已棄用。在 PHP >=5.5 上,請改用 ::class

Defined in: yii\base\BaseObject::className()

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

public static string className ( )
return string

此類別的完整限定名稱。

                public static function className()
{
    return get_called_class();
}

            
detachBehavior() public method

定義於: yii\base\Component::detachBehavior()

從組件分離行為。

行為的 yii\base\Behavior::detach() 方法將會被調用。

public yii\base\Behavior|null detachBehavior ( $name )
$name string

行為的名稱。

return yii\base\Behavior|null

已分離的行為。如果行為不存在則為 Null。

                public function detachBehavior($name)
{
    $this->ensureBehaviors();
    if (isset($this->_behaviors[$name])) {
        $behavior = $this->_behaviors[$name];
        unset($this->_behaviors[$name]);
        $behavior->detach();
        return $behavior;
    }
    return null;
}

            
detachBehaviors() public method

定義於: yii\base\Component::detachBehaviors()

從組件分離所有行為。

public void detachBehaviors ( )

                public function detachBehaviors()
{
    $this->ensureBehaviors();
    foreach ($this->_behaviors as $name => $behavior) {
        $this->detachBehavior($name);
    }
}

            
ensureBehaviors() public method

定義於: yii\base\Component::ensureBehaviors()

確保在 behaviors() 中宣告的行為已附加到此組件。

public void ensureBehaviors ( )

                public function ensureBehaviors()
{
    if ($this->_behaviors === null) {
        $this->_behaviors = [];
        foreach ($this->behaviors() as $name => $behavior) {
            $this->attachBehaviorInternal($name, $behavior);
        }
    }
}

            
getBehavior() public method

定義於: yii\base\Component::getBehavior()

傳回具名的行為物件。

public yii\base\Behavior|null getBehavior ( $name )
$name string

行為名稱

return yii\base\Behavior|null

行為物件,如果行為不存在則為 null

                public function getBehavior($name)
{
    $this->ensureBehaviors();
    return isset($this->_behaviors[$name]) ? $this->_behaviors[$name] : null;
}

            
getBehaviors() public method

定義於: yii\base\Component::getBehaviors()

傳回附加到此組件的所有行為。

public yii\base\Behavior[] getBehaviors ( )
return yii\base\Behavior[]

附加到此元件的行為列表

                public function getBehaviors()
{
    $this->ensureBehaviors();
    return $this->_behaviors;
}

            
getRequestedFields() protected method
protected array getRequestedFields ( )
return array

請求欄位的名稱。第一個元素是代表請求的預設欄位列表的陣列,而第二個元素是除了預設欄位之外請求的額外欄位陣列。

                protected function getRequestedFields()
{
    $fields = $this->request->get($this->fieldsParam);
    $expand = $this->request->get($this->expandParam);
    return [
        is_string($fields) ? preg_split('/\s*,\s*/', $fields, -1, PREG_SPLIT_NO_EMPTY) : [],
        is_string($expand) ? preg_split('/\s*,\s*/', $expand, -1, PREG_SPLIT_NO_EMPTY) : [],
    ];
}

            
hasEventHandlers() public method

定義於: yii\base\Component::hasEventHandlers()

傳回一個值,指示是否有名為事件附加任何處理常式。

public boolean hasEventHandlers ( $name )
$name string

事件名稱

return boolean

是否有任何處理器附加到事件。

                public function hasEventHandlers($name)
{
    $this->ensureBehaviors();
    if (!empty($this->_events[$name])) {
        return true;
    }
    foreach ($this->_eventWildcards as $wildcard => $handlers) {
        if (!empty($handlers) && StringHelper::matchWildcard($wildcard, $name)) {
            return true;
        }
    }
    return Event::hasHandlers($this, $name);
}

            
hasMethod() public method

定義於: yii\base\Component::hasMethod()

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

如果符合以下條件,則定義方法

  • 類別具有指定名稱的方法
  • 附加的行為具有給定名稱的方法 (當 $checkBehaviors 為 true 時)。
public boolean hasMethod ( $name, $checkBehaviors true )
$name string

屬性名稱

$checkBehaviors boolean

是否將行為的方法視為此元件的方法

return boolean

方法是否已定義

                public function hasMethod($name, $checkBehaviors = true)
{
    if (method_exists($this, $name)) {
        return true;
    } elseif ($checkBehaviors) {
        $this->ensureBehaviors();
        foreach ($this->_behaviors as $behavior) {
            if ($behavior->hasMethod($name)) {
                return true;
            }
        }
    }
    return false;
}

            
hasProperty() public method

定義於: yii\base\Component::hasProperty()

傳回一個值,指示是否為此組件定義了屬性。

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

  • 類別具有與指定名稱關聯的 getter 或 setter 方法 (在這種情況下,屬性名稱不區分大小寫);
  • 類別具有具有指定名稱的成員變數(當 $checkVars 為 true 時);
  • 附加的行為具有給定名稱的屬性 (當 $checkBehaviors 為 true 時)。

另請參閱

public boolean hasProperty ( $name, $checkVars true, $checkBehaviors true )
$name string

屬性名稱

$checkVars boolean

是否將成員變數視為屬性

$checkBehaviors boolean

是否將行為的屬性視為此組件的屬性

return boolean

屬性是否已定義

                public function hasProperty($name, $checkVars = true, $checkBehaviors = true)
{
    return $this->canGetProperty($name, $checkVars, $checkBehaviors) || $this->canSetProperty($name, false, $checkBehaviors);
}

            
init() public method

初始化物件。

在物件使用給定配置初始化後,此方法會在建構函式的結尾被調用。

public void init ( )

                public function init()
{
    if ($this->request === null) {
        $this->request = Yii::$app->getRequest();
    }
    if ($this->response === null) {
        $this->response = Yii::$app->getResponse();
    }
}

            
off() public method

定義於: yii\base\Component::off()

從此組件分離現有的事件處理常式。

此方法與 on() 相反。

注意:如果為事件名稱傳遞了萬用字元模式,則只會移除使用此萬用字元註冊的處理器,而使用與此萬用字元匹配的純名稱註冊的處理器將會保留。

另請參閱 on()

public boolean off ( $name, $handler null )
$name string

事件名稱

$handler callable|null

要移除的事件處理器。如果為 null,則會移除附加到命名事件的所有處理器。

return boolean

如果找到並分離處理器

                public function off($name, $handler = null)
{
    $this->ensureBehaviors();
    if (empty($this->_events[$name]) && empty($this->_eventWildcards[$name])) {
        return false;
    }
    if ($handler === null) {
        unset($this->_events[$name], $this->_eventWildcards[$name]);
        return true;
    }
    $removed = false;
    // plain event names
    if (isset($this->_events[$name])) {
        foreach ($this->_events[$name] as $i => $event) {
            if ($event[0] === $handler) {
                unset($this->_events[$name][$i]);
                $removed = true;
            }
        }
        if ($removed) {
            $this->_events[$name] = array_values($this->_events[$name]);
            return true;
        }
    }
    // wildcard event names
    if (isset($this->_eventWildcards[$name])) {
        foreach ($this->_eventWildcards[$name] as $i => $event) {
            if ($event[0] === $handler) {
                unset($this->_eventWildcards[$name][$i]);
                $removed = true;
            }
        }
        if ($removed) {
            $this->_eventWildcards[$name] = array_values($this->_eventWildcards[$name]);
            // remove empty wildcards to save future redundant regex checks:
            if (empty($this->_eventWildcards[$name])) {
                unset($this->_eventWildcards[$name]);
            }
        }
    }
    return $removed;
}

            
on() public method

定義於: yii\base\Component::on()

將事件處理常式附加到事件。

事件處理器必須是有效的 PHP 回呼。以下是一些範例

function ($event) { ... }         // anonymous function
[$object, 'handleClick']          // $object->handleClick()
['Page', 'handleClick']           // Page::handleClick()
'handleClick'                     // global function handleClick()

事件處理器必須使用以下簽章定義,

function ($event)

其中 $event 是一個 yii\base\Event 物件,其中包含與事件關聯的參數。

自 2.0.14 版起,您可以將事件名稱指定為萬用字元模式

$component->on('event.group.*', function ($event) {
    Yii::trace($event->name . ' is triggered.');
});

另請參閱 off()

public void on ( $name, $handler, $data null, $append true )
$name string

事件名稱

$handler 可呼叫

事件處理器

$data mixed

當事件被觸發時要傳遞給事件處理器的資料。當事件處理器被調用時,可以透過 yii\base\Event::$data 存取此資料。

$append boolean

是否將新的事件處理器附加到現有處理器列表的末尾。如果為 false,則新的處理器將插入到現有處理器列表的開頭。

                public function on($name, $handler, $data = null, $append = true)
{
    $this->ensureBehaviors();
    if (strpos($name, '*') !== false) {
        if ($append || empty($this->_eventWildcards[$name])) {
            $this->_eventWildcards[$name][] = [$handler, $data];
        } else {
            array_unshift($this->_eventWildcards[$name], [$handler, $data]);
        }
        return;
    }
    if ($append || empty($this->_events[$name])) {
        $this->_events[$name][] = [$handler, $data];
    } else {
        array_unshift($this->_events[$name], [$handler, $data]);
    }
}

            
serialize() public method

將給定的資料序列化為可以輕鬆轉換為其他格式的格式。

此方法主要將可識別類型的物件轉換為陣列表示形式。它不會對未知物件類型或非物件資料進行轉換。預設實作將處理 yii\base\Modelyii\data\DataProviderInterface\JsonSerializable。您可以覆寫此方法以支援更多物件類型。

public mixed serialize ( $data )
$data mixed

要序列化的資料。

return mixed

轉換後的資料。

                public function serialize($data)
{
    if ($data instanceof Model && $data->hasErrors()) {
        return $this->serializeModelErrors($data);
    } elseif ($data instanceof Arrayable) {
        return $this->serializeModel($data);
    } elseif ($data instanceof \JsonSerializable) {
        return $data->jsonSerialize();
    } elseif ($data instanceof DataProviderInterface) {
        return $this->serializeDataProvider($data);
    } elseif (is_array($data)) {
        $serializedArray = [];
        foreach ($data as $key => $value) {
            $serializedArray[$key] = $this->serialize($value);
        }
        return $serializedArray;
    }
    return $data;
}

            
serializeDataProvider() protected method

序列化資料提供器。

protected array serializeDataProvider ( $dataProvider )
$dataProvider yii\data\DataProviderInterface
return array

資料提供者的陣列表示形式。

                protected function serializeDataProvider($dataProvider)
{
    if (($pagination = $dataProvider->getPagination()) !== false) {
        $this->addPaginationHeaders($pagination);
    }
    if ($this->request->getIsHead()) {
        return null;
    }
    if ($this->preserveKeys) {
        $models = $dataProvider->getModels();
    } else {
        $models = array_values($dataProvider->getModels());
    }
    $models = $this->serializeModels($models);
    if ($this->collectionEnvelope === null) {
        return $models;
    }
    $result = [
        $this->collectionEnvelope => $models,
    ];
    if ($pagination !== false) {
        return array_merge($result, $this->serializePagination($pagination));
    }
    return $result;
}

            
serializeModel() protected method

序列化模型物件。

protected array serializeModel ( $model )
$model yii\base\Arrayable
return array

模型的陣列表示形式

                protected function serializeModel($model)
{
    if ($this->request->getIsHead()) {
        return null;
    }
    list($fields, $expand) = $this->getRequestedFields();
    return $model->toArray($fields, $expand);
}

            
serializeModelErrors() protected method

序列化模型中的驗證錯誤。

protected array serializeModelErrors ( $model )
$model yii\base\Model
return array

錯誤的陣列表示形式

                protected function serializeModelErrors($model)
{
    $this->response->setStatusCode(422, 'Data Validation Failed.');
    $result = [];
    foreach ($model->getFirstErrors() as $name => $message) {
        $result[] = [
            'field' => $name,
            'message' => $message,
        ];
    }
    return $result;
}

            
serializeModels() protected method

序列化一組模型。

protected array serializeModels ( array $models )
$models array
return array

模型的陣列表示形式

                protected function serializeModels(array $models)
{
    foreach ($models as $i => $model) {
        if ($model instanceof Arrayable) {
            $models[$i] = $this->serializeModel($model);
        } elseif (is_array($model)) {
            $models[$i] = ArrayHelper::toArray($model);
        }
    }
    return $models;
}

            
serializePagination() protected method

將分頁序列化為陣列。

另請參閱 addPaginationHeaders()

protected array serializePagination ( $pagination )
$pagination yii\data\Pagination
return array

分頁的陣列表示形式

                protected function serializePagination($pagination)
{
    return [
        $this->linksEnvelope => Link::serialize($pagination->getLinks(true)),
        $this->metaEnvelope => [
            'totalCount' => $pagination->totalCount,
            'pageCount' => $pagination->getPageCount(),
            'currentPage' => $pagination->getPage() + 1,
            'perPage' => $pagination->getPageSize(),
        ],
    ];
}

            
trigger() public method

定義於: yii\base\Component::trigger()

觸發事件。

此方法表示事件的發生。它會調用事件的所有附加處理器,包括類別層級的處理器。

public void trigger ( $name, yii\base\Event $event null )
$name string

事件名稱

$event yii\base\Event|null

事件實例。如果未設定,將會建立預設的 yii\base\Event 物件。

                public function trigger($name, Event $event = null)
{
    $this->ensureBehaviors();
    $eventHandlers = [];
    foreach ($this->_eventWildcards as $wildcard => $handlers) {
        if (StringHelper::matchWildcard($wildcard, $name)) {
            $eventHandlers[] = $handlers;
        }
    }
    if (!empty($this->_events[$name])) {
        $eventHandlers[] = $this->_events[$name];
    }
    if (!empty($eventHandlers)) {
        $eventHandlers = call_user_func_array('array_merge', $eventHandlers);
        if ($event === null) {
            $event = new Event();
        }
        if ($event->sender === null) {
            $event->sender = $this;
        }
        $event->handled = false;
        $event->name = $name;
        foreach ($eventHandlers as $handler) {
            $event->data = $handler[1];
            call_user_func($handler[0], $event);
            // stop further handling if the event is handled
            if ($event->handled) {
                return;
            }
        }
    }
    // invoke class-level attached handlers
    Event::trigger($this, $name, $event);
}