# Bazaarvoice SEO SDK for PHP

This repository contains the codebase for the Bazaarvoice SEO SDK for PHP. Find
out more about Bazaarvoice SEO at [Bazaarvoice Knowledge][1].

## Documentation and Packaged Releases

The latest SDK documentation and links to packaged releases are available at
[Bazaarvoice Knowledge][1].

## Overview

The PHP SDK has the following requirements:

* PHP 5+
* curl library installed
* mbstring library installed

Follow these steps to use the PHP SDK:

1. Include the bvseosdk.php file:

    ```php
    require('bvseosdk.php');
    ```

2. Instantiate the bv object.

    ```php
    $bv = new BV(array(
     'bv_root_folder' => 'Main_Site-en_US',
     // The must match ExternalID in the BV product feed.
     'subject_id' => 'product1',
     // Obtain from the config hub. On the left panel, click "Technical Setup" >
     // "SEO Configuration." The value will be in the "Cloud Key" field.
     'cloud_key' => 'agileville-78b2ef7de83644cab5f8c72f2d8c8491',
     'staging' => TRUE
    ));
    ```

3. Call `$bv->reviews->getContent()` to grab the product's review SEO content.
This call will return the SEO HTML as a string. This string needs to be rendered
on the product page inside the `<div id="BVRRContainer"></div>`. For example:

    ```php
    <div id="BVRRContainer">
      <?php echo $bv->reviews->getContent();?>
    </div>
    ```

4. To test this you will need to modify your HTTP user agent string to match
that of a search engine. Or for testing convenience, you can add the query
parameter `?bvreveal=debug` to trigger the SDK to return SEO content and display
additional debug comments in the HTML markup.

The following is a full list of the parameters you can pass into the BV class
instantiated in step 2 above:

Parameter Name | Default value | Example Values | Required? | Notes
-------------- | ------------- | -------------- | --------- | -----
bv_root_folder |  None | Main_site-en_US | Yes | For PRR customers the root folder is the display code. For Conversations customers unique root folders are created for each deployment zone and locale. |
subject_id |  None | test1 | Yes | The subject ID needs to match the product ID in the product data feed used to power your display of UGC.|
cloud_key |  None | myshco-3e3001e88d9c32d19a17cafacb81bec7 | Yes | Will be provided by the Bazaarvoice team.  |
testing |  `false` | `true` or `false` | No | If set `true` the SDK will pull SEO content from the QA location rather than production. |
staging |  `false` | `true` or `false` | No | If set `true` the SDK will pull SEO content from staging rather than production. |
execution_timeout | 500 | 300 | No | Integer in ms. Period of time before the BVSEO injection times out for user agents that do not match the criteria set in `crawler_agent_pattern`. |
execution_timeout_bot | 2000 | 1000 | No | Integer in ms. Period of time before the BVSEO injection times out for user agents that match the criteria set in `crawler_agent_pattern`. |
base_url | None |  http://www.example.com/pdp/test1 | Yes | The base URL for the current page. |
page_url | None | http://www.example.com/pdp/test1?bvstate=pg:2/ct:r | No | Provide the URL if using query parameters or fragments in your URLs that Google should not index. |
subject_type | product | product, category, entry, detail | No | Provide the subject type here if needed. |
content_sub_type | stories_list | stories_list, stories_grid | No | If `content_type` is set to `stories` then pass either `stories_list` or `stories_grid` as the content subtype. |
crawler_agent_pattern | msnbot, googlebot, teoma, bingbot, yandexbot, yahoo | `msnbot|google` | Any regex valid expression | Provide a regular expression to check the user agent header value. This is used to determine whether or not the current request is made by a search engine crawler. |
ssl_enabled | `false` | `true` or `false` | No | Set `true` to retrieve SEO content over HTTPS. |
proxy_host | None | `proxy.example.com` | No | If using a proxy to access SEO content, set the host here. |
proxy_port | None | `8080` | No | If using a proxy to access SEO content, set the port number here. |
include_display_integration_code | `false` | `true` or `false` | No | Set `true` to include the Javascript that powers the display. The `bvapi.js` file must be included separately. |
local_seo_file_root |  None | '/home/zip/smart_seo/' | No | If using a local file configuration, provide the absolute path to the unzipped directory of Smart SEO content. |
load_seo_file_locally |  `false` | `true` or `false` | No | Set `true` to load content from the local directory specified in `local_seo_file_root`. Local file configurations are not recommended, but may be required to overcome system limitations. A local file system can be be fragile since Bazaarvoice is not responsible for the daily retrieval, unpacking, and distribution of SEO files. To enable local files, both `load_seo_file_locally` and `local_seo_file_root` must be set.  |
seo_sdk_enabled | `true` | `true` or `false` | No | Set `false` to disable the SDK operation and return empty strings in place of content. |

To run unit tests you should first install the [phpunit][2] tool. Then in the
folder where the bvseosdk.php file is placed run `phpunit test` to execute all
of the tests or `phpunit test/<testName>` to run a particular test.

[1]: http://knowledge.bazaarvoice.com/bvseo/
[2]: https://phpunit.de/getting-started.html