QgisFormControlProperties
in package
Properties of a Form field.
These properties are set during the read of the QGIS file. Can be stored into a cache.
Table of Contents
Properties
- $_IsMultiline : mixed
- $_UseHtml : mixed
- $attributeLowerNames : array<string|int, mixed>
- $attributes : array<string|int, mixed>
- $editable : bool
- $fieldAlias : string
- $fieldEditType : int|string
- $markup : mixed
- $name : string
- $rendererCategories : array<string|int, mixed>
Methods
- __construct() : mixed
- getEditAttribute() : null|mixed
- getEditAttributes() : array<string|int, mixed>
- getFieldAlias() : string
- getFieldEditType() : mixed
- getMarkup() : string
- getMimeTypes() : mixed
- getName() : string
- The name of the control.
- getRelationReference() : mixed
- getRendererCategories() : array<string|int, mixed>
- getUploadAccept() : string
- Get the accept value for upload controls.
- getUploadCapture() : string
- Get the capture value for upload controls.
- getValueMap() : mixed
- getValueRelationData() : mixed
- hasEditAttribute() : bool
- isEditable() : bool
- isImageUpload() : mixed
- isMultiline() : bool
- setFieldAlias() : mixed
- setRendererCategories() : mixed
- useHtml() : bool
Properties
$_IsMultiline
protected
mixed
$_IsMultiline
= false
$_UseHtml
protected
mixed
$_UseHtml
= false
$attributeLowerNames
protected
array<string|int, mixed>
$attributeLowerNames
= array()
$attributes
protected
array<string|int, mixed>
$attributes
= array()
$editable
protected
bool
$editable
= true
$fieldAlias
protected
string
$fieldAlias
= ''
$fieldEditType
protected
int|string
$fieldEditType
$markup
protected
mixed
$markup
= ''
$name
protected
string
$name
= ''
$rendererCategories
protected
array<string|int, mixed>
$rendererCategories
= array()
Methods
__construct()
public
__construct(string $name, int|string $fieldEditType, string $markup, array<string|int, mixed> $attributes) : mixed
Parameters
- $name : string
- $fieldEditType : int|string
-
the field edit type
- $markup : string
-
type of markup for the control
- $attributes : array<string|int, mixed>
-
list of qgis/lizmap attributes about the form control
getEditAttribute()
public
getEditAttribute(string $attrName) : null|mixed
Parameters
- $attrName : string
Return values
null|mixedgetEditAttributes()
public
getEditAttributes() : array<string|int, mixed>
Return values
array<string|int, mixed>getFieldAlias()
public
getFieldAlias() : string
Return values
stringgetFieldEditType()
public
getFieldEditType() : mixed
getMarkup()
public
getMarkup() : string
Return values
stringgetMimeTypes()
public
getMimeTypes() : mixed
getName()
The name of the control.
public
getName() : string
Return values
stringgetRelationReference()
public
getRelationReference() : mixed
getRendererCategories()
public
getRendererCategories() : array<string|int, mixed>
Return values
array<string|int, mixed>getUploadAccept()
Get the accept value for upload controls.
public
getUploadAccept() : string
Return values
string —list of type of files separated by a comma. see HTTP accept attribute.
getUploadCapture()
Get the capture value for upload controls.
public
getUploadCapture() : string
Return values
string —the type of capture. empty or 'camera'
getValueMap()
public
getValueMap() : mixed
getValueRelationData()
public
getValueRelationData() : mixed
hasEditAttribute()
public
hasEditAttribute(string $attrName) : bool
Parameters
- $attrName : string
Return values
boolisEditable()
public
isEditable() : bool
Return values
boolisImageUpload()
public
isImageUpload() : mixed
isMultiline()
public
isMultiline() : bool
Return values
boolsetFieldAlias()
public
setFieldAlias(string $fieldAlias) : mixed
Parameters
- $fieldAlias : string
setRendererCategories()
public
setRendererCategories(array<string|int, mixed> $rendererCategories) : mixed
Parameters
- $rendererCategories : array<string|int, mixed>
useHtml()
public
useHtml() : bool