Added ScopedCallback functions for early execution or cancellation.
authorAaron Schulz <aschulz@wikimedia.org>
Thu, 14 Mar 2013 20:23:32 +0000 (13:23 -0700)
committerAaron Schulz <aschulz@wikimedia.org>
Thu, 14 Mar 2013 20:23:32 +0000 (13:23 -0700)
Change-Id: I6493cfa81d778c47aa7283dc3196989384235f0a

includes/ScopedCallback.php

index 1d5b26b..8ecd874 100644 (file)
@@ -22,6 +22,8 @@
 
 /**
  * Class for asserting that a callback happens when an dummy object leaves scope
+ *
+ * @since 1.21
  */
 class ScopedCallback {
        /** @var Closure */
@@ -34,7 +36,34 @@ class ScopedCallback {
                $this->callback = $callback;
        }
 
+       /**
+        * Trigger a scoped callback and destroy it.
+        * This is the same is just setting it to null.
+        *
+        * @param ScopedCallback $sc
+        */
+       public static function consume( ScopedCallback &$sc = null ) {
+               $sc = null;
+       }
+
+       /**
+        * Destroy a scoped callback without triggering it
+        *
+        * @param ScopedCallback $sc
+        */
+       public static function cancel( ScopedCallback &$sc = null ) {
+               if ( $sc ) {
+                       $sc->callback = null;
+               }
+               $sc = null;
+       }
+
+       /**
+        * Trigger the callback when this leaves scope
+        */
        function __destruct() {
-               call_user_func( $this->callback );
+               if ( $this->callback !== null ) {
+                       call_user_func( $this->callback );
+               }
        }
 }