Function Database_Static_xml->_execute_join

Definitions

sources/database/xml.php

  • Get results from a JOIN.
  • Visibility: protected
  • Is abstract?: No
  • Is static?: No
  • Is final?: No
  • Returns: array

Parameters

Name Type Passed by reference? Variadic? Default Set Range Description
$db array No No required parameter N/A N/A Database connection
$joined_as_prior string No No required parameter N/A N/A The renaming of our table, so we can recognise it in the join condition
$join array No No required parameter N/A N/A Join op-tree
$query string No No required parameter N/A N/A Query that was executed
$records array No No required parameter N/A N/A Records so far
$schema array No No required parameter N/A N/A Schema so far
$where_expr array No No required parameter N/A N/A Expression filtering results (used for optimisation, seeing if we can get a quick key match)
$bindings array No No required parameter N/A N/A Bindings available in the execution scope
$fail_ok boolean No No False N/A N/A Whether to not output an error on some kind of run-time failure (parse errors and clear programming errors are always fatal)

Returns

  • A pair: an array of results, an array of the schema for what has been joined (null: error)
  • Type: ?array
  • Set: N/A
  • Range: N/A

Preview

Code (PHP)

/**
 * Get results from a JOIN.
 *
 * @param  array $db Database connection
 * @param  string $joined_as_prior The renaming of our table, so we can recognise it in the join condition
 * @param  array $join Join op-tree
 * @param  string $query Query that was executed
 * @param  array $records Records so far
 * @param  array $schema Schema so far
 * @param  array $where_expr Expression filtering results (used for optimisation, seeing if we can get a quick key match)
 * @param  array $bindings Bindings available in the execution scope
 * @param  boolean $fail_ok Whether to not output an error on some kind of run-time failure (parse errors and clear programming errors are always fatal)
 * @return ?array A pair: an array of results, an array of the schema for what has been joined (null: error)
 */
protected function _execute_join(array $db, string $joined_as_prior, array $join, string $query, array $records, array $schema, array $where_expr, array $bindings, bool $fail_ok = false) : ?array