sandyman/awscloudsearchphp

Basic integration AWS CloudSearch API

AwsCloudSearch PHP API Wrapper

A library to interact with Amazon's AWS CloudSearch API. Please note that this is a fork of Mark Wilson's AwsCloudSearchPhp. You might want to use his library in stead (see Credits)., _(*1)

Requirements

• PHP 5+
• cURL extension
• AWS account
• CloudSearch domain

Getting Started

For detailed instructions, check out Making Amazon CloudSearch API Requests., _(*2)

curl -s https://getcomposer.org/installer | php
php composer.phar install

Require "sandyman/awscloudsearchphp" in your composer.json:-, _(*3)

{
    "require": {
        "sandyman/awscloudsearchphp": "dev-master"
    }
}

Pass your CloudSearch domain and server location to initialise the class:, _(*4)

$loader = require 'vendor/autoload.php';
$cloudSearch = new \AwsCloudSearch\AwsCloudSearch(<domain>, <server location>);

// search domain's indexed documents
$cloudSearch->setReturnFields(<array of fields in storage>);
$response = $cloudSearch->search(<term>, <additional parameters>);
if ($response->wasSuccessful()) {
    print_r($response->getHitDocuments());
}
else {
    print_r($response->getErrors());
}

// add/update/delete array of documents
$documents = array();
$document = new \AwsCloudSearch\Document\AddDocument(<id>, <version>, <lang=en>, <fields array>);
$documents[] = $document;

$response = $cloudSearch->processDocuments($documents);
if ($response->wasSuccesful()) {
    echo $response;
}
else {
    print_r($response->getErrors());
}

You can also check out the samples/ directory., _(*5)

Documents must be formatted to the Search Data Format (SDF)., _(*6)

Getting Help

If you need help or have questions, please contact Sander Huijsen., _(*7)

Credits

Forked from AwsCloudSearchPhp., _(*8)