Function Database_Static_xml->_read_join

Definitions

sources/database/xml.php

  • Read in a table specifier clause for a WHERE query.
  • Visibility: protected
  • Is abstract?: No
  • Is static?: No
  • Is final?: No
  • Returns: array

Parameters

Name Type Passed by reference? Variadic? Default Set Range Description
&$at integer Yes No required parameter N/A N/A Our offset counter
$tokens array No No required parameter N/A N/A Tokens
$query string No No required parameter N/A N/A Query that was executed
$db array No No required parameter N/A N/A Database connection
$fail_ok boolean No No required parameter 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)
&$closing_parentheses_needed integer Yes No required parameter N/A N/A How many closing parentheses we expect

Returns

  • Join condition (null: no join here)
  • Type: ?array
  • Set: N/A
  • Range: N/A

Preview

Code (PHP)

/**
 * Read in a table specifier clause for a WHERE query.
 *
 * @param  integer $at Our offset counter
 * @param  array $tokens Tokens
 * @param  string $query Query that was executed
 * @param  array $db Database connection
 * @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)
 * @param  integer $closing_parentheses_needed How many closing parentheses we expect
 * @return ?array Join condition (null: no join here)
 */
protected function _read_join(int &$at, array $tokens, string $query, array $db, bool $fail_ok, int &$closing_parentheses_needed) : ?array