https://github.com/mybuilder/cronos

A PHP component for updating crontab
https://github.com/mybuilder/cronos

cron php php-library

Last synced: 3 days ago
JSON representation

A PHP component for updating crontab

• Host: GitHub
• URL: https://github.com/mybuilder/cronos
• Owner: mybuilder
• License: mit
• Created: 2013-10-17T14:46:16.000Z (about 11 years ago)
• Default Branch: master
• Last Pushed: 2024-04-13T12:26:09.000Z (9 months ago)
• Last Synced: 2025-01-01T14:04:15.618Z (10 days ago)
• Topics: cron, php, php-library
• Language: PHP
• Size: 83 KB
• Stars: 154
• Watchers: 17
• Forks: 14
• Open Issues: 4
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Cronos

Easily configure cron through PHP.

If you use Symfony 4/5/6, you could use our [cool bundle](https://github.com/mybuilder/cronos-bundle) in order to configure your app jobs through fancy annotations!

## Setup and Configuration

Require the library via composer:

    composer require mybuilder/cronos

## Usage

### Build Cron

```php

header()

        ->setPath('path')

        ->setHome('home')

        ->setMailto('[email protected]')

        ->setShell('shell')

        ->setContentType('text')

        ->setContentTransferEncoding('utf8')

    ->end()

    ->comment('Comment')

    ->job('/bin/bash command --env=dev')

        ->setMinute(1)

        ->setHour(2)

        ->setDayOfMonth(3)

        ->setMonth(4)

        ->setDayOfWeek(5)

        ->setStandardOutFile('log')

        ->appendStandardErrorToFile('error')

    ->end();

echo $cron->format();

```

That will print

    [email protected]

    HOME=home

    SHELL=shell

    LOGNAME=logName

    CONTENT_TYPE=text

    CONTENT_TRANSFER_ENCODING=utf8

    #Comment

    1    2    3    4    5    /bin/bash command --env=dev > log 2>> error

### Updating Cron

```php

replaceWith($cron);

```

## Troubleshooting

* The current user must have a existing crontab file to use the updater, use `crontab -e` to create one.

* When a cron line is executed it is executed with the user that owns the crontab, but it will not execute any of the users default shell files so all paths etc need to be specified in the command called from the cron line.

* Your crontab will not be executed if you do not have usable shell in `/etc/passwd`

* If your jobs don't seem to be running, check the cron daemon is running, also check your username is in `/etc/cron.allow` and not in `/etc/cron.deny`.

* Environmental substitutions do not work, you cannot use things like `$PATH`, `$HOME`, or `~/sbin`.

* You cannot use `%` in the command, if you need to use it, escape the command in backticks.

---

Created by [MyBuilder](http://www.mybuilder.com/) - Check out our [blog](http://tech.mybuilder.com/) for more insight into this and other open-source projects we release.