include/generic/SugarWidgets/SugarWidgetFieldname.php
Show:
inherited
inherited
Classes
\SugarWidgetFieldName
Package:
Generic Sugar widget
- Parent(s)
- \SugarWidgetFieldVarchar < \SugarWidgetReportField < \SugarWidgetField < \SugarWidget
- Children
- \SugarWidgetFieldFullname
Properties
$form_value= ''
inheritedInherited from:
\SugarWidget::$$form_value\SugarWidgetField::$$form_value\SugarWidgetReportField::$$form_value\SugarWidgetFieldVarchar::$$form_value
Details
- Type
- n/a
- Inherited_from
- \SugarWidget::$$form_value
- Inherited_from
- \SugarWidgetField::$$form_value
- Inherited_from
- \SugarWidgetReportField::$$form_value
- Inherited_from
- \SugarWidgetFieldVarchar::$$form_value
$layout_manager= 'null'
inheritedInherited from:
\SugarWidget::$$layout_manager\SugarWidgetField::$$layout_manager\SugarWidgetReportField::$$layout_manager\SugarWidgetFieldVarchar::$$layout_manager
Default value
nullDetails- Type
- n/a
- Inherited_from
- \SugarWidget::$$layout_manager
- Inherited_from
- \SugarWidgetField::$$layout_manager
- Inherited_from
- \SugarWidgetReportField::$$layout_manager
- Inherited_from
- \SugarWidgetFieldVarchar::$$layout_manager
\SugarBean
$reporter= ''
inherited
Layout manager reporter attribute
Inherited from: \SugarWidgetReportField::$$reporter\SugarWidgetFieldVarchar::$$reporter
Details
- Type
- \SugarBean
- Inherited_from
- \SugarWidgetReportField::$$reporter
- Inherited_from
- \SugarWidgetFieldVarchar::$$reporter
$widget_id= ''
inheritedInherited from:
\SugarWidget::$$widget_id\SugarWidgetField::$$widget_id\SugarWidgetReportField::$$widget_id\SugarWidgetFieldVarchar::$$widget_id
Details
- Type
- n/a
- Inherited_from
- \SugarWidget::$$widget_id
- Inherited_from
- \SugarWidgetField::$$widget_id
- Inherited_from
- \SugarWidgetReportField::$$widget_id
- Inherited_from
- \SugarWidgetFieldVarchar::$$widget_id
Methods
SugarWidget(
$layout_manager
)
:
void
inherited
Inherited from:
\SugarWidget::SugarWidget()\SugarWidgetField::SugarWidget()\SugarWidgetReportField::SugarWidget()\SugarWidgetFieldVarchar::SugarWidget()
Parameters
| Name | Type | Description |
|---|---|---|
| $layout_manager |
SugarWidgetField(
$layout_manager
)
:
void
inherited
Inherited from:
\SugarWidgetField::SugarWidgetField()\SugarWidgetReportField::SugarWidgetField()\SugarWidgetFieldVarchar::SugarWidgetField()
Parameters
| Name | Type | Description |
|---|---|---|
| $layout_manager |
SugarWidgetFieldName(
$layout_manager
)
:
void
Parameters
| Name | Type | Description |
|---|---|---|
| $layout_manager |
SugarWidgetFieldVarchar(
$layout_manager
)
:
void
inherited
Inherited from:
\SugarWidgetFieldVarchar::SugarWidgetFieldVarchar()
Parameters
| Name | Type | Description |
|---|---|---|
| $layout_manager |
SugarWidgetReportField(
$layout_manager
)
:
void
inherited
Inherited from:
\SugarWidgetReportField::SugarWidgetReportField()\SugarWidgetFieldVarchar::SugarWidgetReportField()
Parameters
| Name | Type | Description |
|---|---|---|
| $layout_manager |
_get_column_alias(
$layout_def
)
:
void
inherited
Inherited from:
\SugarWidgetReportField::_get_column_alias()\SugarWidgetFieldVarchar::_get_column_alias()
Parameters
| Name | Type | Description |
|---|---|---|
| $layout_def |
_get_column_select(
$layout_def
)
:
void
Parameters
| Name | Type | Description |
|---|---|---|
| $layout_def |
_get_column_select_special(
$layout_def
)
:
void
inherited
Inherited from:
\SugarWidgetReportField::_get_column_select_special()\SugarWidgetFieldVarchar::_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()\SugarWidgetFieldVarchar::_get_list_value()
Parameters
| Name | Type | Description |
|---|---|---|
| $layout_def |
_get_normal_column_select(
$layout_def
)
:
void
Parameters
| Name | Type | Description |
|---|---|---|
| $layout_def |
display(
$layout_def
)
:
void
Parameters
| Name | Type | Description |
|---|---|---|
| $layout_def |
displayDetail(
$layout_def
)
:
void
inherited
Inherited from:
\SugarWidgetField::displayDetail()\SugarWidgetReportField::displayDetail()\SugarWidgetFieldVarchar::displayDetail()
Parameters
| Name | Type | Description |
|---|---|---|
| $layout_def |
displayDetailLabel(
$layout_def
)
:
void
inherited
Inherited from:
\SugarWidgetField::displayDetailLabel()\SugarWidgetReportField::displayDetailLabel()\SugarWidgetFieldVarchar::displayDetailLabel()
Parameters
| Name | Type | Description |
|---|---|---|
| $layout_def |
displayEdit(
$layout_def
)
:
void
inherited
Inherited from:
\SugarWidgetField::displayEdit()\SugarWidgetReportField::displayEdit()\SugarWidgetFieldVarchar::displayEdit()
Parameters
| Name | Type | Description |
|---|---|---|
| $layout_def |
displayEditLabel(
$layout_def
)
:
void
inherited
Inherited from:
\SugarWidgetField::displayEditLabel()\SugarWidgetReportField::displayEditLabel()\SugarWidgetFieldVarchar::displayEditLabel()
Parameters
| Name | Type | Description |
|---|---|---|
| $layout_def |
displayHeaderCell(
$layout_def
)
:
void
inherited
Inherited from:
\SugarWidgetReportField::displayHeaderCell()\SugarWidgetFieldVarchar::displayHeaderCell()
Parameters
| Name | Type | Description |
|---|---|---|
| $layout_def |
displayHeaderCellPlain(
$layout_def
)
:
void
inherited
Inherited from:
\SugarWidgetField::displayHeaderCellPlain()\SugarWidgetReportField::displayHeaderCellPlain()\SugarWidgetFieldVarchar::displayHeaderCellPlain()
Parameters
| Name | Type | Description |
|---|---|---|
| $layout_def |
displayInput(
$layout_def
)
:
void
inherited
Inherited from:
\SugarWidgetFieldVarchar::displayInput()
Parameters
| Name | Type | Description |
|---|---|---|
| $layout_def |
displayList(
$layout_def
)
:
void
Parameters
| Name | Type | Description |
|---|---|---|
| $layout_def |
displayListPlain(
$layout_def
)
:
void
inherited
Inherited from:
\SugarWidgetField::displayListPlain()\SugarWidgetReportField::displayListPlain()\SugarWidgetFieldVarchar::displayListPlain()
Parameters
| Name | Type | Description |
|---|---|---|
| $layout_def |
displaySearch(
$layout_def
)
:
void
inherited
Inherited from:
\SugarWidgetField::displaySearch()\SugarWidgetReportField::displaySearch()\SugarWidgetFieldVarchar::displaySearch()
Parameters
| Name | Type | Description |
|---|---|---|
| $layout_def |
displaySearchLabel(
$layout_def
)
:
void
inherited
Inherited from:
\SugarWidgetField::displaySearchLabel()\SugarWidgetReportField::displaySearchLabel()\SugarWidgetFieldVarchar::displaySearchLabel()
Parameters
| Name | Type | Description |
|---|---|---|
| $layout_def |
getDisplayName(
)
:
void
getSubClass(
$layout_def
)
:
void
inherited
Inherited from:
\SugarWidgetReportField::getSubClass()\SugarWidgetFieldVarchar::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()\SugarWidgetFieldVarchar::getTruncatedColumnAlias()
Parameters
| Name | Type | Description |
|---|---|---|
| $column_name |
getVardef(
$layout_def
)
:
void
inherited
Inherited from:
\SugarWidgetField::getVardef()\SugarWidgetReportField::getVardef()\SugarWidgetFieldVarchar::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()\SugarWidgetFieldVarchar::getWidgetId()
Returns
| Type | Description |
|---|---|
| \id | String label of the widget's unique id |
query(
$layout_def
)
:
void
Parameters
| Name | Type | Description |
|---|---|---|
| $layout_def |
queryFilter(
$layout_def
)
:
void
inherited
Inherited from:
\SugarWidgetReportField::queryFilter()\SugarWidgetFieldVarchar::queryFilter()
Parameters
| Name | Type | Description |
|---|---|---|
| $layout_def |
queryFilterContains(
$layout_def
)
:
void
inherited
Inherited from:
\SugarWidgetFieldVarchar::queryFilterContains()
Parameters
| Name | Type | Description |
|---|---|---|
| $layout_def |
queryFilterEmpty(
$layout_def
)
:
void
inherited
Inherited from:
\SugarWidgetReportField::queryFilterEmpty()\SugarWidgetFieldVarchar::queryFilterEmpty()
Parameters
| Name | Type | Description |
|---|---|---|
| $layout_def |
queryFilterEnds_With(
$layout_def
)
:
void
inherited
Inherited from:
\SugarWidgetFieldVarchar::queryFilterEnds_With()
Parameters
| Name | Type | Description |
|---|---|---|
| $layout_def |
queryFilterEquals(
$layout_def
)
:
void
inherited
Inherited from:
\SugarWidgetFieldVarchar::queryFilterEquals()
Parameters
| Name | Type | Description |
|---|---|---|
| $layout_def |
queryFilterIs(
$layout_def
)
:
void
Parameters
| Name | Type | Description |
|---|---|---|
| $layout_def |
queryFilterNot_Empty(
$layout_def
)
:
void
inherited
Inherited from:
\SugarWidgetReportField::queryFilterNot_Empty()\SugarWidgetFieldVarchar::queryFilterNot_Empty()
Parameters
| Name | Type | Description |
|---|---|---|
| $layout_def |
queryFilterNot_Equals_Str(
$layout_def
)
:
void
inherited
Inherited from:
\SugarWidgetFieldVarchar::queryFilterNot_Equals_Str()
Parameters
| Name | Type | Description |
|---|---|---|
| $layout_def |
queryFilterStarts_With(
$layout_def
)
:
void
inherited
Inherited from:
\SugarWidgetFieldVarchar::queryFilterStarts_With()
Parameters
| Name | Type | Description |
|---|---|---|
| $layout_def |
queryFilterdoes_not_contain(
$layout_def
)
:
void
inherited
Inherited from:
\SugarWidgetFieldVarchar::queryFilterdoes_not_contain()
Parameters
| Name | Type | Description |
|---|---|---|
| $layout_def |
queryFilteris_not(
$layout_def
)
:
void
Parameters
| Name | Type | Description |
|---|---|---|
| $layout_def |
queryFilternot_one_of(
$layout_def, $rename_columns
=
true
)
:
void
Parameters
| Name | Type | Description |
|---|---|---|
| $layout_def | ||
| $rename_columns |
queryFilterone_of(
$layout_def, $rename_columns
=
true
)
:
void
Parameters
| Name | Type | Description |
|---|---|---|
| $layout_def | ||
| $rename_columns |
queryGroupBy(
$layout_def
)
:
void
Parameters
| Name | Type | Description |
|---|---|---|
| $layout_def |
queryOrderBy(
$layout_def
)
:
void
inherited
Inherited from:
\SugarWidgetReportField::queryOrderBy()\SugarWidgetFieldVarchar::queryOrderBy()
Parameters
| Name | Type | Description |
|---|---|---|
| $layout_def |
querySelect(
$layout_def
)
:
void
inherited
Inherited from:
\SugarWidgetReportField::querySelect()\SugarWidgetFieldVarchar::querySelect()
Parameters
| Name | Type | Description |
|---|---|---|
| $layout_def |
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()\SugarWidgetFieldVarchar::setWidgetId()
Parameters
| Name | Type | Description |
|---|---|---|
| $id | \id | String value to set the widget's unique id |