PHPackages                             yuav/php-aria2 - PHPackages - PHPackages  [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register)

1. [Directory](/)
2. /
3. [Utility &amp; Helpers](/categories/utility)
4. /
5. yuav/php-aria2

ActivePhp[Utility &amp; Helpers](/categories/utility)

yuav/php-aria2
==============

PHP interface for the JSON-RPC of Aria2

06401PHP

Since May 25Pushed 11y ago1 watchersCompare

[ Source](https://github.com/Yuav/php-aria2)[ Packagist](https://packagist.org/packages/yuav/php-aria2)[ RSS](/packages/yuav-php-aria2/feed)WikiDiscussions master Synced 1w ago

READMEChangelogDependenciesVersions (1)Used By (0)

php-aria2
=========

[](#php-aria2)

talk with aria2 using json-RPC
==============================

[](#talk-with-aria2-using-json-rpc)

make sure aria2c is running
---------------------------

[](#make-sure-aria2c-is-running)

you can add below into /etc/rc.local `/usr/local/bin/aria2c --enable-rpc --rpc-allow-origin-all -c -D`

> the document of aria2 is [here](http://aria2.sourceforge.net/manual/en/html/aria2c.html#rpc-interface)

How To
------

[](#how-to)

the php-aria2 is simple and just 31 lines.

### Examples

[](#examples)

```
include 'aria2.class.php';
$aria2 = new aria2('http://127.0.0.1:6800/jsonrpc'); //this value is the default value,you can leave it empty.
var_dump($aria2->getGlobalStat());
var_dump($aria2->tellActive());
var_dump($aria2->tellWaiting(0,1000));
var_dump($aria2->tellStopped(0,1000));
var_dump($aria2->addUri(array('https://www.google.com.hk/images/srpr/logo3w.png'),array(
    'dir'=>'/tmp',
)));
var_dump($aria2->tellStatus('1'));
var_dump($aria2->removeDownloadResult('1'));
//and more ...

```

you can read [the the document of aria2](http://aria2.sourceforge.net/manual/en/html/aria2c.html#rpc-interface)

### Download a File

[](#download-a-file)

```
var_dump($aria2->addUri(array('https://www.google.com.hk/images/srpr/logo3w.png'),array(
	'dir'=>'/tmp',
	)));

```

[More Options is Here](http://aria2.sourceforge.net/manual/en/html/aria2c.html#input-file)

### Returned Data Examples

[](#returned-data-examples)

*Can't Download*

```
array(3) {
  ["id"]=>
  string(1) "1"
  ["jsonrpc"]=>
  string(3) "2.0"
  ["result"]=>
  array(13) {
    ["completedLength"]=>
    string(1) "0"
    ["connections"]=>
    string(1) "0"
    ["dir"]=>
    string(4) "/tmp"
    ["downloadSpeed"]=>
    string(1) "0"
    ["errorCode"]=>
    string(1) "1"
    ["files"]=>
    array(1) {
      [0]=>
      array(6) {
        ["completedLength"]=>
        string(1) "0"
        ["index"]=>
        string(1) "1"
        ["length"]=>
        string(1) "0"
        ["path"]=>
        string(0) ""
        ["selected"]=>
        string(4) "true"
        ["uris"]=>
        array(1) {
          [0]=>
          array(2) {
            ["status"]=>
            string(4) "used"
            ["uri"]=>
            string(48) "https://www.google.com.hk/images/srpr/logo3w.png"
          }
        }
      }
    }
    ["gid"]=>
    string(1) "2"
    ["numPieces"]=>
    string(1) "0"
    ["pieceLength"]=>
    string(7) "1048576"
    ["status"]=>
    string(5) "error"
    ["totalLength"]=>
    string(1) "0"
    ["uploadLength"]=>
    string(1) "0"
    ["uploadSpeed"]=>
    string(1) "0"
  }
}

```

*Downloading (Active)*

```
array(3) {
  ["id"]=>
  string(1) "1"
  ["jsonrpc"]=>
  string(3) "2.0"
  ["result"]=>
  array(13) {
    ["bitfield"]=>
    string(8) "e0000000"
    ["completedLength"]=>
    string(7) "3932160"
    ["connections"]=>
    string(1) "1"
    ["dir"]=>
    string(18) "/data/files/lixian"
    ["downloadSpeed"]=>
    string(5) "75972"
    ["files"]=>
    array(1) {
      [0]=>
      array(6) {
        ["completedLength"]=>
        string(7) "3145728"
        ["index"]=>
        string(1) "1"
        ["length"]=>
        string(8) "31550548"
        ["path"]=>
        string(48) "/data/files/lixian/[茶经].陆羽.扫描版.pdf"
        ["selected"]=>
        string(4) "true"
        ["uris"]=>
        array(5) {
          [0]=>
          array(2) {
            ["status"]=>
            string(4) "used"
            ["uri"]=>
            string(417) "http://gdl.lixian.vip.xunlei.com/download?fid=zKHWI/O2IbQ07pi/0hPYP1OLwrBUbOEBAAAAACaqKvQbmfR7K7JcbWGT3XQBlDzs&mid=666&threshold=150&tid=3018BA81C31480902DC937770AC2734F&srcid=4&verno=1&g=26AA2AF41B99F47B2BB25C6D6193DD7401943CEC&scn=c7&i=0D2B59F64D6CCBB5A1507A03C3B685BC&t=4&ui=222151634&ti=106821253185&s=31550548&m=0&n=013A830CE1AD5D2EC2DCE21471C9A8C3E8D1D7CA2F64660000&ff=0&co=33BB9833AB0EE7AAEA94105B64C8013F&cm=1"
          }
          [1]=>
          array(2) {
            ["status"]=>
            string(7) "waiting"
            ["uri"]=>
            string(417) "http://gdl.lixian.vip.xunlei.com/download?fid=zKHWI/O2IbQ07pi/0hPYP1OLwrBUbOEBAAAAACaqKvQbmfR7K7JcbWGT3XQBlDzs&mid=666&threshold=150&tid=3018BA81C31480902DC937770AC2734F&srcid=4&verno=1&g=26AA2AF41B99F47B2BB25C6D6193DD7401943CEC&scn=c7&i=0D2B59F64D6CCBB5A1507A03C3B685BC&t=4&ui=222151634&ti=106821253185&s=31550548&m=0&n=013A830CE1AD5D2EC2DCE21471C9A8C3E8D1D7CA2F64660000&ff=0&co=33BB9833AB0EE7AAEA94105B64C8013F&cm=1"
          }
          [2]=>
          array(2) {
            ["status"]=>
            string(7) "waiting"
            ["uri"]=>
            string(417) "http://gdl.lixian.vip.xunlei.com/download?fid=zKHWI/O2IbQ07pi/0hPYP1OLwrBUbOEBAAAAACaqKvQbmfR7K7JcbWGT3XQBlDzs&mid=666&threshold=150&tid=3018BA81C31480902DC937770AC2734F&srcid=4&verno=1&g=26AA2AF41B99F47B2BB25C6D6193DD7401943CEC&scn=c7&i=0D2B59F64D6CCBB5A1507A03C3B685BC&t=4&ui=222151634&ti=106821253185&s=31550548&m=0&n=013A830CE1AD5D2EC2DCE21471C9A8C3E8D1D7CA2F64660000&ff=0&co=33BB9833AB0EE7AAEA94105B64C8013F&cm=1"
          }
          [3]=>
          array(2) {
            ["status"]=>
            string(7) "waiting"
            ["uri"]=>
            string(417) "http://gdl.lixian.vip.xunlei.com/download?fid=zKHWI/O2IbQ07pi/0hPYP1OLwrBUbOEBAAAAACaqKvQbmfR7K7JcbWGT3XQBlDzs&mid=666&threshold=150&tid=3018BA81C31480902DC937770AC2734F&srcid=4&verno=1&g=26AA2AF41B99F47B2BB25C6D6193DD7401943CEC&scn=c7&i=0D2B59F64D6CCBB5A1507A03C3B685BC&t=4&ui=222151634&ti=106821253185&s=31550548&m=0&n=013A830CE1AD5D2EC2DCE21471C9A8C3E8D1D7CA2F64660000&ff=0&co=33BB9833AB0EE7AAEA94105B64C8013F&cm=1"
          }
          [4]=>
          array(2) {
            ["status"]=>
            string(7) "waiting"
            ["uri"]=>
            string(417) "http://gdl.lixian.vip.xunlei.com/download?fid=zKHWI/O2IbQ07pi/0hPYP1OLwrBUbOEBAAAAACaqKvQbmfR7K7JcbWGT3XQBlDzs&mid=666&threshold=150&tid=3018BA81C31480902DC937770AC2734F&srcid=4&verno=1&g=26AA2AF41B99F47B2BB25C6D6193DD7401943CEC&scn=c7&i=0D2B59F64D6CCBB5A1507A03C3B685BC&t=4&ui=222151634&ti=106821253185&s=31550548&m=0&n=013A830CE1AD5D2EC2DCE21471C9A8C3E8D1D7CA2F64660000&ff=0&co=33BB9833AB0EE7AAEA94105B64C8013F&cm=1"
          }
        }
      }
    }
    ["gid"]=>
    string(1) "3"
    ["numPieces"]=>
    string(2) "31"
    ["pieceLength"]=>
    string(7) "1048576"
    ["status"]=>
    string(6) "active"
    ["totalLength"]=>
    string(8) "31550548"
    ["uploadLength"]=>
    string(1) "0"
    ["uploadSpeed"]=>
    string(1) "0"
  }
}

```

*Downloaded*

```
array(3) {
  ["id"]=>
  string(1) "1"
  ["jsonrpc"]=>
  string(3) "2.0"
  ["result"]=>
  array(14) {
    ["bitfield"]=>
    string(8) "fffffffe"
    ["completedLength"]=>
    string(8) "31550548"
    ["connections"]=>
    string(1) "0"
    ["dir"]=>
    string(18) "/data/files/lixian"
    ["downloadSpeed"]=>
    string(1) "0"
    ["errorCode"]=>
    string(1) "0"
    ["files"]=>
    array(1) {
      [0]=>
      array(6) {
        ["completedLength"]=>
        string(8) "31550548"
        ["index"]=>
        string(1) "1"
        ["length"]=>
        string(8) "31550548"
        ["path"]=>
        string(48) "/data/files/lixian/[茶经].陆羽.扫描版.pdf"
        ["selected"]=>
        string(4) "true"
        ["uris"]=>
        array(6) {
          [0]=>
          array(2) {
            ["status"]=>
            string(4) "used"
            ["uri"]=>
            string(417) "http://gdl.lixian.vip.xunlei.com/download?fid=zKHWI/O2IbQ07pi/0hPYP1OLwrBUbOEBAAAAACaqKvQbmfR7K7JcbWGT3XQBlDzs&mid=666&threshold=150&tid=3018BA81C31480902DC937770AC2734F&srcid=4&verno=1&g=26AA2AF41B99F47B2BB25C6D6193DD7401943CEC&scn=c7&i=0D2B59F64D6CCBB5A1507A03C3B685BC&t=4&ui=222151634&ti=106821253185&s=31550548&m=0&n=013A830CE1AD5D2EC2DCE21471C9A8C3E8D1D7CA2F64660000&ff=0&co=33BB9833AB0EE7AAEA94105B64C8013F&cm=1"
          }
          [1]=>
          array(2) {
            ["status"]=>
            string(7) "waiting"
            ["uri"]=>
            string(417) "http://gdl.lixian.vip.xunlei.com/download?fid=zKHWI/O2IbQ07pi/0hPYP1OLwrBUbOEBAAAAACaqKvQbmfR7K7JcbWGT3XQBlDzs&mid=666&threshold=150&tid=3018BA81C31480902DC937770AC2734F&srcid=4&verno=1&g=26AA2AF41B99F47B2BB25C6D6193DD7401943CEC&scn=c7&i=0D2B59F64D6CCBB5A1507A03C3B685BC&t=4&ui=222151634&ti=106821253185&s=31550548&m=0&n=013A830CE1AD5D2EC2DCE21471C9A8C3E8D1D7CA2F64660000&ff=0&co=33BB9833AB0EE7AAEA94105B64C8013F&cm=1"
          }
          [2]=>
          array(2) {
            ["status"]=>
            string(7) "waiting"
            ["uri"]=>
            string(417) "http://gdl.lixian.vip.xunlei.com/download?fid=zKHWI/O2IbQ07pi/0hPYP1OLwrBUbOEBAAAAACaqKvQbmfR7K7JcbWGT3XQBlDzs&mid=666&threshold=150&tid=3018BA81C31480902DC937770AC2734F&srcid=4&verno=1&g=26AA2AF41B99F47B2BB25C6D6193DD7401943CEC&scn=c7&i=0D2B59F64D6CCBB5A1507A03C3B685BC&t=4&ui=222151634&ti=106821253185&s=31550548&m=0&n=013A830CE1AD5D2EC2DCE21471C9A8C3E8D1D7CA2F64660000&ff=0&co=33BB9833AB0EE7AAEA94105B64C8013F&cm=1"
          }
          [3]=>
          array(2) {
            ["status"]=>
            string(7) "waiting"
            ["uri"]=>
            string(417) "http://gdl.lixian.vip.xunlei.com/download?fid=zKHWI/O2IbQ07pi/0hPYP1OLwrBUbOEBAAAAACaqKvQbmfR7K7JcbWGT3XQBlDzs&mid=666&threshold=150&tid=3018BA81C31480902DC937770AC2734F&srcid=4&verno=1&g=26AA2AF41B99F47B2BB25C6D6193DD7401943CEC&scn=c7&i=0D2B59F64D6CCBB5A1507A03C3B685BC&t=4&ui=222151634&ti=106821253185&s=31550548&m=0&n=013A830CE1AD5D2EC2DCE21471C9A8C3E8D1D7CA2F64660000&ff=0&co=33BB9833AB0EE7AAEA94105B64C8013F&cm=1"
          }
          [4]=>
          array(2) {
            ["status"]=>
            string(7) "waiting"
            ["uri"]=>
            string(417) "http://gdl.lixian.vip.xunlei.com/download?fid=zKHWI/O2IbQ07pi/0hPYP1OLwrBUbOEBAAAAACaqKvQbmfR7K7JcbWGT3XQBlDzs&mid=666&threshold=150&tid=3018BA81C31480902DC937770AC2734F&srcid=4&verno=1&g=26AA2AF41B99F47B2BB25C6D6193DD7401943CEC&scn=c7&i=0D2B59F64D6CCBB5A1507A03C3B685BC&t=4&ui=222151634&ti=106821253185&s=31550548&m=0&n=013A830CE1AD5D2EC2DCE21471C9A8C3E8D1D7CA2F64660000&ff=0&co=33BB9833AB0EE7AAEA94105B64C8013F&cm=1"
          }
          [5]=>
          array(2) {
            ["status"]=>
            string(7) "waiting"
            ["uri"]=>
            string(417) "http://gdl.lixian.vip.xunlei.com/download?fid=zKHWI/O2IbQ07pi/0hPYP1OLwrBUbOEBAAAAACaqKvQbmfR7K7JcbWGT3XQBlDzs&mid=666&threshold=150&tid=3018BA81C31480902DC937770AC2734F&srcid=4&verno=1&g=26AA2AF41B99F47B2BB25C6D6193DD7401943CEC&scn=c7&i=0D2B59F64D6CCBB5A1507A03C3B685BC&t=4&ui=222151634&ti=106821253185&s=31550548&m=0&n=013A830CE1AD5D2EC2DCE21471C9A8C3E8D1D7CA2F64660000&ff=0&co=33BB9833AB0EE7AAEA94105B64C8013F&cm=1"
          }
        }
      }
    }
    ["gid"]=>
    string(1) "3"
    ["numPieces"]=>
    string(2) "31"
    ["pieceLength"]=>
    string(7) "1048576"
    ["status"]=>
    string(8) "complete"
    ["totalLength"]=>
    string(8) "31550548"
    ["uploadLength"]=>
    string(1) "0"
    ["uploadSpeed"]=>
    string(1) "0"
  }
}

```

###  Health Score

23

—

LowBetter than 27% of packages

Maintenance20

Infrequent updates — may be unmaintained

Popularity14

Limited adoption so far

Community10

Small or concentrated contributor base

Maturity41

Maturing project, gaining track record

 Bus Factor1

Top contributor holds 80% of commits — single point of failure

How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window.

**Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores.

**Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement.

**Maturity (30%)** — Project age, version count, PHP version support, and release stability.

### Community

Maintainers

![](https://www.gravatar.com/avatar/6f9f234a993086d36bd9740e3d8e88251b2f3e06d386f9affc0388a8cd8463be?d=identicon)[Yuav](/maintainers/Yuav)

---

Top Contributors

[![shiny](https://avatars.githubusercontent.com/u/117487?v=4)](https://github.com/shiny "shiny (4 commits)")[![jskarpe](https://avatars.githubusercontent.com/u/1322650?v=4)](https://github.com/jskarpe "jskarpe (1 commits)")

### Embed Badge

![Health badge](/badges/yuav-php-aria2/health.svg)

```
[![Health](https://phpackages.com/badges/yuav-php-aria2/health.svg)](https://phpackages.com/packages/yuav-php-aria2)
```

###  Alternatives

[davidgorges/color-contrast

A tiny library to find color combinations with a contrast threshold

10550.4k](/packages/davidgorges-color-contrast)[rovangju/carbon-nbd

Carbon DateTime extension to calculate the "next business day"

2125.4k](/packages/rovangju-carbon-nbd)

PHPackages © 2026

[Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)
