From c910322aa8a441dcc70e1224fb3594676f05827f Mon Sep 17 00:00:00 2001 From: Sajjad Esmaeeli Date: Wed, 26 Jun 2024 04:04:41 +0200 Subject: [PATCH] Fix docblocks of config file (#24) * Modify comment --------- Co-authored-by: @SSEsmaeeli Co-authored-by: @HPWebdeveloper Hamed Panjeh --- config/pay-pocket.php | 29 +++++++++++++++++++---------- 1 file changed, 19 insertions(+), 10 deletions(-) diff --git a/config/pay-pocket.php b/config/pay-pocket.php index 9dd0dbe..bc74b57 100644 --- a/config/pay-pocket.php +++ b/config/pay-pocket.php @@ -2,17 +2,26 @@ // config for HPWebdeveloper/LaravelPayPocket -/** - * The 'log_reference_generator' should be a numeric array with three elements: - * - The first element should be the fully qualified name of a class that contains static methods. - * This includes the namespace of the class. - * - The second element should be the name of a static method available in the specified class. - * - The third element should be an array of optional parameters to pass to the static method. - * For example, the default generator is configured as follows: - * [\Illuminate\Support\Str::class, 'random', [12]], which uses the 'random' static method - * from the \Illuminate\Support\Str class with 12 as a parameter. - */ return [ + + /* + |-------------------------------------------------------------------------- + | Reference Generator Configuration + |-------------------------------------------------------------------------- + | + | This configuration allows you to customize the generation of log reference strings + | within the LaravelPayPocket package. + | + | - log_reference_length: The length of the generated reference string. + | - log_reference_prefix: The prefix for the generated reference string. + | - log_reference_generator_class: The fully qualified name of the class containing static methods for generation. + | - log_reference_generator_method: The name of the static method available in the generator class. + | + | This is how it works by default in the code: + | Illuminate\Support\Str::random(12) + | + */ + 'log_reference_length' => 12, 'log_reference_prefix' => '', 'log_reference_generator_class' => Illuminate\Support\Str::class,