Function Module_admin_zones->get_form_fields

Definitions

adminzone/pages/modules/admin_zones.php

  • Get Tempcode for a zone adding/editing form.
  • Visibility: public
  • Is abstract?: No
  • Is static?: No
  • Is final?: No
  • Returns: array

Parameters

Name Type Passed by reference? Variadic? Default Set Range Description
$in_zone_editor boolean No No False N/A N/A Whether the zone editor will be used
$title SHORT_TEXT No No Blank (empty string) N/A N/A The zone title
$default_page ID_TEXT No No home N/A N/A The zones default page
$header_text SHORT_TEXT No No Blank (empty string) N/A N/A The header text
$theme ?ID_TEXT No No Null N/A N/A The theme (null: no override)
$require_session BINARY No No 0 N/A N/A Whether the zone requires a session for pages to be used
$zone ?ID_TEXT No No Null N/A N/A Name of the zone (null: unknown)

Returns

  • A tuple: The input fields, Hidden fields, ...
  • Type: array
  • Set: N/A
  • Range: N/A

Preview

Code (PHP)

/**
 * Get Tempcode for a zone adding/editing form.
 *
 * @param  boolean $in_zone_editor Whether the zone editor will be used
 * @param  SHORT_TEXT $title The zone title
 * @param  ID_TEXT $default_page The zones default page
 * @param  SHORT_TEXT $header_text The header text
 * @param  ?ID_TEXT $theme The theme (null: no override)
 * @param  BINARY $require_session Whether the zone requires a session for pages to be used
 * @param  ?ID_TEXT $zone Name of the zone (null: unknown)
 * @return array A tuple: The input fields, Hidden fields, ...
 */
public function get_form_fields(bool $in_zone_editor = false, string $title = '', string $default_page = 'home', string $header_text = '', ?string $theme = null, int $require_session = 0, ?string $zone = null) : array