LocalStorage
extends Storage
in package
Table of Contents
Properties
- $container : Container
- $instance : mixed
Methods
- __callStatic() : mixed
- archivesDir() : string
- changeDir() : bool
- changeMod() : bool
- compress() : void
- copy() : bool
- copyDirectory() : bool
- exists() : bool
- get() : string|false
- getFileList() : array<string|int, string>
- getFileSize() : int
- getImageSize() : array{0: int, 1: int, 2: int, 3: string, bits: int, channels: int, mime: string}|false
- getInstance() : mixed
- get service instance
- getMimeType() : string|null
- isDirectory() : bool
- isExecutable() : bool
- isFile() : bool
- isLink() : bool
- isReadable() : bool
- isWritable() : bool
- lastModified() : int
- makeDirectory() : bool
- mbBasename() : string
- move() : bool
- put() : int
- readStream() : resource|false
- remove() : bool
- removeDirectory() : bool
- removeIllegalCharacters() : string
- safeRealpath() : string|false
- setContainer() : void
- setDirectoryMod() : void
- setFileMod() : void
- uniqueFilePath() : string
- unzip() : void
- validateDirectoryTraversal() : string
- validateDirectoryTraversalPath() : bool
- getServiceAlias() : string
- getServiceInstance() : mixed
- isCache() : bool
Properties
$container
protected
static Container
$container
$instance
protected
static mixed
$instance
Methods
__callStatic()
public
static __callStatic(string $method, array<string|int, mixed> $arguments) : mixed
Parameters
- $method : string
- $arguments : array<string|int, mixed>
archivesDir()
public
static archivesDir() : string
アーカイブディレクトリを取得
Return values
stringchangeDir()
public
static changeDir(string $path) : bool
ディレクトリを変更
Parameters
- $path : string
Return values
boolchangeMod()
public
static changeMod(string $path[, int|null $mode = = 'null' ]) : bool
モードを変更
Parameters
- $path : string
- $mode : int|null = = 'null'
Return values
boolcompress()
public
static compress(string $source, string $destination[, string $root = = '\'\'' ][, array<string|int, mixed> $exclude = = '[]' ]) : void
ファイルを圧縮
Parameters
- $source : string
- $destination : string
- $root : string = = '\'\''
- $exclude : array<string|int, mixed> = = '[]'
copy()
public
static copy(string $from, string $to) : bool
ファイルをコピー
Parameters
- $from : string
- $to : string
Return values
boolcopyDirectory()
public
static copyDirectory(string $from, string $to) : bool
ディレクトリをコピー
Parameters
- $from : string
- $to : string
Return values
boolexists()
public
static exists(string $path) : bool
ファイルが存在するか判定
Parameters
- $path : string
Return values
boolget()
public
static get(string $path[, string $publicDir = = '\'\'' ]) : string|false
ファイルの内容を取得
Parameters
- $path : string
- $publicDir : string = = '\'\''
Return values
string|falsegetFileList()
public
static getFileList(string $path) : array<string|int, string>
ディレクトリ内のファイル一覧を取得
Parameters
- $path : string
Return values
array<string|int, string>getFileSize()
public
static getFileSize(string $path) : int
ファイルサイズを取得
Parameters
- $path : string
Return values
intgetImageSize()
public
static getImageSize(string $path[, array<string|int, mixed> &$info = = '[]' ]) : array{0: int, 1: int, 2: int, 3: string, bits: int, channels: int, mime: string}|false
画像サイズを取得
Parameters
- $path : string
- $info : array<string|int, mixed> = = '[]'
Return values
array{0: int, 1: int, 2: int, 3: string, bits: int, channels: int, mime: string}|falsegetInstance()
get service instance
public
static getInstance() : mixed
getMimeType()
public
static getMimeType(string $path) : string|null
ファイルのMIMEタイプを取得
Parameters
- $path : string
Return values
string|nullisDirectory()
public
static isDirectory(string $path) : bool
ディレクトリか判定
Parameters
- $path : string
Return values
boolisExecutable()
public
static isExecutable(string $path) : bool
実行可能か判定
Parameters
- $path : string
Return values
boolisFile()
public
static isFile(string $path) : bool
ファイルか判定
Parameters
- $path : string
Return values
boolisLink()
public
static isLink(string $path) : bool
シンボリックリンクか判定
Parameters
- $path : string
Return values
boolisReadable()
public
static isReadable(string $path) : bool
読み込み可能か判定
Parameters
- $path : string
Return values
boolisWritable()
public
static isWritable(string $path) : bool
書き込み可能か判定
Parameters
- $path : string
Return values
boollastModified()
public
static lastModified(string $path) : int
ファイルの最終更新日時を取得
Parameters
- $path : string
Return values
intmakeDirectory()
public
static makeDirectory(string $path) : bool
ディレクトリを作成
Parameters
- $path : string
Return values
boolmbBasename()
public
static mbBasename(string $path[, string|null $suffix = = 'null' ]) : string
パスのベース名を取得
Parameters
- $path : string
- $suffix : string|null = = 'null'
Return values
stringmove()
public
static move(string $from, string $to) : bool
ファイルを移動
Parameters
- $from : string
- $to : string
Return values
boolput()
public
static put(string $path, string $content) : int
ファイルを書き込む
Parameters
- $path : string
- $content : string
Return values
intreadStream()
public
static readStream(string $path) : resource|false
ファイルをストリームで読み込む
Parameters
- $path : string
Return values
resource|falseremove()
public
static remove(string $path) : bool
ファイルを削除
Parameters
- $path : string
Return values
boolremoveDirectory()
public
static removeDirectory(string $dir) : bool
ディレクトリを削除
Parameters
- $dir : string
Return values
boolremoveIllegalCharacters()
public
static removeIllegalCharacters(string $source) : string
不正な文字を削除
Parameters
- $source : string
Return values
stringsafeRealpath()
public
static safeRealpath(string $path) : string|false
realpath の安全なラッパー関数
Parameters
- $path : string
Return values
string|falsesetContainer()
public
static setContainer(Container $container) : void
Parameters
- $container : Container
setDirectoryMod()
public
static setDirectoryMod(int $mod) : void
ディレクトリのモードを設定
Parameters
- $mod : int
setFileMod()
public
static setFileMod(int $mod) : void
ファイルのモードを設定
Parameters
- $mod : int
uniqueFilePath()
public
static uniqueFilePath(string $original[, string $prefix = = '\'\'' ][, int $num = = '0' ]) : string
ユニークなファイル名を生成
Parameters
- $original : string
- $prefix : string = = '\'\''
- $num : int = = '0'
Return values
stringunzip()
public
static unzip(string $source, string $destination) : void
ファイルを解凍
Parameters
- $source : string
- $destination : string
validateDirectoryTraversal()
public
static validateDirectoryTraversal(string $baseDir, string $fileName) : string
指定されたファイル名がディレクトリトラバーサルを含まないか検証し、絶対パスを返します。
Parameters
- $baseDir : string
- $fileName : string
Return values
stringvalidateDirectoryTraversalPath()
public
static validateDirectoryTraversalPath(string $path[, string $publicDir = = '\'\'' ][, bool $checkExists = = 'true' ]) : bool
ディレクトリ・トラバーサル対応のため、パスが公開領域のものか確認する
Parameters
- $path : string
- $publicDir : string = = '\'\''
- $checkExists : bool = = 'true'
Return values
boolgetServiceAlias()
protected
static getServiceAlias() : string
Return values
stringgetServiceInstance()
protected
static getServiceInstance(string $alias) : mixed
Parameters
- $alias : string
isCache()
protected
static isCache() : bool