Logger
in package
Table of Contents
Properties
- $canceled : bool
- $count : int
- $current : string
- $destinationPath : string
- $errors : array<string|int, mixed>
- $excludeLogStatusCodes : array<string|int, mixed>
- $max : int
- $processingName : string
- $processList : array<string|int, mixed>
- $removedFiles : array<string|int, array{path: string}>
- $terminateFlag : TerminateFlag
Methods
- destroy() : mixed
- error() : mixed
- getDestinationPath() : mixed
- getJson() : array<string|int, mixed>
- Get json object
- init() : mixed
- initLog() : mixed
- markCanceled() : void
- 中止したことを進捗JSONに記録する
- processing() : mixed
- removedFile() : mixed
- start() : mixed
- build() : mixed
- terminate() : void
- 中止要求を受けて書き出しを打ち切る
Properties
$canceled
protected
bool
$canceled
= false
$count
protected
int
$count
= 0
$current
protected
string
$current
$destinationPath
protected
string
$destinationPath
= ''
$errors
protected
array<string|int, mixed>
$errors
= []
$excludeLogStatusCodes
protected
array<string|int, mixed>
$excludeLogStatusCodes
= []
$max
protected
int
$max
= 0
$processingName
protected
string
$processingName
= ''
$processList
protected
array<string|int, mixed>
$processList
= []
$removedFiles
protected
array<string|int, array{path: string}>
$removedFiles
= []
$terminateFlag
protected
TerminateFlag
$terminateFlag
Methods
destroy()
public
destroy() : mixed
error()
public
error(mixed $message[, mixed $path = '' ][, mixed $code = null ]) : mixed
Parameters
- $message : mixed
- $path : mixed = ''
- $code : mixed = null
getDestinationPath()
public
getDestinationPath() : mixed
getJson()
Get json object
public
getJson() : array<string|int, mixed>
Return values
array<string|int, mixed>init()
public
init(string $path, TerminateFlag $terminate_flag[, mixed $excludeLogStatusCodes = [] ]) : mixed
Parameters
- $path : string
- $terminate_flag : TerminateFlag
- $excludeLogStatusCodes : mixed = []
initLog()
public
initLog() : mixed
markCanceled()
中止したことを進捗JSONに記録する
public
markCanceled() : void
完了時も中止時も最後に進捗JSONを消すため、記録しないと画面がどちらで終わったか区別できない。
processing()
public
processing([mixed $current = '' ]) : mixed
Parameters
- $current : mixed = ''
removedFile()
public
removedFile(string $path) : mixed
Parameters
- $path : string
start()
public
start(mixed $name[, mixed $max = 1 ]) : mixed
Parameters
- $name : mixed
- $max : mixed = 1
build()
protected
build() : mixed
terminate()
中止要求を受けて書き出しを打ち切る
protected
terminate() : void
バックグラウンド処理は backgroundRedirect 後の同一プロセスで動き続けており、 ここで die() しないと書き出しループが止まらない。die() を含むためテストから 直接呼べず、差し替えられるよう protected にしている。