Source for file OnpubSAMaps.php

Documentation is available at OnpubSAMaps.php

  1. <?php
  2.  
  3. /**
  4.  * Manage section-article 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 OnpubSAMaps table}. An
  8.  * OnpubSAMaps table maps section IDs to article IDs. This allows Onpub to do
  9.  * the following without any duplication of section/article data:
  10.  * - Add a single article to multiple sections.
  11.  * - Add multiple articles to a single section.
  12.  * - Specify the order of articles in a section.
  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 OnpubSAMaps
  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 $sectionID Delete the map(s) with sectionID.
  59.    * @param int $articleID Delete the map(s) with articleID.
  60.    * @return int The number of maps deleted, 0 if no maps were deleted.
  61.    */
  62.   public function delete($sectionID, $articleID)
  63.   {
  64.     if ($sectionID && $articleID) {
  65.       $stmt = $this->pdo->prepare("DELETE FROM OnpubSAMaps WHERE sectionID = :sectionID AND articleID = :articleID");
  66.       OnpubDatabase::verifyPrepare($this->pdo, $stmt, FALSE);
  67.       $stmt->bindParam(':sectionID', $sectionID);
  68.       $stmt->bindParam(':articleID', $articleID);
  69.     }
  70.  
  71.     if ($sectionID && !$articleID) {
  72.       $stmt = $this->pdo->prepare("DELETE FROM OnpubSAMaps WHERE sectionID = :sectionID");
  73.       OnpubDatabase::verifyPrepare($this->pdo, $stmt, FALSE);
  74.       $stmt->bindParam(':sectionID', $sectionID);
  75.     }
  76.  
  77.     if (!$sectionID && $articleID) {
  78.       $stmt = $this->pdo->prepare("DELETE FROM OnpubSAMaps WHERE articleID = :articleID");
  79.       OnpubDatabase::verifyPrepare($this->pdo, $stmt, FALSE);
  80.       $stmt->bindParam(':articleID', $articleID);
  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 OnpubSAMap $samap 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(OnpubSAMap $samap)
  94.   {
  95.     $stmt = $this->pdo->prepare("SELECT ID FROM OnpubSAMaps WHERE sectionID = :sectionID AND articleID = :articleID");
  96.     OnpubDatabase::verifyPrepare($this->pdo, $stmt, FALSE);
  97.  
  98.     $sectionID = $samap->sectionID;
  99.     $articleID = $samap->articleID;
  100.  
  101.     $stmt->bindParam(':sectionID', $sectionID);
  102.     $stmt->bindParam(':articleID', $articleID);
  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 OnpubSAMap} objects.
  116.    */
  117.   public function select(OnpubQueryOptions $queryOptions = NULL, $sectionID = NULL, $articleID = NULL)
  118.   {
  119.     if ($queryOptions === NULL)
  120.       $queryOptions = new OnpubQueryOptions();
  121.  
  122.     $query = $this->selectQuery($queryOptions, $sectionID, $articleID);
  123.     $result = $this->pdo->query($query);
  124.     OnpubDatabase::verifyQuery($this->pdo, $result, FALSE);
  125.     $rows = $result->fetchAll(PDO::FETCH_ASSOC);
  126.  
  127.     $samaps = array();
  128.  
  129.     if ($rows) {
  130.       foreach ($rows as $row) {
  131.         $samap = new OnpubSAMap();
  132.  
  133.         $samap->ID = $row["ID"];
  134.         $samap->sectionID = $row["sectionID"];
  135.         $samap->articleID = $row["articleID"];
  136.         $samap->setCreated(new DateTime($row["created"]));
  137.         $samap->setModified(new DateTime($row["modified"]));
  138.  
  139.         $samaps[] = $samap;
  140.       }
  141.     }
  142.  
  143.     $result->closeCursor();
  144.     return $samaps;
  145.   }
  146.  
  147.   private function selectQuery(OnpubQueryOptions $queryOptions = NULL, $sectionID = NULL, $articleID = NULL)
  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 <= "
  158.         . $this->pdo->quote($queryOptions->dateLimit->format('Y-m-d H:i:s'));
  159.  
  160.       if ($sectionID) {
  161.         $where .= " AND sectionID = $sectionID";
  162.       }
  163.       elseif ($articleID) {
  164.         $where .= " AND articleID = $articleID";
  165.       }
  166.     }
  167.     else {
  168.       if ($sectionID) {
  169.         $where = "WHERE sectionID = $sectionID";
  170.       }
  171.       elseif ($articleID) {
  172.         $where = "WHERE articleID = $articleID";
  173.       }
  174.     }
  175.  
  176.     if ($queryOptions->orderBy) {
  177.       $orderBy = "ORDER BY " . $queryOptions->orderBy;
  178.  
  179.       if ($queryOptions->order) {
  180.         $orderBy .= " " . $queryOptions->order;
  181.       }
  182.     }
  183.  
  184.     if ($queryOptions->getPage() && $queryOptions->rowLimit && $queryOptions->rowLimit > 0) {
  185.       $limit = "LIMIT "
  186.         . (($queryOptions->getPage() - 1) * $queryOptions->rowLimit) . ","
  187.         . $queryOptions->rowLimit;
  188.     }
  189.     elseif ($queryOptions->rowLimit && $queryOptions->rowLimit > 0) {
  190.       $limit = "LIMIT 0," . $queryOptions->rowLimit;
  191.     }
  192.  
  193.     return "SELECT ID, sectionID, articleID, created, modified FROM OnpubSAMaps $where $orderBy $limit";
  194.   }
  195.  
  196.   /**
  197.    * @param mixed $samaps A single {@link OnpubSAMap} object or an array of {@link OnpubSAMap} objects (to insert multiple maps at a time).
  198.    * @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.
  199.    * @throws PDOException if there's a database error.
  200.    */
  201.   public function insert($samaps)
  202.   {
  203.     $samapIDs = array();
  204.     $isArray = TRUE;
  205.  
  206.     if (!is_array($samaps)) {
  207.       $samaps = array ($samaps);
  208.       $isArray = FALSE;
  209.     }
  210.  
  211.     if ($this->enableTransactions) {
  212.       $status = $this->pdo->beginTransaction();
  213.       OnpubDatabase::verifyTransaction($this->pdo, $status);
  214.     }
  215.  
  216.     $stmt = $this->pdo->prepare("INSERT INTO OnpubSAMaps (ID, sectionID, articleID, created, modified) VALUES (:ID, :sectionID, :articleID, :created, :modified)");
  217.     OnpubDatabase::verifyPrepare($this->pdo, $stmt, $this->enableTransactions);
  218.  
  219.     foreach ($samaps as $samap) {
  220.       try {
  221.         $samapID = $this->getID($samap);
  222.       }
  223.       catch (PDOException $e) {
  224.         if ($this->enableTransactions)
  225.           $this->pdo->rollBack();
  226.  
  227.         throw $e;
  228.       }
  229.  
  230.       if ($samapID) {
  231.         $samapIDs[] = $samapID;
  232.         $samap->ID = $samapID;
  233.       }
  234.       else {
  235.         $ID = $samap->ID;
  236.         $sectionID = $samap->sectionID;
  237.         $articleID = $samap->articleID;
  238.         $created = $samap->getCreated()->format('Y-m-d H:i:s');
  239.         $modified = $samap->getModified()->format('Y-m-d H:i:s');
  240.  
  241.         $stmt->bindParam(':ID', $ID);
  242.         $stmt->bindParam(':sectionID', $sectionID);
  243.         $stmt->bindParam(':articleID', $articleID);
  244.         $stmt->bindParam(':created', $created);
  245.         $stmt->bindParam(':modified', $modified);
  246.         $result = $stmt->execute();
  247.         OnpubDatabase::verifyExecute($this->pdo, $result, $this->enableTransactions, $stmt->errorInfo());
  248.  
  249.         $samapIDs[] = $this->pdo->lastInsertId();
  250.         $samap->ID = $this->pdo->lastInsertId();
  251.       }
  252.     }
  253.  
  254.     if ($this->enableTransactions) {
  255.       $status = $this->pdo->commit();
  256.       OnpubDatabase::verifyTransaction($this->pdo, $status);
  257.     }
  258.  
  259.     if ($isArray) {
  260.       return $samapIDs;
  261.     }
  262.     else {
  263.       return end($samapIDs);
  264.     }
  265.   }
  266.  
  267.   /**
  268.    * @param OnpubSAMap $samap The map to be updated.
  269.    * @return int 1 if the map was updated. 0 if the map does not exist in the database.
  270.    */
  271.   public function update(OnpubSAMap $samap)
  272.   {
  273.     $stmt = $this->pdo->prepare("UPDATE OnpubSAMaps SET sectionID = :sectionID, articleID = :articleID, created = :created, modified = :modified WHERE ID = :ID");
  274.     OnpubDatabase::verifyPrepare($this->pdo, $stmt, $this->enableTransactions);
  275.  
  276.     $ID = $samap->ID;
  277.     $sectionID = $samap->sectionID;
  278.     $articleID = $samap->articleID;
  279.     $created = $samap->getCreated()->format('Y-m-d H:i:s');
  280.     $modified = $samap->getModified()->format('Y-m-d H:i:s');
  281.  
  282.     $stmt->bindParam(':ID', $ID);
  283.     $stmt->bindParam(':sectionID', $sectionID);
  284.     $stmt->bindParam(':articleID', $articleID);
  285.     $stmt->bindParam(':created', $created);
  286.     $stmt->bindParam(':modified', $modified);
  287.     $result = $stmt->execute();
  288.     OnpubDatabase::verifyExecute($this->pdo, $result, $this->enableTransactions, $stmt->errorInfo());
  289.  
  290.     return $stmt->rowCount();
  291.   }
  292. }
  293. ?>

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