plinker / cron
A cron组件,允许您在远程系统上读取和控制cron任务。
v3.0.4
2018-05-11 16:18 UTC
Requires
- plinker/core: >=0.1
README
A cron组件,允许您在远程系统上读取和控制cron任务。
安装
使用以下命令通过composer安装此包
$ composer require plinker/cron
客户端
创建客户端实例的方式如下
<?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
]
]);
组件配置
方法
设置完成后,您可以通过其命名空间调用类的方法。
用户
获取当前用户,有助于调试cronab属于哪个用户。
调用
$result = $client->cron->user();
响应
www-data
cronab
获取当前cronab,相当于crontab -l
。
调用
$result = $client->cron->crontab();
响应
# My Cron Task
0 * * * * cd ~
# \My Cron Task
转储
获取当前cronab日志。日志是一个文件,它被构建然后应用到实际的cronab上。
调用
$result = $client->cron->dump();
响应
# My Cron Task
0 * * * * cd ~
# \My Cron Task
创建
创建cron任务条目。注意每个键一个条目,具有相同键的多个调用将简单地更新。
调用
$result = $client->cron->create('My Cron Task', '* * * * * cd ~');
响应
获取
获取cron任务条目,还有一个别名方法read。
调用
$result = $client->cron->get('My Cron Task');
响应
0 * * * * cd ~
更新
更新cron任务。
调用
$result = $client->cron->update('My Cron Task', '0 * * * * cd ~');
响应
删除
删除cron任务。
调用
$result = $client->cron->delete('My Cron Task');
响应
删除
删除cron任务日志(删除所有,但不应用)。
调用
$result = $client->cron->drop();
响应
应用
将cronab日志应用到用户的cronab上。
调用
$result = $client->cron->apply();
响应
测试
此组件没有设置测试。
贡献
有关详细信息,请参阅CONTRIBUTING。
安全
如果您发现任何与安全相关的问题,请通过https://cherone.co.uk联系我,而不是使用问题跟踪器。
致谢
开发鼓励
如果您使用此项目并从中获利或想表示您的感激,请随时捐款https://www.paypal.me/lcherone,谢谢。
赞助商
让您的公司或姓名在文档和每个github仓库中列出,有关更多详情请联系我https://cherone.co.uk。
许可证
MIT许可证(MIT)。有关更多信息,请参阅许可证文件。
有关其他组件,请参阅组织页面。