Introduction

The Antidot AFS and BO products are modular, open, and flexible solutions. They rely on web services developed in compliance with the web standards.

Here is the documentation of the Antidot PHP API which will help you integrate Antidot products in your own solution.

A short presentation of each API module is presented and links are provided to detailled informations. Some of the examples provided rely on external libraries which should be downloaded if you want to test them.

Most of the Antidot PHP API should work properly with PHP starting at version 5.1. Some specific APIs will only work with more recent version of PHP but version 5.3 is the maximum required version.

AFS search API

This API allows you to simplify integration of AFS search engine query and reply.

It is split in three main functions detailled below. Each of these functions can be used separately but it is highly recommended to combine them to simplify your integration steps.

AFS search query coder/decoder API

This API is optional.

It is used to encode and decode queries. Encoded queries can be used as URL parameters. Such URL can be used to access your web site, filtering on various parameters.

URLs generated from encoded queries can be easilly decoded to build the original query. This original query is used to produce new queries using previous parameters, adding new ones or removing existing ones.

Main classes involved in this feature are:

AfsQueryCoderInterface: interface for the coder/decoder.
AfsQueryCoder: standard implementation of the coder/decoder.
AfsQuery: represents a valid AFS query. It only stores query parameters and manages addition or suppression of parameter values.

For detailled description and examples of this feature, refer to AFS search query coder/decoder API.

AFS search query API

This API simplifies Antidot search engine queries submission.

Main classes involved in this feature are:

AfsSearchConnector: configures AFS search engine connection and sends query with specific parameters to AFS search engine.
AfsFacetManager: manages all configured facets.
AfsQuery: represents a valid AFS query. It only stores query parameters and manages addition or suppression of parameter values.
AfsSearchQueryManager: combines instances of all previous classes to send appropriate query to AFS search engine and return a json_decoded reply.
AfsSearch: this is a facade for previous classes except AfsQuery.

For detailled description of this feature, refer to AFS search query API. If you prefer less details, then choose AFS search API instead.

AFS search reply API

Even if result from previous API is JSON decoded, helpers are provided to access most usefull data in simplest way.

Main helpers involved in this feature are:

AfsResponseHelper: this is the main helper which is initialized from result provided by AfsSearchQueryManager. It allows to check whether an error occured and to retrieve helpers for each replyset and spellcheck suggestion.
AfsReplysetHelper: manage all data related to one replyset (metadata, facets, replies...).
AfsMetaHelper: simple access to useful metadata.
AfsFacetHelper: simple access to all facets and their values.
AfsReplyHelper: basic access to reply components.
AfsPagerHelper: simple access to pager features.

For detailled description and examples of this feature, refer to AFS search reply API.

PaF API

This API allows you to simplify interactions with Antidot PaF. Currently, you can only send one or more documents to an existing PaF. Other functionalities will come soon.

Upload data to Antidot PaF

One or more documents can be sent to specific PaF in order to be worked on. Main classes involved in this feature are:

AfsDocument: manage a simple document defined by existing file or generated content.
AfsDocumentManager: manage one or mode AfsDocument. This is the only mean available to upload multiple documents.
AfsPafConnector: connection manager to upload one or more documents.
AfsPafUploadReply: simple wrapper for upload reply.

For detailled description and examples of this feature, refer to Antidot PaF upload.

Table of Contents