Antidot PHP API  version 0.16.0
##PHP API to simplify integration of Antidot components
 All Classes Files Functions Variables Groups Pages
Public Member Functions | Protected Member Functions | List of all members
AfsSearchConnector Class Reference

AFS search connector. More...

Inheritance diagram for AfsSearchConnector:
AfsConnector AfsConnectorBase AfsConnectorInterface

Public Member Functions

 __construct ($host, AfsService $service, $scheme=AFS_SCHEME_HTTP, SAI_CurlInterface $curlConnector=null)
 Constructs new search connector.
- Public Member Functions inherited from AfsConnector
 get_generated_url ()
 Retrieves the URL generated by previous call to send method.
 send (array $parameters)
 Sends a query.

Protected Member Functions

 get_web_service_name ()
 Retrieves web service name.
- Protected Member Functions inherited from AfsConnector
 build_reply_as_associative_array ($value=true)
 While decoding JSON stream, data can be decoded as associative array.

Detailed Description

AFS search connector.

Only one object of this type should be instanciated in each PHP integration.

Examples:
full_example.php.

Constructor & Destructor Documentation

__construct (   $host,
AfsService  $service,
  $scheme = AFS_SCHEME_HTTP,
SAI_CurlInterface  $curlConnector = null 
)

Constructs new search connector.

All parameter values should have been provided by Antidot.

Parameters
$host[in] server hosting the required service.
$service[in] Antidot service (see AfsService).
$scheme[in] Scheme for the connection URL see Connection scheme (default: AFS_SCHEME_HTTP).
Exceptions
InvalidArgumentExceptioninvalid scheme parameter provided.

Reimplemented from AfsConnectorBase.

Member Function Documentation

get_web_service_name ( )
protected

Retrieves web service name.

Returns
always return 'search';

Reimplemented from AfsConnector.