include/generic/SugarWidgets/SugarWidgetFieldmultienum.php

Show: inherited
Table of Contents

\SugarWidgetFieldMultiEnum

Package:

Generic Sugar widget

Parent(s)
\SugarWidgetFieldEnum < \SugarWidgetReportField < \SugarWidgetField < \SugarWidget

Properties

Propertyprotected\SugarBean  $reporter= ''
inherited

Layout manager reporter attribute

Inherited from: \SugarWidgetReportField::$$reporter\SugarWidgetFieldEnum::$$reporter
Details
Type
\SugarBean
Inherited_from
\SugarWidgetReportField::$$reporter  
Inherited_from
\SugarWidgetFieldEnum::$$reporter  

Methods

methodpublicSugarWidget(  $layout_manager ) : void
Parameters
Name Type Description
$layout_manager
methodpublicSugarWidgetField(  $layout_manager ) : void
Parameters
Name Type Description
$layout_manager
methodpublicSugarWidgetFieldEnum(  $layout_manager ) : void
Parameters
Name Type Description
$layout_manager
methodpublicSugarWidgetReportField(  $layout_manager ) : void
Parameters
Name Type Description
$layout_manager
methodpublic_get_column_alias(  $layout_def ) : void
Parameters
Name Type Description
$layout_def
methodpublic_get_column_select(  $layout_def ) : void
Parameters
Name Type Description
$layout_def
methodpublic_get_column_select_special(  $layout_def ) : void
Parameters
Name Type Description
$layout_def
methodpublic_get_list_value(  $layout_def ) : void
Parameters
Name Type Description
$layout_def
methodpublicdisplay(  $layout_def ) : void
Parameters
Name Type Description
$layout_def
methodpublicdisplayDetail(  $layout_def ) : void
Parameters
Name Type Description
$layout_def
methodpublicdisplayDetailLabel(  $layout_def ) : void
Parameters
Name Type Description
$layout_def
methodpublicdisplayEdit(  $layout_def ) : void
Parameters
Name Type Description
$layout_def
methodpublicdisplayEditLabel(  $layout_def ) : void
Parameters
Name Type Description
$layout_def
methodpublicdisplayHeaderCell(  $layout_def ) : void
Parameters
Name Type Description
$layout_def
methodpublicdisplayHeaderCellPlain(  $layout_def ) : void
Parameters
Name Type Description
$layout_def
methodpublicdisplayInput(  $layout_def ) : void
inherited

Inherited from: \SugarWidgetFieldEnum::displayInput()
Parameters
Name Type Description
$layout_def
methodpublicdisplayList(  $layout_def ) : void
inherited

Inherited from: \SugarWidgetFieldEnum::displayList()
Parameters
Name Type Description
$layout_def
methodpublicdisplayListPlain(  $layout_def ) : void
inherited

Inherited from: \SugarWidgetFieldEnum::displayListPlain()
Parameters
Name Type Description
$layout_def
methodpublicdisplaySearch(  $layout_def ) : void
Parameters
Name Type Description
$layout_def
methodpublicdisplaySearchLabel(  $layout_def ) : void
Parameters
Name Type Description
$layout_def
methodprivateencodeMultienumCustom( array $layout_def, string $value ) : string

Function checks if the multienum field is custom, and escapes it with carets (^) if it is

Parameters
Name Type Description
$layout_def array

field layout definition

$value string

value to be escaped

Returns
Type Description
string
methodpublicgetSubClass(  $layout_def ) : void
Parameters
Name Type Description
$layout_def
methodprotectedgetTruncatedColumnAlias(  $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
methodpublicgetVardef(  $layout_def ) : void
Parameters
Name Type Description
$layout_def
methodpublicgetWidgetId( ) : \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
methodpublicquery(  $layout_def ) : void
Parameters
Name Type Description
$layout_def
methodpublicqueryFilter(  $layout_def ) : void
Parameters
Name Type Description
$layout_def
methodpublicqueryFilterEmpty(  $layout_def ) : void
inherited

Inherited from: \SugarWidgetFieldEnum::queryFilterEmpty()
Parameters
Name Type Description
$layout_def
methodpublicqueryFilterIs(  $layout_def ) : void
Parameters
Name Type Description
$layout_def
methodpublicqueryFilterNot_Empty(  $layout_def ) : void
Parameters
Name Type Description
$layout_def
methodpublicqueryFilteris(  $layout_def ) : void

Parameters
Name Type Description
$layout_def
methodpublicqueryFilteris_not(  $layout_def ) : void

Parameters
Name Type Description
$layout_def
methodpublicqueryFilternot_one_of(  $layout_def ) : void

Parameters
Name Type Description
$layout_def
methodpublicqueryFilterone_of(  $layout_def ) : void

Parameters
Name Type Description
$layout_def
methodpublicqueryGroupBy(  $layout_def ) : void
Parameters
Name Type Description
$layout_def
methodpublicqueryOrderBy(  $layout_def ) : string

Returns an OrderBy query for multi-select. We treat multi-select the same as a normal field because the values stored in the database are in the format ^A^,^B^,^C^ though not necessarily in that order.

Parameters
Name Type Description
$layout_def
Returns
Type Description
string
methodpublicquerySelect(  $layout_def ) : void
Parameters
Name Type Description
$layout_def
methodpublicsetParentBean(  $parent_bean ) : void
Parameters
Name Type Description
$parent_bean
methodpublicsetWidgetId( \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

Documentation was generated by DocBlox 0.18.1.