Services_Scribd
[ class tree: Services_Scribd ] [ index: Services_Scribd ] [ all elements ]

Source for file Thumbnail.php

Documentation is available at Thumbnail.php

  1. <?php
  2. /**
  3.  * Interface for Scribd's "thumbnail" API endpoint.
  4.  *
  5.  * PHP version 5.2.0+
  6.  *
  7.  * LICENSE: This source file is subject to the New BSD license that is
  8.  * available through the world-wide-web at the following URI:
  9.  * http://www.opensource.org/licenses/bsd-license.php. If you did not receive
  10.  * a copy of the New BSD License and are unable to obtain it through the web,
  11.  * please send a note to license@php.net so we can mail you a copy immediately.
  12.  *
  13.  * @category  Services
  14.  * @package   Services_Scribd
  15.  * @author    Rich Schumacher <rich.schu@gmail.com>
  16.  * @copyright 2013 Rich Schumacher <rich.schu@gmail.com>
  17.  * @license   http://www.opensource.org/licenses/bsd-license.php New BSD License
  18.  * @version   Release: 0.2.0
  19.  * @link      http://pear.php.net/package/Services_Scribd
  20.  */
  21.  
  22. require_once 'Services/Scribd/Common.php';
  23.  
  24. /**
  25.  * The interface for the "thumbnail" API endpoint.  Allows the user to retrieve
  26.  * a URL to the thumbnail of a document in a given size.
  27.  *
  28.  * @category  Services
  29.  * @package   Services_Scribd
  30.  * @author    Rich Schumacher <rich.schu@gmail.com>
  31.  * @copyright 2013 Rich Schumacher <rich.schu@gmail.com>
  32.  * @license   http://www.opensource.org/licenses/bsd-license.php New BSD License
  33.  * @link      http://www.scribd.com/developers/platform
  34.  */
  35. {
  36.     /**
  37.      * Array of API endpoints that are supported
  38.      *
  39.      * @var array 
  40.      */
  41.     protected $validEndpoints = array(
  42.         'get'
  43.     );
  44.  
  45.     /**
  46.      * Retrieves a URL to the thumbnail of a document, in a given size. Note
  47.      * that docs.getSettings and docs.getList also retrieve thumbnail URLs in
  48.      * default size - this method is really for resizing those.
  49.      *
  50.      * IMPORTANT - it is possible that at some time in the future, Scribd
  51.      * will redesign its image system, invalidating these URLs. So if you cache
  52.      * them, please have an update strategy in place so that you can update
  53.      * them if neceessary.
  54.      *
  55.      * @param integer $docId  The id of the document
  56.      * @param integer $width  Width in px of the desired image
  57.      * @param integer $height Height in px of the desired image
  58.      *
  59.      * @link http://www.scribd.com/developers/platform/api/thumbnail_get
  60.      * @return string 
  61.      */
  62.     public function get($docId$width = null$height = null)
  63.     {
  64.         $this->arguments['doc_id'$docId;
  65.         $this->arguments['width'$width;
  66.         $this->arguments['height'$height;
  67.  
  68.         $response $this->call('thumbnail.get'HTTP_Request2::METHOD_GET);
  69.  
  70.         return trim((string) $response->thumbnail_url);
  71.     }
  72. }

Documentation generated on Sat, 06 Apr 2013 14:30:04 +0000 by phpDocumentor 1.4.3. PEAR Logo Copyright © PHP Group 2004.