Download the PHP package answear/luigis-box-bundle without Composer

Luigi's Box Bundle

Luigi's Box integration for Symfony. Luigi's Box documentation can be found here: https://live.luigisbox.com/.

Installation

• install with Composer

Setup

• provide required config data: publicKey and privateKey
• searchCacheTtl is time to live for Luigi cache request in seconds (max 300 seconds - this is Luigi's Box limit)

If you have only one config you can omit default_config node. Configs will be passed to \Answear\LuigisBoxBundle\Service\ConfigProvider class.

If you have more configurations you can change them as follows

and use application as before.

If you need to pass custom headers to search request do it as follows

Dynamic configurations

You can pass additional configuration.

Usage

Content requests

1. Full content update document

First argument ($title) will be used as product's title in Luigi's Box unless a title field is present in the $fields argument.

1. Partial update

2. Content removal

3. Change availability

Additional method to simply enable/disable objects - partial update will be used.

In all request you can catch some exceptions:

• BadRequestException - bad request,
• TooManyItemsException - make request with fewer items,
• MalformedResponseException - something went wrong with Luigi's Box api response,
• TooManyRequestsException - delay request rate,
• ServiceUnavailableException

Consider catching them separately:

Content response

\Answear\LuigisBoxBundle\Response\ApiResponse:

• (bool) $success - true if all documents will be passed successfully,
• (int) $okCount - number of successfully passed documents,
• (int) $errorsCount - number of failed documents,
• (array) $errors - array of \Answear\LuigisBoxBundle\Response\ApiResponseError objects,
• (array) $rawResponse - decoded response from api.

ApiResponseError:

• (string) $url - url of document
• (string) $type - type of error (ex. malformed_input)
• (string) $reason - failure text (ex. incorrect object format)
• (array|null) $causedBy - specific reason of error (ex. ["url": ["is missing"]])

Note!

ApiResponse::$success will be set to false if any of passed documents fails. Check $okCount if you want to know how many documents were updated and $errors to check exactly which documents failed.

Searching (documentation here)

1. Request

Check the Luigi's Box documentation to find out exact purpose of each field SearchUrlBuilder is exposing.

1. Response

SearchRequest::search() will return a SearchResponse object with following fields:

• (string) $searchUrl
• (string) $query
• (string|null) $correctedQuery
• (array) $filters
• (Hit[]) $hits. Hit:
  • (string) $url;
  • (array) $attributes;
  • (array) $nested;
  • (string) $type;
  • (array) $highlight;
  • (bool) $exact;
  • (bool) $alternative;
• (Hit[]) $quickSearchHits
  • like above
• (Facet[]) $facets. Facet:
  • (string) $name;
  • (string) $type;
  • (array) $values;
• (int) $totalHits
• (int) $currentSize

Update by query (documentation here)

1. Update

2. Retrieve job status

getStatus will return UpdateByQueryStatusResponse with following fields:

• (array) $rawResponse
• (string) $trackerId
• (bool) $completed
• (int|null) $okCount - null if not completed
• (int|null) $errorsCount - null if not completed
• (ApiResponseError[]|null) $errors - null if not completed

Final notes

Feel free to make pull requests with new features, improvements or bug fixes. The Answear team will be grateful for any comments.

Have fun!