Merge pull request #305 from montymxb/push-status-status

Added methods to ParsePushStatus for checking push status

Author: Arthur Cinader

README.md

@@ -284,21 +284,25 @@ if(ParsePush::hasStatus($response)) {
 
     // Retrieve PushStatus object
     $pushStatus = ParsePush::getStatus($response);
-    
-    // get push status string
-    $status = $pushStatus->getPushStatus();
-    
-    if($status == "succeeded") {
-        // handle a successful push request
-        
-    } else if($status == "running") {
+
+    // check push status
+    if($pushStatus->isPending()) {
+        // handle a pending push request
+
+    } else if($pushStatus->isRunning()) {
         // handle a running push request
-        
-    } else if($status == "failed") {
-        // push request did not succeed
-        
+
+    } else if($pushStatus->hasSucceeded()) {
+        // handle a successful push request
+
+    } else if($pushStatus->hasFailed()) {
+        // handle a failed request
+
     }
 
+    // ...or get the push status string to check yourself
+    $status = $pushStatus->getPushStatus();
+    
     // get # pushes sent
     $sent = $pushStatus->getPushesSent();
 

src/Parse/ParsePushStatus.php

@@ -11,6 +11,17 @@ class ParsePushStatus extends ParseObject
 {
     public static $parseClassName = '_PushStatus';
 
+    // possible push status values from parse server
+    const STATUS_SCHEDULED  = 'scheduled';
+    const STATUS_PENDING    = 'pending';
+    const STATUS_RUNNING    = 'running';
+    const STATUS_SUCCEEDED  = 'succeeded';
+    const STATUS_FAILED     = 'failed';
+
+    /**
+     * 'scheduled', 'pending', etc. Add constants and 'isPending' and such for better status checking
+     */
+
     /**
      * Returns a push status object or null from an id
      *
@@ -98,6 +109,61 @@ public function getPushStatus()
 
     }
 
+    /**
+     * Indicates whether this push is scheduled
+     *
+     * @return bool
+     */
+    public function isScheduled()
+    {
+        return $this->getPushStatus() === self::STATUS_SCHEDULED;
+
+    }
+
+    /**
+     * Indicates whether this push is pending
+     *
+     * @return bool
+     */
+    public function isPending()
+    {
+        return $this->getPushStatus() === self::STATUS_PENDING;
+
+    }
+
+    /**
+     * Indicates whether this push is running
+     *
+     * @return bool
+     */
+    public function isRunning()
+    {
+        return $this->getPushStatus() === self::STATUS_RUNNING;
+
+    }
+
+    /**
+     * Indicates whether this push has succeeded
+     *
+     * @return bool
+     */
+    public function hasSucceeded()
+    {
+        return $this->getPushStatus() === self::STATUS_SUCCEEDED;
+
+    }
+
+    /**
+     * Indicates whether this push has failed
+     *
+     * @return bool
+     */
+    public function hasFailed()
+    {
+        return $this->getPushStatus() === self::STATUS_FAILED;
+
+    }
+
     /**
      * Gets the number of pushes sent
      *

tests/Parse/ParsePushTest.php

@@ -123,10 +123,10 @@ public function testPushDates()
     {
         ParsePush::send(
             [
-            'data'            => ['alert' => 'iPhone 5 is out!'],
-            'push_time'       => new \DateTime(),
-            'expiration_time' => new \DateTime(),
-            'channels'        => [],
+                'data'            => ['alert' => 'iPhone 5 is out!'],
+                'push_time'       => new \DateTime(),
+                'expiration_time' => new \DateTime(),
+                'channels'        => [],
             ]
         , true);
     }
@@ -215,10 +215,18 @@ public function testGettingPushStatus()
         $this->assertEquals("rest", $pushStatus->getPushSource(),
             'Source was not rest');
 
+        // verify not scheduled
+        $this->assertFalse($pushStatus->isScheduled());
+
+        // verify not pending
+        $this->assertFalse($pushStatus->isPending());
+
         // verify 'running'
-        $this->assertEquals("running", $pushStatus->getPushStatus(),
+        $this->assertTrue($pushStatus->isRunning(),
             'Push did not succeed');
 
+
+
         // verify # sent & failed
         $this->assertEquals(0, $pushStatus->getPushesSent(),
             'More than 0 pushes sent');
@@ -228,6 +236,10 @@ public function testGettingPushStatus()
         $this->assertNotNull($pushStatus->getPushHash(),
             'Hash not present');
 
+        // verify we have neither failed or succeeded
+        $this->assertFalse($pushStatus->hasFailed());
+        $this->assertFalse($pushStatus->hasSucceeded());
+
     }
 
     /**