PHP 클래스 Horde_Icalendar_Vfreebusy, horde

저자: Mike Cochrane ([email protected])

상속: extends Horde_Icalendar

공개 프로퍼티들

프로퍼티	타입	설명
$type	string	The component type of this class.

보호된 프로퍼티들

프로퍼티	타입	설명
$_busyPeriods	array	TODO
$_extraParams	array	TODO

공개 메소드들

메소드	설명
addBusyPeriod ( string $type, integer $start, integer $end = null, integer $duration = null, array $extra = [] )	Adds a busy period to the info.
exportvCalendar ( ) : string	Returns the component exported as string.
getBusyPeriods ( ) : array	Returns the busy periods.
getEmail ( ) : string	Returns the email address for this object.
getEnd ( ) : integer	Returns the timestamp of the end of the time period this free busy information covers.
getExtraParams ( ) : array	Returns any additional freebusy parameters.
getFreePeriods ( integer $startStamp, integer $endStamp ) : array	Returns all the free periods of time in a given period.
getName ( ) : string	Returns a display name for this object.
getStart ( ) : integer	Returns the timestamp of the start of the time period this free busy information covers.
merge ( Horde_Icalendar_Vfreebusy $freebusy, boolean $simplify = true )	Merges the busy periods of another Horde_Icalendar_Vfreebusy object into this one.
parsevCalendar ( string $data, $type = null, $charset = null )	Parses a string containing vFreebusy data.
simplify ( )	Removes all overlaps and simplifies the busy periods array as much as possible.

보호된 메소드들

메소드	설명
_simplify ( $busyPeriods, array $extraParams = [] ) : array	TODO

메소드 상세

_simplify() 보호된 메소드

TODO

protected _simplify ( $busyPeriods, array $extraParams = [] ) : array
$busyPeriods		TODO
$extraParams	array	TODO
리턴	array	TODO

addBusyPeriod() 공개 메소드

This function may throw away data in case you add a period with a start date that already exists. The longer of the two periods will be chosen (and all information associated with the shorter one will be removed).

public addBusyPeriod ( string $type, integer $start, integer $end = null, integer $duration = null, array $extra = [] )
$type	string	The type of the period. Either 'FREE' or 'BUSY'; only 'BUSY' supported at the moment.
$start	integer	The start timestamp of the period.
$end	integer	The end timestamp of the period.
$duration	integer	The duration of the period. If specified, the $end parameter will be ignored.
$extra	array	Additional parameters for this busy period.

exportvCalendar() 공개 메소드

Returns the component exported as string.

public exportvCalendar ( ) : string
리턴	string	The exported vFreeBusy information according to the iCalendar format specification.

getBusyPeriods() 공개 메소드

Returns the busy periods.

public getBusyPeriods ( ) : array
리턴	array	All busy periods.

getEmail() 공개 메소드

Returns the email address for this object.

public getEmail ( ) : string
리턴	string	The email address of this object's owner.

getEnd() 공개 메소드

Returns the timestamp of the end of the time period this free busy information covers.

public getEnd ( ) : integer
리턴	integer	A timestamp.

getExtraParams() 공개 메소드

Returns any additional freebusy parameters.

public getExtraParams ( ) : array
리턴	array	Additional parameters of the freebusy periods.

getFreePeriods() 공개 메소드

Returns all the free periods of time in a given period.

public getFreePeriods ( integer $startStamp, integer $endStamp ) : array
$startStamp	integer	The start timestamp.
$endStamp	integer	The end timestamp.
리턴	array	A hash with free time periods, the start times as the keys and the end times as the values.

getName() 공개 메소드

Returns a display name for this object.

public getName ( ) : string
리턴	string	A clear text name for displaying this object.

getStart() 공개 메소드

Returns the timestamp of the start of the time period this free busy information covers.

public getStart ( ) : integer
리턴	integer	A timestamp.

merge() 공개 메소드

This might lead to simplification no matter what you specify for the "simplify" flag since periods with the same start date will lead to the shorter period being removed (see addBusyPeriod).

public merge ( Horde_Icalendar_Vfreebusy $freebusy, boolean $simplify = true )
$freebusy	Horde_Icalendar_Vfreebusy	A freebusy object.
$simplify	boolean	If true, simplify() will called after the merge.

parsevCalendar() 공개 메소드

Parses a string containing vFreebusy data.

public parsevCalendar ( string $data, $type = null, $charset = null )
$data	string	The data to parse.
$type		TODO
$charset		TODO

simplify() 공개 메소드

Removes all overlaps and simplifies the busy periods array as much as possible.

public simplify ( )

프로퍼티 상세

$_busyPeriods 보호되어 있는 프로퍼티

TODO

protected array $_busyPeriods
리턴	array

$_extraParams 보호되어 있는 프로퍼티

TODO

protected array $_extraParams
리턴	array

$type 공개적으로 프로퍼티

The component type of this class.

public string $type
리턴	string