Download the PHP
package adimeo-data-suite/php-client without Composer
On this page you can find all versions of the php package
adimeo-data-suite/php-client. It is possible to download/install
these versions without Composer. Possible dependencies are resolved
automatically.
FAQ
After the download, you have to make one include require_once('vendor/autoload.php');. After that you have to import the classes with use statements.
Example:
If you use only one package a project is not needed. But if you use more then one package, without a project it is not possible to import the classes with use statements.
In general, it is recommended to use always a project to download your libraries. In an application normally there is more than one library needed.
Some PHP packages are not free to download and because of that hosted in private repositories.
In this case some credentials are needed to access such packages.
Please use the auth.json textarea to insert credentials, if a package is coming from a private repository.
You can look here for more information.
Some hosting areas are not accessible by a terminal or SSH. Then it is not possible to use Composer.
To use Composer is sometimes complicated. Especially for beginners.
Composer needs much resources. Sometimes they are not available on a simple webspace.
If you are using private repositories you don't need to share your credentials. You can set up everything on our site and then you provide a simple download link to your team member.
Simplify your Composer build process. Use our own command line tool to download the vendor folder as binary. This makes your build process faster and you don't need to expose your credentials for private repositories.
The most efficient way to install ADS Search Client is using Composer:
Usage
Initialisation
You must first instantiate an AdsClient object, passing to its constructor some base configuration related to your ADS server:
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:
Parameter
Description
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
To actually search the index, just call the search() method:
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:
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
Look at the example(s) folder to see actual sample code.
To add a sticky facet, just set the matching flag on the facet:
Requiresphp Version
>=5.6 ext-json Version
* guzzlehttp/guzzle Version
^6.3
Composer command for our command line client (download client)This client runs in each environment. You don't need a specific PHP version etc. The first 20 API calls are free.Standard composer command
The package adimeo-data-suite/php-client contains the following files
Loading the files please wait ....
Loading please wait ...
Before you can download the PHP files, the dependencies should be resolved. This can take some minutes. Please be patient.