Function DatabaseConnector->singular_join

Definitions

sources/database.php

  • Generate a JOIN clause that will only bind to a single row.
  • Visibility: public
  • Is abstract?: No
  • Is static?: No
  • Is final?: No
  • Return: string

Parameters

Name Type Default Set Range Description
$table string required parameter N/A N/A Table to join to
$alias string required parameter N/A N/A Alias for the table
$join_clause string required parameter N/A N/A The regular join clause
$threshold_field string id N/A N/A The field we will use to choose which row to match
$threshold_func string MIN N/A N/A The SQL function to apply to $threshold_field
$join_type string LEFT JOIN N/A N/A The join type
$prefer_index ?string Null N/A N/A Index to force (null: none)

Return

  • JOIN clause
  • Type: string
  • Set: N/A
  • Range: N/A