Function Hook_fields_list->inputted_to_sql_for_search

Definitions

sources/hooks/systems/fields/list.php

  • Get special SQL from POSTed parameters for this field.
  • 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
$i integer No No required parameter N/A N/A We're processing for the ith row
$table_alias string No No r N/A N/A Table alias for catalogue entry table

Returns

  • Tuple of SQL details (array: extra trans fields to search, array: extra plain fields to search, string: an extra table segment for a join, string: the name of the field to use as a title, if this is the title, extra WHERE clause stuff) (null: nothing special)
  • Type: ?array
  • Set: N/A
  • Range: N/A

Preview

Code (PHP)

/**
 * Get special SQL from POSTed parameters for this field.
 *
 * @param  array $field The field details
 * @param  integer $i We're processing for the ith row
 * @param  string $table_alias Table alias for catalogue entry table
 * @return ?array Tuple of SQL details (array: extra trans fields to search, array: extra plain fields to search, string: an extra table segment for a join, string: the name of the field to use as a title, if this is the title, extra WHERE clause stuff) (null: nothing special)
 */
public function inputted_to_sql_for_search(array $field, int $i, string $table_alias = 'r') : ?array