include/generic/SugarWidgets/SugarWidgetSubPanelTopArchiveEmailButton.php

Show: inherited
Table of Contents

\SugarWidgetSubPanelTopArchiveEmailButton

Package:

Generic Sugar widget

Parent(s)
\SugarWidgetSubPanelTopButton < \SugarWidget

Properties

Propertypublic  $access_key= ''
Details
Type
n/a
Inherited_from
\SugarWidgetSubPanelTopButton::$$access_key  
Propertypublic  $acl= ''
inheritedInherited from: \SugarWidgetSubPanelTopButton::$$acl
Details
Type
n/a
Inherited_from
\SugarWidgetSubPanelTopButton::$$acl  
Propertypublic  $additional_form_fields= ''
Details
Type
n/a
Inherited_from
\SugarWidgetSubPanelTopButton::$$additional_form_fields  
Propertypublic  $form_value= ''
Details
Type
n/a
Inherited_from
\SugarWidgetSubPanelTopButton::$$form_value  
Propertypublic  $layout_manager= 'null'
Default valuenullDetails
Type
n/a
Inherited_from
\SugarWidget::$$layout_manager  
Inherited_from
\SugarWidgetSubPanelTopButton::$$layout_manager  
Propertypublic  $module= ''
inheritedInherited from: \SugarWidgetSubPanelTopButton::$$module
Details
Type
n/a
Inherited_from
\SugarWidgetSubPanelTopButton::$$module  
Propertyprotected  $parent_bean= ''
Details
Type
n/a
Inherited_from
\SugarWidget::$$parent_bean  
Inherited_from
\SugarWidgetSubPanelTopButton::$$parent_bean  
Propertypublic  $title= ''
inheritedInherited from: \SugarWidgetSubPanelTopButton::$$title
Details
Type
n/a
Inherited_from
\SugarWidgetSubPanelTopButton::$$title  
Propertypublic  $widget_id= ''
Details
Type
n/a
Inherited_from
\SugarWidget::$$widget_id  
Inherited_from
\SugarWidgetSubPanelTopButton::$$widget_id  

Methods

methodpublicSugarWidget(  $layout_manager ) : void
Parameters
Name Type Description
$layout_manager
methodpublicSugarWidgetSubPanelTopButton(  $module = '',  $title = '',  $access_key = '',  $form_value = '' ) : void
inherited

Take the keys for the strings and look them up. Module is literal, the rest are label keys

Inherited from: \SugarWidgetSubPanelTopButton::SugarWidgetSubPanelTopButton()
Parameters
Name Type Description
$module
$title
$access_key
$form_value
methodpublic_create_json_encoded_popup_request(  $popup_request_data ) : void
inherited

Returns a string that is the JSON encoded version of the popup request.

Inherited from: \SugarWidgetSubPanelTopButton::_create_json_encoded_popup_request()

Perhaps this function should be moved to a more globally accessible location?

Parameters
Name Type Description
$popup_request_data
methodpublic_get_form(  $defines,  $additionalFormFields = null,  $asUrl = false ) : void
inherited

Inherited from: \SugarWidgetSubPanelTopButton::_get_form()
Parameters
Name Type Description
$defines
$additionalFormFields
$asUrl
methodpublicdisplay(  $defines ) : void

This default function is used to create the HTML for a simple button

Parameters
Name Type Description
$defines
methodpublicgetDisplayName( ) : void
methodpublicgetParentBean( ) : void
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()\SugarWidgetSubPanelTopButton::getTruncatedColumnAlias()
Parameters
Name Type Description
$column_name
methodpublicgetWidgetId(  $buttonSuffix = true ) : \id
inherited

getSubpanelWidgetId This is a utility function to return a widget's unique id

Inherited from: \SugarWidgetSubPanelTopButton::getWidgetId()
Parameters
Name Type Description
$buttonSuffix
Returns
Type Description
\id String label of the widget's unique id
methodpublicget_subpanel_relationship_name( mixed $defines ) : void
inherited

get_subpanel_relationship_name Get the relationship name based on the subapnel definition

Inherited from: \SugarWidgetSubPanelTopButton::get_subpanel_relationship_name()
Parameters
Name Type Description
$defines mixed

The subpanel definition

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()\SugarWidgetSubPanelTopButton::setWidgetId()
Parameters
Name Type Description
$id \id

String value to set the widget's unique id

Documentation was generated by DocBlox 0.18.1.