{"id":16184325,"url":"https://github.com/mattmezza/php-scheduled-job","last_synced_at":"2025-04-07T12:46:19.620Z","repository":{"id":62525363,"uuid":"159817310","full_name":"mattmezza/php-scheduled-job","owner":"mattmezza","description":"A package to run scheduled job with cron.","archived":false,"fork":false,"pushed_at":"2019-02-11T21:40:53.000Z","size":17,"stargazers_count":1,"open_issues_count":0,"forks_count":1,"subscribers_count":3,"default_branch":"master","last_synced_at":"2025-02-13T15:36:27.498Z","etag":null,"topics":["cron","cronjob","crontab","job-runner","scheduled-jobs","task-runner"],"latest_commit_sha":null,"homepage":"","language":"PHP","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/mattmezza.png","metadata":{"files":{"readme":"readme.md","changelog":null,"contributing":null,"funding":null,"license":"license.md","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2018-11-30T11:58:40.000Z","updated_at":"2022-02-19T11:53:10.000Z","dependencies_parsed_at":"2022-11-02T14:16:00.595Z","dependency_job_id":null,"html_url":"https://github.com/mattmezza/php-scheduled-job","commit_stats":null,"previous_names":[],"tags_count":1,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mattmezza%2Fphp-scheduled-job","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mattmezza%2Fphp-scheduled-job/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mattmezza%2Fphp-scheduled-job/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mattmezza%2Fphp-scheduled-job/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/mattmezza","download_url":"https://codeload.github.com/mattmezza/php-scheduled-job/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247656014,"owners_count":20974281,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["cron","cronjob","crontab","job-runner","scheduled-jobs","task-runner"],"created_at":"2024-10-10T07:09:50.921Z","updated_at":"2025-04-07T12:46:19.594Z","avatar_url":"https://github.com/mattmezza.png","language":"PHP","funding_links":[],"categories":[],"sub_categories":[],"readme":"scheduled job\n=======\n\n[![Travis (.org)](https://img.shields.io/travis/mattmezza/php-scheduled-job.svg)](https://github.com/mattmezza/php-scheduled-job)\n\n## Installation\n\n`composer require mattmezza/scheduled-job`\n\n## Usage\n\n##### 1. Create a task\n```php\nclass MyTask extends TaskStandard {\n\n    public function getDescriptionString(): string\n    {\n        return 'Task description';\n    }\n\n    public function run(array $allParam)\n    {\n        // do something\n    }\n}\n```\n\n##### 2. Create a job\n\n```php\nclass MyJob extends JobStandard {\n\n    public function getDescriptionString(): string\n    {\n        return 'Job description';\n    }\n\n    public function getAllTask(): array\n    {\n        return [\n            new MyTask(),\n        ];\n    }\n}\n```\n\n##### 3. Run the job\n\n```php\n(new JobExecutorStandard())-\u003eexecute($job, $argv]);\n```\n\n##### 4. Observe jobs and tasks\n\nYou can attach observers to both jobs and tasks.\n\n```php\n$job-\u003eaddObserver(new JobLogger());\n$task-\u003eaddObserver(new TaskLogger());\n```\n\nYou can define custom observers by implementing `JobObserver` and `TaskObserver`.\n\n##### 5. Automate with cron\n\nCreate a PHP script file that you can run via cron `~/your-project/your-job.php`:\n\n```php\n#!/usr/bin/env php\n\n\u003c?php\n\n$job = ... # create the job as above\n\ntry {\n    (new JobExecutorStandard())-\u003eexecute($job, $argv]);\n} catch (YourException $error) {\n    // Oops, something happened...\n}\n```\n\nAdd the cron entry in the crontab via `crontab -e`:\n\n```\n# run five minutes after midnight, every day \n5 0 * * * $HOME/your-project/your-job.php \u003e\u003e $HOME/tmp/out 2\u003e\u00261\n```\n\n## Development\n\n- [ ] Would be nice to add different kind of jobs each one specialized in a particular way (i.e. memory intensive etc...)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmattmezza%2Fphp-scheduled-job","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmattmezza%2Fphp-scheduled-job","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmattmezza%2Fphp-scheduled-job/lists"}