php-plurk-api
[ class tree: php-plurk-api ] [ index: php-plurk-api ] [ all elements ]

Class: plurk_api

Source Location: /plurk_api.php

Class Overview


This is a PHP Plurk API.


Author(s):

Version:

  • php-plurk-api 1.6.1

Methods



Class Details

[line 17]
This is a PHP Plurk API.



Tags:

version:  php-plurk-api 1.6.1
link:  http://code.google.com/p/php-plurk-api
license:  BSD License


[ Top ]


Class Methods


constructor __construct [line 92]

plurk_api __construct( )

String contains proxy authentication for CURL connection



Tags:

var:  $proxy_auth


[ Top ]

method addPlurk [line 1681]

boolean addPlurk( [ $lang = 'en'], [ $qualifier = 'says'], [ $content = 'test from roga-plurk-api'], [ $limited_to = NULL], [ $no_comments = 0])

function addPlurk Compatible with RLPlurkAPI



Parameters:

   $lang  
   $qualifier  
   $content  
   $limited_to  
   $no_comments  

[ Top ]

method add_all_as_fan [line 1184]

Boolean add_all_as_fan( )

function add_all_as_fan Accept all friendship requests as fans.



Tags:

see:  /API/Alerts/addAllAsFan


[ Top ]

method add_all_as_friends [line 1202]

boolean add_all_as_friends( )

function add_all_as_friends Accept all friendship requests as friends.



Tags:

see:  /API/Alerts/addAllAsFriends


[ Top ]

method add_as_fan [line 1141]

Boolean add_as_fan( [int $user_id = 0])

function add_as_fan Accept user_id as fan.



Tags:

see:  /API/Alerts/addAsFan


Parameters:

int   $user_id   The user_id that has asked for friendship.

[ Top ]

method add_as_friend [line 1163]

Boolean add_as_friend( [int $user_id = 0])

function add_as_friend Accept user_id as friend.



Tags:

see:  /API/Alerts/addAsFriend


Parameters:

int   $user_id   The user_id that has asked for friendship.

[ Top ]

method add_plurk [line 605]

JSON add_plurk( [string $lang = 'en'], [string $qualifier = 'says'], [string $content = 'test from plurk-api'], [$limited_to $limited_to = NULL], [ $no_comments = 0], int $no_commetns)

function add_Plurk



Tags:

return:  object
see:  /API/Timeline/plurkAdd


Parameters:

string   $lang   The plurk's language.
string   $qualifier   The Plurk's qualifier, must be in English. please see documents/README
string   $content   The Plurk's text.
int   $no_commetns   If set to 1, then responses are disabled for this plurk. If set to 2, then only friends can respond to this plurk.
$limited_to   $limited_to   Limit the plurk only to some users (also known as private plurking). limited_to should be a Array list of friend ids, e.g. limited_to = array(3,4,66,34) will only be plurked to these user ids.
   $no_comments  

[ Top ]

method add_response [line 857]

JSON add_response( [int $plurk_id = 0], [string $content = ''], [string $qualifier = 'says'])

function add_response



Tags:

return:  object
see:  /API/Responses/responseAdd


Parameters:

int   $plurk_id   The plurk that the responses should be added to.
string   $content   The response's text.
string   $qualifier   The Plurk's qualifier, please see documents/README

[ Top ]

method add_to_clique [line 1492]

boolean add_to_clique( [string $clique_name = ''], [int $user_id = 0])

function add_to_clique add friend to clique



Tags:

see:  /API/Cliques/add


Parameters:

string   $clique_name   The name of the clique to add.
int   $user_id   The user to add to the clique

[ Top ]

method become_fan [line 1046]

boolean become_fan( [int $fan_id = 0])

function become_fan



Tags:

see:  /API/FriendsFans/becomeFan


Parameters:

int   $fan_id   Become fan of fan_id. To stop being a fan of someone, user /API/FriendsFans/setFollowing?fan_id=FAN_ID&follow=false.

[ Top ]

method become_friend [line 1004]

boolean become_friend( [int $friend_id = 0])

function become_friend



Tags:

see:  /API/FriendsFans/becomeFriend


Parameters:

int   $friend_id   The ID of the user you want to befriend.

[ Top ]

method befriend [line 1747]

void befriend( [array $array_uid = null], [ $bool_befriend = false])

function befriend Compatible with RLPlurkAPI



Tags:

todo:  should modify in a better way


Parameters:

array   $array_uid   The array of firend uids.
   $bool_befriend  

[ Top ]

method blockUser [line 1812]

bool blockUser( [array $array_uid = null])

function blockUser Compatible with RLPlurkAPI



Tags:

return:  Returns true if successful or false otherwise.


Parameters:

array   $array_uid   The array of user ids to be blocked.

[ Top ]

method block_user [line 1362]

boolean block_user( [int $user_id = 0])

funciton block_user



Tags:

see:  /API/Blocks/block


Parameters:

int   $user_id   The id of the user that should be blocked.

[ Top ]

method create_clique [line 1439]

boolean create_clique( [string $clique_name = ''])

function create_clique create clique



Tags:

see:  /API/Cliques/create_clique


Parameters:

string   $clique_name   The name of the new clique

[ Top ]

method deletePlurk [line 1694]

bool deletePlurk( array $int_plurk_id)

function deletePlurk

Compatible with RLPlurkAPI delete a plurk




Tags:

return:  Returns true if successful or false otherwise.


Parameters:

array   $int_plurk_id   The plurk id to be deleted.

[ Top ]

method delete_plurk [line 637]

boolean delete_plurk( [ $plurk_id = 0], int $plurk_id:)

function delete_plurk



Tags:

see:  /API/Timeline/plurkDelete


Parameters:

int   $plurk_id:   The id of the plurk.
   $plurk_id  

[ Top ]

method delete_response [line 887]

boolean delete_response( [int $plurk_id = 0], [int $response_id = 0])

function delete_response



Tags:

see:  /API/Responses/responseDelete


Parameters:

int   $response_id   The plurk that the responses should be added to.
int   $plurk_id   The plurk that the response belongs to.

[ Top ]

method denyFriendMakeFan [line 1776]

void denyFriendMakeFan( [array $array_uid = null])

function denyFriendMakeFan Compatible with RLPlurkAPI



Tags:

todo:  should modify in a better way


Parameters:

array   $array_uid   The array of friend requests uids.

[ Top ]

method deny_friendship [line 1221]

Boolean deny_friendship( [int $user_id = 0])

function deny_friendship Deny friendship to user_id.



Tags:

see:  /API/Alerts/denyFriendship


Parameters:

int   $user_id   The user_id that has asked for friendship.

[ Top ]

method edit_plurk [line 659]

JSON edit_plurk( [int $plurk_id = 0], [string $content = ''])

function edit_plurk



Tags:

return:  object
see:  /API/Timeline/plurkEdit


Parameters:

int   $plurk_id   The id of the plurk.
string   $content   The content of plurk.

[ Top ]

method favorite_plurk [line 729]

boolean favorite_plurk( $ids $ids)

function favorite_plurk



Tags:

see:  /API/Timeline/favoritePlurks


Parameters:

$ids   $ids   The plurk ids, eg. array(123,456,789)

[ Top ]

method getAlerts [line 1735]

JSON getAlerts( )

function getAlerts Compatible with RLPlurkAPI



Tags:

return:  object


[ Top ]

method getBlockedUsers [line 1800]

array getBlockedUsers( )

function getBlockedUsers Compatible with RLPlurkAPI Get my list of blocked users.



Tags:

return:  Returns an array of blocked users.


[ Top ]

method getCities [line 1931]

array getCities( [int $int_uid = null], [int $int_region_id = null])

function getCities Compatible with RLPlurkAPI Get cities.



Tags:

return:  The associative array of cities within a region and their details.
todo:  not implemented yet


Parameters:

int   $int_uid   The user's UID to be passed to the getCities.
int   $int_region_id   The region's ID to be passed to the getCities.

[ Top ]

method getCountries [line 1960]

array getCountries( [int $int_uid = null])

function getCountries Compatible with RLPlurkAPI Get thie list of countries.



Tags:

return:  The associative array of countries and their details.
todo:  not implemented yet


Parameters:

int   $int_uid   The user's UID to be passed to the getCountries.

[ Top ]

method getPermalink [line 1903]

string getPermalink( int $plurk_id)

function getPermalink Compatible with RLPlurkAPI Convert a plurk ID to a permalink URL.



Tags:

return:  The permalink URL address.


Parameters:

int   $plurk_id   The plurk ID number.

[ Top ]

method getPlurks [line 1626]

array getPlurks( [int $int_uid = null], [string $date_from = null], [string $date_offset = null], [bool $fetch_responses = false], [bool $self_plurks_only = false])

function getPlurks Compatible with RLPlurkAPI Gets the plurks for the user.

Only 25 plurks are fetch at a time as this is limited on the server. The array returned is ordered most recent post first followed by previous posts.




Tags:

return:  The array (numerical) of plurks (an associative subarray).
todo:  Should rewrite.


Parameters:

int   $int_uid   The UID to fetch plurks for.
string   $date_from   The date/time to start fetching plurks. This must be in the <yyyy-mm-dd>T<hh:mm:ss> format assumed to be UTC time.
string   $date_offset   The date/time offset that fetches plurks earlier than this offset. The format is the same as $date_from.
bool   $fetch_responses   If true, populate the responses_fetch value with the array of responses.
bool   $self_plurks_only   If true, return only self plurks.

[ Top ]

method getRegions [line 1946]

array getRegions( [int $int_uid = null], [int $int_country_id = null])

function getRegions Compatible with RLPlurkAPI Get the regions in a given country.



Tags:

return:  The associative array of regions in a country and their details.
todo:  not implemented yet


Parameters:

int   $int_uid   The user's UID to be passed to the getRegions.
int   $int_country_id   The country's ID to be passed to the getRegions.

[ Top ]

method getResponses [line 1707]

array getResponses( int $int_plurk_id)

function getResponses Compatible with RLPlurkAPI Get the responses of a plurk.

This method will load "temporary" friends who have responded to the plurk.




Tags:

return:  The array of responses.


Parameters:

int   $int_plurk_id   The plurk ID

[ Top ]

method getUnreadPlurks [line 1640]

array getUnreadPlurks( [bool $fetch_responses = false])

function getUnreadPlurks Compatible with RLPlurkAPI Get the unread plurks.



Tags:

return:  The array (numerical) of unread plurks (an associative subarray).
todo:  $fetch_responses not implemented


Parameters:

bool   $fetch_responses   If true, populate the responses_fetch value with the array of responses.

[ Top ]

method get_active [line 1107]

JSON get_active( )

function get_active Return a JSON list of current active alert



Tags:

return:  object
see:  /API/Alerts/getActive


[ Top ]

method get_blocks [line 1342]

JSON get_blocks( [int $offset = 0])

function get_blocks



Tags:

return:  list
see:  /API/Blocks/get


Parameters:

int   $offset   What page should be shown, e.g. 0, 10, 20.

[ Top ]

method get_clique [line 1419]

array get_clique( [string $clique_name = ''])

function get_clique get users from clique



Tags:

see:  /API/Cliques/get_clique


Parameters:

string   $clique_name   The name of the new clique

[ Top ]

method get_cliques [line 1402]

JSON get_cliques( )

function get_cliques



Tags:

return:  object
see:  /API/Cliques/get_cliques


[ Top ]

method get_completion [line 1091]

JSON get_completion( )

function get_completion Returns a JSON object of the logged in users friends (nick name and full name).



Tags:

return:  object
see:  /API/FriendsFans/getCompletion


[ Top ]

method get_emoticons [line 1324]

JSON get_emoticons( )

function get_emoticons Emoticons are a big part of Plurk since they make it easy to express feelings.

<a href="http://www.plurk.com/Help/extraSmilies">Check out current Plurk emoticons.</a> This call returns a JSON object that looks like: $link http://www.plurk.com/Help/extraSmilies Check out current Plurk emoticons.




Tags:

return:  object
see:  /API/Emoticons/get


[ Top ]

method get_fans [line 965]

JSON get_fans( [int $user_id = 0], [int $offset = 0])

function get_fans



Tags:

return:  object
see:  /API/FriendsFans/getFansByOffset


Parameters:

int   $user_id   The user_id of the public profile. (integer)
int   $offset   The offset, can be 10, 20, 30 etc.

[ Top ]

method get_following [line 985]

JSON get_following( [int $offset = 0])

function get_following



Tags:

return:  object
see:  /API/FriendsFans/getFollowingByOffset


Parameters:

int   $offset   The offset, can be 10, 20, 30 etc.

[ Top ]

method get_friends [line 946]

JSON get_friends( [int $user_id = 0], [int $offset = 0])

function get_friends



Tags:

return:  objects
see:  /API/FriendsFans/getFriendsByOffset


Parameters:

int   $user_id   The user_id of the public profile. (integer)
int   $offset   The offset, can be 10, 20, 30 etc.

[ Top ]

method get_history [line 1124]

JSON get_history( 0)

function get_history Return a JSON list of past 30 alerts.



Tags:

return:  object
see:  /API/Alerts/getHistory


Parameters:

   0  

[ Top ]

method get_http_response [line 1559]

int get_http_response( )

function get_http_response Get HTTP Server Response



[ Top ]

method get_http_status [line 1548]

int get_http_status( )

function get_http_status Get HTTP Status Code



[ Top ]

method get_karma_stats [line 400]

JSON get_karma_stats( )

function get_karma_stats Returns info about a user's karma, including current karma, karma growth, karma graph and the latest reason why the karma has dropped.

karma_trend: Returns a list of 30 recent karma updates. Each update is a string '[[unixtimestamp]]-[[karma_value]]', e.g. a valid entry is '1282046402-97.85' karma_fall_reason: Why did karma drop? This value is a string and can be: friends_rejections, inactivity, too_short_responses http://www.plurk.com/API#/API/Users/getKarmaStats




Tags:

return:  object
see:  /API/Users/getKarmaStats


[ Top ]

method get_login_status [line 1537]

boolean get_login_status( )

function get_login_status Get login status



[ Top ]

method get_own_profile [line 908]

JSON get_own_profile( )

function get_own_profile



Tags:

return:  object
see:  /API/Profile/getOwnProfile


[ Top ]

method get_permalink [line 1582]

string. get_permalink( $plurk_id $plurk_id)

function get_permalink transfer plurk_id to permalink



Parameters:

$plurk_id   $plurk_id  

[ Top ]

method get_plurk [line 521]

JSON get_plurk( [int $plurk_id = 0])

function get_plurk



Tags:

return:  object
see:  /API/Timeline/getPlurk


Parameters:

int   $plurk_id   The unique id of the plurk. Should be passed as a number, and not base 36 encoded.

[ Top ]

method get_plurks [line 545]

JSON get_plurks( [time $offset = NULL], [int $limit = 20], [boolean $only_user = NULL], [boolean $only_responded = NULL], [boolean $only_private = NULL], [boolean $only_favorite = NULL])

function get_plurks



Tags:

return:  object
see:  /API/Timeline/getPlurks


Parameters:

time   $offset   Return plurks older than offset, use timestamp.
int   $limit   How many plurks should be returned? Default is 20.
boolean   $only_user   Setting it to true will only return user plurks.
boolean   $only_responded   Setting it to true will only return responded plurks.
boolean   $only_private   Setting it to true will only return private plurks.
boolean   $only_favorite   Setting it to true will only return favorite plurks.

[ Top ]

method get_plurks_polling [line 479]

JSON get_plurks_polling( [time $offset = NULL], [int $limit = 50])

function get_plurks_polling



Tags:

return:  object
see:  /API/Polling/getPlurks


Parameters:

time   $offset   Return plurks newer than offset, use timestamp.
int   $limit   The max number of plurks to be returned (default 50).

[ Top ]

method get_plurks_polling_unread_count [line 501]

int get_plurks_polling_unread_count( )

function get_plurks_polling_unread_count Use this call to find out if there are unread plurks on a user's timeline.



Tags:

see:  /API/Polling/getUnreadCount


[ Top ]

method get_plurk_id [line 1594]

int. get_plurk_id( $permalink $permalink)

function get_plurk_id transfer permalink to plurk_id



Parameters:

$permalink   $permalink  

[ Top ]

method get_public_profile [line 928]

JSON get_public_profile( [int $user_id = 0])

function get_public_profile



Tags:

return:  object
see:  /API/Profile/getPublicProfile


Parameters:

int   $user_id   The user_id of the public profile. Can be integer (like 34) or nick name (like amix).

[ Top ]

method get_responses [line 835]

JSON get_responses( [ $plurk_id = 0], [ $offset = 0], int $plurk_id:, int $offset:)

function get_responses



Tags:

return:  object
see:  /API/Responses/get


Parameters:

int   $plurk_id:   The plurk that the responses should be added to.
int   $offset:   Only fetch responses from an offset, should be 5, 10 or 15.
   $plurk_id  
   $offset  

[ Top ]

method get_unread_plurks [line 574]

JSON get_unread_plurks( [time $offset = null], [int $limit = 10])

function get_unread_plurks



Tags:

return:  object
see:  /API/Timeline/getUnreadPlurks


Parameters:

time   $offset   Return plurks older than offset, use timestamp
int   $limit   Limit the number of plurks that is retunred.

[ Top ]

method get_user_info [line 1570]

JSON get_user_info( )

function get_user_info Get user information



Tags:

return:  object


[ Top ]

method isLoggedIn [line 1605]

boolean isLoggedIn( )

function isLoggedIn Compatible with RLPlurkAPI



Tags:

return:  true if we are logged in, false otherwise.


[ Top ]

method log [line 110]

void log( [$message $message = NULL])

funciton log



Parameters:

$message   $message  

[ Top ]

method login [line 257]

boolean login( [$api_key $api_key = ''], [$username $username = ''], [$password $password = ''])

function login Login an already created user.

Login creates a session cookie, which can be used to access the other methods.




Tags:

see:  /API/Users/login


Parameters:

$api_key   $api_key   Your Plurk API key.
$username   $username   The user's nick name or email.
$password   $password   The user's password.

[ Top ]

method logout [line 289]

boolean logout( )

function login Logout current user.



Tags:

see:  /API/Users/logout


[ Top ]

method mark_plurk_as_read [line 771]

boolean mark_plurk_as_read( $ids $ids)

function mark_plurk_as_read



Tags:

see:  /API/Timeline/markAsRead


Parameters:

$ids   $ids   The plurk ids, eg. array(123,456,789)

[ Top ]

method mutePlurk [line 1656]

bool mutePlurk( array $int_plurk_id, bool $bool_setmute)

function mutePlurk

Compatible with RLPlurkAPI Mute or unmute plurks




Tags:

return:  Returns true if successful or false otherwise.


Parameters:

array   $int_plurk_id   The plurk id to be muted/unmuted.
bool   $bool_setmute  

If true, this plurk is to be muted, else, unmute it.


[ Top ]

method mute_plurks [line 686]

boolean mute_plurks( $ids $ids)

function mute_plurks



Tags:

see:  /API/Timeline/mutePlurks


Parameters:

$ids   $ids   The plurk ids, eg. array(123,456,789)

[ Top ]

method nicknameToUid [line 1876]

int nicknameToUid( string $string_nick_name)

function nicknameToUid Compatible with RLPlurkAPI Retrieve a user's uid from given his/her plurk nick name.



Tags:

return:  The uid of the given nickname.
todo:  not implemented yet


Parameters:

string   $string_nick_name   The nickname of the user to retrieve the uid from.

[ Top ]

method permalinkToPlurkID [line 1916]

int permalinkToPlurkID( string $string_permalink)

function permalinkToPlurkID Compatible with RLPlurkAPI Convert a plurk permalink URL address to a plurk ID.



Tags:

return:  The plurk ID number.


Parameters:

string   $string_permalink   The plurk permalink URL address.

[ Top ]

method plurk [line 131]

JSON plurk( $url $url, $array $array)

function plurk Connect to Plurk



Tags:

return:  object


Parameters:

$url   $url  
$array   $array  

[ Top ]

method realtime_get_commet_channel [line 441]

JSON realtime_get_commet_channel( [string $comet_server = NULL], [string $new_offset = NULL])

function realtime_get_commet_channel

You'll get an URL from /API/Realtime/getUserChannel and you do GET requests to this URL to get new data. Your request will sleep for about 50 seconds before returning a response if there is no new data added to your channel. You won't get notifications on responses that the logged in user adds, but you will get notifications for new plurks.




Tags:

return:  object


Parameters:

string   $comet_server   full path with channel name
string   $new_offset   only fetch new messages from a given offset. .

[ Top ]

method realtime_get_user_channel [line 421]

JSON realtime_get_user_channel( )

function realtime_get_user_channel

Return's a JSON object with an URL that you should listen to, e.g. {"comet_server": "http://comet03.plurk.com/comet/1235515351741/?channel=generic-4-f733d8522327edf87b4d1651e6395a6cca0807a0", "channel_name": "generic-4-f733d8522327edf87b4d1651e6395a6cca0807a0"}

for Comet channel specification: http://www.plurk.com/API#/API/Realtime/getUserChannel




Tags:

return:  object
see:  /API/Realtime/getUserChannel


[ Top ]

method register [line 219]

JSON register( [string $nick_name = NULL], [string $full_name = NULL], [string $password = ''], [string $gender = 'male'], [string $date_of_birth = '1985-05-13'], [ $email = NULL])

function register Register a new Plurk account.

Should be HTTPS




Tags:

return:  object
see:  /API/Users/register


Parameters:

string   $nick_name   The user's nick name. Should be longer than 3 characters. Should be ASCII. Nick name can only contain letters, numbers and _.
string   $full_name   Can't be empty.
string   $password   Should be longer than 3 characters.
string   $gender   Should be male or female.
string   $date_of_birth   Should be YYYY-MM-DD, example 1985-05-13. $param string $email (Optional) Must be a valid email.
   $email  

[ Top ]

method remove_friend [line 1025]

boolean remove_friend( [int $friend_id = 0])

function remove_Friend



Tags:

see:  /API/FriendsFans/removeAsFriend


Parameters:

int   $friend_id   The ID of the user you want to befriend.

[ Top ]

method remove_from_clique [line 1516]

boolean remove_from_clique( [string $clique_name = ''], [int $user_id = 0])

function remove_from_clique remove friend from clique



Tags:

see:  /API/Cliques/remove


Parameters:

string   $clique_name   The name of the clique to delete
int   $user_id   The user to remove from the clique

[ Top ]

method remove_notification [line 1243]

Boolean remove_notification( [int $user_id = 0])

function remove_notification Remove notification to user with id user_id.



Tags:

see:  /API/Alerts/removeNotification


Parameters:

int   $user_id   The user_id that the current user has requested friendship for.

[ Top ]

method rename_clique [line 1468]

boolean rename_clique( [string $clique_name = ''], [string $new_name = ''])

function rename_clique rename clique



Tags:

see:  /API/Cliques/rename_clique


Parameters:

string   $clique_name   The name of the current clique.
string   $new_name   The name of the new clique.

[ Top ]

method respondToPlurk [line 1724]

mixed respondToPlurk( [int $int_plurk_id = 0], [string $string_lang = 'en'], [ $string_qualifie = 'says'], [string $string_content = 'test from roga-plurk-api'], string $string_qualifier)

function respondToPlurk Compatible with RLPlurkAPI Respond to a plurk.



Tags:

return:  false on failure, otherwise the http response from plurk.


Parameters:

int   $int_plurk_id   The plurk ID number to respond to.
string   $string_lang   The plurk language.
string   $string_qualifier   The qualifier to use for this response.
string   $string_content  

The content to be posted as a reply.

   $string_qualifie  

[ Top ]

method search_plurk [line 1266]

JSON search_plurk( [string $query = ''], [int $offset = 0])

function search_plurk Returns the latest 20 plurks on a search term.



Tags:

return:  object
see:  /API/PlurkSearch/search


Parameters:

string   $query   The query after Plurks.
int   $offset   A plurk_id of the oldest Plurk in the last search result.

[ Top ]

method search_user [line 1295]

JSON search_user( [string $query = ''], [int $offset = 0])

function search_user Returns 10 users that match query, users are sorted by karma.



Tags:

return:  object
see:  /API/UserSearch/search


Parameters:

string   $query   The query after users.
int   $offset   Page offset, like 10, 20, 30 etc.

[ Top ]

method set_cookie_path [line 199]

void set_cookie_path( [string $cookie_path = NULL])

function set_cookie_path set curl cookie path



Parameters:

string   $cookie_path  

[ Top ]

method set_following [line 1069]

boolean set_following( [int $user_id = 0], [boolean $follow = false])

function set_following Update following of user_id. A user can befriend someone, but can unfollow them.

This request is also used to stop following someone as a fan.




Tags:

see:  /API/FriendsFans/setFollowing


Parameters:

int   $user_id   The ID of the user you want to follow/unfollow
boolean   $follow   true if the user should be followed, and false if the user should be unfollowed.

[ Top ]

method set_log_path [line 100]

void set_log_path( [string $log_path = NULL])

function set_log_path set log path



Parameters:

string   $log_path  

[ Top ]

method set_proxy [line 184]

void set_proxy( [string $host = ''], [string $port = 0], [string $username = ''], [string $password = ''])

function set_proxy Set proxy server options while connecting to Plurk API



Parameters:

string   $host   Proxy server host
string   $port   Proxy server port
string   $username   Username for proxy server authentication. Could be ignored if no need.
string   $password   Password for proxy server authentication. Could be ignored if no need.

[ Top ]

method uidToNickname [line 1862]

string uidToNickname( int $uid)

function uidToNickname Compatible with RLPlurkAPI Translates a uid to the corresponding nickname.



Tags:

return:  The nick_name corresponding to the given uid.
todo:  not test yet.


Parameters:

int   $uid   The uid to be translated.

[ Top ]

method uidToUserinfo [line 1890]

array uidToUserinfo( int $int_uid)

function uidToUserinfo Compatible with RLPlurkAPI Retrieve a user's information given a plurk uid.



Tags:

return:  The associative array of user information.
todo:  not implemented yet


Parameters:

int   $int_uid   The uid of the plurk member.

[ Top ]

method unblockUser [line 1836]

bool unblockUser( [array $array_uid = null])

function unblockUser Compatible with RLPlurkAPI



Tags:

return:  Returns true if successful or false otherwise.


Parameters:

array   $array_uid   The array of user ids to be unblocked.

[ Top ]

method unblock_user [line 1382]

boolean unblock_user( [user_id: $user_id = 0])

function unblock_user



Tags:

see:  /API/Blocks/unblock


Parameters:

user_id:   $user_id   The id of the user that should be unblocked.

[ Top ]

method unfavorite_plurk [line 750]

boolean unfavorite_plurk( $ids $ids)

function unfavorite_plurk



Tags:

see:  /API/Timeline/unfavoritePlurks


Parameters:

$ids   $ids   The plurk ids, eg. array(123,456,789)

[ Top ]

method unmute_plurks [line 708]

boolean unmute_plurks( $ids $ids)

function unmute_plurks



Tags:

see:  /API/Timeline/unmutePlurks


Parameters:

$ids   $ids   The plurk ids, eg. array(123,456,789)

[ Top ]

method update [line 316]

boolean update( [string $current_password = NULL], [string $full_name = NULL], [string $new_password = NULL], [string $email = NULL], [string $display_name = NULL], [string $privacy = NULL], [string $date_of_birth = NULL])

function update Update a user's information (such as email, password or privacy).

Should be HTTPS




Tags:

see:  /API/Users/update


Parameters:

string   $current_password   User's current password.
string   $full_name   Change full name.
string   $new_password   Change password.
string   $email   Change email.
string   $display_name   User's display name, can be empty and full unicode. Must be shorter than 15 characters.
string   $privacy   User's privacy settings. The option can be world (whole world can view the profile), only_friends (only friends can view the profile) or only_me (only the user can view own plurks).
string   $date_of_birth   Should be YYYY-MM-DD, example 1985-05-13.

[ Top ]

method update_picture [line 354]

JSON update_picture( [string $profile_image = ''])

function update_picture update a user's profile picture.

You can read more about how to render an avatar via user data.




Tags:

return:  object
see:  /API/Users/updatePicture


Parameters:

string   $profile_image   The new profile image.

[ Top ]

method upload_picture [line 796]

JSON upload_picture( [string $upload_image = ''])

function upload_picture to upload a picture to Plurk, you should do a multipart/form-data POST request to /API/Timeline/uploadPicture.

This will add the picture to Plurk's CDN network and return a image link that you can add to /API/Timeline/plurkAdd




Tags:

return:  object
see:  /API/Timeline/uploadPicture


Parameters:

string   $upload_image  

[ Top ]


Documentation generated on Tue, 16 Nov 2010 14:58:44 +0800 by phpDocumentor 1.4.3