namespace phpnut;
+use CURLFile;
+
/**
* phpnut.php
* pnut.io PHP library
// if processing stream_markers or any fast stream, decrease $sleepFor
public $streamingSleepFor = 20000;
+ private $_clientId;
+
+ private $_clientSecret;
+
/**
* Constructs an phpnut PHP object with the specified client ID and
* client secret.
* from the user. If you don't specify anything, you'll only receive
* access to the user's basic profile (the default).
*/
- public function getAuthUrl(?string $callback_uri=null, array|string|null $scope=null): string
+ public function getAuthUrl(?string $callback_uri=null, array $scope=null): string
{
if (empty($this->_clientId)) {
throw new phpnutException('You must specify your pnut client ID');
/**
* Check the scope of current token to see if it has required scopes
* has to be done after a check
+ *
+ * @return int|array
*/
- public function checkScopes(array $app_scopes): int|array
+ public function checkScopes(array $app_scopes)
{
if (count($this->_scopes) === 0) {
return -1; // _scope is empty
{
return $this->httpReq('delete', "{$this->_baseUrl}token");
}
-
+
/**
* Retrieve an app access token from the app.net API. This allows you
* to access the API without going through the user access flow if you
* @return string The app access token
*/
public function getAppAccessToken()
- {
+ {
if (empty($this->_clientId) || empty($this->_clientSecret)) {
throw new phpnutException('You must specify your Pnut client ID and client secret');
}
/**
* Internal function to handle all
* HTTP requests (POST,PUT,GET,DELETE)
+ *
+ * @param string|array $params
*/
- protected function httpReq(string $act, string $req, string|array $params=[], string $contentType='application/x-www-form-urlencoded')
+ protected function httpReq(string $act, string $req, $params = [], string $contentType='application/x-www-form-urlencoded')
{
$ch = curl_init($req);
$headers = [];
} else {
throw new phpnutException($response['error']);
}
- }
+ }
// look for response migration errors
elseif (isset($response['meta'], $response['meta']['error_message'])) {
{
return $this->_last_request;
}
-
+
public function getLastResponse()
{
return $this->_last_response;
* Retrieve the Posts that are 'in reply to' a specific Post.
* @param integer $post_id The ID of the post you want to retrieve replies for.
* @param array $params An associative array of optional general parameters.
- * @return An array of associative arrays, each representing a single post.
+ * @return array An array of associative arrays, each representing a single post.
*/
public function getPostThread(int $post_id, array $params=[])
{
* Retrieve revisions of a post. Currently only one can be created.
* @param integer $post_id The ID of the post you want to retrieve previous revisions of.
* @param array $params An associative array of optional general parameters.
- * @return An array of associative arrays, each representing a single post.
+ * @return array An array of associative arrays, each representing a single post.
*/
public function getPostRevisions(int $post_id, array $params=[])
{
/**
* Get the most recent Posts created by a specific User in reverse
* chronological order (most recent first).
- * @param mixed $user_id Either the ID of the user you wish to retrieve posts by,
+ * @param string|int $user_id $user_id Either the ID of the user you wish to retrieve posts by,
* or the string "me", which will retrieve posts for the user you're authenticated
* as.
* @param array $params An associative array of optional general parameters.
- * @return An array of associative arrays, each representing a single post.
+ * @return array An array of associative arrays, each representing a single post.
*/
- public function getUserPosts(string|int $user_id='me', array $params=[])
+ public function getUserPosts($user_id = 'me', array $params=[])
{
return $this->httpReq(
'get',
/**
* Get the most recent Posts mentioning by a specific User in reverse
* chronological order (newest first).
- * @param mixed $user_id Either the ID of the user who is being mentioned, or
+ * @param string|int $user_id Either the ID of the user who is being mentioned, or
* the string "me", which will retrieve posts for the user you're authenticated
* as.
* @param array $params An associative array of optional general parameters.
- * @return An array of associative arrays, each representing a single post.
+ * @return array An array of associative arrays, each representing a single post.
*/
- public function getUserMentions(string|int $user_id='me', array $params=[])
+ public function getUserMentions($user_id='me', array $params=[])
{
return $this->httpReq(
'get',
/**
* Get the currently authenticated user's recent messages
* @param array $params An associative array of optional general parameters.
- * @return An array of associative arrays, each representing a single post.
+ * @return array An array of associative arrays, each representing a single post.
*/
public function getUserMessages(array $params=[])
{
* Return the 20 most recent posts from the current User and
* the Users they follow.
* @param array $params An associative array of optional general parameters.
- * @return An array of associative arrays, each representing a single post.
+ * @return array An array of associative arrays, each representing a single post.
*/
public function getUserStream(array $params=[])
{
* Retrieve a list of all public Posts on pnut.io, often referred to as the
* global stream.
* @param array $params An associative array of optional general parameters.
- * @return An array of associative arrays, each representing a single post.
+ * @return array An array of associative arrays, each representing a single post.
*/
public function getPublicPosts(array $params=[])
{
/**
* Retrieve a list of "explore" streams
- * @return An array of associative arrays, each representing a single explore stream.
+ * @return array An array of associative arrays, each representing a single explore stream.
*/
public function getPostExploreStreams()
{
* Retrieve a list of posts from an "explore" stream on pnut.io.
* @param string $slug [<description>]
* @param array $params An associative array of optional general parameters.
- * @return An array of associative arrays, each representing a single post.
+ * @return array An array of associative arrays, each representing a single post.
*/
public function getPostExploreStream(string $slug, array $params=[])
{
* are: count, before_id, since_id, include_muted, include_deleted,
* and include_post_raw.
* See https://github.com/phpnut/api-spec/blob/master/resources/posts.md#general-parameters
+ * @param string|int $user_id
* @return array An array of associative arrays, each representing a single
* user who has bookmarked a post
*/
- public function getBookmarked(string|int $user_id='me', array $params=[])
+ public function getBookmarked($user_id='me', array $params=[])
{
return $this->httpReq(
'get',
/**
* Repost an existing Post object.
* @param integer $post_id The id of the post
- * @return the reposted post
+ * @return mixed the reposted post
*/
public function repost(int $post_id)
{
/**
* Delete a post that the user has reposted.
* @param integer $post_id The id of the post
- * @return the un-reposted post
+ * @return mixed the un-reposted post
*/
public function deleteRepost(int $post_id)
{
* This will likely change as the API evolves, as of this writing allowed keys
* are: count, before_id, since_id, include_muted, include_deleted,
* include_directed_posts, and include_raw.
- * @return An array of associative arrays, each representing a single post.
+ * @return array An array of associative arrays, each representing a single post.
*/
public function searchHashtags(string $hashtag, array $params=[])
{
* This will likely change as the API evolves, as of this writing allowed keys
* are: count, before_id, since_id, include_muted, include_deleted,
* and include_post_raw.
- * @return An array of associative arrays, each representing a single post.
+ * @return array An array of associative arrays, each representing a single post.
*/
public function getUserPersonalStream(array $params=[])
{
);
}
}
-
+
/**
* Return the 20 most recent Posts from the current User's personalized stream
* and mentions stream merged into one stream.
* This will likely change as the API evolves, as of this writing allowed keys
* are: count, before_id, since_id, include_muted, include_deleted,
* include_directed_posts, and include_raw.
- * @return An array of associative arrays, each representing a single post.
+ * @return array An array of associative arrays, each representing a single post.
*/
public function getUserUnifiedStream(array $params=[])
{
/**
* Returns a specific user object.
- * @param mixed $user_id The ID of the user you want to retrieve, or the string "@-username", or the string
+ * @param string|int $user_id The ID of the user you want to retrieve, or the string "@-username", or the string
* "me" to retrieve data for the users you're currently authenticated as.
* @param array $params An associative array of optional general parameters.
* This will likely change as the API evolves, as of this writing allowed keys
* are: include_raw|include_user_raw.
* @return array An associative array representing the user data.
*/
- public function getUser(string|int $user_id='me', array $params=[])
+ public function getUser($user_id='me', array $params=[])
{
return $this->httpReq(
'get',
/**
* Add the specified user ID to the list of users followed.
* Returns the User object of the user being followed.
- * @param integer $user_id The user ID of the user to follow.
+ * @param string|int $user_id The user ID of the user to follow.
* @return array An associative array representing the user you just followed.
*/
- public function followUser(string|int $user_id)
+ public function followUser($user_id)
{
return $this->httpReq(
'put',
/**
* Removes the specified user ID to the list of users followed.
* Returns the User object of the user being unfollowed.
- * @param integer $user_id The user ID of the user to unfollow.
+ * @param string|int $user_id The user ID of the user to unfollow.
* @return array An associative array representing the user you just unfollowed.
*/
- public function unfollowUser(string|int $user_id)
+ public function unfollowUser($user_id)
{
return $this->httpReq(
'delete',
/**
* Returns an array of User objects the specified user is following.
- * @param mixed $user_id Either the ID of the user being followed, or
+ * @param string|int $user_id Either the ID of the user being followed, or
* the string "me", which will retrieve posts for the user you're authenticated
* as.
* @return array An array of associative arrays, each representing a single
* user following $user_id
*/
- public function getFollowing(string|int $user_id='me', array $params=[])
+ public function getFollowing($user_id='me', array $params=[])
{
return $this->httpReq(
'get',
. $this->buildQueryString($params)
);
}
-
+
/**
* Returns an array of User ids the specified user is following.
- * @param mixed $user_id Either the ID of the user being followed, or
+ * @param string|int $user_id Either the ID of the user being followed, or
* the string "me", which will retrieve posts for the user you're authenticated
* as.
* @return array user ids the specified user is following.
*/
- public function getFollowingIDs(string|int $user_id='me')
+ public function getFollowingIDs($user_id='me')
{
return $this->httpReq(
'get',
"{$this->_baseUrl}users/{$user_id}/following?include_user=0"
);
}
-
+
/**
* Returns an array of User objects for users following the specified user.
- * @param mixed $user_id Either the ID of the user being followed, or
+ * @param string|int $user_id Either the ID of the user being followed, or
* the string "me", which will retrieve posts for the user you're authenticated
* as.
* @return array An array of associative arrays, each representing a single
* user following $user_id
*/
- public function getFollowers(string|int $user_id='me', array $params=[])
+ public function getFollowers($user_id='me', array $params=[])
{
return $this->httpReq(
'get',
. $this->buildQueryString($params)
);
}
-
+
/**
* Returns an array of User ids for users following the specified user.
- * @param mixed $user_id Either the ID of the user being followed, or
+ * @param string|int $user_id Either the ID of the user being followed, or
* the string "me", which will retrieve posts for the user you're authenticated
* as.
* @return array user ids for users following the specified user
*/
- public function getFollowersIDs(string|int $user_id='me')
+ public function getFollowersIDs($user_id='me')
{
return $this->httpReq(
'get',
/**
* Mute a user
- * @param integer $user_id The user ID to mute
+ * @param string|int $user_id The user ID to mute
*/
- public function muteUser(string|int $user_id)
+ public function muteUser($user_id)
{
return $this->httpReq(
'put',
/**
* Unmute a user
- * @param integer $user_id The user ID to unmute
+ * @param string|int $user_id The user ID to unmute
*/
- public function unmuteUser(string|int $user_id)
+ public function unmuteUser($user_id)
{
return $this->httpReq(
'delete',
* @param string $search The search query. Supports @username or #tag searches as
* well as normal search terms. Searches username, display name, bio information.
* Does not search posts.
- * @return array An array of associative arrays, each representing one user.
+ * @return array|false An array of associative arrays, each representing one user.
*/
public function searchUsers(array $params=[], string $query='')
{
$mimeType = $test['mime'];
}
$data = [
- $which => new CurlFile($image, $mimeType)
+ $which => new CURLFile($image, $mimeType)
];
return $this->httpReq(
'post-raw',
/**
* get an existing private message channel between multiple users
- * @param mixed $users Can be a comma- or space-separated string, or an array.
+ * @param string|array $users Can be a comma- or space-separated string, or an array.
* Usernames with @-symbol, or user ids.
*/
- public function getExistingPM(string|array $users, array $params=[])
+ public function getExistingPM($users, array $params=[])
{
if (is_string($users)) {
$users = explode(',', str_replace(' ', ',', $users));
/**
* Retrieve a list of "explore" streams
- * @return An array of associative arrays, each representing a single explore stream.
+ * @return array An array of associative arrays, each representing a single explore stream.
*/
public function getChannelExploreStreams()
{
* Retrieve a list of channels from an "explore" stream on pnut.io.
* @param string $slug [<description>]
* @param array $params An associative array of optional general parameters.
- * @return An array of associative arrays, each representing a single channel.
+ * @return array An array of associative arrays, each representing a single channel.
*/
public function getChannelExploreStream(string $slug, array $params=[])
{
. $this->buildQueryString($params)
);
}
-
+
/**
* mark channel inactive
*/
/**
* create message
- * @param $channelid numeric or "pm" for auto-channel (type=io.pnut.core.pm)
+ * @param string|int $channelid numeric or "pm" for auto-channel (type=io.pnut.core.pm)
* @param array $data array('text'=>'YOUR_MESSAGE') If a type=io.pnut.core.pm, then "destinations" key can be set to address as an array of people to send this PM too
* @param array $params query parameters
*/
- public function createMessage(string|int $channelid, array $data, array $params=[])
+ public function createMessage($channelid, array $data, array $params=[])
{
if (isset($data['destinations'])) {
if (is_string($data['destinations'])) {
public function createFile($file, array $data, array $params=[])
{
if (!$file) {
- throw new PhpnutException('You must specify a path to a file');
+ throw new phpnutException('You must specify a path to a file');
}
if (!file_exists($file)) {
- throw new PhpnutException('File path specified does not exist');
+ throw new phpnutException('File path specified does not exist');
}
if (!is_readable($file)) {
- throw new PhpnutException('File path specified is not readable');
+ throw new phpnutException('File path specified is not readable');
}
if (!array_key_exists('type', $data) || !$data['type']) {
- throw new PhpnutException('Type is required when creating a file');
+ throw new phpnutException('Type is required when creating a file');
}
if (!array_key_exists('name', $data)) {
$data['name'] = basename($file);
$mimeType = null;
}
if (!array_key_exists('kind', $data)) {
- $test = @getimagesize($path);
+ $test = @getimagesize($file);
if ($test && array_key_exists('mime', $test)) {
$data['kind'] = 'image';
if (!$mimeType) {
finfo_close($finfo);
}
if (!$mimeType) {
- throw new PhpnutException('Unable to determine mime type of file, try specifying it explicitly');
+ throw new phpnutException('Unable to determine mime type of file, try specifying it explicitly');
}
$data['content'] = new \CurlFile($file, $mimeType);
return $this->httpReq(
$json = json_encode($data);
return $this->httpReq(
'post',
- $this->_baseUrl.'polls?'.$this->buildQueryString($params),
+ $this->_baseUrl.'polls?'.$this->buildQueryString($params),
$json,
'application/json'
);
return $this->httpReq(
'put',
$this->_baseUrl.'polls/'.urlencode($poll_id).'/response?'.$this->buildQueryString($params),
- $json,
+ $json,
'application/json'
);
}
$params
);
}
-
+
/**
* Get User Information
*/
"{$this->_baseUrl}token"
);
}
-
+
/**
* Get Application Authorized User IDs
*/
$params
);
}
-
+
/**
* Get Application Authorized User Tokens
*/
{
$this->_streamCallback = $function;
}
-
+
/**
* Opens a stream that's been created for this user/app and starts sending
* events/objects to your defined callback functions. You must define at
);
return true;
}
-
+
/**
* Close the currently open stream.
* @return true;
$this->_currentStream = null;
$this->_multiStream = null;
}
-
+
/**
* Retrieve all streams for the current access token.
* @return array An array of stream definitions.
"{$this->_baseUrl}streams"
);
}
-
+
/**
* Returns a single stream specified by a stream ID. The stream must have been
* created with the current access token.
$this->_baseUrl.'streams/'.urlencode($streamId)
);
}
-
+
/**
* Creates a stream for the current app access token.
*
);
return $response;
}
-
+
/**
* Update stream for the current app access token
*
);
return $response;
}
-
+
/**
* Deletes a stream if you no longer need it.
*
$this->_baseUrl.'streams/'.urlencode($streamId)
);
}
-
+
/**
* Deletes all streams created by the current access token.
*/
"{$this->_baseUrl}streams"
);
}
-
+
/**
* Internal function used to process incoming chunks from the stream. This is only
* public because it needs to be accessed by CURL. Do not call or use this function
}
return strlen($data);
}
-
+
/**
* Opens a long lived HTTP connection to the pnut.io servers, and sends data
* received to the httpStreamReceive function. As a general rule you should not
$this->_lastStreamActivity = time();
curl_multi_add_handle($this->_multiStream, $this->_currentStream);
}
-
+
public function reconnectStream(): void
{
$this->closeStream();
}
$this->httpStream('get', $this->_streamUrl);
}
-
+
/**
* Process an open stream for x microseconds, then return. This is useful if you want
* to be doing other things while processing the stream. If you just want to
}
} while ($timeSoFar+$sleepFor < $microseconds);
}
-
+
/**
* Process an open stream forever. This function will never return, if you
* want to perform other actions while consuming the stream, you should use
projects / friendica-addons.git / commitdiff