Function Hook_fields_short_trans->get_field_value_row_bits

Definitions

sources/hooks/systems/fields/short_trans.php

  • Get some info bits relating to our field type, that helps us look it up / set defaults.
  • Visibility: public
  • Is abstract?: No
  • Is static?: No
  • Is final?: No
  • Returns: array

Parameters

Name Type Passed by reference? Variadic? Default Set Range Description
$field ?array No No required parameter N/A N/A The field details (null: new field)
$required ?boolean No No Null N/A N/A Whether a default value cannot be blank (null: don't "lock in" a new default value)
$default ?string No No Null N/A N/A The given default value as a string (null: don't "lock in" a new default value)
$db ?object No No Null N/A N/A Database connector (null: main site database)

Returns

  • Tuple of details (row-type,default-value-to-use,db row-type)
  • Type: array
  • Set: N/A
  • Range: N/A

Preview

Code (PHP)

/**
 * Get some info bits relating to our field type, that helps us look it up / set defaults.
 *
 * @param  ?array $field The field details (null: new field)
 * @param  ?boolean $required Whether a default value cannot be blank (null: don't "lock in" a new default value)
 * @param  ?string $default The given default value as a string (null: don't "lock in" a new default value)
 * @param  ?object $db Database connector (null: main site database)
 * @return array Tuple of details (row-type,default-value-to-use,db row-type)
 */
public function get_field_value_row_bits(?array $field, ?bool $required = null, ?string $default = null, ?object $db = null) : array