Function __global->should_ignore_file
Definitions
sources/files.php
- Find whether a file/directory is known to be something that should/could be there but isn't a software distribution file, or for some other reason should be ignored.NB: Don't forget to edit untouchable directories and files in global.php where necessary.
- Visibility: public
- Is abstract?: No
- Is static?: No
- Is final?: No
- Returns: bool
Parameters
| Name | Type | Passed by reference? | Variadic? | Default | Set | Range | Description |
|---|---|---|---|---|---|---|---|
| $path | string | No | No | required parameter | N/A | N/A | Path (relative to the software base directory) |
| $bitmask | integer | No | No | 0 | N/A | N/A | Bitmask of extra stuff to ignore (see IGNORE_* constants) |
Returns
- Whether it should be ignored
- Type: boolean
- Set: N/A
- Range: N/A
Preview
Code (PHP)
/**
* Find whether a file/directory is known to be something that should/could be there but isn't a software distribution file, or for some other reason should be ignored.NB: Don't forget to edit untouchable directories and files in global.php where necessary.
*
* @param string $path Path (relative to the software base directory)
* @param integer $bitmask Bitmask of extra stuff to ignore (see IGNORE_* constants)
* @return boolean Whether it should be ignored
*/
function should_ignore_file(string $path, int $bitmask = 0) : bool
* Find whether a file/directory is known to be something that should/could be there but isn't a software distribution file, or for some other reason should be ignored.NB: Don't forget to edit untouchable directories and files in global.php where necessary.
*
* @param string $path Path (relative to the software base directory)
* @param integer $bitmask Bitmask of extra stuff to ignore (see IGNORE_* constants)
* @return boolean Whether it should be ignored
*/
function should_ignore_file(string $path, int $bitmask = 0) : bool