document.php

<?php
/*
  Class for uploading, loading, and deleting documents using the Vuzit Web
  Service API: http://vuzit.com/developer/documents_api.  
*/
class Vuzit_Document extends Vuzit_Base
{
  /*
    Constructor.  Creates an empty document.  This is not called directly.  
    Use upload or findById to load an instance. 
  */
  public function __construct() {
    $this->id = null;
    $this->title = null;
    $this->subject = null;
    $this->modifiedAt = null;
    $this->imageType = null;
    $this->pageCount = -1;
    $this->pageWidth = -1;
    $this->pageHeight = -1;
    $this->fileSize = -1;
    $this->status = -1;
    $this->excerpt = null;
  }

  /*
    Returns the document web ID.  
  */
  public function getId() {
    return $this->id;
  }

  /*
    Returns the document excerpt if present.  
  */
  public function getExcerpt() {
    return $this->excerpt;
  }

  /*
    Returns the document status.  
  */
  public function getStatus() {
    return $this->status;
  }

  /*
    Returns the document title.  
  */
  public function getTitle() {
    return $this->title;
  }

  /*
    Returns the document subject.  
  */
  public function getSubject() {
    return $this->subject;
  }

  /*
    Returns the document page count.  
  */
  public function getPageCount() {
    return $this->pageCount;
  }

  /*
    Returns the document page width.  
  */
  public function getPageWidth() {
    return $this->pageWidth;
  }

  /*
    Returns the document page height.  
  */
  public function getPageHeight() {
    return $this->pageHeight;
  }

  /*
    Returns the document file size.  
  */
  public function getFileSize() {
    return $this->fileSize;
  }

  /*
    Deletes a document by the ID.  It throws a <Vuzit_ClientException> on failure. 
  */
  public static function destroy($webId)
  {
    if($webId == null) {
      throw new Vuzit_ClientException("webId cannot be null");
    }
    $params = self::postParameters("destroy", null, $webId);

    $url = self::parametersToUrl("documents/$webId.xml", $params);

    $ch = self::curlRequest();
    curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'DELETE');
    curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1); // only if expecting response
    curl_setopt($ch, CURLOPT_URL, $url);

    $xml_string = curl_exec($ch);

    $info = curl_getinfo($ch);
    if($info['http_code'] != 200) {
      $xml = @simplexml_load_string($xml_string); 
      throw new Vuzit_ClientException((string)$xml->msg, (int)$xml->code);
    }
    curl_close($ch);
  }

  /*
    Returns a URL that can download the original document (DOC, PPT, etc)
    or the PDF version. 
  */
  public static function downloadUrl($webId, $fileExtension)
  {
    if($webId == null) {
      throw new Vuzit_ClientException("webId cannot be null");
    }
    if($fileExtension == null) {
      throw new Vuzit_ClientException("fileExtension cannot be null");
    }

    $params = self::postParameters("show", null, $webId);
    $result = self::parametersToUrl("documents/$webId.$fileExtension", $params);

    return $result;
  }

  /*
    Loads up multiple documents.  
  */
  public static function findAll($options = null)
  {
    $result = array();
    $params = self::postParameters("index", $options);

    $ch = self::curlRequest();
    $url = self::parametersToUrl("documents.xml", $params);

    curl_setopt($ch, CURLOPT_URL, $url);
    curl_setopt($ch, CURLOPT_RETURNTRANSFER,1); // only if expecting response

    $xml_string = curl_exec($ch);
    $info = curl_getinfo($ch);

    if(!$xml_string) {
      throw new Vuzit_ClientException('CURL load failed: "' . curl_error($ch) . '"');
    }

    // Prevent the warnings if the XML is malformed
    $xml = @simplexml_load_string($xml_string); 
    curl_close($ch);

    if(!$xml) {
      throw new Vuzit_ClientException("Error loading XML response");
    }
    if($xml->code) {
      throw new Vuzit_ClientException($xml->msg, (int)$xml->code);
    }

    for($i = 0; $i < count($xml->document); $i++)
    {
      $result[$i] = self::xmlToDocument($xml->document[$i]);
    }

    return $result;
  }

  /*
    Finds a document by the ID.  Deprecated.  
  */
  public static function findById($webId, $options = null)
  {
    return self::find($webId, $options);
  }

  /*
    Finds a document by the ID.  It throws a <Vuzit_ClientException> on failure. 
  */
  public static function find($webId, $options = null)
  {
    if($webId == null) {
      throw new Vuzit_ClientException("webId cannot be null");
    }
    $params = self::postParameters("show", $options, $webId);

    $ch = self::curlRequest();

    $url = self::parametersToUrl("documents/$webId.xml", $params);

    curl_setopt($ch, CURLOPT_URL, $url);
    curl_setopt($ch, CURLOPT_RETURNTRANSFER,1); // only if expecting response

    $xml_string = curl_exec($ch);
    $info = curl_getinfo($ch);

    if(!$xml_string) {
      throw new Vuzit_ClientException('CURL load failed: "' . curl_error($ch) . '"');
    }
    // TODO: This needs to be re-added some time in the future by looking at the
    //       error codes.  I would add it but they aren't documented.  
    //if($info['http_code'] != 200) {
    //  throw new Vuzit_ClientException("HTTP error " . $info['http_code']);
    //}

    // Prevent the warnings if the XML is malformed
    $xml = @simplexml_load_string($xml_string); 
    curl_close($ch);

    if(!$xml) {
      throw new Vuzit_ClientException("Error loading XML response");
    }
    if($xml->code) {
      throw new Vuzit_ClientException($xml->msg, (int)$xml->code);
    }
    if(!$xml->web_id) {
      throw new Vuzit_ClientException("Unknown error occurred");
    }
    $result = self::xmlToDocument($xml);

    return $result;
  }

  /*
    Uploads a file to Vuzit. It throws a <Vuzit_ClientException> on failure. 
  */
  public static function upload($file, $options = null)
  {
    $params = self::postParameters("create", $options);
    if(!file_exists($file)) {
      throw new Vuzit_ClientException("Cannot find file at path: $file");
    }
    $params['upload'] = "@".$file;
    $params = self::parametersClean($params);

    $ch = self::curlRequest();
    $url = Vuzit_Service::getServiceUrl() . "/documents.xml";
    curl_setopt($ch, CURLOPT_URL, $url);
    curl_setopt($ch, CURLOPT_RETURNTRANSFER,1); // only if expecting response
    curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'POST');
    curl_setopt($ch, CURLOPT_POSTFIELDS, $params);
    // Setting the timeout to 5 minutes in case the file is large
    curl_setopt($ch, CURLOPT_CONNECTTIMEOUT, (5 * 60 * 1000)); 

    $xml_string = curl_exec($ch);
    if(!$xml_string) {
      throw new Vuzit_ClientException('CURL load failed: "' . curl_error($ch) . '"');
    }

    $info = curl_getinfo($ch);
    // TODO: This needs to be re-added some time in the future by looking at the
    //       error codes.  I would add it but they aren't documented.  
    //if($info['http_code'] != 201) {
    //  throw new Vuzit_ClientException("HTTP error, expected 201 but got: " . $info['http_code']);
    //}

    // Prevent the warnings if the XML is malformed
    $xml = @simplexml_load_string($xml_string); 
    curl_close($ch);

    if(!$xml) {
      throw new Vuzit_ClientException("Error loading XML response");
    }

    if($xml->code) {
      throw new Vuzit_ClientException($xml->msg, (int)$xml->code);
    }

    if(!$xml->web_id) {
      throw new Vuzit_ClientException("Unknown error occurred");
    }

    $result = new Vuzit_Document();
    $result->id = (string)$xml->web_id; 

    return $result;
  }

  // Private static methods

  /*
    Converts an XML array to a Document instance.
  */
  private static function xmlToDocument($xml)
  {
    $result = new Vuzit_Document();

    $result->id = self::nodeValue($xml->web_id); 
    if($result->id == null) {
      throw new Vuzit_ClientException("No web_id found in results");
    }

    $result->title = self::nodeValue($xml->title);
    $result->subject = self::nodeValue($xml->subject);
    $result->pageCount = self::nodeValueInt($xml->page_count);
    $result->pageWidth = self::nodeValueInt($xml->width);
    $result->pageHeight = self::nodeValueInt($xml->height);
    $result->fileSize = self::nodeValueInt($xml->file_size);
    $result->status = self::nodeValueInt($xml->status);
    $result->excerpt = self::nodeValue($xml->excerpt);

    return $result;
  }
}
?>