Merge pull request #61 from alissn/ReadFromEnv

Addition of `permit_empty` Configuration to README
spatie · Jan 20, 2024 · 0a1649b · 0a1649b
2 parents 53ba8bd + 8d28019
commit 0a1649b
Show file tree

Hide file tree

Showing 2 changed files with 13 additions and 2 deletions.
diff --git a/README.md b/README.md
@@ -80,6 +80,16 @@ return [
             'key' => env('CIPHERSWEET_KEY'),
         ],
     ],
+
+    /*
+     * The provided code snippet checks whether the $permitEmpty property is set to false
+     * for a given field. If it is not set to false, it throws an EmptyFieldException indicating
+     * that the field is not defined in the row. This ensures that the code enforces the requirement for
+     * the field to have a value and alerts the user if it is empty or undefined.
+     * Supported: "true", "false"
+     */
+    'permit_empty' => env('CIPHERSWEET_PERMIT_EMPTY', FALSE)
+
 ];
 ```
 

diff --git a/config/ciphersweet.php b/config/ciphersweet.php
@@ -42,12 +42,13 @@
         ],
         // 'custom' => CustomKeyProviderFactory::class,
     ],
-    /**
+
+    /*
      * The provided code snippet checks whether the $permitEmpty property is set to false
      * for a given field. If it is not set to false, it throws an EmptyFieldException indicating
      * that the field is not defined in the row. This ensures that the code enforces the requirement for
      * the field to have a value and alerts the user if it is empty or undefined.
      * Supported: "true", "false"
      */
-    'permit_empty' => false
+    'permit_empty' => env('CIPHERSWEET_PERMIT_EMPTY', FALSE)
 ];