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
function add_all_as_fan Accept all friendship requests as fans.
Boolean
add_all_as_fan
()
function add_all_as_friends Accept all friendship requests as friends.
boolean
add_all_as_friends
()
function add_as_fan Accept user_id as fan.
Boolean
add_as_fan
([int $user_id = 0])
-
int
$user_id: The user_id that has asked for friendship.
function add_as_friend Accept user_id as friend.
Boolean
add_as_friend
([int $user_id = 0])
-
int
$user_id: The user_id that has asked for friendship.
function add_Plurk
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
function add_response
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
function add_to_clique add friend to clique
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
function become_fan
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.
function become_friend
boolean
become_friend
([int $friend_id = 0])
-
int
$friend_id: The ID of the user you want to befriend.
function befriend Compatible with RLPlurkAPI
void
befriend
([array $array_uid = null], [ $bool_befriend = false])
-
array
$array_uid: The array of firend uids.
-
$bool_befriend
function blockUser Compatible with RLPlurkAPI
bool
blockUser
([array $array_uid = null])
-
array
$array_uid: The array of user ids to be blocked.
funciton block_user
boolean
block_user
([int $user_id = 0])
-
int
$user_id: The id of the user that should be blocked.
function create_clique create clique
boolean
create_clique
([string $clique_name = ''])
-
string
$clique_name: The name of the new clique
function deletePlurk Compatible with RLPlurkAPI delete a plurk
bool
deletePlurk
(array $int_plurk_id)
-
array
$int_plurk_id: The plurk id to be deleted.
function delete_clique delete clique
boolean
delete_clique
([string $clique_name = ''])
-
string
$clique_name: The name of the new clique
function delete_plurk
boolean
delete_plurk
([ $plurk_id = 0], int $plurk_id:)
-
int
$plurk_id:: The id of the plurk.
-
$plurk_id
function delete_response
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.
function denyFriendMakeFan Compatible with RLPlurkAPI
void
denyFriendMakeFan
([array $array_uid = null])
-
array
$array_uid: The array of friend requests uids.
function deny_friendship Deny friendship to user_id.
Boolean
deny_friendship
([int $user_id = 0])
-
int
$user_id: The user_id that has asked for friendship.
function edit_plurk
JSON
edit_plurk
([int $plurk_id = 0], [string $content = ''])
-
int
$plurk_id: The id of the plurk.
-
string
$content: The content of plurk.
function getAlerts Compatible with RLPlurkAPI
JSON
getAlerts
()
function getBlockedUsers Compatible with RLPlurkAPI Get my list of blocked users.
array
getBlockedUsers
()
function getCities Compatible with RLPlurkAPI Get cities.
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.
function getCountries Compatible with RLPlurkAPI Get thie list of countries.
array
getCountries
([int $int_uid = null])
-
int
$int_uid: The user's UID to be passed to the getCountries.
function getPermalink Compatible with RLPlurkAPI Convert a plurk ID to a permalink URL.
string
getPermalink
(int $plurk_id)
-
int
$plurk_id: The plurk ID number.
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.
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.
function getRegions Compatible with RLPlurkAPI Get the regions in a given country.
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.
function getResponses Compatible with RLPlurkAPI Get the responses of a plurk. This method will load "temporary" friends who have responded to the plurk.
array
getResponses
(int $int_plurk_id)
-
int
$int_plurk_id: The plurk ID
function getUnreadPlurks Compatible with RLPlurkAPI Get the unread plurks.
array
getUnreadPlurks
([bool $fetch_responses = false])
-
bool
$fetch_responses: If true, populate the responses_fetch value with the array of responses.
function get_active Return a JSON list of current active alert
JSON
get_active
()
function get_blocks
JSON
get_blocks
([int $offset = 0])
-
int
$offset: What page should be shown, e.g. 0, 10, 20.
function get_clique get users from clique
array
get_clique
([string $clique_name = ''])
-
string
$clique_name: The name of the new clique
function get_cliques
JSON
get_cliques
()
function get_completion Returns a JSON object of the logged in users friends (nick name and full name).
JSON
get_completion
()
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.
JSON
get_emoticons
()
function get_fans
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.
function get_following
JSON
get_following
([int $offset = 0])
-
int
$offset: The offset, can be 10, 20, 30 etc.
function get_friends
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.
function get_history Return a JSON list of past 30 alerts.
JSON
get_history
()
function get_http_response Get HTTP Server Response
int
get_http_response
()
function get_http_status Get HTTP Status Code
int
get_http_status
()
function get_login_status Get login status
boolean
get_login_status
()
function get_own_profile
JSON
get_own_profile
()
function get_permalink transfer plurk_id to permalink
string.
get_permalink
($plurk_id $plurk_id)
function get_plurks
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.
function get_plurks
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.
function get_plurks_polling
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).
function get_plurk_id transfer permalink to plurk_id
int.
get_plurk_id
($permalink $permalink)
function get_public_profile
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).
function get_responses
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
function get_unread_plurks
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.
function get_user_info Get user information
JSON
get_user_info
()
function isLoggedIn Compatible with RLPlurkAPI
boolean
isLoggedIn
()
function login Login an already created user. Login creates a session cookie, which can be used to access the other methods.
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.
function login Logout current user.
boolean
logout
()
function mark_plurk_as_read
boolean
mark_plurk_as_read
($ids $ids)
-
$ids
$ids: The plurk ids, eg. array(123,456,789)
function mutePlurk Compatible with RLPlurkAPI Mute or unmute plurks
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.
function mute_plurks
boolean
mute_plurks
($ids $ids)
-
$ids
$ids: The plurk ids, eg. array(123,456,789)
function nicknameToUid Compatible with RLPlurkAPI Retrieve a user's uid from given his/her plurk nick name.
int
nicknameToUid
(string $string_nick_name)
-
string
$string_nick_name: The nickname of the user to retrieve the uid from.
function permalinkToPlurkID Compatible with RLPlurkAPI Convert a plurk permalink URL address to a plurk ID.
int
permalinkToPlurkID
(string $string_permalink)
-
string
$string_permalink: The plurk permalink URL address.
function plurk Connect to Plurk
JSON
plurk
($url $url, $array $array)
function register Register a new Plurk account. Should be HTTPS
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
function remove_Friend
boolean
remove_Friend
([int $friend_id = 0])
-
int
$friend_id: The ID of the user you want to befriend.
function remove_from_clique() remove friend from clique
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
function remove_notification Remove notification to user with id user_id.
Boolean
remove_notification
([int $user_id = 0])
-
int
$user_id: The user_id that the current user has requested friendship for.
function rename_clique 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.
function respondToPlurk Compatible with RLPlurkAPI Respond to a 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
function search_plurk Returns the latest 20 plurks on a search term.
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.
function search_user Returns 10 users that match query, users are sorted by karma.
JSON
search_user
([string $query = ''], [int $offset = 0])
-
string
$query: The query after users.
-
int
$offset: Page offset, like 10, 20, 30 etc.
function set_cookie_path set curl cookie path
void
set_cookie_path
([string $cookie_path = NULL])
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.
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.
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.
function uidToNickname Compatible with RLPlurkAPI Translates a uid to the corresponding nickname.
string
uidToNickname
(int $uid)
-
int
$uid: The uid to be translated.
function uidToUserinfo Compatible with RLPlurkAPI Retrieve a user's information given a plurk uid.
array
uidToUserinfo
(int $int_uid)
-
int
$int_uid: The uid of the plurk member.
function unblockUser Compatible with RLPlurkAPI
bool
unblockUser
([array $array_uid = null])
-
array
$array_uid: The array of user ids to be unblocked.
function unblock_user
boolean
unblock_user
([user_id: $user_id = 0])
-
user_id:
$user_id: The id of the user that should be unblocked.
function unmute_plurks
boolean
unmute_plurks
($ids $ids)
-
$ids
$ids: The plurk ids, eg. array(123,456,789)
function update Update a user's information (such as email, password or privacy). Should be HTTPS
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.
function update_picture update a user's profile picture. You can read more about how to render an avatar via user data.
JSON
update_picture
([string $profile_image = ''])
-
string
$profile_image: The new profile 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
JSON
upload_picture
([string $upload_image = ''])
Inherited Methods
Inherited From common
common::log()
common::__consturct()
common::__deconstruct()