A simple PHP wrapper for utilising the devRant api.
Include the class:
- Using Composer
composer require pxgamer/devrant-php
<?php
require 'vendor/autoload.php';
- Including the files manually
<?php
include 'src/Connection.php';
include 'src/Rant.php';
Once included, you can initialise the class using either of the following:
$devRant = new \pxgamer\devRant\Connection();
use \pxgamer\devRant\Connection;
$devRant = new Connection();
Method Name | Parameters | Returns |
---|---|---|
getRants($searchterm) | string (optional) | array of Rant objects |
getRantById($id) | int | Rant object |
getUserById($id) | int | array |
getUsersId($username) | string | array |
login($username, $password) | strings | boolean |
logout() | void | void |
rant($rant) | Rant object | array |
comment($rantId, $comment) | mixed | array |
voteRant($rantId, $vote) | mixed | array |
voteComment($commentId, $vote) | mixed | array |
notifs() | void | array |
collabs() | void | array |
deleteRant($rantId) | int | array |
deleteComment($commentId) | int | array |
deleteAccount() | void | array |
$devRant = new \pxgamer\devRant\Connection;
$devRant->getRants(); // Get rants
$devRant->getRants($searchterm); // Get rants using a search query
Returns false on failure, or:
[
0 => Rant object,
1 => Rant object,
...
]
$devRant = new \pxgamer\devRant\Connection;
$devRant->getRantById(int);
Returns false on failure, or a Rant
object.
$devRant = new \pxgamer\devRant\Connection;
$devRant->getUserById(int);
Returns:
[
"success" => true,
"profile" => [
"username" => "",
"score" => 0,
"about" => "",
"location" => "",
"created_time" => 1474613872,
"skills" => "",
"github" => "",
"website" => "",
"content" => [
"content" => [
"rants" => [],
"upvoted" => [],
"comments" => [],
"favorites" => []
[,
"counts" => []
],
"avatar" => []
]
]
$devRant = new \pxgamer\devRant\Connection;
$devRant->getRants('string');
Returns false on failure, or:
[
0 => Rant object [
"id" => 0,
"text" => "string",
"num_upvotes" => 0,
"num_downvotes" => 0,
"score" => 0,
"created_time" => 0,
"attached_image" => [
"url" => "string",
"width" => 0,
"height" => 0
],
"num_comments" => 0,
"tags" => [
"string"
],
"vote_state" => 0,
"edited" => false,
"user_id" => 0,
"user_username" => "string",
"user_score" => 0,
"user_avatar" => [
"b" => "string"
]
],
1 => Rant object,
...
]
$devRant = new \pxgamer\devRant\Connection;
$devRant->getUserId('username');
Returns:
[
"success" => true,
"user_id" => 0
]
$devRant = new \pxgamer\devRant\Connection;
$devRant->login('username', 'password');
Returns true
if successful, false
if not
use \pxgamer\devRant\Rant;
$devRant = new \pxgamer\devRant\Connection;
if ($devRant->login('username', 'password')) {
$devRant->rant(new Rant($rant_content, $tags));
}
Returns:
[
"success" => true,
"rant_id" => 31131
]
$devRant = new \pxgamer\devRant\Connection;
if ($devRant->login('username', 'password')) {
$devRant->comment($rantId, 'Comment Content');
}
Returns:
[
"success" => true
]
$devRant = new \pxgamer\devRant\Connection;
$collabs = $devRant->collabs();
Returns:
[
"success" => true,
"rants" => [
[0] => [
...
]
]
]
$devRant = new \pxgamer\devRant\Connection;
if ($devRant->login('username', 'password')) {
$voteRant = $devRant->voteRant($rantId, $vote);
}
Returns:
[
"success" => true,
"rant" => [
[id] => ...,
...
]
]
$devRant = new \pxgamer\devRant\Connection;
if ($devRant->login('username', 'password')) {
$voteRant = $devRant->voteComment($commentId, $vote);
}
Returns:
[
"success" => true,
"comment" => [
[id] => ...,
...
]
]
$devRant = new \pxgamer\devRant\Connection;
if ($devRant->login('username', 'password')) {
$notifications = $devRant->notifs();
}
Returns:
[
"success" => true,
"data" => {
"items" => [
...
],
"check_time" => 11111,
"username_map" => {
...
}
}
]
Please note that this will permanently delete the rant from devRant.
$devRant = new \pxgamer\devRant\Connection;
if ($devRant->login('username', 'password')) {
$devRant->deleteRant($rantId);
}
Returns:
[
"success" => true
]
Please note that this will permanently delete the comment from devRant.
$devRant = new \pxgamer\devRant\Connection;
if ($devRant->login('username', 'password')) {
$devRant->deleteComment($commentId);
}
Returns:
[
"success" => true
]
Please note that this will permanently delete your account from devRant.
$devRant = new \pxgamer\devRant\Connection;
if ($devRant->login('username', 'password')) {
$devRant->deleteAccount();
}
Returns:
[
"success" => true
]
The MIT License (MIT). Please see License File for more information.