include/SugarFields/Fields/Id/SugarFieldId.php

Show:

inherited

Classes
- \SugarFieldId

Table of Contents

\SugarFieldId
jump to top

Package:

SugarFieldBase translates and displays fields from a vardef definition into different formats including DetailView, ListView, EditView. It also provides Search Inputs and database queries to handle searching

Parent(s): \SugarFieldBase

Properties


                 $hasButton= 'false'

inheritedInherited from: \SugarFieldBase::$$hasButton

Default valuefalseDetails

Type: n/a
Inherited_from: \SugarFieldBase::$$hasButton


                 $ss= ''

inheritedInherited from: \SugarFieldBase::$$ss

Details

Type: n/a
Inherited_from: \SugarFieldBase::$$ss

Methods

SugarFieldBase(
           $type
          )
        
        :
          void

inherited

Inherited from: \SugarFieldBase::SugarFieldBase()

Parameters

Name	Type	Description
$type

displayFromFunc(
           $displayType,  $parentFieldArray,  $vardef,  $displayParams,  $tabindex
              =
              0
          )
        
        :
          void

inherited

Inherited from: \SugarFieldBase::displayFromFunc()

Parameters

Name	Type	Description
$displayType
$parentFieldArray
$vardef
$displayParams
$tabindex

fetch(
           $path
          )
        
        :
          void

inherited

Inherited from: \SugarFieldBase::fetch()

Parameters

Name	Type	Description
$path

findTemplate(
           $view
          )
        
        :
          void

inherited

Inherited from: \SugarFieldBase::findTemplate()

Parameters

Name	Type	Description
$view

formatField(
           $rawField,  $vardef
          )
        
        :
          void

inherited

Inherited from: \SugarFieldBase::formatField()

Parameters

Name	Type	Description
$rawField
$vardef

getAccessKey(
           $vardef,  $fieldType
              =
              null,  $module
              =
              null
          )
        
        :
          void

inherited

Inherited from: \SugarFieldBase::getAccessKey()

Parameters

Name	Type	Description
$vardef
$fieldType
$module

getChangeLogSmarty(
           $parentFieldArray,  $vardef,  $displayParams,  $tabindex
          )
        
        :
          void

inherited

Inherited from: \SugarFieldBase::getChangeLogSmarty()

Parameters

Name	Type	Description
$parentFieldArray
$vardef
$displayParams
$tabindex

getDetailViewSmarty(
          \parentFieldArray $parentFieldArray, \vardef $vardef, \displayParam $displayParams,  $tabindex
          )
        
        :
          void

inherited

Returns a smarty template for the DetailViews

Inherited from: \SugarFieldBase::getDetailViewSmarty()

Parameters

Name	Type	Description
$parentFieldArray	\parentFieldArray	string name of the variable in the parent template for the bean's data
$vardef	\vardef	vardef field defintion
$displayParams	\displayParam	parameters for display available paramters are: labelSpan - column span for the label * fieldSpan - column span for the field*
$tabindex

getEditView(
          
          )
        
        :
          void

inherited

Inherited from: \SugarFieldBase::getEditView()

getEditViewSmarty(
           $parentFieldArray,  $vardef,  $displayParams,  $tabindex
          )
        
        :
          void

inherited

Inherited from: \SugarFieldBase::getEditViewSmarty()

Parameters

Name	Type	Description
$parentFieldArray
$vardef
$displayParams
$tabindex

getEmailTemplateValue(
           $inputField,  $vardef,  $context
              =
              null
          )
        
        :
          void

inherited

Inherited from: \SugarFieldBase::getEmailTemplateValue()

Parameters

Name	Type	Description
$inputField
$vardef
$context

getImportViewSmarty(
           $parentFieldArray,  $vardef,  $displayParams,  $tabindex
          )
        
        :
          void

inherited

Inherited from: \SugarFieldBase::getImportViewSmarty()

Parameters

Name	Type	Description
$parentFieldArray
$vardef
$displayParams
$tabindex

getListViewSmarty(
           $parentFieldArray,  $vardef,  $displayParams,  $col
          )
        
        :
          void

inherited

Inherited from: \SugarFieldBase::getListViewSmarty()

Parameters

Name	Type	Description
$parentFieldArray
$vardef
$displayParams
$col

getPopupViewSmarty(
           $parentFieldArray,  $vardef,  $displayParams,  $tabindex
          )
        
        :
          void

inherited

Inherited from: \SugarFieldBase::getPopupViewSmarty()

Parameters

Name	Type	Description
$parentFieldArray
$vardef
$displayParams
$tabindex

getQueryIn(
          
          )
        
        :
          void

inherited

Inherited from: \SugarFieldBase::getQueryIn()

getQueryLike(
          
          )
        
        :
          void

inherited

Inherited from: \SugarFieldBase::getQueryLike()

getSearchInput(
          \$key $key
              =
              '', \$args $args
              =
              array()
          )
        
        :
          \$value

inherited

getSearchInput

Inherited from: \SugarFieldBase::getSearchInput()

This function allows the SugarFields to handle returning the search input value given arguments (typically from $_REQUEST/$_POST) and a search string.

Parameters

Name	Type	Description
$key	\$key	String value of key to search for
$args	\$args	Mixed value containing haystack to search for value in

Returns

Type	Description
\$value	Mixed value that the SugarField should return

getSearchViewSmarty(
           $parentFieldArray,  $vardef,  $displayParams,  $tabindex
          )
        
        :
          void

inherited

Inherited from: \SugarFieldBase::getSearchViewSmarty()

Parameters

Name	Type	Description
$parentFieldArray
$vardef
$displayParams
$tabindex

getSearchWhereValue(
          \$value $value
          )
        
        :
          Mixed

inherited

getSearchWhereValue

Inherited from: \SugarFieldBase::getSearchWhereValue()

Checks and returns a sane value based on the field type that can be used when building the where clause in a search form.

Parameters

Name	Type	Description
$value	\$value	Mixed value being searched on

Returns

Type	Description
Mixed	the value for the where clause used in search

getSmartyView(
           $parentFieldArray,  $vardef,  $displayParams,  $tabindex
              =
              -1,  $view
          )
        
        :
          void

inherited

Inherited from: \SugarFieldBase::getSmartyView()

Parameters

Name	Type	Description
$parentFieldArray
$vardef
$displayParams
$tabindex
$view

getWirelessDetailViewSmarty(
           $parentFieldArray,  $vardef,  $displayParams,  $tabindex
          )
        
        :
          void

inherited

Inherited from: \SugarFieldBase::getWirelessDetailViewSmarty()

Parameters

Name	Type	Description
$parentFieldArray
$vardef
$displayParams
$tabindex

getWirelessEditViewSmarty(
           $parentFieldArray,  $vardef,  $displayParams,  $tabindex
          )
        
        :
          void

inherited

Inherited from: \SugarFieldBase::getWirelessEditViewSmarty()

Parameters

Name	Type	Description
$parentFieldArray
$vardef
$displayParams
$tabindex

getWirelessListViewSmarty(
           $parentFieldArray,  $vardef,  $displayParams,  $tabindex
          )
        
        :
          void

inherited

Inherited from: \SugarFieldBase::getWirelessListViewSmarty()

Parameters

Name	Type	Description
$parentFieldArray
$vardef
$displayParams
$tabindex

getWirelessSmartyView(
           $parentFieldArray,  $vardef,  $displayParams,  $tabindex
              =
              -1,  $view
          )
        
        :
          void

inherited

Inherited from: \SugarFieldBase::getWirelessSmartyView()

Parameters

Name	Type	Description
$parentFieldArray
$vardef
$displayParams
$tabindex
$view

importSanitize(
          \$value $value, \$vardefs $vardef, \$focus $focus, \$settings $settings
          )
        
        :
          string

Handles import field sanitizing for an field type

Parameters

Name	Type	Description
$value	\$value	string value to be sanitized
$vardef	\$vardefs	array
$focus	\$focus	SugarBean object
$settings	\$settings	ImportFieldSanitize object

Returns

Type	Description
string	sanitized value or boolean false if there's a problem with the value

Details

See: \SugarFieldBase::importSanitize()

isRangeSearchView(
          array $vardef
          )
        
        :
          boolean

inherited

isRangeSearchView This method helps determine whether or not to display the range search view code for the sugar field

Inherited from: \SugarFieldBase::isRangeSearchView()

Parameters

Name	Type	Description
$vardef	array	entry representing the sugar field's definition

Returns

Type	Description
boolean	true if range search view should be displayed, false otherwise

isTrimmable(
          string $type
          )
        
        :
          boolean

inherited

Check if the field is allowed to be trimmed

Inherited from: \SugarFieldBase::isTrimmable()

Parameters

Name	Type	Description
$type	string

Returns

Type	Description
boolean

save(
          \SugarBean $bean, array $params,  $field,  $properties,  $prefix
              =
              ''
          )
        
        :
          void

inherited

This should be called when the bean is saved. The bean itself will be passed by reference

Inherited from: \SugarFieldBase::save()

Parameters

Name	Type	Description
$bean	\SugarBean	bean - the bean performing the save
$params	array	params - an array of paramester relevant to the save, most likely will be $_REQUEST
$field
$properties
$prefix

setup(
           $parentFieldArray,  $vardef,  $displayParams,  $tabindex,  $twopass
              =
              true
          )
        
        :
          void

inherited

Setup function to assign values to the smarty template, should be called before every display function

Inherited from: \SugarFieldBase::setup()

Parameters

Name	Type	Description
$parentFieldArray
$vardef
$displayParams
$tabindex
$twopass

setupFieldArray(
          mixed $parentFieldArray, array $vardef
          )
        
        :
          array

inherited

setupFieldArray This method takes the $parentFieldArray mixed variable which may be an Array or object and attempts to call any custom fieldSpecific formatting to the value depending on the field type.

Inherited from: \SugarFieldBase::setupFieldArray()

Parameters

Name	Type	Description
$parentFieldArray	mixed	Array or Object of data where the field's value comes from
$vardef	array	The vardef entry linked to the SugarField instance

Returns

Type	Description
array	$parentFieldArray The formatted $parentFieldArray with the formatField method possibly applied

Details

See: \SugarFieldEnum.php,

unformatField(
           $formattedField,  $vardef
          )
        
        :
          void

inherited

Inherited from: \SugarFieldBase::unformatField()

Parameters

Name	Type	Description
$formattedField
$vardef

include/SugarFields/Fields/Id/SugarFieldId.php

\SugarFieldIdjump to top

Properties

Methods

\SugarFieldId
jump to top