Function __global->actual_edit_catalogue

Definitions

sources/catalogues2.php

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

Parameters

Name Type Passed by reference? Variadic? Default Set Range Description
$old_name ID_TEXT No No required parameter N/A N/A The current name of the catalogue
$name ID_TEXT No No required parameter N/A N/A The new name of the catalogue
$title SHORT_TEXT No No required parameter N/A N/A The human readable name/title of the catalogue
$description LONG_TEXT No No required parameter N/A N/A The description
$display_type SHORT_INTEGER No No required parameter N/A N/A The display type
$notes LONG_TEXT No No required parameter N/A N/A Admin notes
$submit_points integer No No required parameter N/A N/A How many points are given to a member that submits to the catalogue
$ecommerce BINARY No No required parameter N/A N/A Whether the catalogue is an eCommerce catalogue
$categories_sort_order SHORT_TEXT No No required parameter "title ASC" "recent ASC" "recent DESC" N/A Category sort order
$send_view_reports ID_TEXT No No required parameter never daily weekly monthly quarterly N/A How to send view reports
$default_review_freq ?integer No No required parameter N/A N/A Default review frequency for catalogue entries (null: none)
$add_time ?TIME No No Null N/A N/A Add time (null: do not change)
$uniqify boolean No No False N/A N/A Whether to force the name as unique, if there's a conflict

Returns

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

Preview

Code (PHP)

/**
 * Edit a catalogue.
 *
 * @param  ID_TEXT $old_name The current name of the catalogue
 * @param  ID_TEXT $name The new name of the catalogue
 * @param  SHORT_TEXT $title The human readable name/title of the catalogue
 * @param  LONG_TEXT $description The description
 * @param  SHORT_INTEGER $display_type The display type
 * @param  LONG_TEXT $notes Admin notes
 * @param  integer $submit_points How many points are given to a member that submits to the catalogue
 * @param  BINARY $ecommerce Whether the catalogue is an eCommerce catalogue
 * @param  SHORT_TEXT $categories_sort_order Category sort order
 * @set "title ASC" "recent ASC" "recent DESC"
 * @param  ID_TEXT $send_view_reports How to send view reports
 * @set never daily weekly monthly quarterly
 * @param  ?integer $default_review_freq Default review frequency for catalogue entries (null: none)
 * @param  ?TIME $add_time Add time (null: do not change)
 * @param  boolean $uniqify Whether to force the name as unique, if there's a conflict
 * @return ID_TEXT The name
 */
function actual_edit_catalogue(string $old_name, string $name, string $title, string $description, int $display_type, string $notes, int $submit_points, int $ecommerce, string $categories_sort_order, string $send_view_reports, ?int $default_review_freq, ?int $add_time = null, bool $uniqify = false) : string