https://github.com/manticoresoftware/manticoresearch-php
Official PHP client for Manticore Search
https://github.com/manticoresoftware/manticoresearch-php
php search
Last synced: 10 months ago
JSON representation
Official PHP client for Manticore Search
- Host: GitHub
- URL: https://github.com/manticoresoftware/manticoresearch-php
- Owner: manticoresoftware
- License: mit
- Created: 2020-01-21T11:46:19.000Z (about 6 years ago)
- Default Branch: master
- Last Pushed: 2025-04-01T13:50:32.000Z (10 months ago)
- Last Synced: 2025-04-13T07:47:55.290Z (10 months ago)
- Topics: php, search
- Language: PHP
- Size: 1.58 MB
- Stars: 182
- Watchers: 14
- Forks: 33
- Open Issues: 18
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
manticoresearch-php
===================
[](https://scrutinizer-ci.com/g/manticoresoftware/manticoresearch-php/?branch=master)
[](https://codecov.io/github/manticoresoftware/manticoresearch-php)
[](https://packagist.org/packages/manticoresoftware/manticoresearch-php)
[](https://packagist.org/packages/manticoresoftware/manticoresearch-php)
[![Slack][slack-badge]][slack-url]
[](https://packagist.org/packages/manticoresoftware/manticoresearch-php)
[](https://packagist.org/packages/manticoresoftware/manticoresearch-php)
[](https://packagist.org/packages/manticoresoftware/manticoresearch-php)
[](https://packagist.org/packages/manticoresoftware/manticoresearch-php)
[](https://github.com/manticoresoftware/manticoresearch-php)
[](https://github.com/manticoresoftware/manticoresearch-php)
[](https://github.com/manticoresoftware/manticoresearch-php)
[](https://github.com/manticoresoftware/manticoresearch-php)
[](https://github.com/manticoresoftware/manticoresearch-php/issues)
Official PHP client for Manticore Search.
❗ WARNING: this is a development version of the client. The latest release's readme is https://github.com/manticoresoftware/manticoresearch-php/tree/4.0.1
Features
--------
- One to one mapping with the HTTP API
- connection pools with pluggable selection strategy. Defaults to static round robin
- pluggable PSR/Log interface
- pluggable transport protocols.
- persistent connections
Requirements
------------
Requires PHP 7.1 or greater with the native JSON extension. Default transport handler uses the cURL extension.
Minimum Manticore Search version is 2.5.1 with HTTP protocol enabled.
| Manticore Search | manticoresearch-php | PHP |
| ----------------- | ------------------- | ------------- |
| >= 7.0.0 | 4.0.x | >= 7.4, >=8.0 |
| >= 6.3.6 | 3.2.x | >= 7.4, >=8.0 |
| >= 6.2.0 | 3.1.x | >= 7.4, >=8.0 |
| >= 6.2.0 | 3.0.x | >= 7.4, >=8.0 |
| >= 6.0.4 | 3.0.x | >= 7.1, >=8.0 |
| >= 4.2.1 | 2.0.x, 2.1.x, 2.2.x | >= 7.1, >=8.0 |
| >= 4.0.2 | 1.7.x, 1.8.x | >= 7.1, >=8.0 |
| >= 3.5.2 | 1.6.x | >= 7.1, >=8.0 |
| >= 3.5.0 | 1.5.x | >= 7.1, <8.0 |
| >= 3.5.0 | 1.4 | >= 7.1, <8.0 |
| <= 3.4.x | 1.3 | >= 7.1, <8.0 |
| >= 2.5.1, <3.4.0 | 1.2 | >= 7.1, <8.0 |
Documentation
-------------
Full documentation is available in [docs](docs) folder.
Manticore Search server documentation: https://manual.manticoresearch.com/.
Getting Started
---------------
Install the Manticore Search PHP client using [composer](https://getcomposer.org) package manager:
```bash
composer require manticoresoftware/manticoresearch-php:dev-master
```
### Initiate a table:
```php
require_once __DIR__ . '/vendor/autoload.php';
$config = ['host'=>'127.0.0.1','port'=>9308];
$client = new \Manticoresearch\Client($config);
$table = $client->table('movies');
```
### Create the table:
```php
$table->create([
'title'=>['type'=>'text'],
'plot'=>['type'=>'text'],
'_year'=>['type'=>'integer'],
'rating'=>['type'=>'float']
]);
```
### Add a document:
```php
$table->addDocument([
'title' => 'Star Trek: Nemesis',
'plot' => 'The Enterprise is diverted to the Romulan homeworld Romulus, supposedly because they want to negotiate a peace treaty. Captain Picard and his crew discover a serious threat to the Federation once Praetor Shinzon plans to attack Earth.',
'_year' => 2002,
'rating' => 6.4
],
1);
```
### Add several documents at once:
```php
$table->addDocuments([
['id'=>2,'title'=>'Interstellar','plot'=>'A team of explorers travel through a wormhole in space in an attempt to ensure humanity\'s survival.','_year'=>2014,'rating'=>8.5],
['id'=>3,'title'=>'Inception','plot'=>'A thief who steals corporate secrets through the use of dream-sharing technology is given the inverse task of planting an idea into the mind of a C.E.O.','_year'=>2010,'rating'=>8.8],
['id'=>4,'title'=>'1917 ','plot'=>' As a regiment assembles to wage war deep in enemy territory, two soldiers are assigned to race against time and deliver a message that will stop 1,600 men from walking straight into a deadly trap.','_year'=>2018,'rating'=>8.4],
['id'=>5,'title'=>'Alien','plot'=>' After a space merchant vessel receives an unknown transmission as a distress call, one of the team\'s member is attacked by a mysterious life form and they soon realize that its life cycle has merely begun.','_year'=>1979,'rating'=>8.4]
]);
```
### Perform a search:
```php
$results = $table->search('space team')->get();
foreach($results as $doc) {
echo 'Document:'.$doc->getId()."\n";
foreach($doc->getData() as $field=>$value)
{
echo $field.": ".$value."\n";
}
}
```
Result:
```
Document:2
year: 2014
rating: 8.5
title: Interstellar
plot: A team of explorers travel through a wormhole in space in an attempt to ensure humanity's survival.
```
A text search with attribute filters:
```php
$results = $table->search('space team')
->filter('_year','gte',2000)
->filter('rating','gte',8.0)
->sort('_year','desc')
->get();
foreach($results as $doc) {
echo 'Document:'.$doc->getId()."\n";
foreach($doc->getData() as $field=>$value)
{
echo $field.": ".$value."\n";
}
}
```
### Update documents:
By document id:
```php
$table->updateDocument(['_year'=>2019],4);
```
By query:
```php
$table->updateDocument(['_year'=>2019],['match'=>['*'=>'team']]);
```
### Get table schema:
```php
$table->describe();
```
### Drop table:
```php
$table->drop();
```
The above will fail if the table does not exist. To get around this pass a parameter of true, which cause the failure
to be silent.
```php
$table->drop(true);
```
License
-------
Manticore Search PHP Client is an open-source software licensed under the [MIT license](LICENSE.txt)
[slack-url]: https://slack.manticoresearch.com/
[slack-badge]: https://img.shields.io/badge/Slack-join%20chat-green.svg