Function Database_Static_xml->_parsing_peek

Definitions

sources/database/xml.php

  • Reads the next token.
  • Visibility: protected
  • Is abstract?: No
  • Is static?: No
  • Is final?: No
  • Returns: string

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
$fail_ok boolean No No False N/A N/A Whether it can return null if we're out of output (otherwise fails)

Returns

  • Token read (null: error, read too far)
  • Type: ?string
  • Set: N/A
  • Range: N/A

Preview

Code (PHP)

/**
 * Reads the next token.
 *
 * @param  integer $at Our offset counter
 * @param  array $tokens Tokens
 * @param  string $query Query that was executed
 * @param  boolean $fail_ok Whether it can return null if we're out of output (otherwise fails)
 * @return ?string Token read (null: error, read too far)
 */
protected function _parsing_peek(int &$at, array $tokens, string $query, bool $fail_ok = false) : ?string