Function Standard_crud_module->choose_catalogue

Definitions

sources/crud_module.php

  • Get a form to choose a catalogue out of all the available ones.
  • Visibility: public
  • Is abstract?: No
  • Is static?: No
  • Is final?: No
  • Returns: object

Parameters

Name Type Passed by reference? Variadic? Default Set Range Description
$title Tempcode No No required parameter N/A N/A The get_screen_title converted title for this page
$icon string No No buttons/proceed N/A N/A The icon to use

Returns

  • The Tempcode for the catalogue chooser (null: already chosen)
  • Type: ?Tempcode
  • Set: N/A
  • Range: N/A

Preview

Code (PHP)

/**
 * Get a form to choose a catalogue out of all the available ones.
 *
 * @param  Tempcode $title The get_screen_title converted title for this page
 * @param  string $icon The icon to use
 * @return ?Tempcode The Tempcode for the catalogue chooser (null: already chosen)
 */
public function choose_catalogue(object $title, string $icon = 'buttons/proceed') : ?object