leroy-merlin-br/bazaarvoice-productfeed

A PHP library for generating Bazaarvoice XML Product and Interaction Feeds.

Bazaarvoice Product and Interaction feed Library

, _(*1)

A PHP library for generating and sFTPing XML Bazaarvoice Feeds., _(*2)

Install

Via Composer, _(*3)

``` bash $ composer require leroy-merlin-br/bazaarvoice-feed, <sub>(*4)</sub>

## Usage

### Creating a Feed.
``` php
$productFeed = new \BazaarVoice\Product\Feed();

Creating a feedElement

``` php $productFeed = new \BazaarVoice\Product\Feed(); $feedElement = $productFeed->newFeed('my_feed');, <sub>(*5)</sub>

### Creating an Incremental feed.
``` php
$productFeed = new \BazaarVoice\Product\Feed();
$feedElement = $productFeed->newFeed('my_feed', true);

``` php $productFeed = new \BazaarVoice\Product\Feed(); $feedElement = $productFeed->newFeed('my_feed') ->setIncremental(true);, <sub>(*6)</sub>

### Creating products and adding them to a feed.
``` php
$productFeed = new \BazaarVoice\Product\Feed();
$feedElement = $productFeed->newFeed('my_feed');

$productElement = $productFeed->newProduct('my_product', 'My Product', 'product_category_123', 'http://www.example.com/my-product', 'http://www.example.com/images/my-product.jpg');
$feedElement->addProduct($product_element);

$moreProducts = [];

$secondProduct = $productFeed->newProduct('second_product', 'Second Product', 'product_category_456', 'http://www.example.com/second-product', 'http://www.example.com/images/second-product.jpg');
  ->setDescription('This is my second product')
  ->addPageUrl('http://www.example.es/second-product', 'es_SP')
  ->setBrandId('my_brand_123')
  ->addUPC('012345');

$moreProducts[] = $secondProduct;

$moreProducts[] = $productFeed->newProduct('third_product', 'Third Product', 'product_category_789', 'http://www.example.com/third-product', 'http://www.example.com/images/third-product.jpg')
  ->addISBN('123-456-7890')
  ->addPageUrl('http://www.example.co.uk/third-product', 'en_UK')
  ->addCustomAttribute('PRODUCT_FAMILY', 'example_products');

$feedElement->addProducts($moreProducts);

Creating categories and adding them to a feed.

``` php $productFeed = new \BazaarVoice\Product\Feed(); $feedElement = $productFeed->newFeed('my_feed');, <sub>(*7)</sub>

// ..., <sub>(*8)</sub>

$categoryElement = $productFeed->newCategory('my_category', 'My Category', 'http://www.example.com/my-product'); $feedElement->addCategory($categoryElement);, <sub>(*9)</sub>

$moreCategories = [];, <sub>(*10)</sub>

$secondCategory = $productFeed->newCategory('second_category', 'Second Category', 'http://www.example.com/second-category') ->setImageUrl('http://www.example.com/images/second-category.jpg') ->addImageUrl('http://www.example.co.uk/images/uk-second-category.jpg', 'en_UK') ->setParentId('parent_category_id');, <sub>(*11)</sub>

$moreCategories[] = $secondCategory;, <sub>(*12)</sub>

$feedElement->addCategories($moreCategories);, <sub>(*13)</sub>

### Creating brands and adding them to a feed.
``` php
$productFeed = new \BazaarVoice\Product\Feed();
$feedElement = $productFeed->newFeed('my_feed');

// ...

$brandElement = $productFeed->newBrand('my_brand', 'My Brand');
$feedElement->addBrand($brandElement);

$moreBrands = [];

$secondBrand = $productFeed->newBrand('second_brand', 'Second Brand')
  ->addName('Duo Brand', 'es_SP')
  ->addName('Brand the Second', 'en_UK');

$moreBrands[] = $secondBrand;

$moreBrands[] = $productFeed->newBrand('third_brand', 'Third Brand');

$feedElement->addBrands($moreBrands);

Creating interactions (orders) and adding them to a feed.

``` php $orderFeed = new \BazaarVoice\Interaction\Feed(); $feedElement = $orderFeed->newFeed('Order feed');, <sub>(*14)</sub>

$orderProducts = [ [ 'id' => 'productId123', 'name' => 'Product name', 'category' => 'Product Category', 'url' => 'http://product-url', 'imageUrl' => 'http://image-url', 'price' => 29, ], ]; $order = $feed->newInteraction('22/03/1987', 'john@doe.com', 'John Doe', 'userId123', 'pt_BR', $orderProducts);, <sub>(*15)</sub>

$feedElement->addInteraction($orderFeed);, <sub>(*16)</sub>

// $orderFeed->printFeed();, <sub>(*17)</sub>

### Print ProductFeed XML string
``` php
$productFeed = new \BazaarVoice\Product\Feed();
$feedElement = $productFeed->newFeed('my_feed');

// ... add products, brands & categories ...

print $productFeed->printFeed($feedElement);

Saving Productfeed as an XML file.

``` php, <sub>(*18)</sub>

$productFeed = new \BazaarVoice\Product\Feed(); $feedElement = $productFeed->newFeed('my_feed');, <sub>(*19)</sub>

// ... add products, brands & categories ..., <sub>(*20)</sub>

$productFeed->saveFeed($feedElement, 'path/to/dir', 'my_feed_XYZ');, <sub>(*21)</sub>

### SFTP ProductFeed to BazaarVoice Production.
``` php

$productFeed = new \BazaarVoice\Product\Feed();
$feedElement = $productFeed->newFeed('my_feed');

// ... add products, brands & categories ...

if ($feedFile = $productFeed->saveFeed($feedElement, 'path/to/dir', 'my_feed_XYZ') {  
  try {
    $productFeed->sendFeed($feedFile, $sftpUsername, $sftpPassword);
  } catch (\Exception $e) {
    // Failed to FTP feed file.
  }
}

SFTP ProductFeed to Bazaarvoice Staging.

``` php, <sub>(*22)</sub>

$productFeed = new \BazaarVoice\Product\Feed(); $feedElement = $productFeed->newFeed('my_feed');, <sub>(*23)</sub>

// ... add products, brands & categories ..., <sub>(*24)</sub>

if ($feedFile = $productFeed->saveFeed($feedElement, 'path/to/dir', 'my_feed_XYZ') {
try { $productFeed->useStage()->sendFeed($feedFile, $sftpUsername, $sftpPassword); } catch (\Exception $e) { // Failed to FTP feed file. } }, <sub>(*25)</sub>

## Testing

``` bash
$ composer test

Credits

• Mike Miles

License

The MIT License (MIT). Please see License File for more information., <sub>(*26)</sub>