Function Standard_crud_module->pre_run

Definitions

sources/crud_module.php

  • Module pre-run function. Allows us to know metadata for <head> before we start streaming output.
  • Visibility: public
  • Is abstract?: No
  • Is static?: No
  • Is final?: No
  • Returns: object

Parameters

Name Type Passed by reference? Variadic? Default Set Range Description
$top_level boolean No No True N/A N/A Whether this is running at the top level, prior to having sub-objects called
$type ?ID_TEXT No No Null N/A N/A The screen type to consider for metadata purposes (null: read from environment)

Returns

  • Tempcode indicating some kind of exceptional output (null: none)
  • Type: ?Tempcode
  • Set: N/A
  • Range: N/A

Preview

Code (PHP)

/**
 * Module pre-run function. Allows us to know metadata for <head> before we start streaming output.
 *
 * @param  boolean $top_level Whether this is running at the top level, prior to having sub-objects called
 * @param  ?ID_TEXT $type The screen type to consider for metadata purposes (null: read from environment)
 * @return ?Tempcode Tempcode indicating some kind of exceptional output (null: none)
 */
public function pre_run(bool $top_level = true, ?string $type = null) : ?object