Function Hook_commandr_fs_extended_config__notification_lockdown->read_file

Definitions

sources/hooks/systems/commandr_fs_extended_config/notification_lockdown.php

  • Standard Commandr-fs file reading function for commandr_fs hooks.
  • Visibility: public
  • Is abstract?: No
  • Is static?: No
  • Is final?: No
  • Return: N/A

Parameters

Name Type Default Set Range Description
$meta_dir array required parameter N/A N/A The current meta-directory path
$meta_root_node string required parameter N/A N/A The root node of the current meta-directory
$file_name string required parameter N/A N/A The file name
$commandr_fs object required parameter N/A N/A A reference to the Commandr filesystem object

Return

  • The file contents (false: failure)
  • Type: ~string
  • Set: N/A
  • Range: N/A