Class: Services_Facebook_Users

Source Location: /Services_Facebook-0.2.8/Services/Facebook/Users.php

Class Overview

Services_Facebook_Common
   |
   --Services_Facebook_Users

Facebook Users Interface

Author(s):

Joe Stump <joe at joestump.net>

Version:

Release: 0.2.8

Variables

Methods

Inherited Variables

Class: Services_Facebook_Common

Services_Facebook_Common::$api
Services_Facebook_Common::$sessionKey
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 36]
Facebook Users Interface

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

[ Top ]

Class Variables

$photoSizes = array('big', 'small', 'square')

[line 60]

photoSizes

Var: Supported photo sizes
See: self::getPhoto
Access: protected

Type:

array

[ Top ]

$userFields = array(
        'about_me', 'activities', 'affiliations', 'birthday', 'books',
        'current_location', 'education_history', 'first_name', 'has_added_app',
        'hometown_location', 'hs_info', 'interests', 'is_app_user',
        'last_name', 'meeting_for', 'meeting_sex', 'movies', 'music', 'name',
        'notes_count', 'pic', 'pic_small', 'pic_square', 'political',
        'profile_update_time', 'quotes', 'relationship_status', 'religion',
        'sex', 'significant_other_id', 'status', 'timezone', 'tv',
        'wall_count', 'work_history'
    )

[line 43]

Default user fields

Var: List of allowed getInfo fields
Access: public

Type:

array

[ Top ]

Method Detail

getInfo [line 139]

object SimpleXmlElement getInfo(
mixed
$uids, [
$fields = array()])

Get user info

Return: of result
Link: http://wiki.developers.facebook.com/index.php/Users.getInfo
Access: public

Parameters:

mixed	`$uids`	—	A single uid or array of uids
array	`$fields`	—	List of fields to retrieve

[ Top ]

getLoggedInUser [line 166]

int getLoggedInUser(
)

Get the currently logged in uid

Returns the Facebook uid of the person currently "logged in" as specified by $sessionKey.

Return: The uid of the person logged in
See: Services_Digg::$sessionKey
Link: http://wiki.developers.facebook.com/index.php/Users.getLoggedInUser
Access: public

[ Top ]

getPhoto [line 225]

mixed getPhoto(
int
$uid, [string
$size = ''])

Get photo

Get a photo given an user id. Allow different sizes.

Return: Photo data
Access: public

Parameters:

int	`$uid`	—	Id of the user you want to get a photo of
string	`$size`	—	Size of the photo self::photoSizes

[ Top ]

hasAppPermission [line 184]

boolean hasAppPermission(
string
$perm, [integer
$uid = null])

Has given extended permission

Return: True if user has enabled extended permission
Link: http://wiki.developers.facebook.com/index.php/Users.hasAppPermission
Access: public

Parameters:

string	`$perm`	—	Permission to check
integer	`$uid`	—	User's ID, optional if session key present

[ Top ]

isAppAdded [line 67]

boolean isAppAdded(
)

Has the current user added this application?

Access: public

[ Top ]

isAppUser [line 86]

bool isAppUser(
[float
$uid = null])

Is app user

Uses the passed in user ID or session key to determine if the user is a user of the application.

Access: public

Parameters:

float $uid — Facebook user ID

[ Top ]

setStatus [line 114]

boolean setStatus(
mixed
$status)

Set a user's status message

Set $status to true to clear the status or a string to change the actual status message.

Return: True on success, false on failure
Link: http://wiki.developers.facebook.com/index.php/Users.setStatus
Link: http://wiki.developers.facebook.com/index.php/Extended_permission
Access: public

Parameters:

mixed $status — Set to true to clear status

[ Top ]