Function Virtual_shell->_find_script_file

Definitions

sources/commandr.php

  • Find a script file.
  • Visibility: protected
  • Is abstract?: No
  • Is static?: No
  • Is final?: No

Parameters

Name Type Passed by reference? Variadic? Default Set Range Description
$script_name string No No required parameter N/A N/A Script name
$dir ?string No No Null N/A N/A Directory (null: Commandr module data dir)

Returns

  • Path or failure (false: failure)
  • Type: ~string
  • Set: N/A
  • Range: N/A

Preview

Code (PHP)

/**
 * Find a script file.
 *
 * @param  string $script_name Script name
 * @param  ?string $dir Directory (null: Commandr module data dir)
 * @return ~string Path or failure (false: failure)
 */
protected function _find_script_file(string $script_name, ?string $dir = null)