PHPackages                             meshboxfoundation/php-mbfs-api - 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. [API Development](/categories/api)
4. /
5. meshboxfoundation/php-mbfs-api

ActiveLibrary[API Development](/categories/api)

meshboxfoundation/php-mbfs-api
==============================

A client library for the MBFS API

v0.0.2(7y ago)14MITPHPPHP >=5.3.0

Since Jan 21Pushed 7y agoCompare

[ Source](https://github.com/MeshBoxFoundation/php-mbfs-api)[ Packagist](https://packagist.org/packages/meshboxfoundation/php-mbfs-api)[ Docs](https://github.com/MeshBoxFoundation/php-mbfs-api)[ RSS](/packages/meshboxfoundation-php-mbfs-api/feed)WikiDiscussions master Synced 3d ago

READMEChangelogDependenciesVersions (3)Used By (0)

MBFS API wrapper library in PHP
===============================

[](#mbfs-api-wrapper-library-in-php)

> A client library for the MBFS API.

Usage
=====

[](#usage)

Installing
----------

[](#installing)

This library requires the cURL module:

```
$ sudo apt-get install php5-curl
$ composer require meshboxfoundation/php-mbfs-api
$ composer install
```

```
use MBFoundation\PhpIpfsApi\MBFS;

// connect to mbfs daemon API server
$mbfs = new MBFS("localhost", "8080", "5001"); // leaving out the arguments will default to these values
```

API
---

[](#api)

#### add

[](#add)

Adds content to MBFS.

**Usage**

```
$hash = $mbfs->add("Hi, I'm Vingo! Welcome to use MBFS!");
```

#### cat

[](#cat)

Retrieves the contents of a single hash.

**Usage**

```
$mbfs->cat($hash);
```

#### ls

[](#ls)

Gets the node structure of a hash.

**Usage**

```
$obj = $mbfs->ls($hash);

foreach ($obj as $e) {
	echo $e['Hash'];
	echo $e['Size'];
	echo $e['Name'];
}
```

#### Object size

[](#object-size)

Returns object size.

**Usage**

```
$size = $mbfs->size($hash);
```

#### Pin

[](#pin)

Pins a hash.

**Usage**

```
$mbfs->pinAdd($hash);
```

License
=======

[](#license)

The MIT License (MIT)

Copyright (c) 2019-2026 Vingo MBFoundation Copyright (c) 2019 MeshBox Technologies

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

###  Health Score

22

—

LowBetter than 22% of packages

Maintenance20

Infrequent updates — may be unmaintained

Popularity5

Limited adoption so far

Community8

Small or concentrated contributor base

Maturity46

Maturing project, gaining track record

 Bus Factor1

Top contributor holds 87.5% 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.

###  Release Activity

Cadence

Every ~0 days

Total

2

Last Release

2670d ago

### Community

Maintainers

![](https://www.gravatar.com/avatar/3bf149e089878b10e6c8fd5e9848246ed572ae03ba8694e57af7ef0cd29180c5?d=identicon)[MeshBoxFoundation](/maintainers/MeshBoxFoundation)

---

Top Contributors

[![VingoYang](https://avatars.githubusercontent.com/u/40650197?v=4)](https://github.com/VingoYang "VingoYang (7 commits)")[![MeshBoxTech](https://avatars.githubusercontent.com/u/45959616?v=4)](https://github.com/MeshBoxTech "MeshBoxTech (1 commits)")

---

Tags

mbfs

### Embed Badge

![Health badge](/badges/meshboxfoundation-php-mbfs-api/health.svg)

```
[![Health](https://phpackages.com/badges/meshboxfoundation-php-mbfs-api/health.svg)](https://phpackages.com/packages/meshboxfoundation-php-mbfs-api)
```

###  Alternatives

[stripe/stripe-php

Stripe PHP Library

4.0k143.3M480](/packages/stripe-stripe-php)[twilio/sdk

A PHP wrapper for Twilio's API

1.6k92.9M272](/packages/twilio-sdk)[knplabs/github-api

GitHub API v3 client

2.2k15.8M187](/packages/knplabs-github-api)[facebook/php-business-sdk

PHP SDK for Facebook Business

90121.9M34](/packages/facebook-php-business-sdk)[meilisearch/meilisearch-php

PHP wrapper for the Meilisearch API

73813.7M114](/packages/meilisearch-meilisearch-php)[google/gax

Google API Core for PHP

263103.1M454](/packages/google-gax)

PHPackages © 2026

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