include/generic/SugarWidgets/SugarWidgetSubPanelTopButton.php
inherited
Classes
\SugarWidgetSubPanelTopButton
Generic Sugar widget
- Parent(s)
- \SugarWidget
- Children
- \SugarWidgetSubPanelEditProjectTasksButton
- \SugarWidgetSubPanelTopArchiveEmailButton
- \SugarWidgetSubPanelTopMessage
- \SugarWidgetSubPanelTopButtonQuickCreate
- \SugarWidgetSubPanelTopSelectButton
- \SugarWidgetSubPanelTopComposeEmailButton
- \SugarWidgetSubPanelTopSummaryButton
- \SugarWidgetSubPanelTopCreateCampaignLogEntryButton
Properties
$access_key= ''
- Type
- n/a
$acl= ''
- Type
- n/a
$additional_form_fields= ''
- Type
- n/a
$form_value= ''
- Type
- n/a
$layout_manager= 'null'
nullDetails- Type
- n/a
- Inherited_from
- \SugarWidget::$$layout_manager
$module= ''
- Type
- n/a
$parent_bean= ''
- Type
- n/a
- Inherited_from
- \SugarWidget::$$parent_bean
$title= ''
- Type
- n/a
$widget_id= ''
- Type
- n/a
- Inherited_from
- \SugarWidget::$$widget_id
Methods
SugarWidget(
$layout_manager
)
:
void| Name | Type | Description |
|---|---|---|
| $layout_manager |
SugarWidgetSubPanelTopButton(
$module
=
'', $title
=
'', $access_key
=
'', $form_value
=
''
)
:
voidTake the keys for the strings and look them up. Module is literal, the rest are label keys
| Name | Type | Description |
|---|---|---|
| $module | ||
| $title | ||
| $access_key | ||
| $form_value |
_create_json_encoded_popup_request(
$popup_request_data
)
:
voidReturns a string that is the JSON encoded version of the popup request.
Perhaps this function should be moved to a more globally accessible location?
| Name | Type | Description |
|---|---|---|
| $popup_request_data |
_get_form(
$defines, $additionalFormFields
=
null, $asUrl
=
false
)
:
void| Name | Type | Description |
|---|---|---|
| $defines | ||
| $additionalFormFields | ||
| $asUrl |
display(
$defines, $additionalFormFields
=
null, $nonbutton
=
false
)
:
voidThis default function is used to create the HTML for a simple button
| Name | Type | Description |
|---|---|---|
| $defines | ||
| $additionalFormFields | ||
| $nonbutton |
getTruncatedColumnAlias(
$column_name
)
:
voidgetTruncatedColumnAlias 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()| Name | Type | Description |
|---|---|---|
| $column_name |
getWidgetId(
$buttonSuffix
=
true
)
:
\idgetSubpanelWidgetId This is a utility function to return a widget's unique id
| Name | Type | Description |
|---|---|---|
| $buttonSuffix |
| Type | Description |
|---|---|
| \id | String label of the widget's unique id |
get_subpanel_relationship_name(
mixed $defines
)
:
voidget_subpanel_relationship_name Get the relationship name based on the subapnel definition
| Name | Type | Description |
|---|---|---|
| $defines | mixed | The subpanel definition |
setParentBean(
$parent_bean
)
:
void| Name | Type | Description |
|---|---|---|
| $parent_bean |
setWidgetId(
\id $id
=
''
)
:
voidsetSubpanelWidgetId This is a utility function to set the id for a widget
Inherited from: \SugarWidget::setWidgetId()| Name | Type | Description |
|---|---|---|
| $id | \id | String value to set the widget's unique id |