API Documentation
\
Pop
Acl
Assertion
Policy
Audit
Adapter
Model
Auth
Cache
Adapter
Code
Generator
Traits
Reflection
Config
Console
Controller
Cookie
Css
Color
Csv
Db
Adapter
Profiler
Gateway
Record
Relationships
Sql
Migration
Parser
Predicate
Schema
Formatter
Seeder
Debug
Handler
Storage
Dir
Dom
Event
Filter
Form
Element
Input
Select
Ftp
Http
Client
Server
Request
I18n
Format
Image
Adapter
Adjust
Color
Draw
Effect
Filter
Layer
Type
Kettle
Controller
Event
Model
Loader
Log
Writer
Mail
Client
Message
Transport
Smtp
Auth
Stream
Byte
Filter
Mime
Part
Model
Module
Nav
Paginator
Pdf
Build
Font
Standard
TrueType
Table
Cmap
Html
Image
PdfObject
Document
Page
Annotation
Color
Field
Text
Queue
Adapter
Processor
Jobs
Router
Match
Service
Session
Utils
Validator
View
Template
Stream
Popcorn

\Pop\Queue\AdapterFile

File queue adapter class

Summary

Methods
Properties
Constants
hasJob()
getJob()
updateJob()
hasJobs()
getJobs()
hasCompletedJob()
hasCompletedJobs()
getCompletedJob()
getCompletedJobs()
hasFailedJob()
getFailedJob()
hasFailedJobs()
getFailedJobs()
push()
failed()
pop()
clear()
clearFailed()
flush()
flushFailed()
flushAll()
__construct()
folder()
initFolders()
clearFolder()
removeQueueFolder()
getFiles()
No public properties found
No constants found
No protected methods found
$folder
N/A
No private methods found
No private properties found
N/A

Properties

$folder

$folder : string

Queue folder

Type

string

Methods

hasJob()

hasJob(mixed  $jobId) : boolean

Check if queue stack has job

Parameters

mixed $jobId

Returns

boolean

getJob()

getJob(mixed  $jobId, boolean  $unserialize = true) : array|boolean

Get job from queue stack by job ID

Parameters

mixed $jobId
boolean $unserialize

Returns

array|boolean

updateJob()

updateJob(mixed  $jobId, mixed  $completed = false, mixed  $increment = false) : void

Update job from queue stack by job ID

Parameters

mixed $jobId
mixed $completed
mixed $increment

hasJobs()

hasJobs(mixed  $queue) : boolean

Check if queue has jobs

Parameters

mixed $queue

Returns

boolean

getJobs()

getJobs(mixed  $queue, boolean  $unserialize = true) : array

Get queue jobs

Parameters

mixed $queue
boolean $unserialize

Returns

array

hasCompletedJob()

hasCompletedJob(mixed  $jobId) : boolean

Check if queue stack has completed job

Parameters

mixed $jobId

Returns

boolean

hasCompletedJobs()

hasCompletedJobs(mixed  $queue) : boolean

Check if queue has completed jobs

Parameters

mixed $queue

Returns

boolean

getCompletedJob()

getCompletedJob(mixed  $jobId, boolean  $unserialize = true) : array

Get queue completed job

Parameters

mixed $jobId
boolean $unserialize

Returns

array

getCompletedJobs()

getCompletedJobs(mixed  $queue, boolean  $unserialize = true) : array

Get queue completed jobs

Parameters

mixed $queue
boolean $unserialize

Returns

array

hasFailedJob()

hasFailedJob(mixed  $jobId) : boolean

Check if queue stack has failed job

Parameters

mixed $jobId

Returns

boolean

getFailedJob()

getFailedJob(mixed  $jobId, boolean  $unserialize = true) : array

Get failed job from queue stack by job ID

Parameters

mixed $jobId
boolean $unserialize

Returns

array

hasFailedJobs()

hasFailedJobs(mixed  $queue) : boolean

Check if queue adapter has failed jobs

Parameters

mixed $queue

Returns

boolean

getFailedJobs()

getFailedJobs(mixed  $queue, boolean  $unserialize = true) : array

Get queue jobs

Parameters

mixed $queue
boolean $unserialize

Returns

array

push()

push(mixed  $queue, mixed  $job, mixed  $priority = null) : string

Push job onto queue stack

Parameters

mixed $queue
mixed $job
mixed $priority

Returns

string

failed()

failed(mixed  $queue, mixed  $jobId, \Exception  $exception = null) : void

Move failed job to failed queue stack

Parameters

mixed $queue
mixed $jobId
\Exception $exception

pop()

pop(mixed  $jobId, boolean  $payload = true) : void

Pop job off of queue stack

Parameters

mixed $jobId
boolean $payload

clear()

clear(mixed  $queue, boolean  $all = false) : void

Clear jobs off of the queue stack

Parameters

mixed $queue
boolean $all

clearFailed()

clearFailed(mixed  $queue) : void

Clear failed jobs off of the queue stack

Parameters

mixed $queue

flush()

flush(boolean  $all = false) : void

Flush all jobs off of the queue stack

Parameters

boolean $all

flushFailed()

flushFailed() : void

Flush all failed jobs off of the queue stack

flushAll()

flushAll() : void

Flush all pop queue items

__construct()

__construct(string  $folder)

Constructor

Instantiate the file queue object

Parameters

string $folder

folder()

folder() : string

Get the queue folder

Returns

string

initFolders()

initFolders(string  $queueName) : \Pop\Queue\Adapter\File

Initialize queue folders

Parameters

string $queueName

Returns

\Pop\Queue\Adapter\File

clearFolder()

clearFolder(string  $folder) : \Pop\Queue\Adapter\File

Clear queue folder

Parameters

string $folder

Throws

\Pop\Queue\Adapter\Exception

Returns

\Pop\Queue\Adapter\File

removeQueueFolder()

removeQueueFolder(string  $queueName) : \Pop\Queue\Adapter\File

Remove queue folder

Parameters

string $queueName

Returns

\Pop\Queue\Adapter\File

getFiles()

getFiles(string  $folder) : array

Get files from folder

Parameters

string $folder

Returns

array