Docs For Class Sieve_Action

Sieve_Action_Vacation

Description

The Sieve_Action_Vacation class represents a vacation action.

author: Mike Cochrane <mike@graftonhall.co.nz>
since: Ingo 0.1

Located in /lib/Script/sieve.php (line 2588)

Sieve_Action
   |
   --Sieve_Action_Vacation

Method Summary

Sieve_Action_Vacation Sieve_Action_Vacation ([array $vars = array()])

boolean|string check ()

array requires ()

string toCode ()

void _dayCheck ( $begin, $end)

void _monthCheck ( $begin, $end)

void _vacationCode ()

void _yearCheck ( $begin, $end)

Variables

Inherited Variables

Inherited from Sieve_Action

Sieve_Action::$_vars

Methods

Constructor Sieve_Action_Vacation (line 2595)

Constructor.

Sieve_Action_Vacation Sieve_Action_Vacation ([array $vars = array()])

array $vars: Any required parameters.

check (line 2709)

Checks if the rule parameters are valid.

return: True if this rule is valid, an error message otherwise.

boolean|string check ()

Redefinition of:

Sieve_Action::check(): Checks if the rule parameters are valid.

requires (line 2724)

Returns a list of sieve extensions required for this rule and any sub-rules.

return: A Sieve extension list.

array requires ()

Redefinition of:

Sieve_Action::requires(): Returns a list of sieve extensions required for this rule and any sub-rules.

toCode (line 2616)

Returns a script snippet representing this rule and any sub-rules.

return: A Sieve script snippet.

string toCode ()

Redefinition of:

Sieve_Action::toCode(): Returns a script snippet representing this rule and any sub-rules.

_dayCheck (line 2792)

void _dayCheck ( $begin, $end)

$begin
$end

_monthCheck (line 2777)

void _monthCheck ( $begin, $end)

$begin
$end

_vacationCode (line 2731)

void _vacationCode ()

_yearCheck (line 2764)

void _yearCheck ( $begin, $end)

$begin
$end

Inherited Methods

Inherited From Sieve_Action

Sieve_Action::check()
Sieve_Action::requires()
Sieve_Action::toCode()
Sieve_Action::toString()

Documentation generated on Sun, 30 Jan 2011 05:29:29 +0000 by phpDocumentor 1.4.3