PHPackages                             tapioca/client-php - 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. tapioca/client-php

ActiveLibrary

tapioca/client-php
==================

Tapioca PHP client

078[5 issues](https://github.com/Tapioca/Client-php/issues)PHP

Since Apr 14Pushed 10y ago5 watchersCompare

[ Source](https://github.com/Tapioca/Client-php)[ Packagist](https://packagist.org/packages/tapioca/client-php)[ RSS](/packages/tapioca-client-php/feed)WikiDiscussions dev Synced 1mo ago

READMEChangelogDependenciesVersions (2)Used By (0)

Tapioca PHP Client
==================

[](#tapioca-php-client)

This page is a draft of upcoming Tapioca's client in PHP. Feel free to contribute and/or suggest ideas.

Requirements
------------

[](#requirements)

PHP 5.3.3 (or higher) is required.

Installing via Composer
-----------------------

[](#installing-via-composer)

The recommended way to install Tapioca's PHP Clieny is through [Composer](http://getcomposer.org).

1. Add `tapioca/client-php` as a dependency in your project's `composer.json` file:

```
    {
        "require": {
            "tapioca/client-php": "dev-dev"
        }
    }
```

2. Download and install Composer:

    ```
     curl -s http://getcomposer.org/installer | php

    ```
3. Install your dependencies:

    ```
     php composer.phar install

    ```
4. Require Composer's autoloader

    Composer also prepares an autoload file that's capable of autoloading all of the classes in any of the libraries that it downloads. To use it, just add the following line to your code's bootstrap process:

    ```
     require 'vendor/autoload.php';

    ```

You can find out more on how to install Composer, configure autoloading, and other best-practices for defining dependencies at [getcomposer.org](http://getcomposer.org).

Configuration
-------------

[](#configuration)

Minimal configuration array:

```
    $config = array(
	    'slug'         => 'acme' // you App's slug
	  , 'clientId'     => '540e011b8597d'
	  , 'clientSecret' => 'dd4111734d012012b271cdce8aded611'
	  , 'fileStorage'  => 'http://www.yousite.com/file/path/' // public path for your files storage
    );
```

Complet configuration array:

```
	$config = array(
        'slug'         => ...
      , 'driver'       => 'Guzzle' // cUrl client
	  , 'url'          => 'http://www.tapioca.io/' // server's URL, change it if you run your own Tapioca server
      , 'api'          => 'api/0.1/'  // API path + version
      , 'apiVersion'   => 0.1
      , 'clientId'     => ...
      , 'clientSecret' => ...
      , 'fileStorage'  => ...
      , 'cache'        => array(
            'strategy'     => 'filesystem' // cache method
          , 'ttl'          => 3600 // cache time to live
          , 'prefix'       => 'tapioca::' // cache key prefix
        )
      // filesystem specific config
      , 'filesystem'   => array(
          'path'         => __DIR__ . '/cache/' // cache files path
        , 'extention'    => 'cache' // cache file extenTion
      )
      // debug specific config
      , 'memory'       => array()
	);
```

Instance
--------

[](#instance)

Create a new instance based on `$config` array.

```
	include('vendor/autoload.php');

	use Tapioca\Client as Tapioca;
	use Tapioca\Query as Query;
	use Tapioca\Exception as TapiocaException;
	use Tapioca\Cache\Filesystem as Cache;

	try
	{
	  $clientTapioca = Tapioca::client( $config );
	}
	catch( TapiocaException\InvalidArgumentException $e )
	{
	  exit($e->getMessage());
	}
	catch( TapiocaException\ErrorResponseException $e )
	{
	  exit($e->getMessage());
	}
```

Locale
------

[](#locale)

You can define a global `Locale` for the whole instance:

```
    $clientTapioca->setlocale('fr_FR');
```

You can override this on each query.

Query
-----

[](#query)

### Collection

[](#collection)

The easiest collection query, just pass the collection's `slug` as first argument:

```
	try
	{
	  $collection = $clientTapioca->collection( 'acme' );
	}
	catch( TapiocaException\ErrorResponseException $e )
	{
	  exit($e->getMessage());
	}
```

You can refine your query by passing a `Query` object as second parameter.
*Complete list of query methods below.*

```
	$query = new Query();

	$query
		->select( 'title', 'desc', 'image' )
		->setlocale('en_GB') // override global locale
		->limit(10)
		->skip(10);

	try
	{
	  $collection = $clientTapioca->collection( 'acme', $query );
	}
	catch( TapiocaException\ErrorResponseException $e )
	{
	  exit($e->getMessage());
	}
```

These will return a Tapioca\\Collection object based on API result.
The iteration over this object will allow you to handle each documents as an object.

#### API result

[](#api-result)

```
	{
	    "_tapioca": {
	        "total": 11,
	        "limit": 10,
	        "offset": 10,
	        "locale": "en_GB",
	        "dependencies": [
	            {
	                "dependency": "acme--library",
	                "path": "image-seul"
	            }
	        ]
	    },
	    "documents": [
	        {
	            "_tapioca": {
	                "ref": "5414bcc54a15a",
	                "revision": "5414bfbb06eef",
	                "published": true,
	                "created": 1410645189,
	                "updated": 1410645947,
	                "user": {
	                    "id": 3,
	                    "email": "michael@test.zz",
	                    "username": "Michael",
	                    "avatar": "http://www.tapioca.io/avatars/3.jpg",
	                    "url": "http://www.tapioca.io/api/0.1/user/3?token=Twa8NwYgJ7PLOfTQ7QgQ0VRJxOFzb8AMcPnNYf1U&",
	                    "role": "admin"
	                },
	                "locale": "fr_FR",
	                "resources": {
	                    "url": "http://www.tapioca.io/api/0.1/ours-roux/document/test/5414bcc54a15a?token=Twa8NwYgJ7PLOfTQ7QgQ0VRJxOFzb8AMcPnNYf1U&",
	                    "revisions": "http://www.tapioca.io/api/0.1/ours-roux/document/test/revisions/5414bcc54a15a?token=Twa8NwYgJ7PLOfTQ7QgQ0VRJxOFzb8AMcPnNYf1U&"
	                }
	            },
	            "title": "DO IT YOURSELF TORNADO KIT",
	            "description": "Easily create your own tornadoes, anywhere, with the ACME Do It Yourself Tornado kit.",
	            "image": {
	                "id": "54146b3c7324c",
	                "category": "image",
	                "filename": "54146b3c7324c.jpg",
	                "extension": "jpg",
	                "basename": "tornado",
	                "length": 41290,
	                "height": 640,
	                "width": 640
	            }
	        },
	        {
	            "_tapioca": { […] },
	            "title": "ACME DISINTEGRATING PISTOL",
	            "description": "ACME Disintegrating Pistols, when they disintegrate, they distinegrate!"
	        }
	    ]
	}
```

#### Client usage

[](#client-usage)

```
    echo $collection->count() .' on '.$collection->total().' documents';
    // 1 on 11 documents

    echo '';
    foreach( $collection as $product)
    {
        echo '';
        echo $product->title.' || ';
        echo $product->description;
        echo $product->undefinedField; // return empty string
        echo '';

    }
    echo '';
```

#### Helpers

[](#helpers)

You can directly access to `collection` items by there `ref` or there `index` in the result:

```
    try
    {
      // print the document's title with the '5414bcc54a15a' _tapioca.ref
      print_r( $collection->get( '5414bcc54a15a' )->get('title') );
    }
    catch( TapiocaException\DocumentNotFoundException $e )
    {
      echo $e->getMessage();
    }

    try
    {
      // print the second document
      print_r( $collection->at( 1 )->get() );
    }
    catch( TapiocaException\DocumentNotFoundException $e )
    {
      echo $e->getMessage();
    }
    catch( TapiocaException\InvalidArgumentException $e )
    {
      // if index is everything else than numeric
      echo $e->getMessage();
    }
```

#### Debug

[](#debug)

Count results:

```
    echo $collection->count(); // total count of returned documents
    echo $collection->total(); // total count of documents matching the query without offset limit (for pagination)
```

Print your query paramters:

```
    $collection->query();
```

Print interpreted query parameters by the server:

```
    $collection->debug();
```

Dot notation to access to document property:

```
    $doc = $collection->at(0);

    echo $doc->get('title');                             // get title value
    echo $doc->get('undefinedField', 'a default value'); // return the default value
    echo $doc->get('image.basename');                    // walk through the document object
    echo $doc->tapioca('user.username');                 // walk through the document's tapioca property
```

#### Single document collection:

[](#single-document-collection)

Use the `at` method to access to the page

```
    $page = $collection->at(0);
```

---

### Document

[](#document)

Simply pass the collection `slug` and the document `ref`

```
    try
    {
      $document = $clientTapioca->document( 'acme', '5414bcc54a15a' );
    }
    catch( TapiocaException\ErrorResponseException $e )
    {
      echo $e->getMessage();
    }
```

It will return a Tapioca\\Document Object with almost the same helpers than a collection object:

```
    echo $document->tapioca('ref');
    echo $document->tapioca('user.username');
    echo $document->title;
    echo $document->description;
    echo $document->undefinedField; // return empty string
```

---

### Preview

[](#preview)

If passed `token` is valid, return a document's preview as `Tapioca\Document` object.
\_*`tapioca` *part is no reliable.**

```
    try
    {
      $preview = $clientTapioca->preview( 'fb1e19a3991780e4513147c6867ab37876d6a0ca' );
    }
    catch( TapiocaException\ErrorResponseException $e )
    {
      echo $e->getMessage();
    }
```

---

### File

[](#file)

Get file's details from library.

```
	$file = $instance->library('13147c6867ab37876d');
```

---

### Clear Cache

[](#clear-cache)

To clear all cache files

```
    $resp = $clientTapioca->clearCache();
```

###  Health Score

22

—

LowBetter than 22% of packages

Maintenance20

Infrequent updates — may be unmaintained

Popularity9

Limited adoption so far

Community9

Small or concentrated contributor base

Maturity43

Maturing project, gaining track record

 Bus Factor1

Top contributor holds 100% 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/307f58b63dce1fa47265be6aa0fab311432fa4f8d3ae767ffd150f3b3a9e7d0a?d=identicon)[Michael](/maintainers/Michael)

---

Top Contributors

[![michael-lefebvre](https://avatars.githubusercontent.com/u/279053?v=4)](https://github.com/michael-lefebvre "michael-lefebvre (63 commits)")

### Embed Badge

![Health badge](/badges/tapioca-client-php/health.svg)

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

PHPackages © 2026

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