Refactor the Packet class

Author: carlbennett

src/controllers/Packet/Create.php

@@ -75,7 +75,7 @@ protected function handlePost(PacketCreateModel &$model)
 
     try
     {
-      $model->packet->setPacketName($name);
+      $model->packet->setName($name);
     }
     catch (OutOfBoundsException $e)
     {
@@ -85,7 +85,7 @@ protected function handlePost(PacketCreateModel &$model)
 
     try
     {
-      $model->packet->setPacketFormat($format);
+      $model->packet->setFormat($format);
     }
     catch (OutOfBoundsException $e)
     {
@@ -95,7 +95,7 @@ protected function handlePost(PacketCreateModel &$model)
 
     try
     {
-      $model->packet->setPacketRemarks($remarks);
+      $model->packet->setRemarks($remarks);
     }
     catch (OutOfBoundsException $e)
     {
@@ -117,7 +117,6 @@ protected function handlePost(PacketCreateModel &$model)
     $model->packet->setOption(Packet::OPTION_MARKDOWN, $markdown);
     $model->packet->setOption(Packet::OPTION_PUBLISHED, $published);
     $model->packet->setOption(Packet::OPTION_RESEARCH, $research);
-    $model->packet->incrementEdited();
 
     try
     {

src/controllers/Packet/Edit.php

@@ -60,9 +60,9 @@ public function &run(Router &$router, View &$view, array &$args) {
 
       $model->deprecated = $model->packet->isDeprecated();
       $model->id         = $model->packet->getPacketId(true);
-      $model->name       = $model->packet->getPacketName();
-      $model->format     = $model->packet->getPacketFormat();
-      $model->remarks    = $model->packet->getPacketRemarks(false);
+      $model->name       = $model->packet->getName();
+      $model->format     = $model->packet->getFormat();
+      $model->remarks    = $model->packet->getRemarks(false);
       $model->research   = $model->packet->isInResearch();
       $model->markdown   = $model->packet->isMarkdown();
       $model->published  = $model->packet->isPublished();
@@ -119,44 +119,38 @@ protected function handlePost(Router &$router, PacketEditModel &$model) {
 
     $user_id = $model->user->getId();
 
-    try {
-
+    try
+    {
+      $model->packet->setDeprecated($model->deprecated ? true : false);
+      $model->packet->setEditedCount($model->packet->getEditedCount() + 1);
+      $model->packet->setEditedDateTime(new DateTime('now'));
+      $model->packet->setFormat($model->format);
+      $model->packet->setInResearch($model->research ? true : false);
+      $model->packet->setMarkdown($model->markdown ? true : false);
+      $model->packet->setName($model->name);
       $model->packet->setPacketId($model->id);
-      $model->packet->setPacketName($model->name);
-      $model->packet->setPacketFormat($model->format);
-      $model->packet->setPacketRemarks($model->remarks);
-      $model->packet->setMarkdown($model->markdown);
-      $model->packet->setDeprecated($model->deprecated);
-      $model->packet->setInResearch($model->research);
-      $model->packet->setPublished($model->published);
-
-      $model->packet->setEditedCount(
-        $model->packet->getEditedCount() + 1
-      );
-      $model->packet->setEditedDateTime(
-        new DateTime( 'now', new DateTimeZone( 'Etc/UTC' ))
-      );
+      $model->packet->setPublished($model->published ? true : false);
+      $model->packet->setRemarks($model->remarks);
 
-      $success = $model->packet->update();
+      $model->packet->commit();
+      $success = true;
 
       // Used-by is stored in a different table than packet data so it is
       // updated separately.
       $model->packet->setUsedBy($used_by);
-
-    } catch (OutOfBoundsException $e) {
-
+    }
+    catch (OutOfBoundsException $e)
+    {
       // Some value was outside of a boundary
       Logger::logException($e);
       $success = false;
-
-    } catch (QueryException $e) {
-
+    }
+    catch (QueryException $e)
+    {
       // SQL error occurred. We can show a friendly message to the user while
       // also notifying this problem to staff.
       Logger::logException($e);
-
       $success = false;
-
     }
 
     if (!$success) {
@@ -173,10 +167,10 @@ protected function handlePost(Router &$router, PacketEditModel &$model) {
         'error'           => $model->error,
         'id'              => $model->packet->getId(),
         'packet_id'       => $model->packet->getPacketId(true),
-        'name'            => $model->packet->getPacketName(),
-        'options_bitmask' => $model->packet->getOptionsBitmask(),
-        'format'          => $model->packet->getPacketFormat(),
-        'remarks'         => $model->packet->getPacketRemarks(false),
+        'name'            => $model->packet->getName(),
+        'options_bitmask' => $model->packet->getOptions(),
+        'format'          => $model->packet->getFormat(),
+        'remarks'         => $model->packet->getRemarks(false),
         'used_by'         => $used_by
       ])
     );

src/controllers/Packet/Index.php

@@ -95,7 +95,7 @@ private static function &disambiguify( &$packets ) {
 
     foreach ( $packets as $pkt ) {
       // This removes duplicates by overwriting keys that already exist
-      $pkts[ $pkt->getPacketId() . $pkt->getPacketName() ] = $pkt;
+      $pkts[ $pkt->getLabel() ] = $pkt;
     }
 
     return $pkts;

src/controllers/User/View.php

@@ -127,8 +127,8 @@ protected function getUserInfo(UserViewModel &$model)
     if ($model->packets) {
       // Alphabetically sort the packets
       usort($model->packets, function($a, $b){
-        $a1 = $a->getPacketName();
-        $b1 = $b->getPacketName();
+        $a1 = $a->getName();
+        $b1 = $b->getName();
         if ($a1 == $b1) return 0;
         return ($a1 < $b1 ? -1 : 1);
       });