modules/DynamicFields/templates/Fields/TemplateDecimal.php

Show:

inherited

Classes
- \TemplateDecimal

Table of Contents

\TemplateDecimal
jump to top

Package:

Parent(s): \TemplateFloat < \TemplateRange < \TemplateText < \TemplateField

Properties


                 $audited= '0'

inheritedInherited from: \TemplateField::$$audited \TemplateText::$$audited \TemplateRange::$$audited \TemplateFloat::$$audited

Default value0Details

Type: n/a
Inherited_from: \TemplateField::$$audited
Inherited_from: \TemplateText::$$audited
Inherited_from: \TemplateRange::$$audited
Inherited_from: \TemplateFloat::$$audited


                 $bean= ''

inheritedInherited from: \TemplateField::$$bean \TemplateText::$$bean \TemplateRange::$$bean \TemplateFloat::$$bean

Details

Type: n/a
Inherited_from: \TemplateField::$$bean
Inherited_from: \TemplateText::$$bean
Inherited_from: \TemplateRange::$$bean
Inherited_from: \TemplateFloat::$$bean


                 $comment= ''''

inheritedInherited from: \TemplateField::$$comment \TemplateText::$$comment \TemplateRange::$$comment \TemplateFloat::$$comment

Default value''Details

Type: n/a
Inherited_from: \TemplateField::$$comment
Inherited_from: \TemplateText::$$comment
Inherited_from: \TemplateRange::$$comment
Inherited_from: \TemplateFloat::$$comment


                 $decode_from_request_fields_map= 'array('formula', 'dependency')'

inheritedInherited from: \TemplateField::$$decode_from_request_fields_map \TemplateText::$$decode_from_request_fields_map \TemplateRange::$$decode_from_request_fields_map \TemplateFloat::$$decode_from_request_fields_map

Default valuearray('formula', 'dependency')Details

Type: n/a
Inherited_from: \TemplateField::$$decode_from_request_fields_map
Inherited_from: \TemplateText::$$decode_from_request_fields_map
Inherited_from: \TemplateRange::$$decode_from_request_fields_map
Inherited_from: \TemplateFloat::$$decode_from_request_fields_map


                 $default= 'null'

Default valuenullDetails

Type: n/a


                 $default_value= 'null'

Default valuenullDetails

Type: n/a


                 $duplicate_merge= '0'

inheritedInherited from: \TemplateField::$$duplicate_merge \TemplateText::$$duplicate_merge \TemplateRange::$$duplicate_merge \TemplateFloat::$$duplicate_merge

Default value0Details

Type: n/a
Inherited_from: \TemplateField::$$duplicate_merge
Inherited_from: \TemplateText::$$duplicate_merge
Inherited_from: \TemplateRange::$$duplicate_merge
Inherited_from: \TemplateFloat::$$duplicate_merge


                 $ext1= ''''

inheritedInherited from: \TemplateField::$$ext1 \TemplateText::$$ext1 \TemplateRange::$$ext1 \TemplateFloat::$$ext1

Default value''Details

Type: n/a
Inherited_from: \TemplateField::$$ext1
Inherited_from: \TemplateText::$$ext1
Inherited_from: \TemplateRange::$$ext1
Inherited_from: \TemplateFloat::$$ext1


                 $ext2= ''''

inheritedInherited from: \TemplateField::$$ext2 \TemplateText::$$ext2 \TemplateRange::$$ext2 \TemplateFloat::$$ext2

Default value''Details

Type: n/a
Inherited_from: \TemplateField::$$ext2
Inherited_from: \TemplateText::$$ext2
Inherited_from: \TemplateRange::$$ext2
Inherited_from: \TemplateFloat::$$ext2


                 $ext3= ''''

inheritedInherited from: \TemplateField::$$ext3 \TemplateText::$$ext3 \TemplateRange::$$ext3 \TemplateFloat::$$ext3

Default value''Details

Type: n/a
Inherited_from: \TemplateField::$$ext3
Inherited_from: \TemplateText::$$ext3
Inherited_from: \TemplateRange::$$ext3
Inherited_from: \TemplateFloat::$$ext3


                 $ext4= ''''

inheritedInherited from: \TemplateField::$$ext4 \TemplateText::$$ext4 \TemplateRange::$$ext4 \TemplateFloat::$$ext4

Default value''Details

Type: n/a
Inherited_from: \TemplateField::$$ext4
Inherited_from: \TemplateText::$$ext4
Inherited_from: \TemplateRange::$$ext4
Inherited_from: \TemplateFloat::$$ext4


                 $formula= ''''

inheritedInherited from: \TemplateField::$$formula \TemplateText::$$formula \TemplateRange::$$formula \TemplateFloat::$$formula

Default value''Details

Type: n/a
Inherited_from: \TemplateField::$$formula
Inherited_from: \TemplateText::$$formula
Inherited_from: \TemplateRange::$$formula
Inherited_from: \TemplateFloat::$$formula


                 $help= ''''

inheritedInherited from: \TemplateField::$$help \TemplateText::$$help \TemplateRange::$$help \TemplateFloat::$$help

Default value''Details

Type: n/a
Inherited_from: \TemplateField::$$help
Inherited_from: \TemplateText::$$help
Inherited_from: \TemplateRange::$$help
Inherited_from: \TemplateFloat::$$help


                 $id= ''''

inheritedInherited from: \TemplateField::$$id \TemplateText::$$id \TemplateRange::$$id \TemplateFloat::$$id

Default value''Details

Type: n/a
Inherited_from: \TemplateField::$$id
Inherited_from: \TemplateText::$$id
Inherited_from: \TemplateRange::$$id
Inherited_from: \TemplateFloat::$$id


                 $importable= ''true''

inheritedInherited from: \TemplateField::$$importable \TemplateText::$$importable \TemplateRange::$$importable \TemplateFloat::$$importable

Default value'true'Details

Type: n/a
Inherited_from: \TemplateField::$$importable
Inherited_from: \TemplateText::$$importable
Inherited_from: \TemplateRange::$$importable
Inherited_from: \TemplateFloat::$$importable


                 $label_value= ''''

inheritedInherited from: \TemplateField::$$label_value \TemplateText::$$label_value \TemplateRange::$$label_value \TemplateFloat::$$label_value

Default value''Details

Type: n/a
Inherited_from: \TemplateField::$$label_value
Inherited_from: \TemplateText::$$label_value
Inherited_from: \TemplateRange::$$label_value
Inherited_from: \TemplateFloat::$$label_value


                 $len= ''18''

inheritedInherited from: \TemplateFloat::$$len

Default value'18'Details

Type: n/a
Inherited_from: \TemplateFloat::$$len


                 $massupdate= '0'

inheritedInherited from: \TemplateField::$$massupdate \TemplateText::$$massupdate \TemplateRange::$$massupdate \TemplateFloat::$$massupdate

Default value0Details

Type: n/a
Inherited_from: \TemplateField::$$massupdate
Inherited_from: \TemplateText::$$massupdate
Inherited_from: \TemplateRange::$$massupdate
Inherited_from: \TemplateFloat::$$massupdate


                 $name= ''''

inheritedInherited from: \TemplateField::$$name \TemplateText::$$name \TemplateRange::$$name \TemplateFloat::$$name

Default value''Details

Type: n/a
Inherited_from: \TemplateField::$$name
Inherited_from: \TemplateText::$$name
Inherited_from: \TemplateRange::$$name
Inherited_from: \TemplateFloat::$$name


                 $new_field_definition= ''

inheritedInherited from: \TemplateField::$$new_field_definition \TemplateText::$$new_field_definition \TemplateRange::$$new_field_definition \TemplateFloat::$$new_field_definition

Details

Type: n/a
Inherited_from: \TemplateField::$$new_field_definition
Inherited_from: \TemplateText::$$new_field_definition
Inherited_from: \TemplateRange::$$new_field_definition
Inherited_from: \TemplateFloat::$$new_field_definition


                 $precision= ''8''

inheritedInherited from: \TemplateFloat::$$precision

Default value'8'Details

Type: n/a
Inherited_from: \TemplateFloat::$$precision


                 $reportable= 'true'

inheritedInherited from: \TemplateField::$$reportable \TemplateText::$$reportable \TemplateRange::$$reportable \TemplateFloat::$$reportable

Default valuetrueDetails

Type: n/a
Inherited_from: \TemplateField::$$reportable
Inherited_from: \TemplateText::$$reportable
Inherited_from: \TemplateRange::$$reportable
Inherited_from: \TemplateFloat::$$reportable


                 $required= 'false'

inheritedInherited from: \TemplateField::$$required \TemplateText::$$required \TemplateRange::$$required \TemplateFloat::$$required

Default valuefalseDetails

Type: n/a
Inherited_from: \TemplateField::$$required
Inherited_from: \TemplateText::$$required
Inherited_from: \TemplateRange::$$required
Inherited_from: \TemplateFloat::$$required


                 $size= ''20''

inheritedInherited from: \TemplateField::$$size \TemplateText::$$size \TemplateRange::$$size \TemplateFloat::$$size

Default value'20'Details

Type: n/a
Inherited_from: \TemplateField::$$size
Inherited_from: \TemplateText::$$size
Inherited_from: \TemplateRange::$$size
Inherited_from: \TemplateFloat::$$size


                 $supports_unified_search= 'true'

inheritedInherited from: \TemplateText::$$supports_unified_search \TemplateRange::$$supports_unified_search \TemplateFloat::$$supports_unified_search

Default valuetrueDetails

Type: n/a
Inherited_from: \TemplateText::$$supports_unified_search
Inherited_from: \TemplateRange::$$supports_unified_search
Inherited_from: \TemplateFloat::$$supports_unified_search


                 $type= ''decimal''

Default value'decimal'Details

Type: n/a


                 $unified_search= '0'

inheritedInherited from: \TemplateField::$$unified_search \TemplateText::$$unified_search \TemplateRange::$$unified_search \TemplateFloat::$$unified_search

Default value0Details

Type: n/a
Inherited_from: \TemplateField::$$unified_search
Inherited_from: \TemplateText::$$unified_search
Inherited_from: \TemplateRange::$$unified_search
Inherited_from: \TemplateFloat::$$unified_search


                 $vardef_map= 'array(
		'name'=>'name',
		'label'=>'vname',
	// bug 15801 - need to ALWAYS keep default and default_value consistent as some methods/classes use one, some use another...
		'default_value'=>'default',
		'default'=>'default_value',
		'display_default'=>'default_value',
	//		'default_value'=>'default_value',
	//		'default'=>'default_value',
		'len'=>'len',
		'required'=>'required',
		'type'=>'type',
		'audited'=>'audited',
		'massupdate'=>'massupdate',
		'options'=>'ext1',
		'help'=>'help',
	    'comments'=>'comment',
	    'importable'=>'importable',
		'duplicate_merge'=>'duplicate_merge',
		'duplicate_merge_dom_value'=>'duplicate_merge_dom_value', //bug #14897
		'merge_filter'=>'merge_filter',
		'reportable' => 'reportable',
		'min'=>'ext1',
		'max'=>'ext2',
		'ext2'=>'ext2',
		'ext4'=>'ext4',
	//'disable_num_format'=>'ext3',
	    'ext3'=>'ext3',
		'label_value'=>'label_value',
		'unified_search'=>'unified_search',
        'full_text_search'=>'full_text_search',
	)'

inheritedInherited from: \TemplateField::$$vardef_map \TemplateText::$$vardef_map \TemplateRange::$$vardef_map \TemplateFloat::$$vardef_map

Default value

array(
		'name'=>'name',
		'label'=>'vname',
	// bug 15801 - need to ALWAYS keep default and default_value consistent as some methods/classes use one, some use another...
		'default_value'=>'default',
		'default'=>'default_value',
		'display_default'=>'default_value',
	//		'default_value'=>'default_value',
	//		'default'=>'default_value',
		'len'=>'len',
		'required'=>'required',
		'type'=>'type',
		'audited'=>'audited',
		'massupdate'=>'massupdate',
		'options'=>'ext1',
		'help'=>'help',
	    'comments'=>'comment',
	    'importable'=>'importable',
		'duplicate_merge'=>'duplicate_merge',
		'duplicate_merge_dom_value'=>'duplicate_merge_dom_value', //bug #14897
		'merge_filter'=>'merge_filter',
		'reportable' => 'reportable',
		'min'=>'ext1',
		'max'=>'ext2',
		'ext2'=>'ext2',
		'ext4'=>'ext4',
	//'disable_num_format'=>'ext3',
	    'ext3'=>'ext3',
		'label_value'=>'label_value',
		'unified_search'=>'unified_search',
        'full_text_search'=>'full_text_search',
	)

Details

Type: n/a
Inherited_from: \TemplateField::$$vardef_map
Inherited_from: \TemplateText::$$vardef_map
Inherited_from: \TemplateRange::$$vardef_map
Inherited_from: \TemplateFloat::$$vardef_map


                 $view= ''edit''

inheritedInherited from: \TemplateField::$$view \TemplateText::$$view \TemplateRange::$$view \TemplateFloat::$$view

Default value'edit'Details

Type: n/a
Inherited_from: \TemplateField::$$view
Inherited_from: \TemplateText::$$view
Inherited_from: \TemplateRange::$$view
Inherited_from: \TemplateFloat::$$view


                 $vname= ''''

inheritedInherited from: \TemplateField::$$vname \TemplateText::$$vname \TemplateRange::$$vname \TemplateFloat::$$vname

Default value''Details

Type: n/a
Inherited_from: \TemplateField::$$vname
Inherited_from: \TemplateText::$$vname
Inherited_from: \TemplateRange::$$vname
Inherited_from: \TemplateFloat::$$vname

Methods

TemplateDecimal(
          
          )
        
        :
          void

TemplateFloat(
          
          )
        
        :
          void

inherited

Inherited from: \TemplateFloat::TemplateFloat()

__construct(
          
          )
        
        :
          void

inherited

__construct

Inherited from: \TemplateRange::__construct()\TemplateFloat::__construct()

Constructor for class. This constructor ensures that TemplateRanage instances have the enable_range_search vardef value.

applyVardefRules(
          
          )
        
        :
          void

inherited

Inherited from: \TemplateField::applyVardefRules()\TemplateText::applyVardefRules()\TemplateRange::applyVardefRules()\TemplateFloat::applyVardefRules()

convertBooleanValue(
           $value
          )
        
        :
          void

inherited

Inherited from: \TemplateField::convertBooleanValue()\TemplateText::convertBooleanValue()\TemplateRange::convertBooleanValue()\TemplateFloat::convertBooleanValue()

Parameters

Name	Type	Description
$value

delete(
           $df
          )
        
        :
          void

inherited

Inherited from: \TemplateField::delete()\TemplateText::delete()\TemplateRange::delete()\TemplateFloat::delete()

Parameters

Name	Type	Description
$df

getDupMergeDomValue(
          
          )
        
        :
          int

inherited

duplicate_merge_dom_value drives the dropdown in the studio editor. This dropdown drives two fields though, duplicate_merge and merge_filter. When duplicate_merge_dom_value is not set, we need to derive it from the values of those two fields. Also, when studio sends this value down to be read in PopulateFromPost, it is set to duplicate_merge rather than duplicate_merge_dom_value, so we must check if duplicate_merge is a number rather than a string as well.

Inherited from: \TemplateField::getDupMergeDomValue()\TemplateText::getDupMergeDomValue()\TemplateRange::getDupMergeDomValue()\TemplateFloat::getDupMergeDomValue()

Returns

Type	Description
int

get_additional_defs(
          
          )
        
        :
          void

inherited

Inherited from: \TemplateField::get_additional_defs()\TemplateText::get_additional_defs()\TemplateRange::get_additional_defs()\TemplateFloat::get_additional_defs()

get_db_add_alter_table(
           $table
          )
        
        :
          void

inherited

Oracle Support: do not set required constraint if no default value is supplied.

Inherited from: \TemplateField::get_db_add_alter_table()\TemplateText::get_db_add_alter_table()\TemplateRange::get_db_add_alter_table()\TemplateFloat::get_db_add_alter_table()

In this case the default value will be handled by the application/sugarbean.

Parameters

Name	Type	Description
$table

get_db_default(
           $modify
              =
              false
          )
        
        :
          void

inherited

Inherited from: \TemplateField::get_db_default()\TemplateText::get_db_default()\TemplateRange::get_db_default()\TemplateFloat::get_db_default()

Parameters

Name	Type	Description
$modify

get_db_delete_alter_table(
           $table
          )
        
        :
          void

inherited

Inherited from: \TemplateField::get_db_delete_alter_table()\TemplateText::get_db_delete_alter_table()\TemplateRange::get_db_delete_alter_table()\TemplateFloat::get_db_delete_alter_table()

Parameters

Name	Type	Description
$table

get_db_modify_alter_table(
           $table
          )
        
        :
          void

inherited

mysql requires the datatype caluse in the alter statment.it will be no-op anyway.

Inherited from: \TemplateField::get_db_modify_alter_table()\TemplateText::get_db_modify_alter_table()\TemplateRange::get_db_modify_alter_table()\TemplateFloat::get_db_modify_alter_table()

Parameters

Name	Type	Description
$table

get_db_required(
           $modify
              =
              false
          )
        
        :
          void

inherited

Inherited from: \TemplateField::get_db_required()\TemplateText::get_db_required()\TemplateRange::get_db_required()\TemplateFloat::get_db_required()

Parameters

Name	Type	Description
$modify

get_db_type(
          
          )
        
        :
          void

get_dup_merge_def(
           $def
          )
        
        :
          void

inherited

Inherited from: \TemplateField::get_dup_merge_def()\TemplateText::get_dup_merge_def()\TemplateRange::get_dup_merge_def()\TemplateFloat::get_dup_merge_def()

Parameters

Name	Type	Description
$def

get_field_def(
          
          )
        
        :
          void

inherited

get_field_def

Inherited from: \TemplateFloat::get_field_def()

get_field_name(
          String $module, String $name
          )
        
        :
          \The

inherited

get_field_name

Inherited from: \TemplateField::get_field_name()\TemplateText::get_field_name()\TemplateRange::get_field_name()\TemplateFloat::get_field_name()

This is a helper function to return a field's proper name. It checks to see if an instance of the module can be created and then attempts to retrieve the field's name based on the name lookup skey supplied to the method.

Parameters

Name	Type	Description
$module	String	The name of the module
$name	String	The field name key

Returns

Type	Description
\The	field name for the module

get_html(
          
          )
        
        :
          void

inherited

Inherited from: \TemplateField::get_html()\TemplateText::get_html()\TemplateRange::get_html()\TemplateFloat::get_html()

get_html_detail(
          
          )
        
        :
          void

inherited

Inherited from: \TemplateField::get_html_detail()\TemplateText::get_html_detail()\TemplateRange::get_html_detail()\TemplateFloat::get_html_detail()

get_html_edit(
          
          )
        
        :
          void

inherited

Inherited from: \TemplateField::get_html_edit()\TemplateText::get_html_edit()\TemplateRange::get_html_edit()\TemplateFloat::get_html_edit()

get_html_label(
          
          )
        
        :
          void

inherited

Inherited from: \TemplateField::get_html_label()\TemplateText::get_html_label()\TemplateRange::get_html_label()\TemplateFloat::get_html_label()

get_html_list(
          
          )
        
        :
          void

inherited

Inherited from: \TemplateField::get_html_list()\TemplateText::get_html_list()\TemplateRange::get_html_list()\TemplateFloat::get_html_list()

get_html_search(
          
          )
        
        :
          void

inherited

Inherited from: \TemplateField::get_html_search()\TemplateText::get_html_search()\TemplateRange::get_html_search()\TemplateFloat::get_html_search()

get_xtpl(
           $bean
              =
              false
          )
        
        :
          void

inherited

Inherited from: \TemplateField::get_xtpl()\TemplateText::get_xtpl()\TemplateRange::get_xtpl()\TemplateFloat::get_xtpl()

Parameters

Name	Type	Description
$bean

get_xtpl_detail(
          
          )
        
        :
          void

inherited

Inherited from: \TemplateText::get_xtpl_detail()\TemplateRange::get_xtpl_detail()\TemplateFloat::get_xtpl_detail()

get_xtpl_edit(
          
          )
        
        :
          void

inherited

Inherited from: \TemplateText::get_xtpl_edit()\TemplateRange::get_xtpl_edit()\TemplateFloat::get_xtpl_edit()

get_xtpl_list(
          
          )
        
        :
          void

inherited

Inherited from: \TemplateField::get_xtpl_list()\TemplateText::get_xtpl_list()\TemplateRange::get_xtpl_list()\TemplateFloat::get_xtpl_list()

get_xtpl_search(
          
          )
        
        :
          void

inherited

Inherited from: \TemplateText::get_xtpl_search()\TemplateRange::get_xtpl_search()\TemplateFloat::get_xtpl_search()

is_required(
          
          )
        
        :
          void

inherited

Inherited from: \TemplateField::is_required()\TemplateText::is_required()\TemplateRange::is_required()\TemplateFloat::is_required()

populateFromPost(
          
          )
        
        :
          void

inherited

populateFromPost

Inherited from: \TemplateRange::populateFromPost()\TemplateFloat::populateFromPost()

Details

See: \parent::populateFromPost

populateFromRow(
          \$row $row
              =
              array()
          )
        
        :
          void

inherited

populateFromRow This function supports setting the values of all TemplateField instances.

Inherited from: \TemplateField::populateFromRow()\TemplateText::populateFromRow()\TemplateRange::populateFromRow()\TemplateFloat::populateFromRow()

Parameters

Name	Type	Description
$row	\$row	The Array key/value pairs from fields_meta_data table

prepare(
          
          )
        
        :
          void

inherited

Inherited from: \TemplateField::prepare()\TemplateText::prepare()\TemplateRange::prepare()\TemplateFloat::prepare()

repairCustomSearchFields(
           $vardefs,  $module,  $package
              =
              ''
          )
        
        :
          void

staticinherited

Inherited from: \TemplateRange::repairCustomSearchFields()\TemplateFloat::repairCustomSearchFields()

Parameters

Name	Type	Description
$vardefs
$module
$package

save(
          \DynamicField $df
          )
        
        :
          void

inherited

save

Inherited from: \TemplateField::save()\TemplateText::save()\TemplateRange::save()\TemplateFloat::save()

This function says the field template by calling the DynamicField addFieldObject function. It then checks to see if updates are needed for the SearchFields.php file. In the event that the unified_search member variable is set to true, a search field definition is updated/created to the SearchFields.php file.

Parameters

Name	Type	Description
$df	\DynamicField

set(
           $values
          )
        
        :
          void

inherited

Inherited from: \TemplateField::set()\TemplateText::set()\TemplateRange::set()\TemplateFloat::set()

Parameters

Name	Type	Description
$values

modules/DynamicFields/templates/Fields/TemplateDecimal.php

\TemplateDecimaljump to top

Properties

Methods

\TemplateDecimal
jump to top