feat: Add a noop() function (#195)

phanan · lstrojny · commit 0f7d89c04685 · 2019-12-14T00:36:25.000+01:00
diff --git a/composer.json b/composer.json
@@ -77,6 +77,7 @@
             "src/Functional/Memoize.php",
             "src/Functional/Minimum.php",
             "src/Functional/None.php",
+            "src/Functional/Noop.php",
             "src/Functional/Not.php",
             "src/Functional/OmitKeys.php",
             "src/Functional/PartialAny.php",
diff --git a/docs/functional-php.md b/docs/functional-php.md
@@ -67,6 +67,7 @@
   - [id()](#id)
   - [tap()](#tap)
   - [repeat()](#repeat)
+  - [noop()](#noop)
 
 <!-- END doctoc generated TOC please keep comment here to allow auto update -->
 
@@ -1063,7 +1064,6 @@ $one = const_function(1);
 $one(); // -> 1
 ```
 
-
 ## id()
 Proxy function that does nothing except returning its first argument.
 
@@ -1097,4 +1097,10 @@ use function Functional\repeat;
 repeat(function () {
     echo 'foo';
 })(3); // 'foofoofoo'
-``` 
+``` 
+
+## noop()
+
+A no-operation function, i.e. a function that does nothing.
+
+``void Functional\noop()``
diff --git a/src/Functional/Functional.php b/src/Functional/Functional.php
@@ -272,6 +272,11 @@ final class Functional
      */
     const none = '\Functional\none';
 
+    /**
+     * @see \Functional\noop
+     */
+    const noop = '\Functional\noop';
+
     /**
      * @see \Functional\not
      */
diff --git a/src/Functional/Noop.php b/src/Functional/Noop.php
@@ -0,0 +1,30 @@
+<?php
+/**
+ * Copyright (C) 2011-2017 by Lars Strojny <lstrojny@php.net>
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to deal
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in
+ * all copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+ * THE SOFTWARE.
+ */
+namespace Functional;
+
+/**
+ * A no-operation function.
+ */
+function noop()
+{
+}
