Function Commandr_fs->search
Definitions
sources/commandr_fs.php
- Return a listing of all the files/directories found matching the specified pattern. Equivalent to Unix "find".
- Visibility: public
- Is abstract?: No
- Is static?: No
- Is final?: No
- Return: array
Parameters
| Name | Type | Default | Set | Range | Description |
|---|---|---|---|---|---|
| $pattern | string | required parameter | N/A | N/A | The search pattern (PRCE regexp or plain) |
| $regexp | boolean | False | N/A | N/A | Is the search pattern a regexp? |
| $recursive | boolean | False | N/A | N/A | Should the search be recursive? |
| $files | boolean | True | N/A | N/A | Should files be included in the results? |
| $directories | boolean | False | N/A | N/A | Should directories be included in the results? |
| $dir | ?array | Null | N/A | N/A | Directory (null: current directory is used) |
Return
- The search results
- Type: array
- Set: N/A
- Range: N/A