hinashiki/fuelphp-queue

FuelPHP 1.7.x or later, add original Queue system

fuelphp-queue

Add original queue system to FuelPHP 1.7.x or later.
This is FuelPHP package. If you want to use, please use as package.
How to install : http://fuelphp.com/docs/general/packages.html#/installing, _(*1)

Preparation

1. Install Orm package.
   This package depends on fuelphp orm package.
   If you don't have orm package, please install before use this.

php oil package install orm

• Migrate Database.
  This package need to create task_queue table.
  You must prepare database which supported Fuel\Core\DB classes.
  If you already have database, can migrate by this package.

php oil refine migrate --packages=fuelphp-queue

Easy Usage

1. Push queue in your application.

\Model_TaskQueue::save_queue(
    "Static::method",
    array($arg1, $arg2 ...)
);

• Run queue by task.

php oil refine queue

Model_Taskqueue documentation

save_queue($method, $options, $duplicate_type = null, $priority = null)

Push task queue., _(*2)

String $method

Method name that you want to call. Method must be defined static., _(*3)

Array $options

Method's arguments., _(*4)

Integer $duplicate_type

You can define and set queue type.
If you run queue in parallel, $duplicate_type can set max queue that you execute to each type.
Please also check the config queue.duplicate_type if you use this option., _(*5)

Integer $priority

You can define and set queue's priority.
If you have many task in task_queues, Model_TaskQueue::pick() choose most minimum priority queue.
Please also check the config queue.queue_default_priority if you use this option., _(*6)

Task documentation

php oil refine queues

Run a queue. Queue is selected by Model_Taskqueue::pickup().
This task can use in parallel. Also you can set execute limit by queue.queue_parallel_number., _(*7)

php oil refine queues:clean

Delete old queues that succeeded before than 2 weeks.
This delete is physical delete.
If you change this term, please change config queue.success_queue_delete_term., _(*8)

Config documentation

queue.duplicate_type

Can set Integer key and Integer value.
Key is taks_queues.duplicate_type value in database table, and value is parallel execute limit.
If not set value in this config and set value in db value, Model_TaskQueue::pickup()throw OutOfRangeException., _(*9)

Notice: You can't set 0 key in this config because 0 used as default value., _(*10)

queue.zombie_recover_time

Limitation of queue execute time.
If queue status stay 'exec' over this time, status is back to 'wait'
when use Model_Taskqueue::recover_zombie_queues() or run next queue task.
Default value is -1 hour., _(*11)

queue.success_queue_delete_term

Set the physical delete term.
when call the task php oil refine queues:clean, delete old queues that succeeded before than you set.
Default value is -14 days., _(*12)

queue.queue_parallel_number

Number of you can execute task queues in Parallel.
Default value is 3., _(*13)

queue.queue_default_priority

Can set priority number. 0 is top priority.
You can set task priority when queue insert using Model_TaskQueue::save_queue().
Default value is 100., _(*14)

queue.queue_pid_prefix

Task queues are managed by pid file. Pid file is created tmp directory in your application.
You can set original pid prefix for avoid name confliction.
Default value is queue., _(*15)

queue.logical_delete

Logical delete schema setting.
Default values are above. * Not delete = 0 * Deleted = 1, _(*16)