Function __global->internalise_own_screen

Definitions

sources/templates_internalise_screen.php

  • Put the contents of a screen inside an AJAX updatable area. This is typically used when a page is being used to traverse a result-set that spans multiple screens.
  • Visibility: public
  • Is abstract?: No
  • Is static?: No
  • Is final?: No
  • Returns: object

Parameters

Name Type Passed by reference? Variadic? Default Set Range Description
$screen_content Tempcode No No required parameter N/A N/A The screen content
$refresh_time ?integer No No Null N/A N/A The time between refreshes (null: do not refresh)
$refresh_if_changed ?mixed No No Null N/A N/A Data. A refresh will only happen if an AJAX-check indicates this data has changed (null: no check)

Returns

  • The screen output, wrapped with some AJAX code
  • Type: Tempcode
  • Set: N/A
  • Range: N/A

Preview

Code (PHP)

/**
 * Put the contents of a screen inside an AJAX updatable area. This is typically used when a page is being used to traverse a result-set that spans multiple screens.
 *
 * @param  Tempcode $screen_content The screen content
 * @param  ?integer $refresh_time The time between refreshes (null: do not refresh)
 * @param  ?mixed $refresh_if_changed Data. A refresh will only happen if an AJAX-check indicates this data has changed (null: no check)
 * @return Tempcode The screen output, wrapped with some AJAX code
 */
function internalise_own_screen(object $screen_content, ?int $refresh_time = null, $refresh_if_changed = null) : object