modules/DynamicFields/templates/Fields/TemplateField.php

Show:

inherited

Classes
- \TemplateField

Table of Contents

\TemplateField
jump to top

Package:

Children: \TemplateHTML; \TemplateAddress; \TemplateId; \TemplateText; \TemplateEncrypt; \TemplateBoolean

Properties


                 $audited= '0'

Default value0Details

Type: n/a


                 $bean= ''

Details

Type: n/a


                 $comment= ''''

Default value''Details

Type: n/a


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

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

Type: n/a


                 $default= 'null'

Default valuenullDetails

Type: n/a


                 $default_value= 'null'

Default valuenullDetails

Type: n/a


                 $duplicate_merge= '0'

Default value0Details

Type: n/a


                 $ext1= ''''

Default value''Details

Type: n/a


                 $ext2= ''''

Default value''Details

Type: n/a


                 $ext3= ''''

Default value''Details

Type: n/a


                 $ext4= ''''

Default value''Details

Type: n/a


                 $formula= ''''

Default value''Details

Type: n/a


                 $help= ''''

Default value''Details

Type: n/a


                 $id= ''''

Default value''Details

Type: n/a


                 $importable= ''true''

Default value'true'Details

Type: n/a


                 $label_value= ''''

Default value''Details

Type: n/a


                 $len= ''255''

Default value'255'Details

Type: n/a


                 $massupdate= '0'

Default value0Details

Type: n/a


                 $name= ''''

Default value''Details

Type: n/a


                 $new_field_definition= ''

Details

Type: n/a


                 $reportable= 'true'

Default valuetrueDetails

Type: n/a


                 $required= 'false'

Default valuefalseDetails

Type: n/a


                 $size= ''20''

Default value'20'Details

Type: n/a


                 $supports_unified_search= 'false'

Default valuefalseDetails

Type: n/a


                 $type= ''varchar''

Default value'varchar'Details

Type: n/a


                 $unified_search= '0'

Default value0Details

Type: n/a


                 $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',
		'ext2'=>'ext2',
		'ext4'=>'ext4',
	    'ext3'=>'ext3',
		'label_value'=>'label_value',
		'unified_search'=>'unified_search',
        'full_text_search'=>'full_text_search',
		'calculated' => 'calculated',
        'formula' => 'formula',
        'enforced' => 'enforced',
        'dependency' => 'dependency',
	)'

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',
		'ext2'=>'ext2',
		'ext4'=>'ext4',
	    'ext3'=>'ext3',
		'label_value'=>'label_value',
		'unified_search'=>'unified_search',
        'full_text_search'=>'full_text_search',
		'calculated' => 'calculated',
        'formula' => 'formula',
        'enforced' => 'enforced',
        'dependency' => 'dependency',
	)

Details

Type: n/a


                 $view= ''edit''

Default value'edit'Details

Type: n/a


                 $vname= ''''

Default value''Details

Type: n/a

Methods

applyVardefRules(
          
          )
        
        :
          void

convertBooleanValue(
           $value
          )
        
        :
          void

Parameters

Name	Type	Description
$value

delete(
           $df
          )
        
        :
          void

Parameters

Name	Type	Description
$df

getDupMergeDomValue(
          
          )
        
        :
          int

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.

Returns

Type	Description
int

get_additional_defs(
          
          )
        
        :
          void

get_db_add_alter_table(
           $table
          )
        
        :
          void

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

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

Parameters

Name	Type	Description
$table

get_db_default(
           $modify
              =
              false
          )
        
        :
          void

Parameters

Name	Type	Description
$modify

get_db_delete_alter_table(
           $table
          )
        
        :
          void

Parameters

Name	Type	Description
$table

get_db_modify_alter_table(
           $table
          )
        
        :
          void

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

Parameters

Name	Type	Description
$table

get_db_required(
           $modify
              =
              false
          )
        
        :
          void

Parameters

Name	Type	Description
$modify

get_db_type(
          
          )
        
        :
          void

get_dup_merge_def(
           $def
          )
        
        :
          void

Parameters

Name	Type	Description
$def

get_field_def(
          
          )
        
        :
          void

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

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

get_html_detail(
          
          )
        
        :
          void

get_html_edit(
          
          )
        
        :
          void

get_html_label(
          
          )
        
        :
          void

get_html_list(
          
          )
        
        :
          void

get_html_search(
          
          )
        
        :
          void

get_xtpl(
           $bean
              =
              false
          )
        
        :
          void

Parameters

Name	Type	Description
$bean

get_xtpl_detail(
          
          )
        
        :
          void

get_xtpl_edit(
          
          )
        
        :
          void

get_xtpl_list(
          
          )
        
        :
          void

get_xtpl_search(
          
          )
        
        :
          void

is_required(
          
          )
        
        :
          void

populateFromPost(
          
          )
        
        :
          void

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

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

Parameters

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

prepare(
          
          )
        
        :
          void

save(
          \DynamicField $df
          )
        
        :
          void

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

Parameters

Name	Type	Description
$values

modules/DynamicFields/templates/Fields/TemplateField.php

\TemplateFieldjump to top

Properties

Methods

\TemplateField
jump to top