PHPackages                             adimeo-data-suite/php-client - 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. adimeo-data-suite/php-client

ActiveLibrary[API Development](/categories/api)

adimeo-data-suite/php-client
============================

2.2.3(4y ago)18923[2 PRs](https://github.com/louisicard/adimeo-data-suite-php-client/pulls)PHPPHP >=5.6

Since Apr 29Pushed 3y ago1 watchersCompare

[ Source](https://github.com/louisicard/adimeo-data-suite-php-client)[ Packagist](https://packagist.org/packages/adimeo-data-suite/php-client)[ RSS](/packages/adimeo-data-suite-php-client/feed)WikiDiscussions master Synced 1mo ago

READMEChangelog (1)Dependencies (1)Versions (11)Used By (0)

ADS Search Client
=================

[](#ads-search-client)

Installation
------------

[](#installation)

The most efficient way to install ADS Search Client is using Composer:

```
composer require adimeo-data-suite/php-client

```

Usage
-----

[](#usage)

### Initialisation

[](#initialisation)

You must first instantiate an AdsClient object, passing to its constructor some base configuration related to your ADS server:

```
$searchClient = new AdsClient('http://ads.base.url', 'index.mapping', 'analyzer');
```

This code is sufficient for the client to perform a request on the server, given that the client will grab search context from the query string by default.

The query string parameters expected by the client are:

ParameterDescription**query**Elastic style query terms**from**Record index in the resultset**size**Number of records returned (to paginate)**sort**Field to sort results on (e.g. field,ASC or field,DESC)**filter**Results filters (documentation to come)**facetOptions**Facet options (documentation to come)Please note that AdsClient will usually generate required parameters for you. This will be explained later.

### Search

[](#search)

To actually search the index, just call the *search()* method:

```
$result = $searchClient->search();
```

### Adding facets

[](#adding-facets)

Facets are one of the most valuable feature of a search engine compared to database search! Adding a facet to your resultset is quite straightforward:

```
$searchClient->addFacet(new Facet('field.raw'));
```

*Note*: **field** must not be tokenized to be available as facet. If it is, please also keep raw data in the index and refer to *field.raw* instead of *field* (like in the example above) to set your facet up.

Redering example
----------------

[](#redering-example)

Look at the *example(s)* folder to see actual sample code.

To add a sticky facet, just set the matching flag on the facet:

###  Health Score

31

—

LowBetter than 68% of packages

Maintenance20

Infrequent updates — may be unmaintained

Popularity21

Limited adoption so far

Community12

Small or concentrated contributor base

Maturity61

Established project with proven stability

 Bus Factor1

Top contributor holds 57.1% 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 ~108 days

Recently: every ~176 days

Total

8

Last Release

1820d ago

Major Versions

1.1 → 2.02019-05-03

### Community

Maintainers

![](https://www.gravatar.com/avatar/328ae2e1ec79143b6010e15acc82bc4fc92e10dd1b3b62c6f03c8e0d48c62f9c?d=identicon)[louisicard](/maintainers/louisicard)

---

Top Contributors

[![louisicard](https://avatars.githubusercontent.com/u/17336083?v=4)](https://github.com/louisicard "louisicard (4 commits)")[![Rubberg](https://avatars.githubusercontent.com/u/26465808?v=4)](https://github.com/Rubberg "Rubberg (2 commits)")[![gauthier](https://avatars.githubusercontent.com/u/32955?v=4)](https://github.com/gauthier "gauthier (1 commits)")

### Embed Badge

![Health badge](/badges/adimeo-data-suite-php-client/health.svg)

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

###  Alternatives

[tencentcloud/tencentcloud-sdk-php

TencentCloudApi php sdk

3731.2M42](/packages/tencentcloud-tencentcloud-sdk-php)[convertkit/convertkitapi

Kit PHP SDK for the Kit API

2167.1k1](/packages/convertkit-convertkitapi)[mapado/rest-client-sdk

Rest Client SDK for hydra API

1125.9k2](/packages/mapado-rest-client-sdk)

PHPackages © 2026

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