Function __global->_helper_get_table_key_fields

Definitions

sources/database_helper.php

  • Get the key tables for a table.
  • Visibility: public
  • Is abstract?: No
  • Is static?: No
  • Is final?: No
  • Returns: array

Parameters

Name Type Passed by reference? Variadic? Default Set Range Description
$table_name ID_TEXT No No required parameter N/A N/A Table name
$db_types ?array No No Null N/A N/A Database types for whole table from meta registry (null: lookup as needed)

Returns

  • List of key fields
  • Type: array
  • Set: N/A
  • Range: N/A

Preview

Code (PHP)

/**
 * Get the key tables for a table.
 *
 * @param  ID_TEXT $table_name Table name
 * @param  ?array $db_types Database types for whole table from meta registry (null: lookup as needed)
 * @return array List of key fields
 */
function _helper_get_table_key_fields(string $table_name, ?array $db_types = null) : array