Class plurk_api

Description

This is a PHP Plurk API.

Located in /plurk_api.php (line 19)

common
   |
   --plurk_api
Variable Summary
 $api_key $api_key
 string $avatar
 string $cookie_path
 string $display_name
 string $full_name
 int $gender
 bool $is_login
 int $karma
 string $location
 string $nick_name
 string $page_title
 string $password
 boolean $privacy
 string $proxy
 string $proxy_auth
 string $relationship
 int $uid
 string $username
 JSON $user_info
Method Summary
 plurk_api __construct ()
 boolean addPlurk ([ $lang = 'en'], [ $qualifier = 'says'], [ $content = 'test from roga-plurk-api'], [ $limited_to = NULL], [ $no_comments = 0])
 Boolean add_all_as_fan ()
 boolean add_all_as_friends ()
 Boolean add_as_fan ([int $user_id = 0])
 Boolean add_as_friend ([int $user_id = 0])
 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)
 JSON add_response ([int $plurk_id = 0], [string $content = ''], [string $qualifier = 'says'])
 boolean add_to_clique ([string $clique_name = ''], [int $user_id = 0])
 boolean become_fan ([int $fan_id = 0])
 boolean become_friend ([int $friend_id = 0])
 void befriend ([array $array_uid = null], [ $bool_befriend = false])
 bool blockUser ([array $array_uid = null])
 boolean block_user ([int $user_id = 0])
 boolean create_clique ([string $clique_name = ''])
 bool deletePlurk (array $int_plurk_id)
 boolean delete_clique ([string $clique_name = ''])
 boolean delete_plurk ([ $plurk_id = 0], int $plurk_id:)
 boolean delete_response ([int $plurk_id = 0], [int $response_id = 0])
 void denyFriendMakeFan ([array $array_uid = null])
 Boolean deny_friendship ([int $user_id = 0])
 JSON edit_plurk ([int $plurk_id = 0], [string $content = ''])
 JSON getAlerts ()
 array getBlockedUsers ()
 array getCities ([int $int_uid = null], [int $int_region_id = null])
 array getCountries ([int $int_uid = null])
 string getPermalink (int $plurk_id)
 array getPlurks ([int $int_uid = null], [string $date_from = null], [string $date_offset = null], [bool $fetch_responses = false], [bool $self_plurks_only = false])
 array getRegions ([int $int_uid = null], [int $int_country_id = null])
 array getResponses (int $int_plurk_id)
 array getUnreadPlurks ([bool $fetch_responses = false])
 JSON get_active ()
 JSON get_blocks ([int $offset = 0])
 array get_clique ([string $clique_name = ''])
 JSON get_cliques ()
 JSON get_completion ()
 JSON get_emoticons ()
 JSON get_fans ([int|string $user_id = 0], [int $offset = 0])
 JSON get_following ([int $offset = 0])
 JSON get_friends ([int|string $user_id = 0], [int $offset = 0])
 JSON get_history ()
 boolean get_login_status ()
 JSON get_own_profile ()
 string. get_permalink ($plurk_id $plurk_id)
 JSON get_plurk ([int $plurk_id = 0])
 JSON get_plurks ([time $offset = NULL], [int $limit = 20], [int $only_user = NULL], [boolean $only_responded = NULL], [boolean $only_private = NULL])
 JSON get_plurks_polling ([time $offset = NULL], [int $limit = 50])
 int. get_plurk_id ($permalink $permalink)
 JSON get_public_profile ([int $user_id = 0])
 JSON get_responses ([ $plurk_id = 0], [ $offset = 0], int $plurk_id:, int $offset:)
 JSON get_unread_plurks ([time $offset = null], [int $limit = 10])
 JSON get_user_info ()
 boolean isLoggedIn ()
 boolean login ([$api_key $api_key = ''], [$username $username = ''], [$password $password = ''])
 boolean logout ()
 boolean mark_plurk_as_read ($ids $ids)
 bool mutePlurk (array $int_plurk_id, bool $bool_setmute)
 boolean mute_plurks ($ids $ids)
 int nicknameToUid (string $string_nick_name)
 int permalinkToPlurkID (string $string_permalink)
 JSON plurk ($url $url, $array $array)
 JSON register ([string $nick_name = ''], [string $full_name = ''], [string $password = ''], [string $gender = 'male'], [string $date_of_birth = '0000-00-00'], [ $email = NULL])
 boolean remove_Friend ([int $friend_id = 0])
 boolean remove_from_clique ([string $clique_name = ''], [int $user_id = 0])
 Boolean remove_notification ([int $user_id = 0])
 boolean rename_clique ([string $clique_name = ''], [string $new_name = ''])
 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)
 JSON search_plurk ([string $query = ''], [int $offset = 0])
 JSON search_user ([string $query = ''], [int $offset = 0])
 void set_cookie_path ([string $cookie_path = NULL])
 boolean set_following ([int $user_id = 0], [boolean $follow = false])
 void set_proxy ([string $host = ''], [string $port = 0], [string $username = ''], [string $password = ''])
 string uidToNickname (int $uid)
 array uidToUserinfo (int $int_uid)
 bool unblockUser ([array $array_uid = null])
 boolean unblock_user ([user_id: $user_id = 0])
 boolean unmute_plurks ($ids $ids)
 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])
 JSON update_picture ([string $profile_image = ''])
 JSON upload_picture ([string $upload_image = ''])
Variables
int $alerts_count (line 156)

alert count

  • access: protected
$api_key $api_key (line 43)

API KEY

  • access: protected
string $avatar (line 96)

Specifies what the latest avatar (profile picture) version is.

  • access: protected
string $cookie_path = NULL (line 25)

cookie file path.

  • access: protected
string $date_of_birth (line 108)

date_of_birth: The user's birthday.

  • access: protected
string $display_name (line 85)

The non-unique display name of the user, for example Amir S. Only set if it's non empty.

  • access: protected
int $fans_count (line 150)

fans count

  • access: protected
int $friends_count (line 162)

friends count

  • access: protected
string $full_name (line 114)

The user's full name, like Amir Salihefendic.

  • access: protected
int $gender (line 120)

1 is male, 0 is female.

  • access: protected
int $has_profile_image (line 90)

If 1 then the user has a profile picture, otherwise the user should use the default.

  • access: protected
JSON $http_response (line 61)

Current HTTP Server Response

  • var: object $http_response
  • access: protected
int $http_status (line 55)

Current HTTP Status Code

  • access: protected
bool $is_login = FALSE (line 49)

Login status

  • access: protected
int $karma (line 132)

User's karma value.

  • access: protected
string $location (line 102)

The user's location, a text string, for example Aarhus Denmark.

  • access: protected
string $nick_name (line 79)

The unique nick_name of the user, for example amix.

  • access: protected
string $page_title (line 126)

The profile title of the user.

  • access: protected
string $password (line 37)

Password

  • access: protected
boolean $privacy (line 168)

Plurk Privacy

  • access: protected
string $proxy = NULL (line 174)

String contains proxy host and port for CURL connection

  • access: protected
string $proxy_auth = NULL (line 180)

String contains proxy authentication for CURL connection

  • access: protected
int $recruited (line 138)

How many friends has the user recruited.

  • access: protected
string $relationship (line 144)

Can be not_saying, single, married, divorced, engaged, in_relationship, complicated, widowed, open_relationship

  • access: protected
int $uid (line 73)

The unique user id.

  • access: protected
string $username (line 31)

User name

  • access: protected
JSON $user_info (line 67)

User infomation

  • var: object $user_info
  • access: protected
Methods
Constructor __construct (line 182)
plurk_api __construct ()
addPlurk (line 722)

function addPlurk Compatible with RLPlurkAPI

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

function add_all_as_fan Accept all friendship requests as fans.

  • see: /API/Alerts/addAllAsFan
Boolean add_all_as_fan ()
add_all_as_friends (line 1255)

function add_all_as_friends Accept all friendship requests as friends.

  • see: /API/Alerts/addAllAsFriends
boolean add_all_as_friends ()
add_as_fan (line 1193)

function add_as_fan Accept user_id as fan.

  • see: /API/Alerts/addAsFan
Boolean add_as_fan ([int $user_id = 0])
  • int $user_id: The user_id that has asked for friendship.
add_as_friend (line 1215)

function add_as_friend Accept user_id as friend.

  • see: /API/Alerts/addAsFriend
Boolean add_as_friend ([int $user_id = 0])
  • int $user_id: The user_id that has asked for friendship.
add_plurk (line 687)

function add_Plurk

  • return: object
  • see: /API/Timeline/plurkAdd
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)
  • 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
add_response (line 876)

function add_response

  • return: object
  • see: /API/Responses/responseAdd
JSON add_response ([int $plurk_id = 0], [string $content = ''], [string $qualifier = 'says'])
  • 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
add_to_clique (line 1682)

function add_to_clique add friend to clique

  • see: /API/Cliques/add
boolean add_to_clique ([string $clique_name = ''], [int $user_id = 0])
  • string $clique_name: The name of the clique to add.
  • int $user_id: The user to add to the clique
become_fan (line 1087)

function become_fan

  • see: /API/FriendsFans/becomeFan
boolean become_fan ([int $fan_id = 0])
  • 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.
become_friend (line 1045)

function become_friend

  • see: /API/FriendsFans/becomeFriend
boolean become_friend ([int $friend_id = 0])
  • int $friend_id: The ID of the user you want to befriend.
befriend (line 1295)

function befriend Compatible with RLPlurkAPI

  • todo: should modify in a better way
void befriend ([array $array_uid = null], [ $bool_befriend = false])
  • array $array_uid: The array of firend uids.
  • $bool_befriend
blockUser (line 1500)

function blockUser Compatible with RLPlurkAPI

  • return: Returns true if successful or false otherwise.
bool blockUser ([array $array_uid = null])
  • array $array_uid: The array of user ids to be blocked.
block_user (line 1480)

funciton block_user

  • see: /API/Blocks/block
boolean block_user ([int $user_id = 0])
  • int $user_id: The id of the user that should be blocked.
create_clique (line 1606)

function create_clique create clique

  • see: /API/Cliques/create_clique
boolean create_clique ([string $clique_name = ''])
  • string $clique_name: The name of the new clique
deletePlurk (line 795)

function deletePlurk Compatible with RLPlurkAPI delete a plurk

  • return: Returns true if successful or false otherwise.
bool deletePlurk (array $int_plurk_id)
  • array $int_plurk_id: The plurk id to be deleted.
delete_clique (line 1634)

function delete_clique delete clique

  • see:
boolean delete_clique ([string $clique_name = ''])
  • string $clique_name: The name of the new clique
delete_plurk (line 773)

function delete_plurk

  • see: /API/Timeline/plurkDelete
boolean delete_plurk ([ $plurk_id = 0], int $plurk_id:)
  • int $plurk_id:: The id of the plurk.
  • $plurk_id
delete_response (line 927)

function delete_response

  • see: /API/Responses/responseDelete
boolean delete_response ([int $plurk_id = 0], [int $response_id = 0])
  • int $response_id: The plurk that the responses should be added to.
  • int $plurk_id: The plurk that the response belongs to.
denyFriendMakeFan (line 1324)

function denyFriendMakeFan Compatible with RLPlurkAPI

  • todo: should modify in a better way
void denyFriendMakeFan ([array $array_uid = null])
  • array $array_uid: The array of friend requests uids.
deny_friendship (line 1274)

function deny_friendship Deny friendship to user_id.

  • see: /API/Alerts/denyFriendship
Boolean deny_friendship ([int $user_id = 0])
  • int $user_id: The user_id that has asked for friendship.
edit_plurk (line 808)

function edit_plurk

  • return: object
  • see: /API/Timeline/plurkEdit
JSON edit_plurk ([int $plurk_id = 0], [string $content = ''])
  • int $plurk_id: The id of the plurk.
  • string $content: The content of plurk.
getAlerts (line 1163)

function getAlerts Compatible with RLPlurkAPI

  • return: object
JSON getAlerts ()
getBlockedUsers (line 1468)

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

  • return: Returns an array of blocked users.
array getBlockedUsers ()
getCities (line 1873)

function getCities Compatible with RLPlurkAPI Get cities.

  • return: The associative array of cities within a region and their details.
  • todo: not implemented yet
array getCities ([int $int_uid = null], [int $int_region_id = null])
  • 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.
getCountries (line 1902)

function getCountries Compatible with RLPlurkAPI Get thie list of countries.

  • return: The associative array of countries and their details.
  • todo: not implemented yet
array getCountries ([int $int_uid = null])
  • int $int_uid: The user's UID to be passed to the getCountries.
getPermalink (line 1845)

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

  • return: The permalink URL address.
string getPermalink (int $plurk_id)
  • int $plurk_id: The plurk ID number.
getPlurks (line 535)

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.

  • return: The array (numerical) of plurks (an associative subarray).
  • todo: Should rewrite.
array getPlurks ([int $int_uid = null], [string $date_from = null], [string $date_offset = null], [bool $fetch_responses = false], [bool $self_plurks_only = false])
  • 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.
getRegions (line 1888)

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

  • return: The associative array of regions in a country and their details.
  • todo: not implemented yet
array getRegions ([int $int_uid = null], [int $int_country_id = null])
  • 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.
getResponses (line 862)

function getResponses Compatible with RLPlurkAPI Get the responses of a plurk. This method will load "temporary" friends who have responded to the plurk.

  • return: The array of responses.
array getResponses (int $int_plurk_id)
  • int $int_plurk_id: The plurk ID
getUnreadPlurks (line 576)

function getUnreadPlurks Compatible with RLPlurkAPI Get the unread plurks.

  • return: The array (numerical) of unread plurks (an associative subarray).
  • todo: $fetch_responses not implemented
array getUnreadPlurks ([bool $fetch_responses = false])
  • bool $fetch_responses: If true, populate the responses_fetch value with the array of responses.
get_active (line 1148)

function get_active Return a JSON list of current active alert

  • return: object
  • see: /API/Alerts/getActive
JSON get_active ()
get_blocks (line 1448)

function get_blocks

  • return: list
  • see: /API/Blocks/get
JSON get_blocks ([int $offset = 0])
  • int $offset: What page should be shown, e.g. 0, 10, 20.
get_clique (line 1585)

function get_clique get users from clique

  • see: /API/Cliques/get_clique
array get_clique ([string $clique_name = ''])
  • string $clique_name: The name of the new clique
get_cliques (line 1568)

function get_cliques

  • return: object
  • see: /API/Cliques/get_cliques
JSON get_cliques ()
get_completion (line 1132)

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

  • return: object
  • see: /API/FriendsFans/getCompletion
JSON get_completion ()
get_emoticons (line 1430)

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.

  • return: object
  • see: /API/Emoticons/get
JSON get_emoticons ()
get_fans (line 1006)

function get_fans

  • return: object
  • see: /API/FriendsFans/getFansByOffset
JSON get_fans ([int|string $user_id = 0], [int $offset = 0])
  • int|string $user_id: The user_id of the public profile. Can be integer (like 34) or nick name (like amix).
  • int $offset: The offset, can be 10, 20, 30 etc.
get_following (line 1026)

function get_following

  • return: object
  • see: /API/FriendsFans/getFollowingByOffset
JSON get_following ([int $offset = 0])
  • int $offset: The offset, can be 10, 20, 30 etc.
get_friends (line 986)

function get_friends

  • return: objects
  • see: /API/FriendsFans/getFriendsByOffset
JSON get_friends ([int|string $user_id = 0], [int $offset = 0])
  • int|string $user_id: The user_id of the public profile. Can be integer (like 34) or nick name (like amix).
  • int $offset: The offset, can be 10, 20, 30 etc.
get_history (line 1176)

function get_history Return a JSON list of past 30 alerts.

  • return: object
  • see: /API/Alerts/getHistory
JSON get_history ()
get_http_response (line 1806)

function get_http_response Get HTTP Server Response

int get_http_response ()
get_http_status (line 1795)

function get_http_status Get HTTP Status Code

int get_http_status ()
get_login_status (line 1773)

function get_login_status Get login status

boolean get_login_status ()
get_own_profile (line 948)

function get_own_profile

  • return: object
  • see: /API/Profile/getOwnProfile
JSON get_own_profile ()
get_permalink (line 1914)

function get_permalink transfer plurk_id to permalink

string. get_permalink ($plurk_id $plurk_id)
  • $plurk_id $plurk_id
get_plurk (line 476)

function get_plurks

  • return: object
  • see: /API/Timeline/getPlurk
JSON get_plurk ([int $plurk_id = 0])
  • int $plurk_id: The unique id of the plurk. Should be passed as a number, and not base 36 encoded.
get_plurks (line 499)

function get_plurks

  • return: object
  • see: /API/Timeline/getPlurks
JSON get_plurks ([time $offset = NULL], [int $limit = 20], [int $only_user = NULL], [boolean $only_responded = NULL], [boolean $only_private = NULL])
  • time $offset: Return plurks older than offset, use timestamp.
  • int $limit: How many plurks should be returned? Default is 20.
  • int $only_user: The numeric ID of the user who's plurks should be returned.
  • boolean $only_responded: Setting it to true will only return responded plurks.
  • boolean $only_private: Setting it to true will only return private plurks.
get_plurks_polling (line 454)

function get_plurks_polling

  • return: object
  • see: /API/Polling/getPlurks
JSON get_plurks_polling ([time $offset = NULL], [int $limit = 50])
  • time $offset: Return plurks newer than offset, use timestamp.
  • int $limit: The max number of plurks to be returned (default 50).
get_plurk_id (line 1926)

function get_plurk_id transfer permalink to plurk_id

int. get_plurk_id ($permalink $permalink)
  • $permalink $permalink
get_public_profile (line 967)

function get_public_profile

  • return: object
  • see: /API/Profile/getPublicProfile
JSON get_public_profile ([int $user_id = 0])
  • int $user_id: The user_id of the public profile. Can be integer (like 34) or nick name (like amix).
get_responses (line 841)

function get_responses

  • return: object
  • see: /API/Responses/get
JSON get_responses ([ $plurk_id = 0], [ $offset = 0], int $plurk_id:, int $offset:)
  • 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
get_unread_plurks (line 548)

function get_unread_plurks

  • return: object
  • see: /API/Timeline/getUnreadPlurks
JSON get_unread_plurks ([time $offset = null], [int $limit = 10])
  • time $offset: Return plurks older than offset, use timestamp
  • int $limit: Limit the number of plurks that is retunred.
get_user_info (line 1817)

function get_user_info Get user information

  • return: object
JSON get_user_info ()
isLoggedIn (line 1784)

function isLoggedIn Compatible with RLPlurkAPI

  • return: true if we are logged in, false otherwise.
boolean isLoggedIn ()
login (line 308)

function login Login an already created user. Login creates a session cookie, which can be used to access the other methods.

  • see: /API/Users/login
boolean login ([$api_key $api_key = ''], [$username $username = ''], [$password $password = ''])
  • $api_key $api_key: Your Plurk API key.
  • $username $username: The user's nick name or email.
  • $password $password: The user's password.
logout (line 349)

function login Logout current user.

  • see: /API/Users/logout
boolean logout ()
mark_plurk_as_read (line 661)

function mark_plurk_as_read

  • see: /API/Timeline/markAsRead
boolean mark_plurk_as_read ($ids $ids)
  • $ids $ids: The plurk ids, eg. array(123,456,789)
mutePlurk (line 635)

function mutePlurk Compatible with RLPlurkAPI Mute or unmute plurks

  • return: Returns true if successful or false otherwise.
bool mutePlurk (array $int_plurk_id, bool $bool_setmute)
  • 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.
mute_plurks (line 588)

function mute_plurks

  • see: /API/Timeline/mutePlurks
boolean mute_plurks ($ids $ids)
  • $ids $ids: The plurk ids, eg. array(123,456,789)
nicknameToUid (line 1762)

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

  • return: The uid of the given nickname.
  • todo: not implemented yet
int nicknameToUid (string $string_nick_name)
  • string $string_nick_name: The nickname of the user to retrieve the uid from.
permalinkToPlurkID (line 1858)

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

  • return: The plurk ID number.
int permalinkToPlurkID (string $string_permalink)
  • string $string_permalink: The plurk permalink URL address.
plurk (line 192)

function plurk Connect to Plurk

  • return: object
JSON plurk ($url $url, $array $array)
  • $url $url
  • $array $array
register (line 268)

function register Register a new Plurk account. Should be HTTPS

  • return: object
  • see: /API/Users/register
JSON register ([string $nick_name = ''], [string $full_name = ''], [string $password = ''], [string $gender = 'male'], [string $date_of_birth = '0000-00-00'], [ $email = NULL])
  • 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
remove_Friend (line 1066)

function remove_Friend

  • see: /API/FriendsFans/removeAsFriend
boolean remove_Friend ([int $friend_id = 0])
  • int $friend_id: The ID of the user you want to befriend.
remove_from_clique (line 1706)

function remove_from_clique() remove friend from clique

  • see: /API/Cliques/remove
boolean remove_from_clique ([string $clique_name = ''], [int $user_id = 0])
  • string $clique_name: The name of the clique to delete
  • int $user_id: The user to remove from the clique
remove_notification (line 1349)

function remove_notification Remove notification to user with id user_id.

  • see: /API/Alerts/removeNotification
Boolean remove_notification ([int $user_id = 0])
  • int $user_id: The user_id that the current user has requested friendship for.
rename_clique (line 1658)

function rename_clique rename clique

  • see: /API/Cliques/rename_clique
boolean rename_clique ([string $clique_name = ''], [string $new_name = ''])
  • string $clique_name: The name of the current clique.
  • string $new_name: The name of the new clique.
respondToPlurk (line 914)

function respondToPlurk Compatible with RLPlurkAPI Respond to a plurk.

  • return: false on failure, otherwise the http response from plurk.
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)
  • 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
search_plurk (line 1372)

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

  • return: object
  • see: /API/PlurkSearch/search
JSON search_plurk ([string $query = ''], [int $offset = 0])
  • string $query: The query after Plurks.
  • int $offset: A plurk_id of the oldest Plurk in the last search result.
search_user (line 1401)

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

  • return: object
  • see: /API/UserSearch/search
JSON search_user ([string $query = ''], [int $offset = 0])
  • string $query: The query after users.
  • int $offset: Page offset, like 10, 20, 30 etc.
set_cookie_path (line 250)

function set_cookie_path set curl cookie path

void set_cookie_path ([string $cookie_path = NULL])
  • string $cookie_path
set_following (line 1110)

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.

  • see: /API/FriendsFans/setFollowing
boolean set_following ([int $user_id = 0], [boolean $follow = false])
  • 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.
set_proxy (line 235)

function set_proxy Set proxy server options while connecting to Plurk API

void set_proxy ([string $host = ''], [string $port = 0], [string $username = ''], [string $password = ''])
  • 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.
uidToNickname (line 1730)

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

  • return: The nick_name corresponding to the given uid.
  • todo: not test yet.
string uidToNickname (int $uid)
  • int $uid: The uid to be translated.
uidToUserinfo (line 1831)

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

  • return: The associative array of user information.
  • todo: not implemented yet
array uidToUserinfo (int $int_uid)
  • int $int_uid: The uid of the plurk member.
unblockUser (line 1545)

function unblockUser Compatible with RLPlurkAPI

  • return: Returns true if successful or false otherwise.
bool unblockUser ([array $array_uid = null])
  • array $array_uid: The array of user ids to be unblocked.
unblock_user (line 1524)

function unblock_user

  • see: /API/Blocks/unblock
boolean unblock_user ([user_id: $user_id = 0])
  • user_id: $user_id: The id of the user that should be unblocked.
unmute_plurks (line 610)

function unmute_plurks

  • see: /API/Timeline/unmutePlurks
boolean unmute_plurks ($ids $ids)
  • $ids $ids: The plurk ids, eg. array(123,456,789)
update (line 415)

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

  • see: /API/Users/update
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])
  • 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.
update_picture (line 370)

function update_picture update a user's profile picture. You can read more about how to render an avatar via user data.

  • return: object
  • see: /API/Users/updatePicture
JSON update_picture ([string $profile_image = ''])
  • string $profile_image: The new profile image.
upload_picture (line 737)

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

  • return: object
  • see: /API/Timeline/uploadPicture
JSON upload_picture ([string $upload_image = ''])
  • string $upload_image

Inherited Methods

Inherited From common

 common::log()
 common::__consturct()
 common::__deconstruct()

Documentation generated on Wed, 24 Feb 2010 16:27:38 +0800 by phpDocumentor 1.4.3