Download the PHP package croudtech/recurring-task-scheduler without Composer

Recurring Task Scheduler Package

PHP Laravel Package to provide scheduler functionality.

A SchedulableTrait is provided which allows you to link elqoquent models to a schedule model.

The scheduler generates a collection of future schedule event records and has a command line task that executes the schedule callback on the attached object.

Package Installation

composer require croudtech/recurring_task_scheduler

Add the schedulable provider to the providers list in your laravel config/app.php file:

A schedulable model must use the RecurringTaskSchedulableTrait and implement RecurringTaskSchedulableInterface.

The RecurringTaskSchedulableInterface interface expects a recurringTaskScheduleCallback() method which is called when the schedule is executed.

Routes

api/croudtech/schedule/{schedule}

Restful resource route for schedule objects

api/croudtech/schedule/{schedule}/schedule-event/{schedule_event}

Nested resource route for schedule events

api/croudtech/schedule/parse

Schedule parser. Pass a definition array in to get the matching dates. Doesn't save any data so is useful for previews

Prerequisites

PHP 7 and Laravel 5.3^

Versioning

SemVer

Deployment

This package should be installed via composer following the package installation steps above

Owner

Jim Robinson [email protected]

Documentation

Schedule definition schema

• Daily
• • Every N days {period, interval}
• • Every Workday {period, interval, modifier}
• • Every DOW {period, interval}
• Weekly
• • N weeks {period, interval}
• • On DOW {period, interval, modifier}
• Same day each month
• • Day N of every N months {period, interval, modifier}
• Same week each month
• – every N months on the (1,2,3,4,last) DOW {period, interval, modifier}
• Same day each year
• – Day Month {period, interval, modifier}
• Same week each year
• – (1,2,3,4,last) DOW or Month {period, interval, modifier}