IPFS API wrapper library in PHP

Ref. https://github.com/cloutier/php-ipfs-api

A client library for the IPFS API.

Good news everyone! S3r3nity is sponsoring the development of this library. They will be using it inside one of their (unannounced) projects and its maintainer is hired to implement all the missing api calls (including the new file api) before the end of September 2016.

Warning: Changes will be made from user's suggestions and this warning will be removed when everything is stable. First stable release is scheduled for the end of September 2016.

Usage

Installing

This library requires the cURL module:

$ sudo apt-get install php5-curl $ composer require cloutier/php-ipfs-api $ composer install

use Cloutier\PhpIpfsApi\IPFS; // connect to ipfs daemon API server $ipfs = new IPFS("localhost", "8080", "5001"); // leaving out the arguments will default to these values

API

add

Adds content to IPFS.

Usage

$hash = $ipfs->add("Hello world");

cat

Retrieves the contents of a single hash.

Usage

$ipfs->cat($hash);

ls

Gets the node structure of a hash.

Usage

$obj = $ipfs->ls($hash); foreach ($obj as $e) { echo $e['Hash']; echo $e['Size']; echo $e['Name']; }

Object size

Returns object size.

Usage

$size = $ipfs->size($hash);

Pin

Pin or unpin a hash.

Usage

$ipfs->pinAdd($hash); $ipfs->pinRm($hash);

Pin

Get information about your ipfs node.

Usage

print_r($ipfs->id());

License

The MIT License (MIT)

Copyright (c) 2015-2016 Vincent Cloutier
Copyright (c) 2016 S3r3nity Technologies