Function Module_cms_catalogues_alt->get_field_fields

Definitions

cms/pages/modules/cms_catalogues.php

  • Get Tempcode for a catalogue field adding/editing form (many of these are put together to add/edit a single catalogue!).
  • Visibility: public
  • Is abstract?: No
  • Is static?: No
  • Is final?: No
  • Return: array

Parameters

Name Type Default Set Range Description
$catalogue_name ID_TEXT required parameter N/A N/A The catalogue being edited (blank: new and no name pre-specified)
$first_field boolean required parameter N/A N/A Whether this is the first field of the entry fields
$num_fields_to_show integer required parameter N/A N/A The number of fields that will be on the screen
$prefix string required parameter N/A N/A The prefix the field input fields are given (e.g. new1_)
$order integer required parameter N/A N/A The order of the field relative to the other fields
$name SHORT_TEXT Blank (empty string) N/A N/A The name of the field
$description LONG_TEXT Blank (empty string) N/A N/A Description for the field
$type ID_TEXT short_text N/A N/A The field type
$defines_order BINARY 0 N/A N/A Whether the field defines entry ordering
$visible BINARY 1 N/A N/A Whether the field is visible when an entry is viewed
$sensitive BINARY 0 N/A N/A Whether the field contains sensitive or personal data
$default SHORT_TEXT Blank (empty string) N/A N/A Default value for the field
$required BINARY 0 N/A N/A Whether the field is required
$is_sortable BINARY 0 N/A N/A Whether the field is sortable
$include_in_main_search BINARY 0 N/A N/A Whether the field is included in main search
$allow_template_search BINARY 0 N/A N/A Whether to allow template search
$put_in_category BINARY 1 N/A N/A Whether the field is to be shown in category views (not applicable for the list display type)
$put_in_search BINARY 1 N/A N/A Whether the field is to be shown in search views (not applicable for the list display type)
$options SHORT_TEXT Blank (empty string) N/A N/A Field options

Return

  • A pair: the Tempcode for the visible fields, and the Tempcode for the hidden fields
  • Type: array
  • Set: N/A
  • Range: N/A