Update docblock for pregReplace.

zero-to-prod · Nov 7, 2024 · c5873e2 · c5873e2
1 parent a613054
commit c5873e2
Showing 1 changed file with 13 additions and 0 deletions.
diff --git a/src/DataModelHelper.php b/src/DataModelHelper.php
@@ -84,6 +84,19 @@ public static function mapOf(mixed $value, array $context, ?ReflectionAttribute
         return $mapper($value, $args[0]['level'] ?? 1);
     }
 
+    /**
+     * Perform a regular expression search and replace.
+     *
+     * NOTE: If property allows null, null will be returned, else an empty string.
+     *
+     * ```
+     *  #[Describe([
+     *      'cast' => [self::class, 'pregReplace'],
+     *      'pattern' => '/s/', // any regular expression
+     *      'replacement' => '' // default
+     *  ])]
+     * ```
+     */
     public static function pregReplace(mixed $value, array $context, ?ReflectionAttribute $Attribute, ReflectionProperty $Property): array|string|null
     {
         if (!$value) {