Source for file OnpubImages.php

Documentation is available at OnpubImages.php

  1. <?php
  2.  
  3. /**
  4.  * Manage images in an Onpub database.
  5.  *
  6.  * @author {@link mailto:corey@onpub.com Corey H.M. Taylor}
  7.  * @copyright Onpub (TM). Copyright 2012, Onpub.com.
  8.  *  {@link http://onpub.com/}
  9.  * @license http://www.gnu.org/copyleft/gpl.html GNU General Public License
  10.  *  Version 2
  11.  * @package OnpubAPI
  12.  */
  13. class OnpubImages
  14. {
  15.   private $pdo;
  16.   /**
  17.    * @var bool 
  18.    */
  19.   public $enableTransactions;
  20.  
  21.   /**
  22.    * Connect to an Onpub database.
  23.    *
  24.    * All the methods in this class which query the database use the database
  25.    * connection provided by the PDO object required by this constructor.
  26.    * Currently, Onpub only supports MySQL as a database for storing content.
  27.    * Therefore, when constructing the PDO object, only the
  28.    * {@link PHP_MANUAL#ref.pdo-mysql PDO_MYSQL} driver is supported
  29.    * as a PDO {@link PHP_MANUAL#ref.pdo-mysql.connection data source}.
  30.    *
  31.    * All the methods in this class require the
  32.    * {@link http://onpub.com/pdfs/onpub_schema.pdf Onpub schema}
  33.    * to be installed in the PDO-connected database. The {@link OnpubDatabase}
  34.    * class contains methods to manage the Onpub schema. The Onpub
  35.    * schema can also be installed by clicking the "Install the schema" link
  36.    * once logged in to the Onpub web interface. The schema generally only has
  37.    * to be installed once per database.
  38.    *
  39.    * @param PDO $pdo A {@link PHP_MANUAL#function.pdo-construct PHP Data Object}.
  40.    * @param bool $enableTransactions 
  41.    */
  42.   function __construct(PDO $pdo, $enableTransactions = TRUE)
  43.   {
  44.     $this->pdo = $pdo;
  45.     $this->enableTransactions = $enableTransactions;
  46.     $this->pdo->setAttribute(PDO::ATTR_EMULATE_PREPARES, TRUE);
  47.   }
  48.  
  49.   /**
  50.    * @return int 
  51.    */
  52.   public function count()
  53.   {
  54.     $query = $this->countQuery();
  55.     $result = $this->pdo->query($query);
  56.     OnpubDatabase::verifyQuery($this->pdo, $result, FALSE);
  57.  
  58.     if (!($row = $result->fetch(PDO::FETCH_ASSOC))) {
  59.       return 0;
  60.     }
  61.  
  62.     $result->closeCursor();
  63.     return $row["count"];
  64.   }
  65.  
  66.   private function countQuery()
  67.   {
  68.     return "SELECT COUNT(ID) AS count FROM OnpubImages";
  69.   }
  70.  
  71.   /**
  72.    * @param mixed $images A single {@link OnpubImage} object or an array of {@link OnpubImage} objects (to insert multiple images at a time).
  73.    * @return mixed The ID(s) of the new image(s). An int will be returned if a single image was inserted. An array of ints will be returned if multiple images were inserted.
  74.    * @throws PDOException if there's a database error.
  75.    */
  76.   public function insert($images)
  77.   {
  78.     $IDs = array();
  79.     $isArray = TRUE;
  80.  
  81.     if (!is_array($images)) {
  82.       $images = array ($images);
  83.       $isArray = FALSE;
  84.     }
  85.  
  86.     if ($this->enableTransactions) {
  87.       $status = $this->pdo->beginTransaction();
  88.       OnpubDatabase::verifyTransaction($this->pdo, $status);
  89.     }
  90.  
  91.     $stmt = $this->pdo->prepare("INSERT INTO OnpubImages (ID, websiteID, fileName, description, url, created, modified) VALUES (:ID, :websiteID, :fileName, :description, :url, :created, :modified)");
  92.     OnpubDatabase::verifyPrepare($this->pdo, $stmt, $this->enableTransactions);
  93.  
  94.     foreach ($images as $image) {
  95.       try {
  96.         $ID = $this->getID($image);
  97.       }
  98.       catch (PDOException $e) {
  99.         if ($this->enableTransactions)
  100.           $this->pdo->rollBack();
  101.  
  102.         throw $e;
  103.       }
  104.  
  105.       if ($ID) {
  106.         $IDs[] = $ID;
  107.         $image->ID = $ID;
  108.       }
  109.       else {
  110.         $ID = $image->ID;
  111.         $websiteID = $image->websiteID;
  112.         $fileName = OnpubDatabase::utf8Decode(trim($image->fileName));
  113.         $description = OnpubDatabase::utf8Decode(trim($image->description));
  114.         $url = OnpubDatabase::utf8Decode(trim($image->url));
  115.         $created = $image->getCreated()->format('Y-m-d H:i:s');
  116.         $modified = $image->getModified()->format('Y-m-d H:i:s');
  117.  
  118.         $stmt->bindParam(':ID', $ID);
  119.         $stmt->bindParam(':websiteID', $websiteID);
  120.         $stmt->bindParam(':fileName', $fileName);
  121.         $stmt->bindParam(':description', $description);
  122.         $stmt->bindParam(':url', $url);
  123.         $stmt->bindParam(':created', $created);
  124.         $stmt->bindParam(':modified', $modified);
  125.         $result = $stmt->execute();
  126.         OnpubDatabase::verifyExecute($this->pdo, $result, $this->enableTransactions, $stmt->errorInfo());
  127.  
  128.         $IDs[] = $this->pdo->lastInsertId();
  129.         $image->ID = $this->pdo->lastInsertId();
  130.       }
  131.     }
  132.  
  133.     if ($this->enableTransactions) {
  134.       $status = $this->pdo->commit();
  135.       OnpubDatabase::verifyTransaction($this->pdo, $status);
  136.     }
  137.  
  138.     if ($isArray) {
  139.       return $IDs;
  140.     }
  141.     else {
  142.       return end($IDs);
  143.     }
  144.   }
  145.  
  146.   /**
  147.    * @param int $ID ID of the image to get.
  148.    * @return OnpubImage An {@link OnpubImage} object. NULL if the image does not exist in the database.
  149.    */
  150.   public function get($ID)
  151.   {
  152.     $query = $this->getQuery($ID);
  153.     $result = $this->pdo->query($query);
  154.     OnpubDatabase::verifyQuery($this->pdo, $result, FALSE);
  155.  
  156.     if (!($row = $result->fetch(PDO::FETCH_ASSOC))) {
  157.       return NULL;
  158.     }
  159.  
  160.     $website = new OnpubWebsite();
  161.  
  162.     $website->ID = $row["websiteID"];
  163.     $website->imageID = $row["websiteImageID"];
  164.     $website->name = $row["websiteName"];
  165.     $website->url = $row["websiteURL"];
  166.     $website->imagesURL = $row["websiteImagesURL"];
  167.     $website->imagesDirectory = $row["websiteImagesDirectory"];
  168.     $website->setCreated(new DateTime($row["websiteCreated"]));
  169.     $website->setModified(new DateTime($row["websiteModified"]));
  170.  
  171.     $image = new OnpubImage();
  172.  
  173.     $image->ID = $row["ID"];
  174.     $image->websiteID = $row["websiteID"];
  175.     $image->fileName = $row["fileName"];
  176.     $image->description = $row["description"];
  177.     $image->url = $row["url"];
  178.     $image->setCreated(new DateTime($row["created"]));
  179.     $image->setModified(new DateTime($row["modified"]));
  180.     $image->website = $website;
  181.  
  182.     $result->closeCursor();
  183.     return $image;
  184.   }
  185.  
  186.   private function getQuery($ID)
  187.   {
  188.     return "SELECT images.ID, images.websiteID, images.fileName, " .
  189.            "images.description, images.url, images.created, images.modified, " .
  190.            "website.imageID as websiteImageID, website.name as websiteName, " .
  191.            "website.url as websiteURL, website.imagesURL as websiteImagesURL, " .
  192.            "website.imagesDirectory as websiteImagesDirectory, website.created " .
  193.            "as websiteCreated, website.modified as websiteModified FROM " .
  194.            "OnpubImages as images LEFT JOIN OnpubWebsites as website ON " .
  195.            "images.websiteID = website.ID WHERE images.ID = $ID";
  196.   }
  197.  
  198.   /**
  199.    * @param OnpubImage $image Image whose ID you want to get.
  200.    * @return int The ID of the image. NULL if the image does not exist in the database.
  201.    */
  202.   public function getID(OnpubImage $image)
  203.   {
  204.     $stmt = $this->pdo->prepare("SELECT ID FROM OnpubImages WHERE websiteID = :websiteID AND fileName = :fileName");
  205.     OnpubDatabase::verifyPrepare($this->pdo, $stmt, FALSE);
  206.  
  207.     $websiteID = $image->websiteID;
  208.     $fileName = OnpubDatabase::utf8Decode(trim($image->fileName));
  209.  
  210.     $stmt->bindParam(':websiteID', $websiteID);
  211.     $stmt->bindParam(':fileName', $fileName);
  212.     $result = $stmt->execute();
  213.     OnpubDatabase::verifyExecute($this->pdo, $result, FALSE, $stmt->errorInfo());
  214.  
  215.     if (($row = $stmt->fetch(PDO::FETCH_ASSOC))) {
  216.       return $row["ID"];
  217.     }
  218.  
  219.     return NULL;
  220.   }
  221.  
  222.   /**
  223.    * @param OnpubQueryOptions $queryOptions Database query options.
  224.    * @return array An array of {@link OnpubImage} objects.
  225.    */
  226.   public function select(OnpubQueryOptions $queryOptions = NULL)
  227.   {
  228.     if ($queryOptions === NULL)
  229.       $queryOptions = new OnpubQueryOptions();
  230.  
  231.     $query = $this->selectQuery($queryOptions);
  232.     $result = $this->pdo->query($query);
  233.     OnpubDatabase::verifyQuery($this->pdo, $result, FALSE);
  234.     $rows = $result->fetchAll(PDO::FETCH_ASSOC);
  235.  
  236.     $images = array();
  237.  
  238.     if ($rows) {
  239.       foreach ($rows as $row) {
  240.         $website = new OnpubWebsite();
  241.  
  242.         $website->ID = $row["websiteID"];
  243.         $website->imageID = $row["websiteImageID"];
  244.         $website->name = $row["websiteName"];
  245.         $website->url = $row["websiteURL"];
  246.         $website->imagesURL = $row["websiteImagesURL"];
  247.         $website->imagesDirectory = $row["websiteImagesDirectory"];
  248.         $website->setCreated(new DateTime($row["websiteCreated"]));
  249.         $website->setModified(new DateTime($row["websiteModified"]));
  250.  
  251.         $image = new OnpubImage();
  252.  
  253.         $image->ID = $row["ID"];
  254.         $image->websiteID = $row["websiteID"];
  255.         $image->fileName = $row["fileName"];
  256.         $image->description = $row["description"];
  257.         $image->url = $row["url"];
  258.         $image->setCreated(new DateTime($row["created"]));
  259.         $image->setModified(new DateTime($row["modified"]));
  260.         $image->website = $website;
  261.  
  262.         $images[] = $image;
  263.       }
  264.     }
  265.  
  266.     $result->closeCursor();
  267.     return $images;
  268.   }
  269.  
  270.   private function selectQuery(OnpubQueryOptions $queryOptions = NULL)
  271.   {
  272.     if ($queryOptions === NULL)
  273.       $queryOptions = new OnpubQueryOptions();
  274.  
  275.     $where = "";
  276.     $orderBy = "";
  277.     $limit = "";
  278.  
  279.     if ($queryOptions->dateLimit) {
  280.       $where = "WHERE images.created <= "
  281.         . $this->pdo->quote($queryOptions->dateLimit->format('Y-m-d H:i:s'));
  282.     }
  283.  
  284.     if ($queryOptions->orderBy) {
  285.       $orderBy = "ORDER BY " . $queryOptions->orderBy;
  286.  
  287.       if ($queryOptions->order) {
  288.         $orderBy .= " " . $queryOptions->order;
  289.       }
  290.     }
  291.  
  292.     if ($queryOptions->getPage() && $queryOptions->rowLimit && $queryOptions->rowLimit > 0) {
  293.       $limit = "LIMIT "
  294.         . (($queryOptions->getPage() - 1) * $queryOptions->rowLimit) . ","
  295.         . $queryOptions->rowLimit;
  296.     }
  297.     elseif ($queryOptions->rowLimit && $queryOptions->rowLimit > 0) {
  298.       $limit = "LIMIT 0," . $queryOptions->rowLimit;
  299.     }
  300.  
  301.     return "SELECT images.ID, images.websiteID, images.fileName, " .
  302.            "images.description, images.url, images.created, images.modified, " .
  303.            "website.imageID as websiteImageID, website.name as websiteName, " .
  304.            "website.url as websiteURL, website.imagesURL as websiteImagesURL, " .
  305.            "website.imagesDirectory as websiteImagesDirectory, website.created " .
  306.            "as websiteCreated, website.modified as websiteModified FROM " .
  307.            "OnpubImages as images LEFT JOIN OnpubWebsites as website ON " .
  308.            "images.websiteID = website.ID $where $orderBy $limit";
  309.   }
  310.  
  311.   /**
  312.    * @param string $keywords Keyword(s) to search for.
  313.    * @return array All the images which were found as an array of {@link OnpubImage} objects.
  314.    */
  315.   public function search($keywords, OnpubQueryOptions $queryOptions = NULL)
  316.   {
  317.     if ($queryOptions === NULL)
  318.       $queryOptions = new OnpubQueryOptions();
  319.  
  320.     $query = $this->searchQuery($keywords, $queryOptions);
  321.     $result = $this->pdo->query($query);
  322.     OnpubDatabase::verifyQuery($this->pdo, $result, FALSE);
  323.  
  324.     $rows = $result->fetchAll(PDO::FETCH_ASSOC);
  325.  
  326.     $images = array();
  327.  
  328.     if ($rows) {
  329.       foreach ($rows as $row) {
  330.         $image = new OnpubImage();
  331.  
  332.         $image->ID = $row["ID"];
  333.         $image->websiteID = $row["websiteID"];
  334.         $image->fileName = $row["fileName"];
  335.         $image->description = $row["description"];
  336.         $image->url = $row["url"];
  337.         $image->setCreated(new DateTime($row["created"]));
  338.         $image->setModified(new DateTime($row["modified"]));
  339.  
  340.         $images[] = $image;
  341.       }
  342.     }
  343.  
  344.     $result->closeCursor();
  345.     return $images;
  346.   }
  347.  
  348.   private function searchQuery($keywords, OnpubQueryOptions $queryOptions = NULL)
  349.   {
  350.     if ($queryOptions === NULL)
  351.       $queryOptions = new OnpubQueryOptions();
  352.  
  353.     $keywords = $this->pdo->quote(OnpubDatabase::utf8Decode(trim($keywords)));
  354.  
  355.     if ($queryOptions->orderBy) {
  356.       $orderBy = $queryOptions->orderBy;
  357.     }
  358.     else {
  359.       $orderBy = "";
  360.     }
  361.  
  362.     if ($queryOptions->order) {
  363.       $order = $queryOptions->order;
  364.     }
  365.     else {
  366.       $order = "";
  367.     }
  368.  
  369.     if ($orderBy) {
  370.       if ($order) {
  371.         return "SELECT ID, websiteID, fileName ,description, url, created, modified FROM OnpubImages WHERE ID RLIKE $keywords OR fileName RLIKE $keywords OR description RLIKE $keywords OR modified RLIKE $keywords ORDER BY $orderBy $order";
  372.       }
  373.       else {
  374.         return "SELECT ID, websiteID, fileName ,description, url, created, modified FROM OnpubImages WHERE ID RLIKE $keywords OR fileName RLIKE $keywords OR description RLIKE $keywords OR modified RLIKE $keywords ORDER BY $orderBy";
  375.       }
  376.     }
  377.     else {
  378.       return "SELECT ID, websiteID, fileName ,description, url, created, modified FROM OnpubImages WHERE ID RLIKE $keywords OR fileName RLIKE $keywords OR description RLIKE $keywords OR modified RLIKE $keywords";
  379.     }
  380.   }
  381.  
  382.   /**
  383.    * @param OnpubImage $image The image to be updated.
  384.    * @return int 1 if the image was updated. 0 if the image does not exist in the database.
  385.    */
  386.   public function update(OnpubImage $image)
  387.   {
  388.     $now = new DateTime();
  389.  
  390.     $stmt = $this->pdo->prepare("UPDATE OnpubImages SET fileName = :fileName, description = :description, url = :url, modified = :modified WHERE ID = :ID");
  391.     OnpubDatabase::verifyPrepare($this->pdo, $stmt, $this->enableTransactions);
  392.  
  393.     $ID = $image->ID;
  394.     $fileName = OnpubDatabase::utf8Decode(trim($image->fileName));
  395.     $description = OnpubDatabase::utf8Decode(trim($image->description));
  396.     $url = OnpubDatabase::utf8Decode(trim($image->url));
  397.     $modified = $now->format('Y-m-d H:i:s');
  398.  
  399.     $stmt->bindParam(':ID', $ID);
  400.     $stmt->bindParam(':fileName', $fileName);
  401.     $stmt->bindParam(':description', $description);
  402.     $stmt->bindParam(':url', $url);
  403.     $stmt->bindParam(':modified', $modified);
  404.     $result = $stmt->execute();
  405.     OnpubDatabase::verifyExecute($this->pdo, $result, $this->enableTransactions, $stmt->errorInfo());
  406.  
  407.     return $stmt->rowCount();
  408.   }
  409.  
  410.   /**
  411.    * @param int $ID ID of the image to delete.
  412.    * @return int 1 if the image was deleted, 0 if the image does not exist in the database.
  413.    */
  414.   public function delete($ID)
  415.   {
  416.     $stmt = $this->pdo->prepare("DELETE FROM OnpubImages WHERE ID = :ID");
  417.     OnpubDatabase::verifyPrepare($this->pdo, $stmt, FALSE);
  418.  
  419.     $stmt->bindParam(':ID', $ID);
  420.     $result = $stmt->execute();
  421.     OnpubDatabase::verifyExecute($this->pdo, $result, FALSE, $stmt->errorInfo());
  422.  
  423.     return $stmt->rowCount();
  424.   }
  425.  
  426.   public static function getThumbURL($phpThumbParams, $onpub_dir_phpthumb = '../api/phpThumb/')
  427.   {
  428.     global $PHPTHUMB_CONFIG;
  429.  
  430.     if ($PHPTHUMB_CONFIG['high_security_enabled']) {
  431.       return $onpub_dir_phpthumb . 'phpThumb.php?' . $phpThumbParams . '&hash=' . md5($phpThumbParams . $PHPTHUMB_CONFIG['high_security_password']);
  432.     }
  433.  
  434.     return $onpub_dir_phpthumb . 'phpThumb.php?' . $phpThumbParams;
  435.   }
  436. }
  437. ?>

Documentation generated on Fri, 08 Feb 2013 04:02:21 -0500 by phpDocumentor 1.4.4