Ingo_Rule_System_Vacation
extends Ingo_Rule_Addresses
in package
implements
Ingo_Rule_System
The vacation rule.
Tags
Interfaces, Classes, Traits and Enums
- Ingo_Rule_System
- Interface that indicates the implementing class is a system rule.
Table of Contents
- $addresses : array<string|int, string>
- $addresses : array<string|int, string>|string
- $addressList : Horde_Mail_Rfc822_List
- $days : int
- $disable : bool
- Is this rule disabled?
- $end : int
- $end_day : int
- $end_month : int
- $end_year : int
- $exclude : mixed
- $exclude : array<string|int, mixed>
- $ignore_list : bool
- $name : string
- Rule name.
- $reason : string
- $start : int
- $start_day : int
- $start_month : int
- $start_year : int
- $subject : string
- $uid : string
- Unique ID of the rule.
- $_addr : Horde_Mail_Rfc822_List
- Address list.
- $_days : int
- Number of vacation days.
- $_end : int
- End date.
- $_exclude : array<string|int, mixed>
- Vacation address exclusions.
- $_ignoreList : bool
- Ignore list messages?
- $_perm : string
- Permission name.
- $_reason : string
- Reason.
- $_start : int
- Start date.
- $_subject : string
- Subject of outgoing message.
- __construct() : mixed
- Constructor.
- __get() : mixed
- __set() : mixed
- __toString() : mixed
- addAddresses() : mixed
- Add addresses to the current address list.
- count() : mixed
- description() : string
- Generate the rule description.
- vacationReason() : string
- Returns the vacation reason with all placeholder replaced.
- _setAddressesException() : Ingo_Excception
Properties
$addresses read-only
public
array<string|int, string>
$addresses
The list of addresses.
$addresses write-only
public
array<string|int, string>|string
$addresses
A list of addresses.
$addressList read-only
public
Horde_Mail_Rfc822_List
$addressList
The list of addresses.
$days
public
int
$days
Number of vacation days.
$disable
Is this rule disabled?
public
bool
$disable
= \false
$end
public
int
$end
End date.
$end_day read-only
public
int
$end_day
End date (day).
$end_month read-only
public
int
$end_month
End date (month).
$end_year read-only
public
int
$end_year
End date (year).
$exclude write-only
public
mixed
$exclude
Vacation address exclusions (array or string).
$exclude read-only
public
array<string|int, mixed>
$exclude
Vacation address exclusions.
$ignore_list
public
bool
$ignore_list
Ignore list messages?
$name
Rule name.
public
string
$name
= ''
$reason
public
string
$reason
Vacation reason.
$start
public
int
$start
Start date.
$start_day read-only
public
int
$start_day
Start date (day).
$start_month read-only
public
int
$start_month
Start date (month).
$start_year read-only
public
int
$start_year
Start date (year).
$subject
public
string
$subject
Outgoing message subject line.
$uid
Unique ID of the rule.
public
string
$uid
= ''
$_addr
Address list.
protected
Horde_Mail_Rfc822_List
$_addr
$_days
Number of vacation days.
protected
int
$_days
= 7
$_end
End date.
protected
int
$_end
= 0
$_exclude
Vacation address exclusions.
protected
array<string|int, mixed>
$_exclude
= array()
$_ignoreList
Ignore list messages?
protected
bool
$_ignoreList
= \true
$_perm
Permission name.
protected
string
$_perm
= \null
$_reason
Reason.
protected
string
$_reason
= ''
$_start
Start date.
protected
int
$_start
= 0
$_subject
Subject of outgoing message.
protected
string
$_subject
= ''
Methods
__construct()
Constructor.
public
__construct() : mixed
Return values
mixed —__get()
public
__get(mixed $name) : mixed
Parameters
- $name : mixed
Return values
mixed —__set()
public
__set(mixed $name, mixed $data) : mixed
Parameters
- $name : mixed
- $data : mixed
Return values
mixed —__toString()
public
__toString() : mixed
Return values
mixed —addAddresses()
Add addresses to the current address list.
public
addAddresses(mixed $to_add) : mixed
Parameters
- $to_add : mixed
Tags
Return values
mixed —count()
public
count() : mixed
Return values
mixed —description()
Generate the rule description.
public
description() : string
Return values
string —Rule description.
vacationReason()
Returns the vacation reason with all placeholder replaced.
public
static vacationReason(string $reason, int $start, int $end) : string
Parameters
- $reason : string
-
The vacation reason including placeholders.
- $start : int
-
The vacation start timestamp.
- $end : int
-
The vacation end timestamp.
Return values
string —The vacation reason suitable for usage in the filter scripts.
_setAddressesException()
protected
_setAddressesException(mixed $addr_count, mixed $max) : Ingo_Excception
Parameters
- $addr_count : mixed
- $max : mixed