Function __global->comcode_parse_error_exit

Definitions

sources/comcode_renderer.php

  • Show a Comcode parser error.
  • Visibility: public
  • Is abstract?: No
  • Is static?: No
  • Is final?: No
  • Returns: object

Parameters

Name Type Passed by reference? Variadic? Default Set Range Description
$preparse_mode boolean No No required parameter N/A N/A Whether this is being pre-parsed, to pick up errors before row insertion
$_message array No No required parameter N/A N/A Error message details to pass to do_lang, or if the first in the list is null, use directly
$pos integer No No required parameter N/A N/A The position during parsing that the error occurred at
$comcode LONG_TEXT No No required parameter N/A N/A The Comcode the parser error occurred in
$check_only boolean No No False N/A N/A Whether to only check the Comcode

Returns

  • An error message to put in the output stream (shown in certain situations, where in other situations we bomb out)
  • Type: Tempcode
  • Set: N/A
  • Range: N/A

Preview

Code (PHP)

/**
 * Show a Comcode parser error.
 *
 * @param  boolean $preparse_mode Whether this is being pre-parsed, to pick up errors before row insertion
 * @param  array $_message Error message details to pass to do_lang, or if the first in the list is null, use directly
 * @param  integer $pos The position during parsing that the error occurred at
 * @param  LONG_TEXT $comcode The Comcode the parser error occurred in
 * @param  boolean $check_only Whether to only check the Comcode
 * @return Tempcode An error message to put in the output stream (shown in certain situations, where in other situations we bomb out)
 */
function comcode_parse_error_exit(bool $preparse_mode, array $_message, int $pos, string $comcode, bool $check_only = false) : object