Function __global->actual_edit_catalogue_entry
Definitions
sources/catalogues2.php
- Edit the specified catalogue entry.
- Visibility: public
- Is abstract?: No
- Is static?: No
- Is final?: No
Parameters
| Name | Type | Passed by reference? | Variadic? | Default | Set | Range | Description |
|---|---|---|---|---|---|---|---|
| $id | AUTO_LINK | No | No | required parameter | N/A | N/A | The ID of the entry being edited |
| $category_id | AUTO_LINK | No | No | required parameter | N/A | N/A | The ID of the category that the entry is in |
| $validated | BINARY | No | No | required parameter | N/A | N/A | Whether the entry has been validated |
| $notes | LONG_TEXT | No | No | required parameter | N/A | N/A | Hidden notes pertaining to the entry |
| $allow_rating | BINARY | No | No | required parameter | N/A | N/A | Whether the entry may be rated |
| $allow_comments | SHORT_INTEGER | No | No | required parameter | N/A | N/A | Whether comments are allowed (0=no, 1=yes, 2=review style) |
| $allow_trackbacks | BINARY | No | No | required parameter | N/A | N/A | Whether the entry may be trackbacked |
| $map | array | No | No | required parameter | N/A | N/A | A map of field IDs, to values, that defines the entries settings |
| $meta_keywords | ?SHORT_TEXT | No | No | Blank (empty string) | N/A | N/A | Meta keywords for this resource (null: do not edit) |
| $meta_description | ?LONG_TEXT | No | No | Blank (empty string) | N/A | N/A | Meta description for this resource (null: do not edit) |
| $edit_time | ?TIME | No | No | Null | N/A | N/A | Edit time (null: either means current time, or if $null_is_literal, means reset to to null) |
| $add_time | ?TIME | No | No | Null | N/A | N/A | Add time (null: do not change) |
| $views | ?integer | No | No | Null | N/A | N/A | Number of views (null: do not change) |
| $submitter | ?MEMBER | No | No | Null | N/A | N/A | Submitter (null: do not change) |
| $null_is_literal | boolean | No | No | False | N/A | N/A | Determines whether some nulls passed mean 'use a default' or literally mean 'set to null |
Preview
Code (PHP)
/**
* Edit the specified catalogue entry.
*
* @param AUTO_LINK $id The ID of the entry being edited
* @param AUTO_LINK $category_id The ID of the category that the entry is in
* @param BINARY $validated Whether the entry has been validated
* @param LONG_TEXT $notes Hidden notes pertaining to the entry
* @param BINARY $allow_rating Whether the entry may be rated
* @param SHORT_INTEGER $allow_comments Whether comments are allowed (0=no, 1=yes, 2=review style)
* @param BINARY $allow_trackbacks Whether the entry may be trackbacked
* @param array $map A map of field IDs, to values, that defines the entries settings
* @param ?SHORT_TEXT $meta_keywords Meta keywords for this resource (null: do not edit)
* @param ?LONG_TEXT $meta_description Meta description for this resource (null: do not edit)
* @param ?TIME $edit_time Edit time (null: either means current time, or if $null_is_literal, means reset to to null)
* @param ?TIME $add_time Add time (null: do not change)
* @param ?integer $views Number of views (null: do not change)
* @param ?MEMBER $submitter Submitter (null: do not change)
* @param boolean $null_is_literal Determines whether some nulls passed mean 'use a default' or literally mean 'set to null
*/
function actual_edit_catalogue_entry(int $id, int $category_id, int $validated, string $notes, int $allow_rating, int $allow_comments, int $allow_trackbacks, array $map, ?string $meta_keywords = '', ?string $meta_description = '', ?int $edit_time = null, ?int $add_time = null, ?int $views = null, ?int $submitter = null, bool $null_is_literal = false)
* Edit the specified catalogue entry.
*
* @param AUTO_LINK $id The ID of the entry being edited
* @param AUTO_LINK $category_id The ID of the category that the entry is in
* @param BINARY $validated Whether the entry has been validated
* @param LONG_TEXT $notes Hidden notes pertaining to the entry
* @param BINARY $allow_rating Whether the entry may be rated
* @param SHORT_INTEGER $allow_comments Whether comments are allowed (0=no, 1=yes, 2=review style)
* @param BINARY $allow_trackbacks Whether the entry may be trackbacked
* @param array $map A map of field IDs, to values, that defines the entries settings
* @param ?SHORT_TEXT $meta_keywords Meta keywords for this resource (null: do not edit)
* @param ?LONG_TEXT $meta_description Meta description for this resource (null: do not edit)
* @param ?TIME $edit_time Edit time (null: either means current time, or if $null_is_literal, means reset to to null)
* @param ?TIME $add_time Add time (null: do not change)
* @param ?integer $views Number of views (null: do not change)
* @param ?MEMBER $submitter Submitter (null: do not change)
* @param boolean $null_is_literal Determines whether some nulls passed mean 'use a default' or literally mean 'set to null
*/
function actual_edit_catalogue_entry(int $id, int $category_id, int $validated, string $notes, int $allow_rating, int $allow_comments, int $allow_trackbacks, array $map, ?string $meta_keywords = '', ?string $meta_description = '', ?int $edit_time = null, ?int $add_time = null, ?int $views = null, ?int $submitter = null, bool $null_is_literal = false)