Make more readable documentation of Arrays class

This commit is contained in:
Meritoo
2019-08-28 15:44:37 +02:00
parent e704dacabd
commit 10992570ad

View File

@@ -17,17 +17,19 @@ File: `src/Utilities/Arrays.php`
- `array $values` - The values to filter - `array $values` - The values to filter
##### Example 1 ##### Examples
1)
- values: `[]` (no values) - values: `[]` (no values)
- result: `[]` (an empty array) - result: `[]` (an empty array)
##### Example 2 2)
- values: `[null, ""]` (all empty values) - values: `[null, ""]` (all empty values)
- result: `[]` (an empty array) - result: `[]` (an empty array)
##### Example 3 3)
- values: `["test 1", "", 123, null, 0]` - values: `["test 1", "", 123, null, 0]`
- result: `["test 1", 123, 0]` - result: `["test 1", 123, 0]`
@@ -41,25 +43,27 @@ File: `src/Utilities/Arrays.php`
- `array $values` - The values to filter - `array $values` - The values to filter
- `[string $separator]` - (optional) Separator used to implode the values. Default: ", ". - `[string $separator]` - (optional) Separator used to implode the values. Default: ", ".
##### Example 1 ##### Examples
1)
- values: `[]` (no values) - values: `[]` (no values)
- separator: default or any other string - separator: default or any other string
- result: `""` (an empty string) - result: `""` (an empty string)
##### Example 2 2)
- values: `[null, ""]` (all empty values) - values: `[null, ""]` (all empty values)
- separator: default or any other string - separator: default or any other string
- result: `""` (an empty string) - result: `""` (an empty string)
##### Example 3 3)
- values: `["test 1", "", 123, null, 0]` - values: `["test 1", "", 123, null, 0]`
- separator: `", "` (default) - separator: `", "` (default)
- result: `"test 1, 123, 0"` - result: `"test 1, 123, 0"`
##### Example 4 4)
- values: `["test 1", "", 123, null, 0]` - values: `["test 1", "", 123, null, 0]`
- separator: `" | "` - separator: `" | "`