• var: hostname of computer hosting ABC

This property is set when an error occurs

ERROR_PROTOCOL errors do not have an error number

• var: error number

This property is set when an error occurs

• var: error type (see constants)

• var: number of seconds to timeout connection

Constructor that defines constants and sets the default class properties

• version: 1.0

• string $host: hostname of target computer with ABC
• integer $port: port of target computer with ABC
• string $unique_key: unique_key set in ABC
• integer $timeout: connection timeout

$abc->add_torrent( 'http://file1.torrent' );
 
$abc->add_torrent( 'http://file1.torrent', 'C:\\Downloads\\' );
 

Adds a list of torrents

List of Torrent URLs

$abc->add_torrents_list( array( 'http://file1.torrent', 'http://file2.torrent' ) );
 

List of Torrent URLs with Save Location

$abc->add_torrents_list( array(
 
      array( 'http://file1.torrent', '/path/to/save/1' ),
 
      array( 'http://file2.torrent', '/path/to/save/2' ) ),
 
      );
 

Supports setting a save location ONLY IF set parameters and get parameters are enabled in ABC for the web service (disabled by default)

• return: the success of the command
• version: 1.0

• array $torrents: pass an array such as array( 'http://file1.torrent', 'http://file2.torrent' ) OR for URLs with save locations, use array( array( 'http://file1.torrent', '/path/to/save/1' ), array( 'http://file2.torrent', '/path/to/save/2' ) )

$abc->close();
 

Deletes torrent(s)

Instead of passing an array of torrent hashes, you may also send the following constants:

• ALL
• COMPLETED (all tasks with 100% completion)
• RUNNING (all tasks without 100% completion regardless of status)

Note: ALL and RUNNING are not native features of the protocol so this function automatically sends a query for a list of torrents and then processes that list of torrents.

Example Code

$abc->delete_torrents( array(
 
      'abcdef01234569abcdef01234569abc1' => 4,
 
      'abcdef01234569abcdef01234569abc2' => 2,
 
      ) );
 
$abc->delete_torrents( 'abcdef01234569abcdef01234569abc1' );
 
$abc->delete_torrents( ALL );
 
$abc->delete_torrents( COMPLETED );
 

• return: the success of the command
• version: 1.0

• mixed $torrents: array of torrent info hashes, constant ALL, constant COMPLETED, constant RUNNING, or one info hash as string

print_r( $abc->get_lang_strings( array(
 
      'superseederrornotcompleted',
 
      'superwarningmsg_line2',
 
      ) ) );
 
print_r( $abc->get_lang_strings( 'superseederrornotcompleted' ) );
 

Gets ABC parameter(s)

Example Code

echo $abc->get_params( array( 'window_width', 'maxdownloadrate' ) );
 
echo $abc->get_params( 'window_width' );
 

• return: either an array with param => value for multiple parameters or a value if only one parameter was requested
• version: 1.0

• mixed $params: either an array of parameters to get or a string of a parameter to get

$abc->pause_torrents( array(
 
      'abcdef01234569abcdef01234569abc1' => 4,
 
      'abcdef01234569abcdef01234569abc2' => 2,
 
      ) );
 
$abc->pause_torrents( 'abcdef01234569abcdef01234569abc1' );
 
$abc->pause_torrents( ALL );
 
$abc->pause_torrents( COMPLETED );
 

Queries ABC for a list of torrents

Pass an array of fields. If no fields are passed, a default set of fields will be passed.

Note: Do not trust that the order of fields you send are received in the same order (especially if you send repeat fields)

List of Fields (these are constants)

• COL_FILENAME
• COL_PROGRESS
• COL_BT_STATUS
• COL_PIORITY
• COL_ETA
• COL_SIZE
• COL_DL_SPEED
• COL_UL_SPEED
• COL_UD_SIZE
• COL_MESSAGE
• COL_SEEDS
• COL_PEERS
• COL_COPIES
• COL_PEER_AVG_PROGRESS
• COL_DL_SIZE
• COL_UL_SIZE
• COL_TOTAL_SPEED
• COL_TORRENT_NAME
• COL_DESTINATION
• COL_SEEDING_TIME
• COL_CONNECTIONS
• COL_SEEDING_OPTION

COL_INFO_HASH will be a field gotten AUTOMATICALLY. Do NOT send this as a field! All your query results will have COL_INFO_HASH.

Your results will be an array with keys as the field and the values as the values

Example Code

print_r( $abc->query( array( COL_FILENAME, COL_PROGRESS ) ) );
 
print_r( $abc->query() );
 

Example Results (outputted with print_r())

Array
 
 (
 
     [0] => Array
 
         (
 
             [4] => [AonE]_Naruto_142_[A96A4B42].avi
 
             [5] => 100.0%
 
         )
 
 )Array
 
 (
 
     [0] => Array
 
         (
 
             [4] => [AonE]_Naruto_142_[A96A4B42].avi
 
             [5] => 100.0%
 
             [6] => stop
 
             [8] =>
 
             [10] =>
 
             [11] =>
 
             [12] => 49.7%
 
             [15] => 0 (388)
 
             [14] => 0 (531)
 
             [16] =>
 
             [18] => 174.29 MB
 
             [19] => 86.59 MB
 
             [17] =>
 
             [20] =>
 
             [99] => c6ef01d7f1fa5d458e31a37457fead490dfb7bf5
 
         )
 
 )
 

The key names appear as numbers but you can use $result[0][COL_TORRENT_NAME] or respectively.

• return: list of current torrents or FALSE for error
• version: 1.0

• array $fields: list of fields (the COL_ constants) to get for each torrent - do NOT use COL_INFO_HASH; if $fields is not defined, the default list of fields will be used

$abc->queue_torrents( array(
 
      'abcdef01234569abcdef01234569abc1' => 4,
 
      'abcdef01234569abcdef01234569abc2' => 2,
 
      ) );
 
$abc->queue_torrents( 'abcdef01234569abcdef01234569abc1' );
 
$abc->queue_torrents( ALL );
 
$abc->queue_torrents( COMPLETED );
 

Resumes torrent(s)

Instead of passing an array of torrent hashes, you may also send the following constants:

• ALL
• COMPLETED (all tasks with 100% completion regardless of status)
• RUNNING (all tasks without 100% completion regardless of status)

Note: COMPLETED and RUNNING are not native features of the protocol so this function automatically sends a query for a list of torrents and then processes that list of torrents.

Example Code

$abc->resume_torrents( array(
 
      'abcdef01234569abcdef01234569abc1' => 4,
 
      'abcdef01234569abcdef01234569abc2' => 2,
 
      ) );
 
$abc->resume_torrents( 'abcdef01234569abcdef01234569abc1' );
 
$abc->resume_torrents( ALL );
 
$abc->resume_torrents( COMPLETED );
 

• return: the success of the command
• version: 1.0

• mixed $torrents: array of torrent info hashes, constant ALL, constant COMPLETED, constant RUNNING, or one info hash as string

$abc->send_command( 'CLOSE|' );
 

Set ABC parameters

Will return FALSE if one command does not go through.

Note: For each parameter, a new command will be sent. When all the parameters were sent at once, the error Command should end with | kept appearing and a solution could not be found.

Example Code

$abc->set_params( array( 'window_width' => 500 ) );
 

• return: the success of the command
• version: 1.0

• mixed $params: either an array of parameters to set or a string of a parameter to set

$abc->set_torrent_priorities( array(
 
      'abcdef01234569abcdef01234569abc1' => 4,
 
      'abcdef01234569abcdef01234569abc2' => 2,
 
      ) );
 

Stops torrent(s)

Instead of passing an array of torrent hashes, you may also send the following constants:

• ALL
• COMPLETED (all tasks with 100% completion regardless of status)
• RUNNING (all tasks without 100% completion regardless of status)

Note: COMPLETED and RUNNING are not native features of the protocol so this function automatically sends a query for a list of torrents and then processes that list of torrents.

Example Code

$abc->stop_torrents( array(
 
      'abcdef01234569abcdef01234569abc1' => 4,
 
      'abcdef01234569abcdef01234569abc2' => 2,
 
      ) );
 
$abc->stop_torrents( 'abcdef01234569abcdef01234569abc1' );
 
$abc->stop_torrents( ALL );
 
$abc->stop_torrents( COMPLETED );
 

• return: the success of the command
• version: 1.0

• mixed $torrents: array of torrent info hashes, constant ALL, constant COMPLETED, constant RUNNING, or one info hash as string

$abc->unpause_torrents( array(
 
      'abcdef01234569abcdef01234569abc1' => 4,
 
      'abcdef01234569abcdef01234569abc2' => 2,
 
      ) );
 
$abc->unpause_torrents( 'abcdef01234569abcdef01234569abc1' );
 
$abc->unpause_torrents( ALL );
 
$abc->unpause_torrents( COMPLETED );
 

Gets current version of ABC installed

Example Code

echo $abc->version();
 

• return: the version as a string or FALSE for error
• version: 1.0