PHP Класс Crontab\Crontab

Автор: Benjamin Laugueux ([email protected])

Показать файл Открыть проект Примеры использования класса

Защищенные свойства (Protected)

Свойство	Тип	Описание
$crontabFileHandler	CrontabFileHandler
$user	string	The user executing the comment 'crontab'

Открытые методы

Метод	Описание
__construct ( boolean \| true $parseExistingCrontab = true )	Constructor
addItem ( Crontab\Job \| Variable $item ) : Crontab
addJob ( Crontab\Job $job ) : Crontab	Add a new job to the crontab
addVariable ( Variable $variable ) : Crontab
flush ( ) : Crontab	Remove all crontab content
getCrontabExecutable ( ) : string	Get crontab executable location
getCrontabFileHandler ( ) : CrontabFileHandler	Returns a Crontab File Handler
getError ( ) : string	Get crontab error
getJobs ( ) : Crontab\Job[]	Get all crontab jobs
getOutput ( ) : string	Get crontab output
getUser ( ) : string	Get unix user to add crontab
getVariables ( ) : Variable[]	Get all variables in crontab
parseExistingCrontab ( ) : Crontab	Parse an existing crontab
removeAllJobs ( ) : Crontab	Remove all job in the current crontab
removeAllVariables ( ) : Crontab
removeJob ( Crontab\Job $job ) : Crontab	Remove a specified job in the current crontab
removeVariable ( Variable $variable ) : Crontab
render ( ) : string	Render the crontab and associated jobs
setCrontabExecutable ( string $crontabExecutable ) : Crontab	Set unix user to add crontab
setCrontabFileHandler ( CrontabFileHandler $command )	Set the Crontab File Handler
setJobs ( array $jobs ) : Crontab	Adda new job to the crontab
setUser ( string $user ) : Crontab	Set unix user to add crontab
setVariables ( array $variables ) : Crontab
write ( )	Write the current crons in the cron table

Описание методов

__construct() публичный Метод

Constructor

public __construct ( boolean \| true $parseExistingCrontab = true )
$parseExistingCrontab	boolean \| true

addItem() публичный Метод

public addItem ( Crontab\Job \| Variable $item ) : Crontab
$item	Crontab\Job \| Variable
Результат	Crontab

addJob() публичный Метод

Add a new job to the crontab

public addJob ( Crontab\Job $job ) : Crontab
$job	Crontab\Job
Результат	Crontab

addVariable() публичный Метод

public addVariable ( Variable $variable ) : Crontab
$variable	Variable
Результат	Crontab

flush() публичный Метод

Remove all crontab content

public flush ( ) : Crontab
Результат	Crontab

getCrontabExecutable() публичный Метод

Get crontab executable location

Устаревший: Please use {@see \CrontabFileHandler::getCrontabExecutable()}

public getCrontabExecutable ( ) : string
Результат	string

getCrontabFileHandler() публичный Метод

Returns a Crontab File Handler

public getCrontabFileHandler ( ) : CrontabFileHandler
Результат	CrontabFileHandler

getError() публичный Метод

Get crontab error

Устаревший: Please use {@see \CrontabFileHandler::getError()}

public getError ( ) : string
Результат	string

getJobs() публичный Метод

Get all crontab jobs

public getJobs ( ) : Crontab\Job[]
Результат	Crontab\Job[]	An array of Job

getOutput() публичный Метод

Get crontab output

Устаревший: Please use {@see \CrontabFileHandler::getOutput()}

public getOutput ( ) : string
Результат	string

getUser() публичный Метод

Get unix user to add crontab

public getUser ( ) : string
Результат	string

getVariables() публичный Метод

Get all variables in crontab

public getVariables ( ) : Variable[]
Результат	Variable[]	an array of Variable

parseExistingCrontab() публичный Метод

Parse an existing crontab

Устаревший: Please use {@see \CrontabFileHandler::parseExistingCrontab()}

public parseExistingCrontab ( ) : Crontab
Результат	Crontab

removeAllJobs() публичный Метод

Remove all job in the current crontab

public removeAllJobs ( ) : Crontab
Результат	Crontab

removeAllVariables() публичный Метод

public removeAllVariables ( ) : Crontab
Результат	Crontab

removeJob() публичный Метод

Remove a specified job in the current crontab

public removeJob ( Crontab\Job $job ) : Crontab
$job	Crontab\Job
Результат	Crontab

removeVariable() публичный Метод

public removeVariable ( Variable $variable ) : Crontab
$variable	Variable
Результат	Crontab

render() публичный Метод

Render the crontab and associated jobs

public render ( ) : string
Результат	string

setCrontabExecutable() публичный Метод

Set unix user to add crontab

Устаревший: Please use {@see \CrontabFileHandler::setCrontabExecutable()}

public setCrontabExecutable ( string $crontabExecutable ) : Crontab
$crontabExecutable	string
Результат	Crontab

setCrontabFileHandler() публичный Метод

Set the Crontab File Handler

public setCrontabFileHandler ( CrontabFileHandler $command )
$command	CrontabFileHandler

setJobs() публичный Метод

Adda new job to the crontab

public setJobs ( array $jobs ) : Crontab
$jobs	array
Результат	Crontab

setUser() публичный Метод

Set unix user to add crontab

public setUser ( string $user ) : Crontab
$user	string
Результат	Crontab

setVariables() публичный Метод

public setVariables ( array $variables ) : Crontab
$variables	array
Результат	Crontab

write() публичный Метод

Write the current crons in the cron table

Устаревший: Please use {@see \CrontabFileHandler::write()}

public write ( )

Описание свойств

$crontabFileHandler защищенное свойство

protected CrontabFileHandler,crontab $crontabFileHandler
Результат	CrontabFileHandler

$user защищенное свойство

The user executing the comment 'crontab'

protected string $user
Результат	string