modules/DynamicFields/templates/Fields/TemplateText.php

Show:

inherited

Classes
- \TemplateText

Table of Contents

\TemplateText
jump to top

Package:

Parent(s): \TemplateField
Children: \TemplateRange; \TemplatePhone; \TemplateTextArea; \TemplateImage; \TemplateEmail; \TemplateEnum; \TemplateRelatedTextField; \TemplateParentType; \TemplateURL

Properties


                 $audited= '0'

inheritedInherited from: \TemplateField::$$audited

Default value0Details

Type: n/a
Inherited_from: \TemplateField::$$audited


                 $bean= ''

inheritedInherited from: \TemplateField::$$bean

Details

Type: n/a
Inherited_from: \TemplateField::$$bean


                 $comment= ''''

inheritedInherited from: \TemplateField::$$comment

Default value''Details

Type: n/a
Inherited_from: \TemplateField::$$comment


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

inheritedInherited from: \TemplateField::$$decode_from_request_fields_map

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

Type: n/a
Inherited_from: \TemplateField::$$decode_from_request_fields_map


                 $default= 'null'

inheritedInherited from: \TemplateField::$$default

Default valuenullDetails

Type: n/a
Inherited_from: \TemplateField::$$default


                 $default_value= 'null'

inheritedInherited from: \TemplateField::$$default_value

Default valuenullDetails

Type: n/a
Inherited_from: \TemplateField::$$default_value


                 $duplicate_merge= '0'

inheritedInherited from: \TemplateField::$$duplicate_merge

Default value0Details

Type: n/a
Inherited_from: \TemplateField::$$duplicate_merge


                 $ext1= ''''

inheritedInherited from: \TemplateField::$$ext1

Default value''Details

Type: n/a
Inherited_from: \TemplateField::$$ext1


                 $ext2= ''''

inheritedInherited from: \TemplateField::$$ext2

Default value''Details

Type: n/a
Inherited_from: \TemplateField::$$ext2


                 $ext3= ''''

inheritedInherited from: \TemplateField::$$ext3

Default value''Details

Type: n/a
Inherited_from: \TemplateField::$$ext3


                 $ext4= ''''

inheritedInherited from: \TemplateField::$$ext4

Default value''Details

Type: n/a
Inherited_from: \TemplateField::$$ext4


                 $formula= ''''

inheritedInherited from: \TemplateField::$$formula

Default value''Details

Type: n/a
Inherited_from: \TemplateField::$$formula


                 $help= ''''

inheritedInherited from: \TemplateField::$$help

Default value''Details

Type: n/a
Inherited_from: \TemplateField::$$help


                 $id= ''''

inheritedInherited from: \TemplateField::$$id

Default value''Details

Type: n/a
Inherited_from: \TemplateField::$$id


                 $importable= ''true''

inheritedInherited from: \TemplateField::$$importable

Default value'true'Details

Type: n/a
Inherited_from: \TemplateField::$$importable


                 $label_value= ''''

inheritedInherited from: \TemplateField::$$label_value

Default value''Details

Type: n/a
Inherited_from: \TemplateField::$$label_value


                 $len= ''255''

inheritedInherited from: \TemplateField::$$len

Default value'255'Details

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


                 $massupdate= '0'

inheritedInherited from: \TemplateField::$$massupdate

Default value0Details

Type: n/a
Inherited_from: \TemplateField::$$massupdate


                 $name= ''''

inheritedInherited from: \TemplateField::$$name

Default value''Details

Type: n/a
Inherited_from: \TemplateField::$$name


                 $new_field_definition= ''

inheritedInherited from: \TemplateField::$$new_field_definition

Details

Type: n/a
Inherited_from: \TemplateField::$$new_field_definition


                 $reportable= 'true'

inheritedInherited from: \TemplateField::$$reportable

Default valuetrueDetails

Type: n/a
Inherited_from: \TemplateField::$$reportable


                 $required= 'false'

inheritedInherited from: \TemplateField::$$required

Default valuefalseDetails

Type: n/a
Inherited_from: \TemplateField::$$required


                 $size= ''20''

inheritedInherited from: \TemplateField::$$size

Default value'20'Details

Type: n/a
Inherited_from: \TemplateField::$$size


                 $supports_unified_search= 'true'

Default valuetrueDetails

Type: n/a


                 $type= ''varchar''

Default value'varchar'Details

Type: n/a


                 $unified_search= '0'

inheritedInherited from: \TemplateField::$$unified_search

Default value0Details

Type: n/a
Inherited_from: \TemplateField::$$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

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


                 $view= ''edit''

inheritedInherited from: \TemplateField::$$view

Default value'edit'Details

Type: n/a
Inherited_from: \TemplateField::$$view


                 $vname= ''''

inheritedInherited from: \TemplateField::$$vname

Default value''Details

Type: n/a
Inherited_from: \TemplateField::$$vname

Methods

applyVardefRules(
          
          )
        
        :
          void

inherited

Inherited from: \TemplateField::applyVardefRules()

convertBooleanValue(
           $value
          )
        
        :
          void

inherited

Inherited from: \TemplateField::convertBooleanValue()

Parameters

Name	Type	Description
$value

delete(
           $df
          )
        
        :
          void

inherited

Inherited from: \TemplateField::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()

Returns

Type	Description
int

get_additional_defs(
          
          )
        
        :
          void

inherited

Inherited from: \TemplateField::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()

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()

Parameters

Name	Type	Description
$modify

get_db_delete_alter_table(
           $table
          )
        
        :
          void

inherited

Inherited from: \TemplateField::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()

Parameters

Name	Type	Description
$table

get_db_required(
           $modify
              =
              false
          )
        
        :
          void

inherited

Inherited from: \TemplateField::get_db_required()

Parameters

Name	Type	Description
$modify

get_db_type(
          
          )
        
        :
          void

inherited

Inherited from: \TemplateField::get_db_type()

get_dup_merge_def(
           $def
          )
        
        :
          void

inherited

Inherited from: \TemplateField::get_dup_merge_def()

Parameters

Name	Type	Description
$def

get_field_def(
          
          )
        
        :
          void

inherited

Inherited from: \TemplateField::get_field_def()

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

inherited

get_field_name

Inherited from: \TemplateField::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()

get_html_detail(
          
          )
        
        :
          void

inherited

Inherited from: \TemplateField::get_html_detail()

get_html_edit(
          
          )
        
        :
          void

inherited

Inherited from: \TemplateField::get_html_edit()

get_html_label(
          
          )
        
        :
          void

inherited

Inherited from: \TemplateField::get_html_label()

get_html_list(
          
          )
        
        :
          void

inherited

Inherited from: \TemplateField::get_html_list()

get_html_search(
          
          )
        
        :
          void

inherited

Inherited from: \TemplateField::get_html_search()

get_xtpl(
           $bean
              =
              false
          )
        
        :
          void

inherited

Inherited from: \TemplateField::get_xtpl()

Parameters

Name	Type	Description
$bean

get_xtpl_detail(
          
          )
        
        :
          void

get_xtpl_edit(
          
          )
        
        :
          void

get_xtpl_list(
          
          )
        
        :
          void

inherited

Inherited from: \TemplateField::get_xtpl_list()

get_xtpl_search(
          
          )
        
        :
          void

is_required(
          
          )
        
        :
          void

inherited

Inherited from: \TemplateField::is_required()

populateFromPost(
          
          )
        
        :
          void

inherited

Inherited from: \TemplateField::populateFromPost()

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

inherited

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

Inherited from: \TemplateField::populateFromRow()

Parameters

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

prepare(
          
          )
        
        :
          void

inherited

Inherited from: \TemplateField::prepare()

save(
          \DynamicField $df
          )
        
        :
          void

inherited

save

Inherited from: \TemplateField::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()

Parameters

Name	Type	Description
$values

modules/DynamicFields/templates/Fields/TemplateText.php

\TemplateTextjump to top

Properties

Methods

\TemplateText
jump to top