reevoomark-php-api

##Description

The reevoomark-php-api is a PHP tag library for ReevooMark and Reevoo Essentials customers who want to quickly and easily integrate Reevoo content in to their sites server-side.

##Other Languages Tag libraries are also available for .NET and Java.

##Features

• Server-side inclusion of Reevoo content.
• Included CSS for display of Reevoo content.
• Server-side caching of content that respects the cache control rules set by Reevoo.

##Support For ReevooMark and Reevoo Essentials customers, support can be obtained by emailing [email protected].

There is also a bug tracker available.

##Installation

Add Pearhub as a PEAR channel if you don't already have it:

pear channel-discover pearhub.org

Install the ReevooMark API:

pear install pearhub/reevoomark_php_api

##Implementation

Include the relevant CSS. For product reviews use:

<link rel="stylesheet" href="http://mark.reevoo.com/stylesheets/reevoomark/embedded_reviews.css" type="text/css" />

Include your customer specific Reevoo JavaScript:

<script src="http://mark.reevoo.com/reevoomark/<TRKREF>.js" type="text/javascript"></script>

Include the PHP library (make sure you use the correct path to the reevoo_mark.php file):

<? include("reevoo_mark.php"); ?>

Render embedded review content. Make sure you replace <reevoo_cache> with the path of a directory that can be used to cache review content:

<? $reevoo_mark = new ReevooMark("<reevoo_cache>", "http://mark.reevoo.com/reevoomark/embeddable_reviews.html", "<TRKREF>", "<SKU>") ?>
<?php $reevoo_mark->render(); ?>

It is also possible to specify locale and the number of reviews you'd like in the URI:

http://mark.reevoo.com/reevoomark/fr-FR/10/embeddable_reviews.html

By default Reevoo will display helpful pages to the user when there are no reviews available. If you'd like to handle this yourself, you can check the review count:

<? if( $reevoo_mark->reviewCount() > 0 ){ ?>
  <?php $reevoo_mark->render(); ?>
<? }else{ ?>
  <h1>No reviews</h1>
<? } ?>

Tracking

If you display the reviews in a tabbed display, or otherwise require visitors to your site to click an element before seeing the embedded reviews, add the following onclick attribute to track the clickthroughs:

  onclick="ReevooMark.track_click_through(‘<SKU>’)”

Overall rating

The overall rating section at the top of inline reviews contains an overall score, a summary and the score breakdowns. Your container must be at least 650px for the score breakdowns to be shown. The absolute minimum width for inline reviews is 350px.

##License

This software is released under the MIT license. Only certified ReevooMark partners are licensed to display Reevoo content on their sites. Contact [email protected] for more information.

(The MIT License)

Copyright (c) 2008 - 2010:

• Reevoo

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the 'Software'), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.