Skip to content

Commit

Permalink
Fix docblocks of config file (#24)
Browse files Browse the repository at this point in the history
* Modify comment

---------

Co-authored-by: @SSEsmaeeli
Co-authored-by: @HPWebdeveloper  Hamed Panjeh <[email protected]>
  • Loading branch information
SSEsmaeeli and HPWebdeveloper authored Jun 26, 2024
1 parent 805c8f1 commit c910322
Showing 1 changed file with 19 additions and 10 deletions.
29 changes: 19 additions & 10 deletions config/pay-pocket.php
Original file line number Diff line number Diff line change
Expand Up @@ -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,
Expand Down

0 comments on commit c910322

Please sign in to comment.