]> Kevux Git Server - koopa/commitdiff
Cleanup: move has_value() to c_base_return and document guaranteed functions provided...
authorKevin Day <thekevinday@gmail.com>
Tue, 14 Aug 2018 04:28:03 +0000 (23:28 -0500)
committerKevin Day <thekevinday@gmail.com>
Tue, 14 Aug 2018 04:28:03 +0000 (23:28 -0500)
common/base/classes/base_return.php
common/base/traits/base_return.php

index 201d07cd08c9e667b23fca27e75d5901e37dc374..17fcbcb4118e2fc43c739fc91e3b12f48b5bc0f0 100644 (file)
@@ -327,6 +327,16 @@ class c_base_return {
   public function get_value_exact() {
     return NULL;
   }
+
+  /**
+   * Determine if this class has a value assigned to it.
+   *
+   * @return bool
+   *   TRUE if a value is assigned, FALSE otherwise.
+   */
+  public function has_value() {
+    return FALSE;
+  }
 }
 
 /**
@@ -537,6 +547,16 @@ class c_base_return_value extends c_base_return {
 
     return $this->value;
   }
+
+  /**
+   * Determine if this class has a value assigned to it.
+   *
+   * @return bool
+   *   TRUE if a value is assigned, FALSE otherwise.
+   */
+  public function has_value() {
+    return !is_null($this->value);
+  }
 }
 
 /**
index 93406cc0ccceeeae3b1a592b29682b651f604b7d..332ff22468c79264b1daec8cba1dbd4870c7b41e 100644 (file)
@@ -13,6 +13,9 @@ namespace n_koopa;
  *
  * Most return classes will use this trait.
  *
+ * This does not define has_value(), get_value(), and get_value_exact().
+ * Those functions are always gauranteed by the class c_base_return.
+ *
  * @require class base_error
  */
 trait t_base_return_value {
@@ -41,16 +44,6 @@ trait t_base_return_value {
   }
 
   /**
-   * Determine if this class has a value assigned to it.
-   *
-   * @return bool
-   *   TRUE if a value is assigned, FALSE otherwise.
-   */
-  public function has_value() {
-    return !is_null($this->value);
-  }
-
-  /**
    * Creates a new return __class__ type.
    *
    * This is used to simplify the returning of a new class value.