PHP Class Horde_Service_Facebook_Events, horde

Copyright 2009-2016 Horde LLC (http://www.horde.org/)
Author: Michael J. Rubinsky ([email protected])
Inheritance: extends Horde_Service_Facebook_Base
ファイルを表示 Open project: horde/horde

Public Methods

Method Description
cancel ( integer $eid, $cancel_message = '' ) : boolean Cancels an event. Only works for events where application is the admin.
create ( string $uid, array $event_info ) : integer Creates an event on behalf of the user is there is a session, otherwise on behalf of app. Successful creation guarantees app will be admin.
get ( array $options = [] ) : array Returns events according to the filters specified.
getMembers ( integer $eid ) : array Returns membership list data associated with an event.
rsvp ( integer $eid, string $rsvp ) : boolean RSVPs the current user to this event.

Protected Methods

Method Description
_fromDriverStatus ( $driver_status )

Method Details

_fromDriverStatus() protected method

protected _fromDriverStatus ( $driver_status )

cancel() public method

Cancels an event. Only works for events where application is the admin.
public cancel ( integer $eid, $cancel_message = '' ) : boolean
$eid integer event id
return boolean

create() public method

Creates an event on behalf of the user is there is a session, otherwise on behalf of app. Successful creation guarantees app will be admin.
public create ( string $uid, array $event_info ) : integer
$uid string The facebook id the event is attached to.
$event_info array json encoded event information
return integer event id

get() public method

Returns events according to the filters specified.
public get ( array $options = [] ) : array
$options array The filter options: - uid: (string) The user id. - eids: (string) Comma delimited list of event ids to filter on. - start: (integer) Only return events occuring after this timestamp. - end: (integet) Only return events occuring before this timestamp. - rsvp: (string) Only return events if uid is specified and the user has this rsvp status.
return array The events matching the query.

getMembers() public method

Returns membership list data associated with an event.
public getMembers ( integer $eid ) : array
$eid integer event id
return array An array of objects with 'name', 'id', and 'rsvp_status' values.

rsvp() public method

RSVPs the current user to this event.
public rsvp ( integer $eid, string $rsvp ) : boolean
$eid integer event id
$rsvp string 'attending', 'maybe', or 'declined'
return boolean