include/generic/SugarWidgets/SugarWidgetFieldbool.php
\SugarWidgetFieldBool
Package: 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
Generic Sugar widget
- Parent(s)
- \SugarWidgetReportField < \SugarWidgetField < \SugarWidget
Properties


 $form_value= ''
                 $form_value= ''
                
inheritedInherited from:
                        \SugarWidget::$$form_value\SugarWidgetField::$$form_value\SugarWidgetReportField::$$form_value
Details
- Type
- n/a
- Inherited_from
- \SugarWidget::$$form_value
- Inherited_from
- \SugarWidgetField::$$form_value
- Inherited_from
- \SugarWidgetReportField::$$form_value


 $layout_manager= 'null'
                 $layout_manager= 'null'
                
inheritedInherited from:
                        \SugarWidget::$$layout_manager\SugarWidgetField::$$layout_manager\SugarWidgetReportField::$$layout_manager
Default value
nullDetails- Type
- n/a
- Inherited_from
- \SugarWidget::$$layout_manager
- Inherited_from
- \SugarWidgetField::$$layout_manager
- Inherited_from
- \SugarWidgetReportField::$$layout_manager


 $parent_bean= ''
                 $parent_bean= ''
                
inheritedInherited from:
                        \SugarWidget::$$parent_bean\SugarWidgetField::$$parent_bean\SugarWidgetReportField::$$parent_bean
Details
- Type
- n/a
- Inherited_from
- \SugarWidget::$$parent_bean
- Inherited_from
- \SugarWidgetField::$$parent_bean
- Inherited_from
- \SugarWidgetReportField::$$parent_bean


 $widget_id= ''
                 $widget_id= ''
                
inheritedInherited from:
                        \SugarWidget::$$widget_id\SugarWidgetField::$$widget_id\SugarWidgetReportField::$$widget_id
Details
- Type
- n/a
- Inherited_from
- \SugarWidget::$$widget_id
- Inherited_from
- \SugarWidgetField::$$widget_id
- Inherited_from
- \SugarWidgetReportField::$$widget_id
Methods


 SugarWidget(
           $layout_manager
          )
        
        :
          void
SugarWidget(
           $layout_manager
          )
        
        :
          void
inherited
Inherited from:
                    \SugarWidget::SugarWidget()\SugarWidgetField::SugarWidget()\SugarWidgetReportField::SugarWidget()
Parameters
| Name | Type | Description | 
|---|---|---|
| $layout_manager | 


 SugarWidgetField(
           $layout_manager
          )
        
        :
          void
SugarWidgetField(
           $layout_manager
          )
        
        :
          void
inherited
Inherited from:
                    \SugarWidgetField::SugarWidgetField()\SugarWidgetReportField::SugarWidgetField()
Parameters
| Name | Type | Description | 
|---|---|---|
| $layout_manager | 


 SugarWidgetReportField(
           $layout_manager
          )
        
        :
          void
SugarWidgetReportField(
           $layout_manager
          )
        
        :
          void
inherited
Inherited from:
                    \SugarWidgetReportField::SugarWidgetReportField()
Parameters
| Name | Type | Description | 
|---|---|---|
| $layout_manager | 


 _get_column_alias(
           $layout_def
          )
        
        :
          void
_get_column_alias(
           $layout_def
          )
        
        :
          void
inherited
Inherited from:
                    \SugarWidgetReportField::_get_column_alias()
Parameters
| Name | Type | Description | 
|---|---|---|
| $layout_def | 


 _get_column_select(
           $layout_def
          )
        
        :
          void
_get_column_select(
           $layout_def
          )
        
        :
          void
inherited
Inherited from:
                    \SugarWidgetReportField::_get_column_select()
Parameters
| Name | Type | Description | 
|---|---|---|
| $layout_def | 


 _get_column_select_special(
           $layout_def
          )
        
        :
          void
_get_column_select_special(
           $layout_def
          )
        
        :
          void
inherited
Inherited from:
                    \SugarWidgetReportField::_get_column_select_special()
Parameters
| Name | Type | Description | 
|---|---|---|
| $layout_def | 


 _get_list_value(
           $layout_def
          )
        
        :
          void
_get_list_value(
           $layout_def
          )
        
        :
          void
inherited
Inherited from:
                    \SugarWidgetField::_get_list_value()\SugarWidgetReportField::_get_list_value()
Parameters
| Name | Type | Description | 
|---|---|---|
| $layout_def | 


 display(
           $layout_def
          )
        
        :
          void
display(
           $layout_def
          )
        
        :
          void
inherited
Inherited from:
                    \SugarWidgetReportField::display()
Parameters
| Name | Type | Description | 
|---|---|---|
| $layout_def | 


 displayDetail(
           $layout_def
          )
        
        :
          void
displayDetail(
           $layout_def
          )
        
        :
          void
inherited
Inherited from:
                    \SugarWidgetField::displayDetail()\SugarWidgetReportField::displayDetail()
Parameters
| Name | Type | Description | 
|---|---|---|
| $layout_def | 


 displayDetailLabel(
           $layout_def
          )
        
        :
          void
displayDetailLabel(
           $layout_def
          )
        
        :
          void
inherited
Inherited from:
                    \SugarWidgetField::displayDetailLabel()\SugarWidgetReportField::displayDetailLabel()
Parameters
| Name | Type | Description | 
|---|---|---|
| $layout_def | 


 displayEditLabel(
           $layout_def
          )
        
        :
          void
displayEditLabel(
           $layout_def
          )
        
        :
          void
inherited
Inherited from:
                    \SugarWidgetField::displayEditLabel()\SugarWidgetReportField::displayEditLabel()
Parameters
| Name | Type | Description | 
|---|---|---|
| $layout_def | 


 displayHeaderCell(
           $layout_def
          )
        
        :
          void
displayHeaderCell(
           $layout_def
          )
        
        :
          void
inherited
Inherited from:
                    \SugarWidgetReportField::displayHeaderCell()
Parameters
| Name | Type | Description | 
|---|---|---|
| $layout_def | 


 displayHeaderCellPlain(
           $layout_def
          )
        
        :
          void
displayHeaderCellPlain(
           $layout_def
          )
        
        :
          void
inherited
Inherited from:
                    \SugarWidgetField::displayHeaderCellPlain()\SugarWidgetReportField::displayHeaderCellPlain()
Parameters
| Name | Type | Description | 
|---|---|---|
| $layout_def | 


 displaySearch(
           $layout_def
          )
        
        :
          void
displaySearch(
           $layout_def
          )
        
        :
          void
inherited
Inherited from:
                    \SugarWidgetField::displaySearch()\SugarWidgetReportField::displaySearch()
Parameters
| Name | Type | Description | 
|---|---|---|
| $layout_def | 


 displaySearchLabel(
           $layout_def
          )
        
        :
          void
displaySearchLabel(
           $layout_def
          )
        
        :
          void
inherited
Inherited from:
                    \SugarWidgetField::displaySearchLabel()\SugarWidgetReportField::displaySearchLabel()
Parameters
| Name | Type | Description | 
|---|---|---|
| $layout_def | 


 getParentBean(
          
          )
        
        :
          void
getParentBean(
          
          )
        
        :
          void
inherited
Inherited from:
                    \SugarWidget::getParentBean()\SugarWidgetField::getParentBean()\SugarWidgetReportField::getParentBean()


 getSubClass(
           $layout_def
          )
        
        :
          void
getSubClass(
           $layout_def
          )
        
        :
          void
inherited
Inherited from:
                    \SugarWidgetReportField::getSubClass()
Parameters
| Name | Type | Description | 
|---|---|---|
| $layout_def | 


 getTruncatedColumnAlias(
           $column_name
          )
        
        :
          void
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()
Parameters
| Name | Type | Description | 
|---|---|---|
| $column_name | 


 getWidgetId(
          
          )
        
        :
          \id
getWidgetId(
          
          )
        
        :
          \id
inherited
getSubpanelWidgetId This is a utility function to return a widget's unique id
Inherited from: \SugarWidget::getWidgetId()\SugarWidgetField::getWidgetId()\SugarWidgetReportField::getWidgetId()
Returns
| Type | Description | 
|---|---|
| \id | String label of the widget's unique id | 


 query(
           $layout_def
          )
        
        :
          void
query(
           $layout_def
          )
        
        :
          void
inherited
Inherited from:
                    \SugarWidgetReportField::query()
Parameters
| Name | Type | Description | 
|---|---|---|
| $layout_def | 


 queryFilter(
           $layout_def
          )
        
        :
          void
queryFilter(
           $layout_def
          )
        
        :
          void
inherited
Inherited from:
                    \SugarWidgetReportField::queryFilter()
Parameters
| Name | Type | Description | 
|---|---|---|
| $layout_def | 


 queryFilterEmpty(
           $layout_def
          )
        
        :
          void
queryFilterEmpty(
           $layout_def
          )
        
        :
          void
inherited
Inherited from:
                    \SugarWidgetReportField::queryFilterEmpty()
Parameters
| Name | Type | Description | 
|---|---|---|
| $layout_def | 


 queryFilterIs(
           $layout_def
          )
        
        :
          void
queryFilterIs(
           $layout_def
          )
        
        :
          void
inherited
Inherited from:
                    \SugarWidgetReportField::queryFilterIs()
Parameters
| Name | Type | Description | 
|---|---|---|
| $layout_def | 


 queryFilterNot_Empty(
           $layout_def
          )
        
        :
          void
queryFilterNot_Empty(
           $layout_def
          )
        
        :
          void
inherited
Inherited from:
                    \SugarWidgetReportField::queryFilterNot_Empty()
Parameters
| Name | Type | Description | 
|---|---|---|
| $layout_def | 


 queryFilteris_not(
           $layout_def
          )
        
        :
          void
queryFilteris_not(
           $layout_def
          )
        
        :
          void
inherited
Inherited from:
                    \SugarWidgetReportField::queryFilteris_not()
Parameters
| Name | Type | Description | 
|---|---|---|
| $layout_def | 


 queryGroupBy(
           $layout_def
          )
        
        :
          void
queryGroupBy(
           $layout_def
          )
        
        :
          void
inherited
Inherited from:
                    \SugarWidgetReportField::queryGroupBy()
Parameters
| Name | Type | Description | 
|---|---|---|
| $layout_def | 


 queryOrderBy(
           $layout_def
          )
        
        :
          void
queryOrderBy(
           $layout_def
          )
        
        :
          void
inherited
Inherited from:
                    \SugarWidgetReportField::queryOrderBy()
Parameters
| Name | Type | Description | 
|---|---|---|
| $layout_def | 


 querySelect(
           $layout_def
          )
        
        :
          void
querySelect(
           $layout_def
          )
        
        :
          void
inherited
Inherited from:
                    \SugarWidgetReportField::querySelect()
Parameters
| Name | Type | Description | 
|---|---|---|
| $layout_def | 


 setParentBean(
           $parent_bean
          )
        
        :
          void
setParentBean(
           $parent_bean
          )
        
        :
          void
inherited
Inherited from:
                    \SugarWidget::setParentBean()\SugarWidgetField::setParentBean()\SugarWidgetReportField::setParentBean()
Parameters
| Name | Type | Description | 
|---|---|---|
| $parent_bean | 


 setWidgetId(
          \id $id
              =
              ''
          )
        
        :
          void
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()
Parameters
| Name | Type | Description | 
|---|---|---|
| $id | \id | String value to set the widget's unique id | 

 Classes
                          Classes
                      