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,20 +17,22 @@ File: `src/Utilities/Arrays.php`
- `array $values` - The values to filter - `array $values` - The values to filter
##### Example 1 ##### Examples
- values: `[]` (no values) 1)
- result: `[]` (an empty array)
##### Example 2 - values: `[]` (no values)
- result: `[]` (an empty array)
- values: `[null, ""]` (all empty values) 2)
- result: `[]` (an empty array)
##### Example 3 - values: `[null, ""]` (all empty values)
- result: `[]` (an empty array)
- values: `["test 1", "", 123, null, 0]` 3)
- result: `["test 1", 123, 0]`
- values: `["test 1", "", 123, null, 0]`
- result: `["test 1", 123, 0]`
### getNonEmptyValuesAsString(array $values, $separator = ', ') ### getNonEmptyValuesAsString(array $values, $separator = ', ')
@@ -41,29 +43,31 @@ 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
- values: `[]` (no values) 1)
- separator: default or any other string
- result: `""` (an empty string)
##### Example 2 - values: `[]` (no values)
- separator: default or any other string
- result: `""` (an empty string)
- values: `[null, ""]` (all empty values) 2)
- separator: default or any other string
- result: `""` (an empty string)
##### Example 3 - values: `[null, ""]` (all empty values)
- separator: default or any other string
- result: `""` (an empty string)
- values: `["test 1", "", 123, null, 0]` 3)
- separator: `", "` (default)
- result: `"test 1, 123, 0"`
##### Example 4 - values: `["test 1", "", 123, null, 0]`
- separator: `", "` (default)
- result: `"test 1, 123, 0"`
- values: `["test 1", "", 123, null, 0]` 4)
- separator: `" | "`
- result: `"test 1 | 123 | 0"` - values: `["test 1", "", 123, null, 0]`
- separator: `" | "`
- result: `"test 1 | 123 | 0"`
# More # More