include/generic/SugarWidgets/SugarWidgetFieldsingleenum.php
\SugarWidgetFieldSingleEnum
Package:
Generic Sugar widget
- Parent(s)
- \SugarWidgetFieldEnum < \SugarWidgetReportField < \SugarWidgetField < \SugarWidget
Properties
$form_value= ''
inheritedInherited from:
\SugarWidget::$$form_value\SugarWidgetField::$$form_value\SugarWidgetReportField::$$form_value\SugarWidgetFieldEnum::$$form_value
Details
- Type
- n/a
- Inherited_from
- \SugarWidget::$$form_value
- Inherited_from
- \SugarWidgetField::$$form_value
- Inherited_from
- \SugarWidgetReportField::$$form_value
- Inherited_from
- \SugarWidgetFieldEnum::$$form_value
$layout_manager= 'null'
inheritedInherited from:
\SugarWidget::$$layout_manager\SugarWidgetField::$$layout_manager\SugarWidgetReportField::$$layout_manager\SugarWidgetFieldEnum::$$layout_manager
Default value
null
Details- Type
- n/a
- Inherited_from
- \SugarWidget::$$layout_manager
- Inherited_from
- \SugarWidgetField::$$layout_manager
- Inherited_from
- \SugarWidgetReportField::$$layout_manager
- Inherited_from
- \SugarWidgetFieldEnum::$$layout_manager
$parent_bean= ''
inheritedInherited from:
\SugarWidget::$$parent_bean\SugarWidgetField::$$parent_bean\SugarWidgetReportField::$$parent_bean\SugarWidgetFieldEnum::$$parent_bean
Details
- Type
- n/a
- Inherited_from
- \SugarWidget::$$parent_bean
- Inherited_from
- \SugarWidgetField::$$parent_bean
- Inherited_from
- \SugarWidgetReportField::$$parent_bean
- Inherited_from
- \SugarWidgetFieldEnum::$$parent_bean
\SugarBean
$reporter= ''
inherited
Layout manager reporter attribute
Inherited from: \SugarWidgetReportField::$$reporter\SugarWidgetFieldEnum::$$reporter
Details
- Type
- \SugarBean
- Inherited_from
- \SugarWidgetReportField::$$reporter
- Inherited_from
- \SugarWidgetFieldEnum::$$reporter
$widget_id= ''
inheritedInherited from:
\SugarWidget::$$widget_id\SugarWidgetField::$$widget_id\SugarWidgetReportField::$$widget_id\SugarWidgetFieldEnum::$$widget_id
Details
- Type
- n/a
- Inherited_from
- \SugarWidget::$$widget_id
- Inherited_from
- \SugarWidgetField::$$widget_id
- Inherited_from
- \SugarWidgetReportField::$$widget_id
- Inherited_from
- \SugarWidgetFieldEnum::$$widget_id
Methods
SugarWidget(
$layout_manager
)
:
void
inherited
Inherited from:
\SugarWidget::SugarWidget()\SugarWidgetField::SugarWidget()\SugarWidgetReportField::SugarWidget()\SugarWidgetFieldEnum::SugarWidget()
Parameters
Name | Type | Description |
---|---|---|
$layout_manager |
SugarWidgetField(
$layout_manager
)
:
void
inherited
Inherited from:
\SugarWidgetField::SugarWidgetField()\SugarWidgetReportField::SugarWidgetField()\SugarWidgetFieldEnum::SugarWidgetField()
Parameters
Name | Type | Description |
---|---|---|
$layout_manager |
SugarWidgetFieldEnum(
$layout_manager
)
:
void
inherited
Inherited from:
\SugarWidgetFieldEnum::SugarWidgetFieldEnum()
Parameters
Name | Type | Description |
---|---|---|
$layout_manager |
SugarWidgetReportField(
$layout_manager
)
:
void
inherited
Inherited from:
\SugarWidgetReportField::SugarWidgetReportField()\SugarWidgetFieldEnum::SugarWidgetReportField()
Parameters
Name | Type | Description |
---|---|---|
$layout_manager |
_get_column_alias(
$layout_def
)
:
void
inherited
Inherited from:
\SugarWidgetReportField::_get_column_alias()\SugarWidgetFieldEnum::_get_column_alias()
Parameters
Name | Type | Description |
---|---|---|
$layout_def |
_get_column_select(
$layout_def
)
:
void
inherited
Inherited from:
\SugarWidgetReportField::_get_column_select()\SugarWidgetFieldEnum::_get_column_select()
Parameters
Name | Type | Description |
---|---|---|
$layout_def |
_get_column_select_special(
$layout_def
)
:
void
inherited
Inherited from:
\SugarWidgetReportField::_get_column_select_special()\SugarWidgetFieldEnum::_get_column_select_special()
Parameters
Name | Type | Description |
---|---|---|
$layout_def |
_get_list_value(
$layout_def
)
:
void
inherited
Inherited from:
\SugarWidgetField::_get_list_value()\SugarWidgetReportField::_get_list_value()\SugarWidgetFieldEnum::_get_list_value()
Parameters
Name | Type | Description |
---|---|---|
$layout_def |
displayDetail(
$layout_def
)
:
void
inherited
Inherited from:
\SugarWidgetField::displayDetail()\SugarWidgetReportField::displayDetail()\SugarWidgetFieldEnum::displayDetail()
Parameters
Name | Type | Description |
---|---|---|
$layout_def |
displayDetailLabel(
$layout_def
)
:
void
inherited
Inherited from:
\SugarWidgetField::displayDetailLabel()\SugarWidgetReportField::displayDetailLabel()\SugarWidgetFieldEnum::displayDetailLabel()
Parameters
Name | Type | Description |
---|---|---|
$layout_def |
displayEdit(
$layout_def
)
:
void
inherited
Inherited from:
\SugarWidgetField::displayEdit()\SugarWidgetReportField::displayEdit()\SugarWidgetFieldEnum::displayEdit()
Parameters
Name | Type | Description |
---|---|---|
$layout_def |
displayEditLabel(
$layout_def
)
:
void
inherited
Inherited from:
\SugarWidgetField::displayEditLabel()\SugarWidgetReportField::displayEditLabel()\SugarWidgetFieldEnum::displayEditLabel()
Parameters
Name | Type | Description |
---|---|---|
$layout_def |
displayHeaderCell(
$layout_def
)
:
void
inherited
Inherited from:
\SugarWidgetReportField::displayHeaderCell()\SugarWidgetFieldEnum::displayHeaderCell()
Parameters
Name | Type | Description |
---|---|---|
$layout_def |
displayHeaderCellPlain(
$layout_def
)
:
void
inherited
Inherited from:
\SugarWidgetField::displayHeaderCellPlain()\SugarWidgetReportField::displayHeaderCellPlain()\SugarWidgetFieldEnum::displayHeaderCellPlain()
Parameters
Name | Type | Description |
---|---|---|
$layout_def |
displayList(
$layout_def
)
:
void
inherited
Inherited from:
\SugarWidgetFieldEnum::displayList()
Parameters
Name | Type | Description |
---|---|---|
$layout_def |
displayListPlain(
$layout_def
)
:
void
inherited
Inherited from:
\SugarWidgetFieldEnum::displayListPlain()
Parameters
Name | Type | Description |
---|---|---|
$layout_def |
displaySearch(
$layout_def
)
:
void
inherited
Inherited from:
\SugarWidgetField::displaySearch()\SugarWidgetReportField::displaySearch()\SugarWidgetFieldEnum::displaySearch()
Parameters
Name | Type | Description |
---|---|---|
$layout_def |
displaySearchLabel(
$layout_def
)
:
void
inherited
Inherited from:
\SugarWidgetField::displaySearchLabel()\SugarWidgetReportField::displaySearchLabel()\SugarWidgetFieldEnum::displaySearchLabel()
Parameters
Name | Type | Description |
---|---|---|
$layout_def |
getSubClass(
$layout_def
)
:
void
inherited
Inherited from:
\SugarWidgetReportField::getSubClass()\SugarWidgetFieldEnum::getSubClass()
Parameters
Name | Type | Description |
---|---|---|
$layout_def |
getTruncatedColumnAlias(
$column_name
)
:
void
inherited
getTruncatedColumnAlias This function ensures that a column alias is no more than 28 characters. Should the column_name argument exceed 28 charcters, it creates an alias using the first 22 characters of the column_name plus an md5 of the first 6 characters of the lowercased column_name value.
Inherited from: \SugarWidget::getTruncatedColumnAlias()\SugarWidgetField::getTruncatedColumnAlias()\SugarWidgetReportField::getTruncatedColumnAlias()\SugarWidgetFieldEnum::getTruncatedColumnAlias()
Parameters
Name | Type | Description |
---|---|---|
$column_name |
getVardef(
$layout_def
)
:
void
inherited
Inherited from:
\SugarWidgetField::getVardef()\SugarWidgetReportField::getVardef()\SugarWidgetFieldEnum::getVardef()
Parameters
Name | Type | Description |
---|---|---|
$layout_def |
getWidgetId(
)
:
\id
inherited
getSubpanelWidgetId This is a utility function to return a widget's unique id
Inherited from: \SugarWidget::getWidgetId()\SugarWidgetField::getWidgetId()\SugarWidgetReportField::getWidgetId()\SugarWidgetFieldEnum::getWidgetId()
Returns
Type | Description |
---|---|
\id | String label of the widget's unique id |
queryFilter(
$layout_def
)
:
void
inherited
Inherited from:
\SugarWidgetReportField::queryFilter()\SugarWidgetFieldEnum::queryFilter()
Parameters
Name | Type | Description |
---|---|---|
$layout_def |
queryFilterEmpty(
$layout_def
)
:
void
inherited
Inherited from:
\SugarWidgetFieldEnum::queryFilterEmpty()
Parameters
Name | Type | Description |
---|---|---|
$layout_def |
queryFilterIs(
$layout_def
)
:
void
inherited
Inherited from:
\SugarWidgetReportField::queryFilterIs()\SugarWidgetFieldEnum::queryFilterIs()
Parameters
Name | Type | Description |
---|---|---|
$layout_def |
queryFilterNot_Empty(
$layout_def
)
:
void
inherited
Inherited from:
\SugarWidgetFieldEnum::queryFilterNot_Empty()
Parameters
Name | Type | Description |
---|---|---|
$layout_def |
queryFilteris(
$layout_def
)
:
void
inherited
Inherited from:
\SugarWidgetFieldEnum::queryFilteris()
Parameters
Name | Type | Description |
---|---|---|
$layout_def |
queryFilteris_not(
$layout_def
)
:
void
inherited
Inherited from:
\SugarWidgetFieldEnum::queryFilteris_not()
Parameters
Name | Type | Description |
---|---|---|
$layout_def |
queryFilternot_one_of(
$layout_def
)
:
void
inherited
Inherited from:
\SugarWidgetFieldEnum::queryFilternot_one_of()
Parameters
Name | Type | Description |
---|---|---|
$layout_def |
queryFilterone_of(
$layout_def
)
:
void
inherited
Inherited from:
\SugarWidgetFieldEnum::queryFilterone_of()
Parameters
Name | Type | Description |
---|---|---|
$layout_def |
queryGroupBy(
$layout_def
)
:
void
inherited
Inherited from:
\SugarWidgetReportField::queryGroupBy()\SugarWidgetFieldEnum::queryGroupBy()
Parameters
Name | Type | Description |
---|---|---|
$layout_def |
queryOrderBy(
$layout_def
)
:
void
inherited
Inherited from:
\SugarWidgetFieldEnum::queryOrderBy()
Parameters
Name | Type | Description |
---|---|---|
$layout_def |
querySelect(
$layout_def
)
:
void
inherited
Inherited from:
\SugarWidgetReportField::querySelect()\SugarWidgetFieldEnum::querySelect()
Parameters
Name | Type | Description |
---|---|---|
$layout_def |
setParentBean(
$parent_bean
)
:
void
inherited
Inherited from:
\SugarWidget::setParentBean()\SugarWidgetField::setParentBean()\SugarWidgetReportField::setParentBean()\SugarWidgetFieldEnum::setParentBean()
Parameters
Name | Type | Description |
---|---|---|
$parent_bean |
setWidgetId(
\id $id
=
''
)
:
void
inherited
setSubpanelWidgetId This is a utility function to set the id for a widget
Inherited from: \SugarWidget::setWidgetId()\SugarWidgetField::setWidgetId()\SugarWidgetReportField::setWidgetId()\SugarWidgetFieldEnum::setWidgetId()
Parameters
Name | Type | Description |
---|---|---|
$id | \id | String value to set the widget's unique id |