CoolCMS API

ParameterType
in package

Parameter Types Defines available input types for parameters (form fields)

Table of Contents

Constants

ADDRESS_DISTANCE  : mixed = 31
BUTTON  : mixed = 28
CHECKBOX  : mixed = 1
CHECKBOXLIST  : mixed = 32
COLOR  : mixed = 2
DATE  : mixed = 3
DATETIME  : mixed = 4
EMAIL  : mixed = 5
FILE  : mixed = 6
FILE_UPLOADER  : mixed = 34
HIDDEN  : mixed = 7
IMAGE  : mixed = 8
IMAGE_UPLOADER  : mixed = 33
INPUT_PRICE  : mixed = 25
LIMITRANGE_SLIDER  : mixed = 30
MONTH  : mixed = 9
MULTISELECT  : mixed = 22
NUMBER  : mixed = 10
OPENING_HOURS  : mixed = 35
PASSWORD  : mixed = 11
PRICE  : mixed = 24
RADIO  : mixed = 12
RANGE  : mixed = 13
RANGE_SLIDER  : mixed = 29
REGION_PICKER  : mixed = 38
Municipality/postcode suggester. The value is the region id; the advert form accepts only a municipality (tree leaf), the filter also accepts a county/district. {@see SELECT_REGION} remains the `<select>` variant for sites with only countries/counties.
RESET  : mixed = 14
SEARCH  : mixed = 15
SELECT  : mixed = 21
SELECT_COMCAT_ADVERT  : mixed = 36
SELECT_CURRENCY  : mixed = 26
SELECT_REGION  : mixed = 27
SUBMIT  : mixed = 16
TEL  : mixed = 17
TEXT  : mixed = 18
TEXTAREA  : mixed = 23
TIME  : mixed = 19
TYPE_NAMES  : mixed = [ self::CHECKBOX => 'Checkbox', self::COLOR =>...
Type names for display
URL  : mixed = 20

Methods

getAllTypes()  : array<int, string>
Get all types
getTypeName()  : string|null
Get type name
hasOptions()  : bool
Check if type has options (select, radio, etc.)
isFileUpload()  : bool
Check if type is file upload

Constants

REGION_PICKER

Municipality/postcode suggester. The value is the region id; the advert form accepts only a municipality (tree leaf), the filter also accepts a county/district. {@see SELECT_REGION} remains the `<select>` variant for sites with only countries/counties.

public mixed REGION_PICKER = 38

SELECT_COMCAT_ADVERT

module-specific leak into Core with no consumers; kept for backward compatibility only.

public mixed SELECT_COMCAT_ADVERT = 36

TYPE_NAMES

Type names for display

public mixed TYPE_NAMES = [ self::CHECKBOX => 'Checkbox', self::COLOR => 'Color', self::DATE => 'Date', self::DATETIME => 'Datetime', self::EMAIL => 'Email', self::FILE => 'File', self::HIDDEN => 'Hidden', self::IMAGE => 'Image', self::MONTH => 'Month', self::NUMBER => 'Number', self::PASSWORD => 'Password', self::RADIO => 'Radio', self::RANGE => 'Range', self::RESET => 'Reset', self::SEARCH => 'Search', self::SUBMIT => 'Submit', self::TEL => 'Tel', self::TEXT => 'Text', self::TIME => 'Time', self::URL => 'URL', self::SELECT => 'Select', self::MULTISELECT => 'Multiselect', self::TEXTAREA => 'Textarea', self::PRICE => 'Price', self::INPUT_PRICE => 'Input Price', self::SELECT_CURRENCY => 'Select Currency', self::SELECT_REGION => 'Select Region', self::BUTTON => 'Button', self::RANGE_SLIDER => 'Range Slider', self::LIMITRANGE_SLIDER => 'Limitrange Slider', self::ADDRESS_DISTANCE => 'Address Distance', self::CHECKBOXLIST => 'Checkboxlist', self::IMAGE_UPLOADER => 'Image Uploader', self::FILE_UPLOADER => 'File Uploader', self::OPENING_HOURS => 'Opening Hours', self::SELECT_COMCAT_ADVERT => 'Select Comcat Advert', // deprecated self::REGION_PICKER => 'Region Picker', ]

Methods

getAllTypes()

Get all types

public static getAllTypes() : array<int, string>
Return values
array<int, string>

getTypeName()

Get type name

public static getTypeName(int $type) : string|null
Parameters
$type : int
Return values
string|null

hasOptions()

Check if type has options (select, radio, etc.)

public static hasOptions(int $type) : bool
Parameters
$type : int
Return values
bool

isFileUpload()

Check if type is file upload

public static isFileUpload(int $type) : bool
Parameters
$type : int
Return values
bool
On this page

Search results