Function Hook_commandr_fs_members->get_field_id_for

Definitions

sources/hooks/systems/commandr_fs/members.php

  • Get the field ID of a CPF from a filename.
  • Visibility: protected
  • Is abstract?: No
  • Is static?: No
  • Is final?: No
  • Returns: int

Parameters

Name Type Passed by reference? Variadic? Default Set Range Description
$file_name string No No required parameter N/A N/A Filename
$missing_ok boolean No No False N/A N/A If the field may be missing

Returns

  • CPF ID (null: none)
  • Type: ?AUTO_LINK
  • Set: N/A
  • Range: N/A

Preview

Code (PHP)

/**
 * Get the field ID of a CPF from a filename.
 *
 * @param  string $file_name Filename
 * @param  boolean $missing_ok If the field may be missing
 * @return ?AUTO_LINK CPF ID (null: none)
 */

protected function get_field_id_for(string $file_name, bool $missing_ok = false) : ?int