Class: Services_Facebook_Friends

Source Location: /Services_Facebook-0.2.14/Services/Facebook/Friends.php

Class Overview

Services_Facebook_Common
   |
   --Services_Facebook_Friends

Facebook Friends Interface

Author(s):

Joe Stump <joe at joestump.net>

Version:

Release: 0.2.14

Methods

Inherited Variables

Class: Services_Facebook_Common

Services_Facebook_Common::$api
Services_Facebook_Common::$sessionKey
Services_Facebook_Common::$useSessionSecret
Services_Facebook_Common::$version

Inherited Methods

Class: Services_Facebook_Common

Services_Facebook_Common::__construct(): Construct
Services_Facebook_Common::callMethod(): Call method
Services_Facebook_Common::checkRequest(): Check if request resulted in an error
Services_Facebook_Common::getAPI(): Get API
Services_Facebook_Common::parseResponse(): parseResponse
Services_Facebook_Common::sendRequest(): Send a request to the API
Services_Facebook_Common::setAPI(): Set API
Services_Facebook_Common::signRequest(): Sign the request
Services_Facebook_Common::updateArgs(): Update arguments

Class Details

[line 35]
Facebook Friends Interface

Author: Joe Stump <joe@joestump.net>
Version: Release: 0.2.14
Link: http://wiki.developers.facebook.com
License: New BSD License

[ Top ]

Method Detail

areFriends [line 50]

mixed areFriends(
array
$uid1, array
$uid2)

Are groupings of friends friends?

If an array matrix of friend pairings is passed then a SimpleXmlElement is passed back. If it's a single pairing of friends then a boolean is passed back.

Return: Instance of SimpleXML response or boolean
Link: http://wiki.developers.facebook.com/index.php/Friends.areFriends
Access: public

Parameters:

array	`$uid1`	—	First uid to check
array	`$uid2`	—	Second one to see if friends with $uid1

[ Top ]

get [line 85]

array get(
[string
$uid = null])

Get the current user's friends

Return: A list of uid's of current user's friends
Link: http://wiki.developers.facebook.com/index.php/Friends.get
Access: public

Parameters:

string $uid — FB uid to get a friend list of

[ Top ]

getAppUsers [line 134]

array getAppUsers(
)

Get a user's friends who are using your application

Return: A list of Facebook uid's
Link: http://wiki.developers.facebook.com/index.php/Friends.getAppUsers
Access: public

[ Top ]

getByList [line 113]

array getByList(
integer
$flid)

Get the current user's friends by list

Return: A list of uid's of a particular list from the current user
Author: Jeff Hodsdon <jeffhodsdon@gmail.com>
Link: http://wiki.developers.facebook.com/index.php/Friends.get
Access: public

Parameters:

integer $flid — The friends list id to fetch

[ Top ]

getLists [line 155]

object SimpleXMLObject getLists(
)

Get the current user's friend lists

Return: with a name and id for each list
Author: Jeff Hodsdon <jeffhodsdon@gmail.com>
Link: http://wiki.developers.facebook.com/index.php/Friends.getLists
Access: public

[ Top ]