CrontabJob Class Reference

Public Member Functions
	__construct ($details=null, $identifier=null)
	__get ($variableName)
	set_details ($details)
	set_minute ($minute)
	set_hour ($hour)
	set_dayOfMonth ($dayOfMonth)
	set_month ($month)
	set_dayOfWeek ($dayOfWeek)
	set_task ($task)
	set_identifier ($identifier)
	output ()
	toArray ()
	is_valid ()
	is_task ($task)

Private Member Functions
	load_fromDetails ()
	load_fromArrayDetails ()
	load_fromStringDetails ()

Private Attributes
	$lastError = 0
	Last error. More...
	$details = null
	Source details. More...
	$minute = '*'
	Minute value for crontab setup. More...
	$hour = '*'
	Hour value for crontab setup. More...
	$dayOfMonth = '*'
	Day of month value for crontab setup. More...
	$month = '*'
	Month value for crontab setup. More...
	$dayOfWeek = '*'
	Day of week value for crontab setup. More...
	$task = ''
	Task value for crontab setup. More...
	$identifier = null
	Job identifier. More...

Detailed Description

CrontabJob class.

Constructor & Destructor Documentation

__construct()

CrontabJob::__construct	(		$details = null,
			$identifier = null
	)

Class constructor.

Parameters

mixed	$details
string	$identifier

Returns

void

Member Function Documentation

__get()

CrontabJob::__get

(

$variableName

)

Makes variables accessible in read-only

Parameters

string

$variableName

Returns

mixed

set_details()

CrontabJob::set_details

(

$details

)

Define details and overwrite all values.

Parameters

mixed

$details

Returns

boolean success

set_minute()

CrontabJob::set_minute

(

$minute

)

Define minute value.

Parameters

string

$minute

Returns

boolean success

set_hour()

CrontabJob::set_hour

(

$hour

)

Define hour value.

Parameters

string

$hour

Returns

boolean

set_dayOfMonth()

CrontabJob::set_dayOfMonth

(

$dayOfMonth

)

Define day of month value.

Parameters

string

$dayOfMonth

Returns

boolean success

set_month()

CrontabJob::set_month

(

$month

)

Define month value.

Parameters

string

$month

Returns

boolean success

set_dayOfWeek()

CrontabJob::set_dayOfWeek

(

$dayOfWeek

)

Define day of week value.

Parameters

string

$dayOfWeek

Returns

boolean success

set_task()

CrontabJob::set_task

(

$task

)

Define task value.

Parameters

string

$task

Returns

boolean success

set_identifier()

CrontabJob::set_identifier

(

$identifier

)

Define identifier value.

Parameters

string

$identifier

Returns

boolean success

output()

CrontabJob::output

(

)

Output job.

Returns

string

toArray()

CrontabJob::toArray

(

)

Return job values as an array.

Returns

string

is_valid()

CrontabJob::is_valid

(

)

Check job is valid.

Returns

boolean success

is_task()

CrontabJob::is_task

(

$task

)

Check task is the same as the given one.

Parameters

string

$task

Returns

boolean result

load_fromDetails()

CrontabJob::load_fromDetails ( )

private

Load job settings from details.

Returns

boolean success

load_fromArrayDetails()

CrontabJob::load_fromArrayDetails ( )

private

Load job settings from details in an array.

Returns

void

load_fromStringDetails()

CrontabJob::load_fromStringDetails ( )

private

Load job settings from details in a string.

Returns

void

Member Data Documentation

$lastError

integer CrontabJob::$lastError = 0

private

Last error.

$details

mixed CrontabJob::$details = null

private

Source details.

$minute

string CrontabJob::$minute = '*'

private

Minute value for crontab setup.

$hour

string CrontabJob::$hour = '*'

private

Hour value for crontab setup.

$dayOfMonth

string CrontabJob::$dayOfMonth = '*'

private

Day of month value for crontab setup.

$month

string CrontabJob::$month = '*'

private

Month value for crontab setup.

$dayOfWeek

string CrontabJob::$dayOfWeek = '*'

private

Day of week value for crontab setup.

$task

srting CrontabJob::$task = ''

private

Task value for crontab setup.

$identifier

string CrontabJob::$identifier = null

private

Job identifier.

---

The documentation for this class was generated from the following file:

• CaMykS/engine/lib/object/CrontabEditor.php.inc