mikemiles86/bazaarvoice-productfeed

A PHP library for generating Bazaarvoice XML ProductFeeds.

Bazaarvoice Productfeed Library

, _(*1)

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

Install

Via Composer, _(*3)

``` bash $ composer require mikemiles86/bazaarvoice-productfeed, <sub>(*4)</sub>

## Usage

### Creating a Feed.
``` php
$productFeed = new \BazaarvoiceProductFeed\ProductFeed();

Creating a feedElement

``` php $productFeed = new \BazaarvoiceProductFeed\ProductFeed(); $feed_element = $productFeed->newFeed('my_feed');, <sub>(*5)</sub>

### Creating an Incremental feed.
``` php
$productFeed = new \BazaarvoiceProductFeed\ProductFeed();
$feed_element = $productFeed->newFeed('my_feed', TRUE);

``` php $productFeed = new \BazaarvoiceProductFeed\ProductFeed(); $feed_element = $productFeed->newFeed('my_feed') ->setIncremental(TRUE);, <sub>(*6)</sub>

### Creating products and adding them to a feed.
``` php
$productFeed = new \BazaarvoiceProductFeed\ProductFeed();
$feed_element = $productFeed->newFeed('my_feed');

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

$more_products = [];

$second_product = $productFeed->newProduct('second_product', 'Second Product', 'product_category_456', 'htttp://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');

$more_products[] = $second_product;

$more_products[] = $productFeed->newProduct('third_product', 'Third Product', 'product_category_789', 'htttp://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');

$feed_element->addProducts($more_products);

Creating categories and adding them to a feed.

``` php $productFeed = new \BazaarvoiceProductFeed\ProductFeed(); $feed_element = $productFeed->newFeed('my_feed');, <sub>(*7)</sub>

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

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

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

$second_category = $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>

$more_categories[] = $second_category;, <sub>(*12)</sub>

$feed_element->addCategories($more_categories);, <sub>(*13)</sub>

### Creating brands and adding them to a feed.
``` php
$productFeed = new \BazaarvoiceProductFeed\ProductFeed();
$feed_element = $productFeed->newFeed('my_feed');

// ...

$brand_element = $productFeed->newBrand('my_brand', 'My Brand');
$feed_element->addBrand($brand_element);

$more_brands = [];

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

$more_brands[] = $second_brand;

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

$feed_element->addBrands($more_brands);

Print ProductFeed XML string

``` php $productFeed = new \BazaarvoiceProductFeed\ProductFeed(); $feed_element = $productFeed->newFeed('my_feed');, <sub>(*14)</sub>

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

print $productFeed->printFeed($feed_element);, <sub>(*16)</sub>

### Saving Productfeed as an XML file.
``` php

$productFeed = new \BazaarvoiceProductFeed\ProductFeed();
$feed_element = $productFeed->newFeed('my_feed');

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

$productFeed->saveFeed($feed_element, 'path/to/dir', 'my_feed_XYZ');

SFTP ProductFeed to Bazaarvoice Production.

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

$productFeed = new \BazaarvoiceProductFeed\ProductFeed(); $feed_element = $productFeed->newFeed('my_feed');, <sub>(*18)</sub>

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

if ($feed_file = $productFeed->saveFeed($feed_element, 'path/to/dir', 'my_feed_XYZ') {
try { $productFeed->sendFeed($feed_file, $sftp_username, $sftp_password); } catch (\Exception $e) { // Failed to FTP feed file. } }, <sub>(*20)</sub>

#### SFTP ProductFeed to Bazaarvoice Staging.
``` php

$productFeed = new \BazaarvoiceProductFeed\ProductFeed();
$feed_element = $productFeed->newFeed('my_feed');

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

if ($feed_file = $productFeed->saveFeed($feed_element, 'path/to/dir', 'my_feed_XYZ') {  
  try {
    $productFeed->useStage()->sendFeed($feed_file, $sftp_username, $sftp_password);
  } catch (\Exception $e) {
    // Failed to FTP feed file.
  }
}

Testing

bash $ composer test, <sub>(*21)</sub>

Credits

• Mike Miles

License

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