include/MassUpdate.php

Show:

inherited

Classes
- \MassUpdate

Table of Contents

\MassUpdate
jump to top

Package: SugarCRM

MassUpdate class for updating multiple records at once

Api

Properties


                 $sugarbean= 'null'

Default valuenullDetails

Type: n/a


                 $where_clauses= ''''

where clauses used to filter rows that have to be updated

Default value''Details

Type: n/a

Methods

addAccountID(
          \displayname $displayname, \varname $varname, \id_name $id_name
              =
              ''
          )
        
        :
          void

Add Account selection popup window HTML code

Parameters

Name	Type	Description
$displayname	\displayname	Name to display in the popup window
$varname	\varname	name of the variable
$id_name	\id_name	name of the id in vardef

addAssignedUserID(
          \displayname $displayname, \varname $varname
          )
        
        :
          void

Add AssignedUser popup window HTML code

Parameters

Name	Type	Description
$displayname	\displayname	Name to display in the popup window
$varname	\varname	name of the variable

addBool(
          \displayname $displayname, \varname $varname
          )
        
        :
          void

Add Status selection popup window HTML code

Parameters

Name	Type	Description
$displayname	\displayname	Name to display in the popup window
$varname	\varname	name of the variable

addDate(
          \displayname $displayname, \varname $varname
          )
        
        :
          void

Add Date selection popup window HTML code

Parameters

Name	Type	Description
$displayname	\displayname	Name to display in the popup window
$varname	\varname	name of the variable

addDatetime(
          \displayname $displayname, \varname $varname
          )
        
        :
          void

Add Datetime selection popup window HTML code

Parameters

Name	Type	Description
$displayname	\displayname	Name to display in the popup window
$varname	\varname	name of the variable

addDefault(
          string $displayname, string $field, bool $even
          )
        
        :
          string

Have to be overridden in children

Parameters

Name	Type	Description
$displayname	string	field label
$field	string	field name
$even	bool	even or odd

Returns

Type	Description
string	html field data

addGenericModuleID(
          \displayname $displayname, \varname $varname, \id_name $id_name
              =
              '', \mod_type $mod_type
          )
        
        :
          void

Add a generic module popup selection popup window HTML code.

Currently supports Contact and Releases

Parameters

Name	Type	Description
$displayname	\displayname	Name to display in the popup window
$varname	\varname	name of the variable
$id_name	\id_name	name of the id in vardef
$mod_type	\mod_type	name of the module, either "Contact" or "Releases" currently

addInputType(
          \displayname $displayname, \field_name $varname
          )
        
        :
          void

Add a generic input type='text' field

Parameters

Name	Type	Description
$displayname	\displayname	Name to display in the popup window
$varname	\field_name	name of the field

addParent(
          \displayname $displayname, \field_name $field
          )
        
        :
          void

Add a parent selection popup window

Parameters

Name	Type	Description
$displayname	\displayname	Name to display in the popup window
$field	\field_name	name of the field

addRadioenum(
           $displayname,  $varname,  $options
          )
        
        :
          void

Parameters

Name	Type	Description
$displayname
$varname
$options

addRadioenumItem(
           $name,  $value,  $output
          )
        
        :
          void

Parameters

Name	Type	Description
$name
$value
$output

addStatus(
          \displayname $displayname, \varname $varname, \options $options
          )
        
        :
          void

Add Status selection popup window HTML code

Parameters

Name	Type	Description
$displayname	\displayname	Name to display in the popup window
$varname	\varname	name of the variable
$options	\options	array of options for status

addStatusMulti(
           $displayname,  $varname,  $options
          )
        
        :
          void

Parameters

Name	Type	Description
$displayname
$varname
$options

addUserName(
          \displayname $displayname, \varname $varname, \id_name $id_name
              =
              '', \mod_type $mod_type
          )
        
        :
          void

Add a generic widget to lookup Users.

Parameters

Name	Type	Description
$displayname	\displayname	Name to display in the popup window
$varname	\varname	name of the variable
$id_name	\id_name	name of the id in vardef
$mod_type	\mod_type	name of the module, either "Contact" or "Releases" currently

checkClearField(
           $field,  $value
          )
        
        :
          void

Parameters

Name	Type	Description
$field
$value

date_to_dateTime(
           $field,  $value
          )
        
        :
          void

Parameters

Name	Type	Description
$field
$value

doMassUpdateFieldsExistForFocus(
          
          )
        
        :
          bool

This is kinda a hack how it is implimented, but will tell us whether or not a focus has fields for Mass Update

Returns

Type	Description
bool

endMassUpdateForm(
          
          )
        
        :
          void

Returns end of the massupdate form

generateSearchWhere(
           $module,  $query
          )
        
        :
          void

Parameters

Name	Type	Description
$module
$query

getDisplayMassUpdateForm(
          bool $bool, \multi_select_popup $multi_select_popup
              =
              false
          )
        
        :
          void

get the massupdate form

Parameters

Name	Type	Description
$bool	bool	boolean need to execute the massupdate form or not
$multi_select_popup	\multi_select_popup	booleanif it is a multi-select value

getFunctionValue(
           $focus,  $vardef
          )
        
        :
          void

Parameters

Name	Type	Description
$focus
$vardef

getMassUpdateForm(
           $hideDeleteIfNoFieldsAvailable
              =
              false
          )
        
        :
          void

Displays the massupdate form

Parameters

Name	Type	Description
$hideDeleteIfNoFieldsAvailable

getMassUpdateFormHeader(
          \multi_select_popup $multi_select_popup
              =
              false
          )
        
        :
          void

returns the mass update's html form header

Parameters

Name	Type	Description
$multi_select_popup	\multi_select_popup	boolean if it is a mult-select or not

getSearchDefs(
           $module,  $metafiles
              =
              array()
          )
        
        :
          void

Parameters

Name	Type	Description
$module
$metafiles

getSearchFields(
           $module,  $metafiles
              =
              array()
          )
        
        :
          void

Parameters

Name	Type	Description
$module
$metafiles

handleMassUpdate(
          
          )
        
        :
          void

Executes the massupdate form

handleRelationship(
          \displayname $displayname, \field $field
          )
        
        :
          void

Decides which popup HTML code is needed for mass updating

Parameters

Name	Type	Description
$displayname	\displayname	Name to display in the popup window
$field	\field	name of the field to update

setSugarBean(
          \sugar $sugar
          )
        
        :
          void

set the sugar bean to its internal member

Parameters

Name	Type	Description
$sugar	\sugar	bean reference

include/MassUpdate.php

\MassUpdatejump to top

Properties

Methods

\MassUpdate
jump to top