PHP Class Horde_Service_Facebook_Streams, horde

Copyright 2009-2016 Horde LLC (http://www.horde.org/)
Author: Michael J. Rubinsky ([email protected])
Inheritance: extends Horde_Service_Facebook_Base
Show file Open project: horde/horde

Public Methods

Method Description
addComment ( string $postId, string $comment ) : string Add a comment to a user's post.
addLike ( string $postId ) : boolean Add a "like" to a post.
delete ( $postid ) : boolean Remove a post from a user's stream
getFilters ( integer $uid ) : array Get a user's stream filter.
getPost ( $uid ) : object Get a specific post.
getStream ( string $filter = null, array $options = [] ) : object Return the logged in user's news stream.
getWall ( string $uid = '' ) : mixed Get a user's wall stream
post ( string $uid, string $message, array $options = [] ) : string Post a message to a user's stream.
removeComment ( string $commentId ) : boolean Remove a comment from a post.
removeLike ( string $postId ) : boolean Remove a "like" from a stream post.

Method Details

addComment() public method

Add a comment to a user's post.
public addComment ( string $postId, string $comment ) : string
$postId string The post id the comment belongs to
$comment string The body of the comment (text only, no HTML).
return string The comment id of the posted comment.

addLike() public method

Add a "like" to a post.
public addLike ( string $postId ) : boolean
$postId string
return boolean

delete() public method

Remove a post from a user's stream
public delete ( $postid ) : boolean
return boolean

getFilters() public method

Get a user's stream filter.
public getFilters ( integer $uid ) : array
$uid integer The user id of whose filters we are requesting.
return array of filter data.

getPost() public method

Get a specific post.
public getPost ( $uid ) : object
return object The post object.

getStream() public method

Return the logged in user's news stream.
public getStream ( string $filter = null, array $options = [] ) : object
$filter string A named stream filter to apply.
$options array Additional options: - limit: (integer) The maximum number of posts to return. - offset: (integer) The post to start returning from. - until: (timestamp) Do not return posts after this timestamp. - since: (timestamp) Do not return posts before this timestamp.
return object

getWall() public method

Get a user's wall stream
public getWall ( string $uid = '' ) : mixed
$uid string The user id.
return mixed Method call results.

post() public method

Post a message to a user's stream.
public post ( string $uid, string $message, array $options = [] ) : string
$uid string The user id of the user whose stream we are posting the message to.
$message string The message body to post.
$options array Additional post options: - link: (string) A link to attach to this post. - picture (string) A URL to a thumbnail image to use for this post if link is set. - name: (string) A name for the post if link is set. - caption: (string) The caption, if link is set. - description: (string) A description, if link is specified. - actions: (array) An array of actions containing name and link (?). - place: (string) Facebook page id of the location associated with post. - tags: (string) Comma delimted list of Facebook ids of people tagged in this post. Requires place tags to be passed also. - privacy: (string) Privacy settings (if posting to the current user's stream only). This is a JSON encoded object that defines the privacy settings. See https://developers.facebook.com/docs/reference/api/user/#posts -object_attachment: (string) The Facebook id for an existing picture in the user's photo albums to use as the thumbnail image. User must be the owner of the photo.
return string The UID of the new post.

removeComment() public method

Remove a comment from a post.
public removeComment ( string $commentId ) : boolean
$commentId string The comment id to remove.
return boolean

removeLike() public method

Remove a "like" from a stream post.
public removeLike ( string $postId ) : boolean
$postId string The post id to remove a like from.
return boolean