Function __global->actual_edit_zone

Definitions

sources/zones3.php

  • Edit a zone.
  • Visibility: public
  • Is abstract?: No
  • Is static?: No
  • Is final?: No
  • Returns: string

Parameters

Name Type Passed by reference? Variadic? Default Set Range Description
$zone ID_TEXT No No required parameter N/A N/A The current name of the zone
$title SHORT_TEXT No No required parameter N/A N/A The zone title
$default_page ID_TEXT No No required parameter N/A N/A The zones default page
$header_text SHORT_TEXT No No required parameter N/A N/A The header text
$theme ID_TEXT No No required parameter N/A N/A The theme
$require_session BINARY No No required parameter N/A N/A Whether the zone requires a session for pages to be used
$new_zone ID_TEXT No No required parameter N/A N/A The new name of the zone
$uniqify boolean No No False N/A N/A Whether to force the name as unique, if there's a conflict
$skip_afm boolean No No False N/A N/A Whether to skip the AFM because we know it's not needed (or can't be loaded)
$base_url string No No Blank (empty string) N/A N/A The base URL (blank: natural)

Returns

  • The name
  • Type: ID_TEXT
  • Set: N/A
  • Range: N/A

Preview

Code (PHP)

/**
 * Edit a zone.
 *
 * @param  ID_TEXT $zone The current name of the zone
 * @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
 * @param  BINARY $require_session Whether the zone requires a session for pages to be used
 * @param  ID_TEXT $new_zone The new name of the zone
 * @param  boolean $uniqify Whether to force the name as unique, if there's a conflict
 * @param  boolean $skip_afm Whether to skip the AFM because we know it's not needed (or can't be loaded)
 * @param  string $base_url The base URL (blank: natural)
 * @return ID_TEXT The name
 */
function actual_edit_zone(string $zone, string $title, string $default_page, string $header_text, string $theme, int $require_session, string $new_zone, bool $uniqify = false, bool $skip_afm = false, string $base_url = '') : string