Overview

Classes

  • btnapi
  • Overview
  • Class
  • Tree

Class btnapi

An awesome class to give BTNv1 a cool JSON-RPC API

Author: AzzA <azza@broadcasthe.net>
Located at btn_api.php
Methods summary
public
# __construct( )

__construct, to init the mysql class for all functions to use

__construct, to init the mysql class for all functions to use

Var

object
public array
# userInfo( string $key )

returns basic info about the current user

returns basic info about the current user

Parameters

$key
string
$key

Returns

array
$userArray

Values

UserID, Username, Email, Upload, Download, Lumens, Bonus, JoinDate, Title, Enabled, Paranoia, Invites, Class, ClassLevel, UploadsSnatched, Snatches
public array
# getChangelog( )

returns the api change log

returns the api change log

Returns

array
$changeArray
public array
# getNews( string $key )

get the latest 5 news posts

get the latest 5 news posts

Parameters

$key
string
$key

Returns

array
$newsArray

Values

Title, Body, Time, Author
public array
# getNewsById( string $key, string $id )

get a single news post based on id

get a single news post based on id

Parameters

$key
string
$key
$id
string
$id

Returns

array
$newsArray

Values

Title, Body, Time, Author
public array
# getBlog( string $key )

get the latest 5 blog posts

get the latest 5 blog posts

Parameters

$key
string
$key

Returns

array
$blogArray

Values

Title, Body, Time, Author
public array
# getBlogById( string $key, string $id )

get a single blog post based on id

get a single blog post based on id

Parameters

$key
string
$key
$id
string
$id

Returns

array
$blogArray

Values

Title, Body, Time, Author
public array
# getTVNews( string $key )

get the latest 5 tvnews posts

get the latest 5 tvnews posts

Parameters

$key
string
$key

Returns

array
$newsArray

Values

Title, Body, Time, Author
public array
# getTVNewsById( string $key, string $id )

get a single tvnews post based on id

get a single tvnews post based on id

Parameters

$key
string
$key
$id
string
$id

Returns

array
$newsArray

Values

Title, Body, Time, Author
public array
# getInbox( string $key, string $page = 1 )

get a list of recent PMs for the user

get a list of recent PMs for the user

Parameters

$key
string
$key
$page
string
$page

Returns

array
$pmArray
public array
# getInboxConversation( string $key, string $ConvID )

get a conversation by convoid

get a conversation by convoid

Parameters

$key
string
$key
$ConvID
string
$convid

Returns

array
$pmArray
public string
# sendInboxConversation( string $key, string $ConvID, string $Body )

send to a conversation by convoid

send to a conversation by convoid

Parameters

$key
string
$key
$ConvID
string
$ConvID
$Body
string
$Body

Returns

string
"success"
public array
# getSchedule( string $key, string $sort = 'today' )

get a television schedule

get a television schedule

Parameters

$key
string
$key
$sort
string
$sort

Returns

array
$tvArray
public array
# getNewSeries( string $key )

get the latest new series

get the latest new series

Parameters

$key
string
$key

Returns

array
$tvArray
public array
# getTorrentsBrowse( string $key, integer $results = 10, integer $offset = 0 )

get the torrents browse page [Deprecated, use getTorrents]

get the torrents browse page [Deprecated, use getTorrents]

Parameters

$key
string
$key
$results
integer
$results
$offset
integer
$offset

Returns

array
$torrentArray
public array
# getTorrentsSearch( string $key, string|array $searchstr, integer $results = 10, integer $offset = 0 )

get the torrents search page [Deprecated, use getTorrents]

get the torrents search page [Deprecated, use getTorrents]

Parameters

$key
string
$key
$searchstr
string|array
$searchstr
$results
integer
$results
$offset
integer
$offset

Returns

array
$torrentArray
public array
# getTorrents( string $key, string|array $search, integer $results = 10, integer $offset = 0 )

search/browse for torrents.

search/browse for torrents.

Parameters

$key
string
$key
$search
string|array
$search
$results
integer
$results
$offset
integer
$offset

Returns

array
$torrentArray

Comment

search can be either a search string, or a search array. array currently accepts: - id: Torrent ID - series: Series Name - category: 'Season' or 'Episode' - name: Group Name - search: General text search - codec - one or more of "XViD", "x264", "MPEG2", "DiVX", "DVDR", "VC-1", "h.264", "WMV", "BD", "x264-Hi10P" - container - one or more of "AVI", "MKV", "VOB", "MPEG", "MP4", "ISO", "WMV", "TS", "M4V", "M2TS" - source - one or more of "HDTV","PDTV","DSR","DVDRip","TVRip","VHSRip","Bluray","BDRip","BRRip","DVD5","DVD9","HDDVD","WEB","BD5","BD9","BD25","BD50","Mixed" - resolution - one or more of "Portable Device", "SD", "720p", "1080i", "1080p" - origin - one or more of "Scene", "P2P", "User" - hash: torrent infohash - tvdb: TVDB Series ID - tvrage: tvrage series id - time: time torrent was uploaded. - age: age of the torrent in seconds. Numeric values will accept a prefix of >, <, >=, or <=. eg. {"age": ">=3600"} String fields accept sql LIKE wildcards, but do not use any by default. eg. {"Series": "Simpsons"} will not return results. {"Series": "%Simpsons"} will. % - Represents any number of characters. _ - represents a single character. prefix % or _ with \\ for a literal % or _. All of the field names are case-insensitive, as are the values of the string 'choice' fields.
public string
# getTorrentsUrl( string $key, string $TorrentID )

get a torrent's download link

get a torrent's download link

Parameters

$key
string
$key
$TorrentID
string
$TorrentID

Returns

string
$url

Comment

gief torrent id, and thou shall recieve a download link
public array
# getForumsIndex( string $key, mixed $lastPost = 1 )

get the forum main page

get the forum main page

Parameters

$key
string
$key
$lastPost

Returns

array
$forumArray

Comment

Gives you a list of forums :3

Optional

bool $lastPost
public array
# getForumsPage( string $key, mixed $ForumID, mixed $Page = 1 )

get the threads in a forum

get the threads in a forum

Parameters

$key
string
$key
$ForumID
$Page

Returns

array
$forumArray

Comment

Well, it returns the threads in a forum O.o
public array
# getTorrentById( integer $key, mixed $id )

get a torrent by it's torrentId

get a torrent by it's torrentId

Parameters

$key
integer
$id
$id

Returns

array
$torrentInfo
public array
# getUserSubscriptions( string $key )

get a user's subscription list

get a user's subscription list

Parameters

$key
string
$key

Returns

array
$SubArray
public
# getUserSnatchlist( string $key, string $results = 10, mixed $offset = 0 )

get a users hnr list

get a users hnr list

Parameters

$key
string
$key
$results
string
$results
$offset
public
# getUserStats( mixed $key )
Properties summary
public string $DB
#

Declaration of the $DB variable!

Declaration of the $DB variable!

BTN API API documentation generated by ApiGen 2.8.0