File
extends AbstractTaskAdapter
in package
File adapter class
Tags
Table of Contents
Properties
Methods
- __construct() : mixed
- Constructor
- clear() : File
- Clear jobs out of queue
- clearFailed() : File
- Clear failed jobs out of the queue
- clearTasks() : File
- Clear all scheduled task
- create() : File
- Create file adapter
- folder() : string|null
- Get folder (alias)
- getEnd() : int
- Get queue end index
- getFailedJob() : mixed
- Get failed job
- getFailedJobs() : array<string|int, mixed>
- Get adapter failed jobs
- getFiles() : array<string|int, mixed>
- Get files from folder
- getFolder() : string|null
- Get folder
- getFolders() : array<string|int, mixed>
- Get folders
- getPriority() : string
- Get queue priority
- getStart() : int
- Get queue start index
- getStatus() : int
- Get queue job status
- getTask() : Task|null
- Get scheduled task
- getTaskCount() : int
- Get scheduled tasks count
- getTasks() : array<string|int, mixed>
- Get scheduled tasks
- hasFailedJob() : bool
- Check if adapter has failed job
- hasFailedJobs() : bool
- Check if adapter has failed jobs
- hasJobs() : bool
- Check if adapter has jobs
- hasTasks() : bool
- Has scheduled tasks
- isFifo() : bool
- Is FIFO
- isFilo() : bool
- Is FILO
- isLifo() : bool
- Is LIFO (alias to FILO)
- isLilo() : bool
- Is LILO (alias to FIFO)
- pop() : AbstractJob|null
- Pop job off of queue
- push() : File
- Push job on to queue
- removeTask() : File
- Remove scheduled task
- schedule() : File
- Schedule job with queue
- setPriority() : AbstractAdapter
- Set queue priority
- updateTask() : File
- Update scheduled task
Properties
$folder
Folder
protected
string|null
$folder
= null
$priority
Queue type
protected
string
$priority
= 'FIFO'
Methods
__construct()
Constructor
public
__construct(string $folder[, string|null $priority = null ]) : mixed
Instantiate the file object
Parameters
- $folder : string
- $priority : string|null = null
Tags
clear()
Clear jobs out of queue
public
clear() : File
Return values
FileclearFailed()
Clear failed jobs out of the queue
public
clearFailed() : File
Return values
FileclearTasks()
Clear all scheduled task
public
clearTasks() : File
Return values
Filecreate()
Create file adapter
public
static create(string $folder[, string|null $priority = null ]) : File
Parameters
- $folder : string
- $priority : string|null = null
Tags
Return values
Filefolder()
Get folder (alias)
public
folder() : string|null
Return values
string|nullgetEnd()
Get queue end index
public
getEnd() : int
Return values
intgetFailedJob()
Get failed job
public
getFailedJob(int $index[, bool $unserialize = true ]) : mixed
Parameters
- $index : int
- $unserialize : bool = true
getFailedJobs()
Get adapter failed jobs
public
getFailedJobs([bool $unserialize = true ]) : array<string|int, mixed>
Parameters
- $unserialize : bool = true
Return values
array<string|int, mixed>getFiles()
Get files from folder
public
getFiles(string $folder) : array<string|int, mixed>
Parameters
- $folder : string
Return values
array<string|int, mixed>getFolder()
Get folder
public
getFolder() : string|null
Return values
string|nullgetFolders()
Get folders
public
getFolders(string $folder) : array<string|int, mixed>
Parameters
- $folder : string
Return values
array<string|int, mixed>getPriority()
Get queue priority
public
getPriority() : string
Return values
stringgetStart()
Get queue start index
public
getStart() : int
Return values
intgetStatus()
Get queue job status
public
getStatus(int $index) : int
Parameters
- $index : int
Return values
intgetTask()
Get scheduled task
public
getTask(string $taskId) : Task|null
Parameters
- $taskId : string
Return values
Task|nullgetTaskCount()
Get scheduled tasks count
public
getTaskCount() : int
Return values
intgetTasks()
Get scheduled tasks
public
getTasks() : array<string|int, mixed>
Return values
array<string|int, mixed>hasFailedJob()
Check if adapter has failed job
public
hasFailedJob(int $index) : bool
Parameters
- $index : int
Return values
boolhasFailedJobs()
Check if adapter has failed jobs
public
hasFailedJobs() : bool
Return values
boolhasJobs()
Check if adapter has jobs
public
hasJobs() : bool
Return values
boolhasTasks()
Has scheduled tasks
public
hasTasks() : bool
Return values
boolisFifo()
Is FIFO
public
isFifo() : bool
Return values
boolisFilo()
Is FILO
public
isFilo() : bool
Return values
boolisLifo()
Is LIFO (alias to FILO)
public
isLifo() : bool
Return values
boolisLilo()
Is LILO (alias to FIFO)
public
isLilo() : bool
Return values
boolpop()
Pop job off of queue
public
pop() : AbstractJob|null
Return values
AbstractJob|nullpush()
Push job on to queue
public
push(AbstractJob $job) : File
Parameters
- $job : AbstractJob
Return values
FileremoveTask()
Remove scheduled task
public
removeTask(string $taskId) : File
Parameters
- $taskId : string
Return values
Fileschedule()
Schedule job with queue
public
schedule(Task $task) : File
Parameters
- $task : Task
Return values
FilesetPriority()
Set queue priority
public
setPriority([string $priority = 'FIFO' ]) : AbstractAdapter
Parameters
- $priority : string = 'FIFO'
Return values
AbstractAdapterupdateTask()
Update scheduled task
public
updateTask(Task $task) : File
Parameters
- $task : Task