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.
  • Is abstract?: No
  • Is static?: No
  • Is final?: No
  • Return: bool

Parameters

Name Type Default Set Range Description
$path string required parameter N/A N/A Path (relative to the software base directory)
$bitmask integer 0 N/A N/A Bitmask of extra stuff to ignore (see IGNORE_* constants)

Return

  • Whether it should be ignored
  • Type: boolean
  • Set: N/A
  • Range: N/A