PHP 클래스 Horde_ActiveSync_Message_Appointment, horde

저자: Michael J Rubinsky ([email protected])
상속: extends Horde_ActiveSync_Message_Base
파일 보기 프로젝트 열기: horde/horde 1 사용 예제들

보호된 프로퍼티들

프로퍼티 타입 설명
$_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