Function Module_cms_banners->get_form_fields

Definitions

cms/pages/modules/cms_banners.php

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

Parameters

Name Type Default Set Range Description
$name ID_TEXT Blank (empty string) N/A N/A The name of the banner (blank: new)
$image_url URLPATH Blank (empty string) N/A N/A The URL to the banner image
$site_url URLPATH Blank (empty string) N/A N/A The URL to the site the banner leads to
$caption SHORT_TEXT Blank (empty string) N/A N/A The caption of the banner
$direct_code LONG_TEXT Blank (empty string) N/A N/A Complete HTML/PHP for the banner
$notes LONG_TEXT Blank (empty string) N/A N/A Any notes associated with the banner
$display_likelihood integer 3 N/A N/A The banner's "Display likelihood"
$campaign_remaining ?integer 50 N/A N/A The number of hits the banner may have (null: not applicable for this banner type)
$deployment_agreement SHORT_INTEGER 0 N/A N/A The type of banner (a BANNER_* constant)
$expiry_date ?TIME Null N/A N/A The banner expiry date (null: never expires)
$submitter ?MEMBER Null N/A N/A The banners submitter (null: current member)
$validated BINARY 1 N/A N/A Whether the banner has been validated
$b_type ID_TEXT Blank (empty string) N/A N/A The banner type (can be anything, where blank means 'normal')
$b_types array [] N/A N/A The secondary banner types (empty: no secondary banner types)
$regions array [] N/A N/A The regions (empty: not region-limited)
$title_text SHORT_TEXT Blank (empty string) N/A N/A The title text for the banner (only used for text banners, and functions as the 'trigger text' if the banner type is shown inline)

Return

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