PHP Класс Horde_ActiveSync_Message_Appointment, horde

Автор: Michael J Rubinsky ([email protected])
Наследование: extends Horde_ActiveSync_Message_Base
Показать файл Открыть проект Примеры использования класса

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

Свойство Тип Описание
$_dayOfWeekMap array DOW mapping for DATE to MASK
$_mapping array Property mapping.
$_properties array Property values.

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

Метод Описание
__construct ( array $options = [] ) Const'r
addAttachment ( Horde_ActiveSync_Message_AirSyncBaseAttachment $atc )
addAttendee ( array $attendee ) Add an attendee to this appointment
addCategory ( string $category ) Add a category to the appointment
addException ( Horde_ActiveSync_Message_Exception $exception ) Add a recurrence exception
getAttendees ( ) : array Get a list of this event's attendees
getBody ( ) : string Get the appointment's body
getBusyStatus ( ) : integer Return the busy status for this appointment.
getCategories ( ) : array Return this appointments tags/categories.
getClass ( ) : string Return the collection class name the object is for.
getDTStamp ( ) : Horde_Date Get the appointment's dtimestamp
getDatetime ( ) : array Get the appointment's time data
getExceptions ( ) : array Return the exceptions for this appointment.
getLocation ( ) : string Get the location field
getMeetingStatus ( ) : integer Return the meeting status for this meeting.
getOrganizer ( ) : array Get the details for the appointment organizer
getRecurrence ( ) : Horde_Date_Recurrence Obtain a recurrence object. Note this returns a Horde_Date_Recurrence object, not Horde_ActiveSync_Message_Recurrence.
getReminder ( ) : integer | boolean Get the reminder time.
getResponseType ( ) : integer Get response type
getSensitivity ( ) : integer Return the sensitivity setting for this appointment
getServerUID ( ) : string Obtain the server UID. See note above.
getSubject ( ) : string Get the subject
getTimezone ( ) : string Get the event's timezone
getUid ( ) : string Get the client's UID. See not above regarding server UIDs.
isGhosted ( string $property ) : boolean Override parent class' method. In EAS 16.0, top level appointment properties are ALWAYS ghosted if they are not explicitly sent.
setBody ( string $body ) Set the appointment's body
setBusyStatus ( integer $busy ) Sets the busy status for this appointment
setDTStamp ( $date ) Set the appointment's modify timestamp
setDatetime ( array $datetime = [] ) Set the appointment time/duration.
setLocation ( string $location ) Set appointment location field.
setMeetingStatus ( integer $status ) Set the status for this appointment. Should be one of: none, meeting, received, canceled, canceledreceived.
setOrganizer ( array $organizer ) Set the organizer name and/or email
setRecurrence ( Horde_Date_Recurrence $recurrence, integer $fdow = null ) Set recurrence information for this appointment
setReminder ( integer $minutes ) Set reminder for this appointment.
setResponseType ( integer $response ) Set user response type. Should be one of: none, organizer, tentative, accepted, declined
setSensitivity ( integer $sensitivity ) Set the sensitivity level for this appointment.
setServerUID ( string $uid ) Because the client doesn't pass the server uid as part of the message, we need to add it manually so the backend can have access to it when changing this object.
setSubject ( string $subject ) Set the appointment subject field.
setTimezone ( mixed $date ) Set the timezone
setUid ( string $uid ) Set the appointment uid. Note that this is the client's UID value, and not the value that the server normally uses for the UID. ActiveSync messages do not normally include any server uid value as part of the message directly. This causes issues with meeting requests since most clients will use the CLIENT_ENTRY_ID for this value, and will send the invitation email out using this value as the UID so we sort-of HAVE to use this value as the server's UID.

Защищенные методы

Метод Описание
_preEncodeValidation ( ) : boolean Give concrete classes the chance to enforce rules before encoding messages to send to the client.
_validateDecodedValues ( ) : boolean Give concrete classes the chance to enforce rules on property values.

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

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

Const'r
См. также: Horde_ActiveSync_Message_Base::__construct()
public __construct ( array $options = [] )
$options array

_preEncodeValidation() защищенный Метод

Give concrete classes the chance to enforce rules before encoding messages to send to the client.
С версии: 2.31.0
protected _preEncodeValidation ( ) : boolean
Результат boolean True if values were valid (or could be made valid). False if values are unable to be validated.

_validateDecodedValues() защищенный Метод

Give concrete classes the chance to enforce rules on property values.
protected _validateDecodedValues ( ) : boolean
Результат boolean True on success, otherwise false.

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

public addAttachment ( Horde_ActiveSync_Message_AirSyncBaseAttachment $atc )
$atc Horde_ActiveSync_Message_AirSyncBaseAttachment

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

Add an attendee to this appointment
public addAttendee ( array $attendee )
$attendee array 'name', 'email' for each attendee

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

Add a category to the appointment
public addCategory ( string $category )
$category string

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

Add a recurrence exception
public addException ( Horde_ActiveSync_Message_Exception $exception )
$exception Horde_ActiveSync_Message_Exception

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

Get a list of this event's attendees
public getAttendees ( ) : array
Результат array An array of 'name' and 'email' hashes

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

Get the appointment's body
Устаревший:
public getBody ( ) : string
Результат string UTF-8 encoded string

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

Return the busy status for this appointment.
Устаревший:
public getBusyStatus ( ) : integer
Результат integer The BUSYSTATUS constant

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

Return this appointments tags/categories.
public getCategories ( ) : array
Результат array

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

Return the collection class name the object is for.
public getClass ( ) : string
Результат string

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

Get the appointment's dtimestamp
Устаревший:
public getDTStamp ( ) : Horde_Date
Результат Horde_Date The timestamp.

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

Get the appointment's time data
public getDatetime ( ) : array
Результат array An array containing: - start: (Horde_Date) The start time. - end: (Horde_Date) The end time. - allday: (boolean) If true, this is an allday event. @deprecated

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

Return the exceptions for this appointment.
public getExceptions ( ) : array
Результат array An array of Horde_ActiveSync_Message_Exception objects

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

Get the location field
Устаревший:
public getLocation ( ) : string
Результат string

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

Return the meeting status for this meeting.
public getMeetingStatus ( ) : integer
Результат integer A MEETING_* constant

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

Get the details for the appointment organizer
public getOrganizer ( ) : array
Результат array with 'name' and 'email' values

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

Obtain a recurrence object. Note this returns a Horde_Date_Recurrence object, not Horde_ActiveSync_Message_Recurrence.
public getRecurrence ( ) : Horde_Date_Recurrence
Результат Horde_Date_Recurrence

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

Get the reminder time.
Устаревший:
public getReminder ( ) : integer | boolean
Результат integer | boolean Number of minutes before appointment for notifications or false if not set.

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

Get response type
Устаревший:
public getResponseType ( ) : integer
Результат integer The responsetype constant

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

Return the sensitivity setting for this appointment
Устаревший:
public getSensitivity ( ) : integer
Результат integer The SENSITIVITY constant

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

Obtain the server UID. See note above.
public getServerUID ( ) : string
Результат string

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

Get the subject
Устаревший: Retrieve the value directly. I.e., $message->subject
public getSubject ( ) : string
Результат string The UTF-8 subject string

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

Get the event's timezone
public getTimezone ( ) : string
Результат string The timezone identifier

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

Get the client's UID. See not above regarding server UIDs.
public getUid ( ) : string
Результат string

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

Override parent class' method. In EAS 16.0, top level appointment properties are ALWAYS ghosted if they are not explicitly sent.
public isGhosted ( string $property ) : boolean
$property string The property to check
Результат boolean

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

Set the appointment's body
Устаревший:
public setBody ( string $body )
$body string UTF-8 encoded string

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

Sets the busy status for this appointment
Устаревший:
public setBusyStatus ( integer $busy )
$busy integer The BUSYSTATUS constant

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

Set the appointment's modify timestamp
Устаревший:
public setDTStamp ( $date )

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

Set the appointment time/duration.
Устаревший: Set individual properties manually from calling code.
public setDatetime ( array $datetime = [] )
$datetime array An array containing: - start: (Horde_Date) The start time. - end: (Horde_Date) The end time. If omitted, must include duration or allday. - duration: (integer) The event duration in seconds. - allday: (boolean) If true, this is an allday event.

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

Set appointment location field.
Устаревший:
public setLocation ( string $location )
$location string

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

Set the status for this appointment. Should be one of: none, meeting, received, canceled, canceledreceived.
public setMeetingStatus ( integer $status )
$status integer A MEETING_* constant

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

Set the organizer name and/or email
public setOrganizer ( array $organizer )
$organizer array

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

Set recurrence information for this appointment
public setRecurrence ( Horde_Date_Recurrence $recurrence, integer $fdow = null )
$recurrence Horde_Date_Recurrence The recurrence data.
$fdow integer The first day of the week. (A Horde_ActiveSync_Message_Recurrence:: constant). @since 2.4.0

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

Set reminder for this appointment.
Устаревший:
public setReminder ( integer $minutes )
$minutes integer The number of minutes before appintment to trigger a reminder.

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

Set user response type. Should be one of: none, organizer, tentative, accepted, declined
Устаревший:
public setResponseType ( integer $response )
$response integer The response type constant

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

Should be one of: normal, personal, private, confidential
Устаревший:
public setSensitivity ( integer $sensitivity )
$sensitivity integer The SENSITIVITY constant

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

Because the client doesn't pass the server uid as part of the message, we need to add it manually so the backend can have access to it when changing this object.
public setServerUID ( string $uid )
$uid string The server UID

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

Set the appointment subject field.
Устаревший: Set the property directly. I.e. $message->subject = 'Test'
public setSubject ( string $subject )
$subject string A UTF-8 string

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

Set the timezone
public setTimezone ( mixed $date )
$date mixed Either a Horde_Date or timezone descriptor such as America/New_York etc...

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

Set the appointment uid. Note that this is the client's UID value, and not the value that the server normally uses for the UID. ActiveSync messages do not normally include any server uid value as part of the message directly. This causes issues with meeting requests since most clients will use the CLIENT_ENTRY_ID for this value, and will send the invitation email out using this value as the UID so we sort-of HAVE to use this value as the server's UID.
public setUid ( string $uid )
$uid string The server's uid for this appointment

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

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

DOW mapping for DATE to MASK
protected array $_dayOfWeekMap
Результат array

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

Property mapping.
protected array $_mapping
Результат array

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

Property values.
protected array $_properties
Результат array