0 追蹤者

Class yii\validators\FileValidator

繼承關係yii\validators\FileValidator » yii\validators\Validator » yii\base\Component » yii\base\BaseObject
實作介面yii\base\Configurable
子類別yii\validators\ImageValidator
自版本起可用2.0
原始碼 https://github.com/yiisoft/yii2/blob/master/framework/validators/FileValidator.php

FileValidator 驗證屬性是否接收到有效的上傳檔案。

請注意,您應該啟用 fileinfo PHP 擴展。

公開屬性

隱藏繼承的屬性

屬性 類型 描述 定義於
$attributeNames array 屬性名稱。 yii\validators\Validator
$attributes array|string 此驗證器要驗證的屬性。 yii\validators\Validator
$behaviors yii\base\Behavior[] 附加到此組件的行為列表。 yii\base\Component
$builtInValidators array 內建驗證器列表 (名稱 => 類別或配置) yii\validators\Validator
$checkExtensionByMimeType boolean 是否使用 mime-type 檢查檔案類型 (副檔名)。 yii\validators\FileValidator
$enableClientValidation boolean 是否为此验证器启用客户端验证。 yii\validators\Validator
$except array|string 驗證器不應應用於的場景。 yii\validators\Validator
$extensions array|string|null 允許上傳的檔案名稱副檔名列表。 yii\validators\FileValidator
$isEmpty callable|null 一個 PHP 可調用物件,用於替換 isEmpty() 的預設實作。 yii\validators\Validator
$maxFiles integer 給定屬性可以容納的最大檔案計數。 yii\validators\FileValidator
$maxSize integer|null 上傳檔案所需的最大位元組數。 yii\validators\FileValidator
$message string 當檔案未正確上傳時使用的錯誤訊息。 yii\validators\FileValidator
$mimeTypes array|string|null 允許上傳的檔案 MIME 類型列表。 yii\validators\FileValidator
$minFiles integer 給定屬性可以容納的最小檔案計數。 yii\validators\FileValidator
$minSize integer|null 上傳檔案所需的最小位元組數。 yii\validators\FileValidator
$on array|string 驗證器可以應用於的場景。 yii\validators\Validator
$sizeLimit integer 上傳檔案的大小限制。 yii\validators\FileValidator
$skipOnEmpty boolean 如果屬性值為 null 或空字串,是否應跳過此驗證規則。 yii\validators\Validator
$skipOnError boolean 如果根據先前的規則,要驗證的屬性已經存在一些驗證錯誤,是否應跳過此驗證規則。 yii\validators\Validator
$tooBig string 當上傳的檔案太大時使用的錯誤訊息。 yii\validators\FileValidator
$tooFew string 如果多個上傳的計數小於 minFiles 時使用的錯誤訊息。 yii\validators\FileValidator
$tooMany string 如果多個上傳的計數超過限制時使用的錯誤訊息。 yii\validators\FileValidator
$tooSmall string 當上傳的檔案太小時使用的錯誤訊息。 yii\validators\FileValidator
$uploadRequired string 當未上傳任何檔案時使用的錯誤訊息。 yii\validators\FileValidator
$validationAttributes array|null 屬性名稱列表。 yii\validators\Validator
$when callable|null 一個 PHP 可調用物件,其返回值決定是否應應用此驗證器。 yii\validators\Validator
$whenClient string|null 一個 JavaScript 函數名稱,其返回值決定是否應在客戶端應用此驗證器。 yii\validators\Validator
$wrongExtension string 當上傳檔案的副檔名未在 $extensions 中列出時使用的錯誤訊息。 yii\validators\FileValidator
$wrongMimeType string 當檔案的 MIME 類型不被 $mimeTypes 屬性允許時,所使用的錯誤訊息。 yii\validators\FileValidator

Public Methods

Hide inherited methods

Method 描述 定義於
__call() 呼叫未定義為類別方法的具名方法。 yii\base\Component
__clone() 當透過複製現有物件建立物件後,會呼叫此方法。 yii\base\Component
__construct() 建構子。 yii\base\BaseObject
__get() 傳回組件屬性的值。 yii\base\Component
__isset() 檢查屬性是否已設定,即已定義且非空值。 yii\base\Component
__set() 設定組件屬性的值。 yii\base\Component
__unset() 將組件屬性設定為空值。 yii\base\Component
addError() 將關於指定屬性的錯誤新增至模型物件。 yii\validators\Validator
attachBehavior() 將行為附加到此組件。 yii\base\Component
attachBehaviors() 將行為列表附加到此組件。 yii\base\Component
behaviors() 傳回此組件應表現為的行為列表。 yii\base\Component
canGetProperty() 傳回一個值,指示是否可以讀取屬性。 yii\base\Component
canSetProperty() 傳回一個值,指示是否可以設定屬性。 yii\base\Component
className() 傳回此類別的完整限定名稱。 yii\base\BaseObject
clientValidateAttribute() 傳回執行用戶端驗證所需的 JavaScript。 yii\validators\FileValidator
createValidator() 建立驗證器物件。 yii\validators\Validator
detachBehavior() 從組件分離行為。 yii\base\Component
detachBehaviors() 從組件分離所有行為。 yii\base\Component
ensureBehaviors() 確保在 behaviors() 中宣告的行為已附加到此組件。 yii\base\Component
getAttributeNames() 傳回已清理的屬性名稱,不包含開頭的 ! 字元。 yii\validators\Validator
getBehavior() 傳回具名的行為物件。 yii\base\Component
getBehaviors() 傳回附加到此組件的所有行為。 yii\base\Component
getClientOptions() 傳回用戶端驗證選項。 yii\validators\FileValidator
getSizeLimit() 傳回允許上傳檔案的最大大小。 yii\validators\FileValidator
getValidationAttributes() 傳回此驗證器適用的屬性列表。 yii\validators\Validator
hasEventHandlers() 傳回一個值,指示是否有名稱事件附加任何處理常式。 yii\base\Component
hasMethod() 傳回一個值,指示是否已定義方法。 yii\base\Component
hasProperty() 傳回一個值,指示是否為此組件定義了屬性。 yii\base\Component
init() 初始化物件。 yii\validators\FileValidator
isActive() 傳回一個值,指示驗證器是否對給定的情境和屬性處於活動狀態。 yii\validators\Validator
isEmpty() 檢查給定的值是否為空。 yii\validators\FileValidator
off() 從此組件分離現有的事件處理常式。 yii\base\Component
on() 將事件處理常式附加到事件。 yii\base\Component
trigger() 觸發事件。 yii\base\Component
validate() 驗證給定的值。 yii\validators\Validator
validateAttribute() 驗證單一屬性。 yii\validators\FileValidator
validateAttributes() 驗證指定的物件。 yii\validators\Validator

Protected Methods

Hide inherited methods

Method 描述 定義於
formatMessage() 如果 \Yii::$app 不可用,則使用 I18N 格式化訊息,或使用簡單的 strtr。 yii\validators\Validator
getMimeTypeByFile() 依檔案路徑取得 MIME 類型 yii\validators\FileValidator
validateExtension() 根據目前的驗證器設定,檢查給定的上傳檔案是否具有正確的類型 (副檔名)。 yii\validators\FileValidator
validateMimeType() 根據 $mimeTypes 屬性中的列表檢查 $file 的 mimeType。 yii\validators\FileValidator
validateValue() 驗證值。 yii\validators\FileValidator

Property Details

隱藏繼承的屬性

$checkExtensionByMimeType public property

是否使用 mime-type 檢查檔案類型 (副檔名)。如果檔案 mime-type 檢查產生的副檔名與上傳檔案的副檔名不同,則該檔案將被視為無效。

$extensions public property

允許上傳的檔案名稱副檔名列表。這可以是陣列或字串,字串由空格或逗號分隔的檔案副檔名名稱組成 (例如 "gif, jpg")。副檔名名稱不區分大小寫。預設為 null,表示允許所有檔案名稱副檔名。

另請參閱 $wrongExtension 以取得錯誤檔案類型的自訂訊息。

public array|string|null $extensions null
$maxFiles public property

給定屬性可以容納的最大檔案計數。預設為 1,表示單一檔案上傳。透過定義較高的數字,可以進行多次上傳。將其設定為 0 表示同時上傳的檔案數量沒有限制。

注意:同時允許上傳的最大檔案數量也受限於 PHP 指令 max_file_uploads,預設值為 20。

另請參閱

public integer $maxFiles 1
$maxSize public property

上傳檔案所需的最大位元組數。預設為 null,表示沒有限制。請注意,大小限制也受 upload_max_filesizepost_max_size INI 設定以及 'MAX_FILE_SIZE' 隱藏欄位值影響。請參閱 getSizeLimit() 以取得詳細資訊。

另請參閱

public integer|null $maxSize null
$message public property

當檔案未正確上傳時使用的錯誤訊息。

public string $message null
$mimeTypes public property

允許上傳的檔案 MIME 類型列表。這可以是陣列或字串,字串由空格或逗號分隔的檔案 MIME 類型組成 (例如 "text/plain, image/png")。具有特殊字元 * 的遮罩可用於比對 MIME 類型群組。例如,image/* 將通過所有以 image/ 開頭的 MIME 類型 (例如 image/jpegimage/png)。MIME 類型名稱不區分大小寫。預設為 null,表示允許所有 MIME 類型。

另請參閱 $wrongMimeType 以取得錯誤 MIME 類型的自訂訊息。

public array|string|null $mimeTypes null
$minFiles public property (自版本 2.0.14 起可用)

給定屬性可以容納的最小檔案計數。預設為 0。較高的值表示至少應上傳該數量的檔案。

另請參閱 $tooFew 以取得上傳檔案過少時的自訂訊息。

public integer $minFiles 0
$minSize public property

上傳檔案所需的最小位元組數。預設為 null,表示沒有限制。

另請參閱 $tooSmall 以取得檔案過小時的自訂訊息。

public integer|null $minSize null
$sizeLimit public property

上傳檔案的大小限制。

public integer $sizeLimit null
$tooBig public property

當上傳檔案過大時所使用的錯誤訊息。您可以在訊息中使用以下符記

  • {attribute}: 屬性名稱
  • {file}: 上傳的檔案名稱
  • {limit}: 允許的最大大小 (請參閱 getSizeLimit())
  • {formattedLimit}: 使用 Formatter::asShortSize() 格式化的最大大小
public string $tooBig null
$tooFew public property (自版本 2.0.14 起可用)

當多次上傳的計數少於 minFiles 時所使用的錯誤訊息。您可以在訊息中使用以下符記

  • {attribute}: 屬性名稱
  • {limit}: $minFiles 的值
public string $tooFew null
$tooMany public property

當多次上傳的計數超過限制時所使用的錯誤訊息。您可以在訊息中使用以下符記

  • {attribute}: 屬性名稱
  • {limit}: $maxFiles 的值
public string $tooMany null
$tooSmall public property

當上傳檔案過小時所使用的錯誤訊息。您可以在訊息中使用以下符記

  • {attribute}: 屬性名稱
  • {file}: 上傳的檔案名稱
  • {limit}: $minSize 的值
  • {formattedLimit}: 使用 [[\yii\i18n\Formatter::asShortSize()|Formatter::asShortSize()] 格式化的 $minSize
public string $tooSmall null
$uploadRequired public property

當未上傳任何檔案時所使用的錯誤訊息。請注意,這是驗證錯誤訊息的文字。若要使上傳檔案成為必要,您必須將 $skipOnEmpty 設定為 false

public string $uploadRequired null
$wrongExtension public property

當上傳檔案的副檔名未列在 $extensions 中時所使用的錯誤訊息。您可以在訊息中使用以下符記

  • {attribute}: 屬性名稱
  • {file}: 上傳的檔案名稱
  • {extensions}: 允許的副檔名列表。
public string $wrongExtension null
$wrongMimeType public property

當檔案的 MIME 類型不被 $mimeTypes 屬性允許時,所使用的錯誤訊息。您可以在訊息中使用以下符記

  • {attribute}: 屬性名稱
  • {file}: 上傳的檔案名稱
  • {mimeTypes}: $mimeTypes 的值
public string $wrongMimeType null

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()

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

此方法將依以下順序檢查並採取相應措施

  • 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()

將組件屬性設定為空值。

此方法將依以下順序檢查並採取相應措施

  • 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);
}

            
addError() public method

Defined in: yii\validators\Validator::addError()

將關於指定屬性的錯誤新增至模型物件。

這是一個輔助方法,用於執行訊息選擇和國際化。

public void addError ( $model, $attribute, $message, $params = [] )
$model yii\base\Model

正在驗證的資料模型

$attribute string

正在驗證的屬性

$message string

錯誤訊息

$params array

錯誤訊息中佔位符的值

                public function addError($model, $attribute, $message, $params = [])
{
    $params['attribute'] = $model->getAttributeLabel($attribute);
    if (!isset($params['value'])) {
        $value = $model->$attribute;
        if (is_array($value)) {
            $params['value'] = 'array()';
        } elseif (is_object($value) && !method_exists($value, '__toString')) {
            $params['value'] = '(object)';
        } else {
            $params['value'] = $value;
        }
    }
    $model->addError($attribute, $this->formatMessage($message, $params));
}

            
attachBehavior() public method

定義於: 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

定義於: 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

定義於: 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

定義於: 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

定義於: 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

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

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

public static string className ( )
return string

此類別的完整限定名稱。

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

            
clientValidateAttribute() public method

傳回執行用戶端驗證所需的 JavaScript。

呼叫 getClientOptions() 以產生用於用戶端驗證的選項陣列。

您可以覆寫此方法以傳回 JavaScript 驗證程式碼,如果驗證器可以支援用戶端驗證。

以下 JavaScript 變數是預先定義的,可以在驗證程式碼中使用

  • attribute:一個描述正在驗證的屬性的物件。
  • value:正在驗證的值。
  • messages:一個用於保存屬性的驗證錯誤訊息的陣列。
  • deferred:一個用於保存非同步驗證的延遲物件的陣列
  • $form:一個包含表單元素的 jQuery 物件

attribute 物件包含以下屬性

  • id:表單中識別屬性的唯一 ID(例如 "loginform-username")
  • name:屬性名稱或表達式(例如表格輸入的 "[0]content")
  • container:輸入欄位容器的 jQuery 選擇器
  • input:表單上下文中輸入欄位的 jQuery 選擇器
  • error:容器上下文中錯誤標籤的 jQuery 選擇器
  • status:輸入欄位的狀態,0:空,之前未輸入,1:已驗證,2:等待驗證,3:正在驗證
public string|null clientValidateAttribute ( $model, $attribute, $view )
$model yii\base\Model

正在驗證的資料模型

$attribute string

要驗證的屬性名稱。

$view yii\web\View

將用於呈現視圖或包含應用此驗證器的模型表單的視圖檔案的視圖物件。

return string|null

用戶端驗證腳本。如果驗證器不支援用戶端驗證,則為 Null。

                public function clientValidateAttribute($model, $attribute, $view)
{
    ValidationAsset::register($view);
    $options = $this->getClientOptions($model, $attribute);
    return 'yii.validation.file(attribute, messages, ' . Json::htmlEncode($options) . ');';
}

            
createValidator() public static method

定義於: yii\validators\Validator::createValidator()

建立驗證器物件。

public static yii\validators\Validator createValidator ( $type, $model, $attributes, $params = [] )
$type string|Closure

驗證器類型。這可以是

  • $builtInValidators 中列出的內建驗證器名稱;
  • 模型類別的方法名稱;
  • 一個匿名函式;
  • 一個驗證器類別名稱。
$model yii\base\Model

要驗證的資料模型。

$attributes array|string

要驗證的屬性列表。這可以是屬性名稱的陣列或逗號分隔的屬性名稱字串。

$params array

要應用於驗證器屬性的初始值。

return yii\validators\Validator

驗證器

                public static function createValidator($type, $model, $attributes, $params = [])
{
    $params['attributes'] = $attributes;
    if ($type instanceof \Closure) {
        $params['class'] = __NAMESPACE__ . '\InlineValidator';
        $params['method'] = $type;
    } elseif (!isset(static::$builtInValidators[$type]) && $model->hasMethod($type)) {
        // method-based validator
        $params['class'] = __NAMESPACE__ . '\InlineValidator';
        $params['method'] = [$model, $type];
    } else {
        unset($params['current']);
        if (isset(static::$builtInValidators[$type])) {
            $type = static::$builtInValidators[$type];
        }
        if (is_array($type)) {
            $params = array_merge($type, $params);
        } else {
            $params['class'] = $type;
        }
    }
    return Yii::createObject($params);
}

            
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);
        }
    }
}

            
formatMessage() protected method (available since version 2.0.12)

定義於: yii\validators\Validator::formatMessage()

如果 \Yii::$app 不可用,則使用 I18N 格式化訊息,或使用簡單的 strtr。

protected string formatMessage ( $message, $params )
$message string
$params array

                protected function formatMessage($message, $params)
{
    if (Yii::$app !== null) {
        return \Yii::$app->getI18n()->format($message, $params, Yii::$app->language);
    }
    $placeholders = [];
    foreach ((array) $params as $name => $value) {
        $placeholders['{' . $name . '}'] = $value;
    }
    return ($placeholders === []) ? $message : strtr($message, $placeholders);
}

            
getAttributeNames() public method (available since version 2.0.12)

定義於: yii\validators\Validator::getAttributeNames()

傳回已清理的屬性名稱,不包含開頭的 ! 字元。

public array getAttributeNames ( )
return array

屬性名稱。

                public function getAttributeNames()
{
    return array_map(function ($attribute) {
        return ltrim($attribute, '!');
    }, $this->attributes);
}

            
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;
}

            
getClientOptions() public method (available since version 2.0.11)

傳回用戶端驗證選項。

此方法通常從 clientValidateAttribute() 呼叫。您可以覆寫此方法以修改將傳遞到用戶端驗證的選項。

public array getClientOptions ( $model, $attribute )
$model yii\base\Model

正在驗證的模型

$attribute string

正在驗證的屬性名稱

return array

用戶端驗證選項

                public function getClientOptions($model, $attribute)
{
    $label = $model->getAttributeLabel($attribute);
    $options = [];
    if ($this->message !== null) {
        $options['message'] = $this->formatMessage($this->message, [
            'attribute' => $label,
        ]);
    }
    $options['skipOnEmpty'] = $this->skipOnEmpty;
    if (!$this->skipOnEmpty) {
        $options['uploadRequired'] = $this->formatMessage($this->uploadRequired, [
            'attribute' => $label,
        ]);
    }
    if ($this->mimeTypes !== null) {
        $mimeTypes = [];
        foreach ($this->mimeTypes as $mimeType) {
            $mimeTypes[] = new JsExpression(Html::escapeJsRegularExpression($this->buildMimeTypeRegexp($mimeType)));
        }
        $options['mimeTypes'] = $mimeTypes;
        $options['wrongMimeType'] = $this->formatMessage($this->wrongMimeType, [
            'attribute' => $label,
            'mimeTypes' => implode(', ', $this->mimeTypes),
        ]);
    }
    if ($this->extensions !== null) {
        $options['extensions'] = $this->extensions;
        $options['wrongExtension'] = $this->formatMessage($this->wrongExtension, [
            'attribute' => $label,
            'extensions' => implode(', ', $this->extensions),
        ]);
    }
    if ($this->minSize !== null) {
        $options['minSize'] = $this->minSize;
        $options['tooSmall'] = $this->formatMessage($this->tooSmall, [
            'attribute' => $label,
            'limit' => $this->minSize,
            'formattedLimit' => Yii::$app->formatter->asShortSize($this->minSize),
        ]);
    }
    if ($this->maxSize !== null) {
        $options['maxSize'] = $this->maxSize;
        $options['tooBig'] = $this->formatMessage($this->tooBig, [
            'attribute' => $label,
            'limit' => $this->getSizeLimit(),
            'formattedLimit' => Yii::$app->formatter->asShortSize($this->getSizeLimit()),
        ]);
    }
    if ($this->maxFiles !== null) {
        $options['maxFiles'] = $this->maxFiles;
        $options['tooMany'] = $this->formatMessage($this->tooMany, [
            'attribute' => $label,
            'limit' => $this->maxFiles,
        ]);
    }
    return $options;
}

            
getMimeTypeByFile() protected method (available since version 2.0.26)

依檔案路徑取得 MIME 類型

protected string|null getMimeTypeByFile ( $filePath )
$filePath string
throws yii\base\InvalidConfigException

                protected function getMimeTypeByFile($filePath)
{
    return FileHelper::getMimeType($filePath);
}

            
getSizeLimit() public method

傳回允許上傳檔案的最大大小。

這取決於四個因素

  • php.ini 中的 'upload_max_filesize'
  • php.ini 中的 'post_max_size'
  • 'MAX_FILE_SIZE' 隱藏欄位
  • $maxSize
public integer getSizeLimit ( )
return integer

上傳檔案的大小限制。

                public function getSizeLimit()
{
    // Get the lowest between post_max_size and upload_max_filesize, log a warning if the first is < than the latter
    $limit = $this->sizeToBytes(ini_get('upload_max_filesize'));
    $postLimit = $this->sizeToBytes(ini_get('post_max_size'));
    if ($postLimit > 0 && $postLimit < $limit) {
        Yii::warning('PHP.ini\'s \'post_max_size\' is less than \'upload_max_filesize\'.', __METHOD__);
        $limit = $postLimit;
    }
    if ($this->maxSize !== null && $limit > 0 && $this->maxSize < $limit) {
        $limit = $this->maxSize;
    }
    if (isset($_POST['MAX_FILE_SIZE']) && $_POST['MAX_FILE_SIZE'] > 0 && $_POST['MAX_FILE_SIZE'] < $limit) {
        $limit = (int) $_POST['MAX_FILE_SIZE'];
    }
    return $limit;
}

            
getValidationAttributes() public method (available since version 2.0.16)

定義於: yii\validators\Validator::getValidationAttributes()

傳回此驗證器適用的屬性列表。

public array|null getValidationAttributes ( $attributes null )
$attributes array|string|null

要驗證的屬性列表。

return array|null

屬性名稱列表。

                public function getValidationAttributes($attributes = null)
{
    if ($attributes === null) {
        return $this->getAttributeNames();
    }
    if (is_scalar($attributes)) {
        $attributes = [$attributes];
    }
    $newAttributes = [];
    $attributeNames = $this->getAttributeNames();
    foreach ($attributes as $attribute) {
        // do not strict compare, otherwise int attributes would fail due to to string conversion in getAttributeNames() using ltrim().
        if (in_array($attribute, $attributeNames, false)) {
            $newAttributes[] = $attribute;
        }
    }
    return $newAttributes;
}

            
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()
{
    parent::init();
    if ($this->message === null) {
        $this->message = Yii::t('yii', 'File upload failed.');
    }
    if ($this->uploadRequired === null) {
        $this->uploadRequired = Yii::t('yii', 'Please upload a file.');
    }
    if ($this->tooMany === null) {
        $this->tooMany = Yii::t('yii', 'You can upload at most {limit, number} {limit, plural, one{file} other{files}}.');
    }
    if ($this->tooFew === null) {
        $this->tooFew = Yii::t('yii', 'You should upload at least {limit, number} {limit, plural, one{file} other{files}}.');
    }
    if ($this->wrongExtension === null) {
        $this->wrongExtension = Yii::t('yii', 'Only files with these extensions are allowed: {extensions}.');
    }
    if ($this->tooBig === null) {
        $this->tooBig = Yii::t('yii', 'The file "{file}" is too big. Its size cannot exceed {formattedLimit}.');
    }
    if ($this->tooSmall === null) {
        $this->tooSmall = Yii::t('yii', 'The file "{file}" is too small. Its size cannot be smaller than {formattedLimit}.');
    }
    if (!is_array($this->extensions)) {
        $this->extensions = preg_split('/[\s,]+/', strtolower((string)$this->extensions), -1, PREG_SPLIT_NO_EMPTY);
    } else {
        $this->extensions = array_map('strtolower', $this->extensions);
    }
    if ($this->wrongMimeType === null) {
        $this->wrongMimeType = Yii::t('yii', 'Only files with these MIME types are allowed: {mimeTypes}.');
    }
    if (!is_array($this->mimeTypes)) {
        $this->mimeTypes = preg_split('/[\s,]+/', strtolower((string)$this->mimeTypes), -1, PREG_SPLIT_NO_EMPTY);
    } else {
        $this->mimeTypes = array_map('strtolower', $this->mimeTypes);
    }
}

            
isActive() public method

定義於: yii\validators\Validator::isActive()

傳回一個值,指示驗證器是否對給定的情境和屬性處於活動狀態。

如果符合以下條件,則驗證器處於活動狀態:

  • 驗證器的 on 屬性為空,或
  • 驗證器的 on 屬性包含指定的場景
public boolean isActive ( $scenario )
$scenario string

場景名稱

return boolean

驗證器是否適用於指定的場景。

                public function isActive($scenario)
{
    return !in_array($scenario, $this->except, true) && (empty($this->on) || in_array($scenario, $this->on, true));
}

            
isEmpty() public method

檢查給定的值是否為空。

如果值為 null、空陣列或空字串,則該值被視為空。請注意,此方法與 PHP empty() 不同。當值為 0 時,它將傳回 false。

public boolean isEmpty ( $value, $trim false )
$value mixed

要檢查的值

$trim boolean
return boolean

值是否為空

                public function isEmpty($value, $trim = false)
{
    $value = is_array($value) ? reset($value) : $value;
    return !($value instanceof UploadedFile) || $value->error == UPLOAD_ERR_NO_FILE;
}

            
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]);
    }
}

            
trigger() public method

Defined in: 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);
}

            
validate() public method

Defined in: yii\validators\Validator::validate()

驗證給定的值。

您可以使用此方法在資料模型的上下文之外驗證值。

public boolean validate ( $value, &$error null )
$value mixed

要驗證的資料值。

$error string|null

如果驗證失敗,要傳回的錯誤訊息。

return boolean

資料是否有效。

                public function validate($value, &$error = null)
{
    $result = $this->validateValue($value);
    if (empty($result)) {
        return true;
    }
    list($message, $params) = $result;
    $params['attribute'] = Yii::t('yii', 'the input value');
    if (is_array($value)) {
        $params['value'] = 'array()';
    } elseif (is_object($value)) {
        $params['value'] = 'object';
    } else {
        $params['value'] = $value;
    }
    $error = $this->formatMessage($message, $params);
    return false;
}

            
validateAttribute() public method

驗證單一屬性。

子類別必須實作此方法以提供實際的驗證邏輯。

public void validateAttribute ( $model, $attribute )
$model yii\base\Model

要驗證的資料模型

$attribute string

要驗證的屬性名稱。

                public function validateAttribute($model, $attribute)
{
    if ($this->maxFiles != 1 || $this->minFiles > 1) {
        $rawFiles = $model->$attribute;
        if (!is_array($rawFiles)) {
            $this->addError($model, $attribute, $this->uploadRequired);
            return;
        }
        $files = $this->filterFiles($rawFiles);
        $model->$attribute = $files;
        if (empty($files)) {
            $this->addError($model, $attribute, $this->uploadRequired);
            return;
        }
        $filesCount = count($files);
        if ($this->maxFiles && $filesCount > $this->maxFiles) {
            $this->addError($model, $attribute, $this->tooMany, ['limit' => $this->maxFiles]);
        }
        if ($this->minFiles && $this->minFiles > $filesCount) {
            $this->addError($model, $attribute, $this->tooFew, ['limit' => $this->minFiles]);
        }
        foreach ($files as $file) {
            $result = $this->validateValue($file);
            if (!empty($result)) {
                $this->addError($model, $attribute, $result[0], $result[1]);
            }
        }
    } else {
        $result = $this->validateValue($model->$attribute);
        if (!empty($result)) {
            $this->addError($model, $attribute, $result[0], $result[1]);
        }
    }
}

            
validateAttributes() public method

Defined in: yii\validators\Validator::validateAttributes()

驗證指定的物件。

public void validateAttributes ( $model, $attributes null )
$model yii\base\Model

正在驗證的資料模型

$attributes array|string|null

要驗證的屬性列表。請注意,如果屬性未與驗證器關聯,則會被忽略。如果此參數為 null,則會驗證 $attributes 中列出的每個屬性。

                public function validateAttributes($model, $attributes = null)
{
    $attributes = $this->getValidationAttributes($attributes);
    foreach ($attributes as $attribute) {
        $skip = $this->skipOnError && $model->hasErrors($attribute)
            || $this->skipOnEmpty && $this->isEmpty($model->$attribute);
        if (!$skip) {
            if ($this->when === null || call_user_func($this->when, $model, $attribute)) {
                $this->validateAttribute($model, $attribute);
            }
        }
    }
}

            
validateExtension() protected method

根據目前的驗證器設定,檢查給定的上傳檔案是否具有正確的類型 (副檔名)。

protected boolean validateExtension ( $file )
$file yii\web\UploadedFile

                protected function validateExtension($file)
{
    $extension = mb_strtolower($file->extension, 'UTF-8');
    if ($this->checkExtensionByMimeType) {
        $mimeType = FileHelper::getMimeType($file->tempName, null, false);
        if ($mimeType === null) {
            return false;
        }
        $extensionsByMimeType = FileHelper::getExtensionsByMimeType($mimeType);
        if (!in_array($extension, $extensionsByMimeType, true)) {
            return false;
        }
    }
    if (!empty($this->extensions)) {
        foreach ((array) $this->extensions as $ext) {
            if ($extension === $ext || StringHelper::endsWith($file->name, ".$ext", false)) {
                return true;
            }
        }
        return false;
    }
    return true;
}

            
validateMimeType() protected method (available since version 2.0.8)

根據 $mimeTypes 屬性中的列表檢查 $file 的 mimeType。

另請參閱 $mimeTypes

protected boolean validateMimeType ( $file )
$file yii\web\UploadedFile
return boolean

$file 的 mimeType 是否允許

throws yii\base\InvalidConfigException

                protected function validateMimeType($file)
{
    $fileMimeType = $this->getMimeTypeByFile($file->tempName);
    if ($fileMimeType === null) {
        return false;
    }
    foreach ($this->mimeTypes as $mimeType) {
        if (strcasecmp($mimeType, $fileMimeType) === 0) {
            return true;
        }
        if (strpos($mimeType, '*') !== false && preg_match($this->buildMimeTypeRegexp($mimeType), $fileMimeType)) {
            return true;
        }
    }
    return false;
}

            
validateValue() protected method

驗證值。

驗證器類別可以實作此方法,以支援在資料模型的上下文之外進行資料驗證。

protected array|null validateValue ( $value )
$value mixed

要驗證的資料值。

return array|null

錯誤訊息和要插入錯誤訊息的參數陣列。 `php if (!$valid) {

return [$this->message, [
    'param1' => $this->param1,
    'formattedLimit' => Yii::$app->formatter->asShortSize($this->getSizeLimit()),
    'mimeTypes' => implode(', ', $this->mimeTypes),
    'param4' => 'etc...',
]];

}

return null; ` 在此範例中,message 範本可以包含 {param1}{formattedLimit}{mimeTypes}{param4}

如果資料有效,則應傳回 Null。

throws yii\base\NotSupportedException

如果驗證器不支援在沒有模型的情況下進行資料驗證

                protected function validateValue($value)
{
    if (!$value instanceof UploadedFile || $value->error == UPLOAD_ERR_NO_FILE) {
        return [$this->uploadRequired, []];
    }
    switch ($value->error) {
        case UPLOAD_ERR_OK:
            if ($this->maxSize !== null && $value->size > $this->getSizeLimit()) {
                return [
                    $this->tooBig,
                    [
                        'file' => $value->name,
                        'limit' => $this->getSizeLimit(),
                        'formattedLimit' => Yii::$app->formatter->asShortSize($this->getSizeLimit()),
                    ],
                ];
            } elseif ($this->minSize !== null && $value->size < $this->minSize) {
                return [
                    $this->tooSmall,
                    [
                        'file' => $value->name,
                        'limit' => $this->minSize,
                        'formattedLimit' => Yii::$app->formatter->asShortSize($this->minSize),
                    ],
                ];
            } elseif (!empty($this->extensions) && !$this->validateExtension($value)) {
                return [$this->wrongExtension, ['file' => $value->name, 'extensions' => implode(', ', $this->extensions)]];
            } elseif (!empty($this->mimeTypes) && !$this->validateMimeType($value)) {
                return [$this->wrongMimeType, ['file' => $value->name, 'mimeTypes' => implode(', ', $this->mimeTypes)]];
            }
            return null;
        case UPLOAD_ERR_INI_SIZE:
        case UPLOAD_ERR_FORM_SIZE:
            return [$this->tooBig, [
                'file' => $value->name,
                'limit' => $this->getSizeLimit(),
                'formattedLimit' => Yii::$app->formatter->asShortSize($this->getSizeLimit()),
            ]];
        case UPLOAD_ERR_PARTIAL:
            Yii::warning('File was only partially uploaded: ' . $value->name, __METHOD__);
            break;
        case UPLOAD_ERR_NO_TMP_DIR:
            Yii::warning('Missing the temporary folder to store the uploaded file: ' . $value->name, __METHOD__);
            break;
        case UPLOAD_ERR_CANT_WRITE:
            Yii::warning('Failed to write the uploaded file to disk: ' . $value->name, __METHOD__);
            break;
        case UPLOAD_ERR_EXTENSION:
            Yii::warning('File upload was stopped by some PHP extension: ' . $value->name, __METHOD__);
            break;
        default:
            break;
    }
    return [$this->message, []];
}