Source for file OnpubWSMaps.php

Documentation is available at OnpubWSMaps.php

  1. <?php
  2.  
  3. /**
  4.  * Manage website-section maps in an Onpub database.
  5.  *
  6.  * This class contains the methods to manage the data contained in an
  7.  * {@link http://onpub.com/pdfs/onpub_schema.pdf OnpubWSMaps table}. An
  8.  * OnpubWSMaps table maps website IDs to section IDs. This allows Onpub to do
  9.  * the following without any duplication of website/section data:
  10.  * - Add a single section to multiple websites.
  11.  * - Add multiple sections to a single website.
  12.  * - Specify the order of sections in a website.
  13.  *
  14.  * @author {@link mailto:corey@onpub.com Corey H.M. Taylor}
  15.  * @copyright Onpub (TM). Copyright 2012, Onpub.com.
  16.  *  {@link http://onpub.com/}
  17.  * @license http://www.gnu.org/copyleft/gpl.html GNU General Public License
  18.  *  Version 2
  19.  * @package OnpubAPI
  20.  */
  21. class OnpubWSMaps
  22. {
  23.   private $pdo;
  24.   /**
  25.    * @var bool 
  26.    */
  27.   public $enableTransactions;
  28.  
  29.   /**
  30.    * Connect to an Onpub database.
  31.    *
  32.    * All the methods in this class which query the database use the database
  33.    * connection provided by the PDO object required by this constructor.
  34.    * Currently, Onpub only supports MySQL as a database for storing content.
  35.    * Therefore, when constructing the PDO object, only the
  36.    * {@link PHP_MANUAL#ref.pdo-mysql PDO_MYSQL} driver is supported
  37.    * as a PDO {@link PHP_MANUAL#ref.pdo-mysql.connection data source}.
  38.    *
  39.    * All the methods in this class require the
  40.    * {@link http://onpub.com/pdfs/onpub_schema.pdf Onpub schema}
  41.    * to be installed in the PDO-connected database. The {@link OnpubDatabase}
  42.    * class contains methods to manage the Onpub schema. The Onpub
  43.    * schema can also be installed by clicking the "Install the schema" link
  44.    * once logged in to the Onpub web interface. The schema generally only has
  45.    * to be installed once per database.
  46.    *
  47.    * @param PDO $pdo A {@link PHP_MANUAL#function.pdo-construct PHP Data Object}.
  48.    * @param bool $enableTransactions 
  49.    */
  50.   function __construct(PDO $pdo, $enableTransactions = TRUE)
  51.   {
  52.     $this->pdo = $pdo;
  53.     $this->enableTransactions = $enableTransactions;
  54.     $this->pdo->setAttribute(PDO::ATTR_EMULATE_PREPARES, TRUE);
  55.   }
  56.  
  57.   /**
  58.    * @param int $websiteID Delete the map(s) with websiteID.
  59.    * @param int $sectionID Delete the map(s) with sectionID.
  60.    * @return int The number of maps deleted, 0 if no maps were deleted.
  61.    */
  62.   public function delete($websiteID, $sectionID)
  63.   {
  64.     if ($websiteID && $sectionID) {
  65.       $stmt = $this->pdo->prepare("DELETE FROM OnpubWSMaps WHERE websiteID = :websiteID AND sectionID = :sectionID");
  66.       OnpubDatabase::verifyPrepare($this->pdo, $stmt, FALSE);
  67.       $stmt->bindParam(':websiteID', $websiteID);
  68.       $stmt->bindParam(':sectionID', $sectionID);
  69.     }
  70.  
  71.     if ($websiteID && !$sectionID) {
  72.       $stmt = $this->pdo->prepare("DELETE FROM OnpubWSMaps WHERE websiteID = :websiteID");
  73.       OnpubDatabase::verifyPrepare($this->pdo, $stmt, FALSE);
  74.       $stmt->bindParam(':websiteID', $websiteID);
  75.     }
  76.  
  77.     if (!$websiteID && $sectionID) {
  78.       $stmt = $this->pdo->prepare("DELETE FROM OnpubWSMaps WHERE sectionID = :sectionID");
  79.       OnpubDatabase::verifyPrepare($this->pdo, $stmt, FALSE);
  80.       $stmt->bindParam(':sectionID', $sectionID);
  81.     }
  82.  
  83.     $result = $stmt->execute();
  84.     OnpubDatabase::verifyExecute($this->pdo, $result, FALSE, $stmt->errorInfo());
  85.  
  86.     return $stmt->rowCount();
  87.   }
  88.  
  89.   /**
  90.    * @param OnpubWSMap $wsmap Map whose ID you want to get.
  91.    * @return int The ID of the map. NULL if the map does not exist in the database.
  92.    */
  93.   public function getID(OnpubWSMap $wsmap)
  94.   {
  95.     $stmt = $this->pdo->prepare("SELECT ID FROM OnpubWSMaps WHERE websiteID = :websiteID AND sectionID = :sectionID");
  96.     OnpubDatabase::verifyPrepare($this->pdo, $stmt, FALSE);
  97.  
  98.     $websiteID = $wsmap->websiteID;
  99.     $sectionID = $wsmap->sectionID;
  100.  
  101.     $stmt->bindParam(':websiteID', $websiteID);
  102.     $stmt->bindParam(':sectionID', $sectionID);
  103.     $result = $stmt->execute();
  104.     OnpubDatabase::verifyExecute($this->pdo, $result, FALSE, $stmt->errorInfo());
  105.  
  106.     if (($row = $stmt->fetch(PDO::FETCH_ASSOC))) {
  107.       return $row["ID"];
  108.     }
  109.  
  110.     return NULL;
  111.   }
  112.  
  113.   /**
  114.    * @param OnpubQueryOptions $queryOptions Database query options.
  115.    * @return array An array of {@link OnpubWSMap} objects.
  116.    */
  117.   public function select(OnpubQueryOptions $queryOptions = NULL, $websiteID = NULL, $sectionID = NULL)
  118.   {
  119.     if ($queryOptions === NULL)
  120.       $queryOptions = new OnpubQueryOptions();
  121.  
  122.     $query = $this->selectQuery($queryOptions, $websiteID, $sectionID);
  123.     $result = $this->pdo->query($query);
  124.     OnpubDatabase::verifyQuery($this->pdo, $result, FALSE);
  125.     $rows = $result->fetchAll(PDO::FETCH_ASSOC);
  126.  
  127.     $wsmaps = array();
  128.  
  129.     if ($rows) {
  130.       foreach ($rows as $row) {
  131.         $wsmap = new OnpubWSMap();
  132.  
  133.         $wsmap->ID = $row["ID"];
  134.         $wsmap->websiteID = $row["websiteID"];
  135.         $wsmap->sectionID = $row["sectionID"];
  136.         $wsmap->setCreated(new DateTime($row["created"]));
  137.         $wsmap->setModified(new DateTime($row["modified"]));
  138.  
  139.         $wsmaps[] = $wsmap;
  140.       }
  141.     }
  142.  
  143.     $result->closeCursor();
  144.     return $wsmaps;
  145.   }
  146.  
  147.   private function selectQuery(OnpubQueryOptions $queryOptions = NULL, $websiteID, $sectionID)
  148.   {
  149.     if ($queryOptions === NULL)
  150.       $queryOptions = new OnpubQueryOptions();
  151.  
  152.     $where = "";
  153.     $orderBy = "";
  154.     $limit = "";
  155.  
  156.     if ($queryOptions->dateLimit) {
  157.       $where = "WHERE created <= " . $this->pdo->quote($queryOptions->dateLimit->format('Y-m-d H:i:s'));
  158.  
  159.       if ($websiteID) {
  160.         $where .= " AND websiteID = $websiteID";
  161.       }
  162.       elseif ($sectionID) {
  163.         $where .= " AND sectionID = $sectionID";
  164.       }
  165.     }
  166.     else {
  167.       if ($websiteID) {
  168.         $where = "WHERE websiteID = $websiteID";
  169.       }
  170.       elseif ($sectionID) {
  171.         $where = "WHERE sectionID = $sectionID";
  172.       }
  173.     }
  174.  
  175.     if ($queryOptions->orderBy) {
  176.       $orderBy = "ORDER BY " . $queryOptions->orderBy;
  177.  
  178.       if ($queryOptions->order) {
  179.         $orderBy .= " " . $queryOptions->order;
  180.       }
  181.     }
  182.  
  183.     if ($queryOptions->getPage() && $queryOptions->rowLimit && $queryOptions->rowLimit > 0) {
  184.       $limit = "LIMIT " . (($queryOptions->getPage() - 1) * $queryOptions->rowLimit) .
  185.                "," . $queryOptions->rowLimit;
  186.     }
  187.     elseif ($queryOptions->rowLimit && $queryOptions->rowLimit > 0) {
  188.       $limit = "LIMIT 0," . $queryOptions->rowLimit;
  189.     }
  190.  
  191.     return "SELECT ID, websiteID, sectionID, created, modified FROM OnpubWSMaps $where $orderBy $limit";
  192.   }
  193.  
  194.   /**
  195.    * @param mixed $wsmaps A single {@link OnpubWSMap} object or an array of {@link OnpubWSMap} objects (to insert multiple maps at a time).
  196.    * @return mixed The ID(s) of the new map(s). An int will be returned if a single map was inserted. An array of ints will be returned if multiple maps were inserted.
  197.    * @throws PDOException if there's a database error.
  198.    */
  199.   public function insert($wsmaps)
  200.   {
  201.     $wsmapIDs = array();
  202.     $isArray = TRUE;
  203.  
  204.     if (!is_array($wsmaps)) {
  205.       $wsmaps = array ($wsmaps);
  206.       $isArray = FALSE;
  207.     }
  208.  
  209.     if ($this->enableTransactions) {
  210.       $status = $this->pdo->beginTransaction();
  211.       OnpubDatabase::verifyTransaction($this->pdo, $status);
  212.     }
  213.  
  214.     $stmt = $this->pdo->prepare("INSERT INTO OnpubWSMaps (ID, websiteID, sectionID, created, modified) VALUES (:ID, :websiteID, :sectionID, :created, :modified)");
  215.     OnpubDatabase::verifyPrepare($this->pdo, $stmt, $this->enableTransactions);
  216.  
  217.     foreach ($wsmaps as $wsmap) {
  218.       try {
  219.         $wsmapID = $this->getID($wsmap);
  220.       }
  221.       catch (PDOException $e) {
  222.         if ($this->enableTransactions)
  223.           $this->pdo->rollBack();
  224.  
  225.         throw $e;
  226.       }
  227.  
  228.       if ($wsmapID) {
  229.         $wsmapIDs[] = $wsmapID;
  230.         $wsmap->ID = $wsmapID;
  231.       }
  232.       else {
  233.         $ID = $wsmap->ID;
  234.         $websiteID = $wsmap->websiteID;
  235.         $sectionID = $wsmap->sectionID;
  236.         $created = $wsmap->getCreated()->format('Y-m-d H:i:s');
  237.         $modified = $wsmap->getModified()->format('Y-m-d H:i:s');
  238.  
  239.         $stmt->bindParam(':ID', $ID);
  240.         $stmt->bindParam(':websiteID', $websiteID);
  241.         $stmt->bindParam(':sectionID', $sectionID);
  242.         $stmt->bindParam(':created', $created);
  243.         $stmt->bindParam(':modified', $modified);
  244.         $result = $stmt->execute();
  245.         OnpubDatabase::verifyExecute($this->pdo, $result, $this->enableTransactions, $stmt->errorInfo());
  246.  
  247.         $wsmapIDs[] = $this->pdo->lastInsertId();
  248.         $wsmap->ID = $this->pdo->lastInsertId();
  249.       }
  250.     }
  251.  
  252.     if ($this->enableTransactions) {
  253.       $status = $this->pdo->commit();
  254.       OnpubDatabase::verifyTransaction($this->pdo, $status);
  255.     }
  256.  
  257.     if ($isArray) {
  258.       return $wsmapIDs;
  259.     }
  260.     else {
  261.       return end($wsmapIDs);
  262.     }
  263.   }
  264. }
  265. ?>

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