Merge pull request #90 from BNETDocs/feature/packet-edit-usedby

Add feature to edit products a packet is used with

Author: carlbennett

src/controllers/Packet/Edit.php

@@ -8,6 +8,7 @@
 use \BNETDocs\Libraries\Exceptions\PacketNotFoundException;
 use \BNETDocs\Libraries\Logger;
 use \BNETDocs\Libraries\Packet;
+use \BNETDocs\Libraries\Product;
 use \BNETDocs\Libraries\User;
 use \BNETDocs\Models\Packet\Edit as PacketEditModel;
 
@@ -36,8 +37,10 @@ public function &run(Router &$router, View &$view, array &$args) {
     $model->name       = null;
     $model->packet     = null;
     $model->packet_id  = (isset($data["id"]) ? $data["id"] : null);
+    $model->products   = Product::getAllProducts();
     $model->published  = null;
     $model->remarks    = null;
+    $model->used_by    = null;
     $model->user       = Authentication::$user;
 
     $model->acl_allowed = ($model->user && $model->user->getAcl(
@@ -59,6 +62,7 @@ public function &run(Router &$router, View &$view, array &$args) {
       $model->remarks   = $model->packet->getPacketRemarks(false);
       $model->markdown  = ($flags & Packet::OPTION_MARKDOWN);
       $model->published = ($flags & Packet::OPTION_PUBLISHED);
+      $model->used_by   = $this->getUsedBy($model->packet);
 
       if ($router->getRequestMethod() == "POST") {
         $this->handlePost($router, $model);
@@ -96,6 +100,7 @@ protected function handlePost(Router &$router, PacketEditModel &$model) {
     $content    = (isset($data["content"   ]) ? $data["content"   ] : null);
     $publish    = (isset($data["publish"   ]) ? $data["publish"   ] : null);
     $save       = (isset($data["save"      ]) ? $data["save"      ] : null);
+    $used_by    = (isset($data["used_by"   ]) ? $data["used_by"   ] : null);
 
     $model->id       = $id;
     $model->name     = $name;
@@ -138,6 +143,10 @@ protected function handlePost(Router &$router, PacketEditModel &$model) {
 
       $success = $model->packet->update();
 
+      // Used-by is stored in a different table than packet data so it is
+      // updated separately.
+      $model->packet->setUsedBy($used_by);
+
     } catch (QueryException $e) {
 
       // SQL error occurred. We can show a friendly message to the user while
@@ -166,8 +175,14 @@ protected function handlePost(Router &$router, PacketEditModel &$model) {
         "name"            => $model->packet->getPacketName(),
         "format"          => $model->packet->getPacketFormat(),
         "remarks"         => $model->packet->getPacketRemarks(false),
+        "used_by"         => $used_by
       ])
     );
   }
 
+  protected function getUsedBy(Packet &$packet) {
+    if (is_null($packet)) return null;
+    return Product::getProductsFromIds($packet->getUsedBy());
+  }
+
 }

src/controllers/Packet/View.php

@@ -49,12 +49,7 @@ public function &run(Router &$router, ViewLib &$view, array &$args) {
 
   protected function getUsedBy(Packet &$packet) {
     if (is_null($packet)) return null;
-    $used_by = $packet->getUsedBy();
-    $products = [];
-    foreach ($used_by as $bnet_product_id) {
-      $products[] = new Product($bnet_product_id);
-    }
-    return $products;
+    return Product::getProductsFromIds($packet->getUsedBy());
   }
 
 }

src/libraries/Packet.php

@@ -725,6 +725,49 @@ public function setPublished( $value ) {
       $this->options_bitmask &= ~self::OPTION_PUBLISHED;
     }
   }
+  
+  public function setUsedBy( $value ) {
+    if (!isset(Common::$database)) {
+      Common::$database = DatabaseDriver::getDatabaseObject();
+    }
+    try {
+      Common::$database->beginTransaction();
+      $stmt = Common::$database->prepare('
+        DELETE FROM `packet_used_by`
+        WHERE `id` = :id;
+      ');
+      $stmt->bindParam(':id', $this->id, PDO::PARAM_INT);
+      if (!$stmt->execute()) {
+        throw new QueryException('Cannot update packet used by');
+      }
+      if ($value !== null && count($value) > 0) {
+        $insert = [];
+        $placeholders = [];
+        foreach ($value as $v) {
+          array_push($insert, $this->id, (int)$v);
+          $placeholders[] = '(?, ?)';
+        }
+        $stmt = Common::$database->prepare('
+          INSERT INTO `packet_used_by`
+            (`id`, `bnet_product_id`)
+          VALUES
+            ' . implode(', ', $placeholders) . '; 
+        ');
+        if (!$stmt->execute($insert)) {
+          Common::$database->rollBack();
+          throw new QueryException('Cannot update packet used by');
+        }
+      }
+
+      Common::$database->commit();
+
+      $cache_key = 'bnetdocs-packetusedby-' . $this->id;
+      Common::$cache->set($cache_key, serialize($value), self::CACHE_TTL);
+    } catch (PDOException $e) {
+      Common::$database->rollBack();
+      throw new QueryException('Cannot update packet used by', $e);
+    }
+  }
 
   public function update() {
     if (!isset(Common::$database)) {

src/libraries/Product.php

@@ -65,7 +65,7 @@ public static function getAllProducts() {
           `bnls_product_id`,
           `label`,
           `sort`,
-          `version_byte
+          `version_byte`
         FROM `products`
         ORDER BY `sort` ASC;
       ");
@@ -90,6 +90,16 @@ public static function getAllProducts() {
     return null;
   }
 
+  public static function getProductsFromIds($product_ids) {
+    $products = [];
+    if ($product_ids !== null) {
+      foreach ($product_ids as $bnet_product_id) {
+        $products[] = new self($bnet_product_id);
+      }
+    }
+    return $products;
+  }
+
   public function getBnetProductId() {
     return $this->bnet_product_id;
   }

src/models/Packet/Edit.php

@@ -16,8 +16,10 @@ class Edit extends Model {
   public $name;
   public $packet;
   public $packet_id;
+  public $products;
   public $published;
   public $remarks;
+  public $used_by;
   public $user;
 
 }

src/templates/Packet/Edit.phtml

@@ -82,6 +82,31 @@ require('./header.inc.phtml');
                 filter_var( $this->getContext()->format, FILTER_SANITIZE_FULL_SPECIAL_CHARS );
               ?></textarea>
           </section>
+          <section>
+            <label for="usedby">Used by:</label>
+            <table>
+              <thead></thead><tbody>
+<?php function add_product_checkbox( $id, $name, $checked ) { ?>
+                  <td><input type="checkbox" id="used_by_<?php echo $id; ?>" name="used_by[]" value="<?php echo $id; ?>"<?php if ( $checked ) { ?> checked="checked"<?php } ?>/><label for="used_by_<?php echo $id; ?>"><?php echo $name; ?></label></td>
+<?php }
+$product_ubound = count( $this->getContext()->products );
+for ( $product_i = 0; $product_i < $product_ubound; ++$product_i ) { ?>
+                <tr>
+<?php
+  $p = $this->getContext()->products[ $product_i ];
+  $checked = in_array( $p, $this->getContext()->used_by );
+  add_product_checkbox( $p->getBnetProductId(), $p->getLabel(), $checked );
+  if ( $product_i + 1 < $product_ubound ) {
+    $p = $this->getContext()->products[ ++$product_i ];
+    $checked = in_array( $p, $this->getContext()->used_by );
+    add_product_checkbox( $p->getBnetProductId(), $p->getLabel(), $checked );
+  }
+?>
+                </tr>
+<?php } ?>
+              </tbody>
+            </table>
+          </section>
           <section>
             <label for="remarks">Remarks:</label>
             <span style="float:right;">