API Documentation
\

\Horde_Service_Facebook_Events

Events methods for Horde_Service_Facebook

Copyright 2009-2017 Horde LLC (http://www.horde.org/)

Summary

Methods
Properties
Constants
__construct()
get()
getMembers()
rsvp()
cancel()
create()
No public properties found
No constants found
_fromDriverStatus()
$_facebook
$_http
N/A
No private methods found
No private properties found
N/A

Properties

$_http

$_http : \Horde_Http_Client

Type

\Horde_Http_Client

Methods

__construct()

__construct(\Horde_Service_Facebook  $facebook)

Constructor

Parameters

\Horde_Service_Facebook $facebook

get()

get(array  $options = array()) : array

Returns events according to the filters specified.

Parameters

array $options

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.

Returns

array —

The events matching the query.

getMembers()

getMembers(integer  $eid) : array

Returns membership list data associated with an event.

Parameters

integer $eid

event id

Returns

array —

An array of objects with 'name', 'id', and 'rsvp_status' values.

rsvp()

rsvp(integer  $eid, string  $rsvp) : boolean

RSVPs the current user to this event.

Parameters

integer $eid

event id
string $rsvp

'attending', 'maybe', or 'declined'

Returns

boolean

cancel()

cancel(integer  $eid,   $cancel_message = '') : boolean

Cancels an event. Only works for events where application is the admin.

Parameters

integer $eid

event id
$cancel_message

Returns

boolean

create()

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.

Parameters

string $uid

The facebook id the event is attached to.
array $event_info

json encoded event information

Returns

integer —

event id

_fromDriverStatus()

_fromDriverStatus(  $driver_status)

Parameters

$driver_status