Define
in package
ファイルバリデーションの設定・検証を提供するクラスです。
Table of Contents
Properties
- $allowExtensions : array<string|int, string>
- $limitSize : string|null
Methods
- getAllowExtensions() : array<string|int, string>
- 許容する拡張子を取得します
- getLimitSize() : string|null
- ファイルサイズの上限値（byte）を取得します
- isAllowExtension() : bool
- 許可されたファイル拡張子かどうか確認します。
- isUnderSizeLimit() : bool
- 指定されたファイルサイズ上限以下であるか確認します。
- make() : Define
- バリデーション定義を作成します。
- __construct() : mixed
- バリデーション定義を作成します。
Properties
$allowExtensions
private
array<string|int, string>
$allowExtensions
許容する拡張子
$limitSize
private
string|null
$limitSize
ファイルサイズ上限
Methods
getAllowExtensions()
許容する拡張子を取得します
public
getAllowExtensions() : array<string|int, string>
Return values
array<string|int, string> —許容する拡張子を返します
getLimitSize()
ファイルサイズの上限値（byte）を取得します
public
getLimitSize() : string|null
Return values
string|null —ファイルサイズの上限値を返します
isAllowExtension()
許可されたファイル拡張子かどうか確認します。
public
isAllowExtension(string $filePath) : bool
Parameters
- $filePath : string
-
ファイルパスを渡します
Return values
bool —許可されたファイル拡張子の場合はtrueを、それ以外の場合はfalseを返します。
NOTE: $allowExtensionsを指定しなかった場合（$allowExtensions = []）は常にtrueを返します。
isUnderSizeLimit()
指定されたファイルサイズ上限以下であるか確認します。
public
isUnderSizeLimit(string $filePath) : bool
Parameters
- $filePath : string
-
ファイルパスを渡します
Return values
bool —指定されたファイルサイズ上限以下であればtrueを、それ以外の場合はfalseを返します。
NOTE: $limitSizeを指定しなかった場合（$limitSize = null）は常にtrueを返します。
make()
バリデーション定義を作成します。
public
static make([string|null $limitSize = null ], string ...$allowExtensions) : Define
Parameters
- $limitSize : string|null = null
-
ファイルサイズの上限を指定します。指定しない場合はnullを指定します。
- $allowExtensions : string
-
許容する拡張子を指定します
Return values
Define__construct()
バリデーション定義を作成します。
private
__construct([string|null $limitSize = null ], string ...$allowExtensions) : mixed
Parameters
- $limitSize : string|null = null
-
ファイルサイズの上限を指定します
- $allowExtensions : string
-
許容する拡張子を指定します。