Download the PHP package plinker/cron without Composer
On this page you can find all versions of the php package plinker/cron. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Package cron
Short Description A cron component which allows you to read and control cron tasks on remote systems.
License MIT
Homepage https://github.com/plinker-rpc
Informations about the package cron
PlinkerRPC - Cron
A cron component which allows you to read and control cron tasks on remote systems.
Install
Require this package with composer using the following command:
Client
Creating a client instance is done as follows:
<?php
require 'vendor/autoload.php';
/**
* Initialize plinker client.
*
* @param string $server - URL to server listener.
* @param string $config - server secret, and/or a additional component data
*/
$client = new \Plinker\Core\Client(
'http://example.com/server.php',
[
'secret' => 'a secret password',
// optional
'config' => [
'journal' => './.plinker/crontab.journal',
'apply' => false
]
]
);
// or using global function, with optional array
$client = plinker_client('http://example.com/server.php', 'a secret password', [
'config' => [
'journal' => './.plinker/crontab.journal',
'apply' => false
]
]);
Component Config
Parameter | Description | Default |
---|---|---|
journal | Path to journal file | ./.plinker/crontab.journal |
apply | Apply crontab after each call, default is to only apply upon calling apply() method |
false |
Methods
Once setup, you call the class though its namespace to its method.
User
Get current user, helps to debug which user the crontab is owned by.
Call
Response
Crontab
Get current crontab, equivalent to crontab -l
.
Call
Response
Dump
Get current crontab journal. The journal is a file which gets built and then applied to the real crontab.
Call
Response
Create
Create a crontask entry. Note one entry per key, multiple calls with same key would simply update.
Call
Response
Get
Get a crontask entry, also has an alias method read.
Call
Response
Update
Update cron task.
Call
Response
Delete
Delete a cron task.
Call
Response
Drop
Drop cron task journal (delete all, but does not apply it).
Call
Response
Apply
Apply crontab journal to users crontab.
Call
Response
Testing
There are no tests setup for this component.
Contributing
Please see CONTRIBUTING for details.
Security
If you discover any security related issues, please contact me via https://cherone.co.uk instead of using the issue tracker.
Credits
Development Encouragement
If you use this project and make money from it or want to show your appreciation, please feel free to make a donation https://www.paypal.me/lcherone, thanks.
Sponsors
Get your company or name listed throughout the documentation and on each github repository, contact me at https://cherone.co.uk for further details.
License
The MIT License (MIT). Please see License File for more information.
See the organisations page for additional components.