modules/UpgradeWizard/SugarMerge/EditViewMerge.php

Show:

inherited

Classes
- \EditViewMerge

Table of Contents

\EditViewMerge
jump to top

Package: SugarCRM

This is the base class that all other SugarMerge objects extend

Children: \QuickCreateMerge; \ListViewMerge; \DetailViewMerge

Properties

BOOLEAN
                 $bestMatch= 'true'

If we should use the best match algorithim

Default valuetrueDetails

Type: BOOLEAN

ARRAY
                 $customData= 'array()'

this will store the meta data for the custom file

Default valuearray()Details

Type: ARRAY

ARRAY
                 $customFields= 'array()'

this will store an associative array contianing all the fields that are used in the custom meta data file

Default valuearray()Details

Type: ARRAY


                 $customPanelIds= 'array()'

The ids of the panels found in custom metadata fuke

Default valuearray()Details

Type: n/a

STRING
                 $defaultPanel= ''default''

The default panel we place the fields in if we aren't using the best match algorithim

Default value'default'Details

Type: STRING


                 $fieldConversionMapping= 'array(
			'Campaigns' => array('created_by_name'=>'date_entered', 'modified_by_name'=>'date_modified'),
            'Cases' => array('created_by_name'=>'date_entered', 'modified_by_name'=>'date_modified'),
			'Contracts' => array('created_by_name'=>'date_entered', 'modified_by_name'=>'date_modified'),
			'Leads' => array('created_by'=>'date_entered'),
            'Meetings' => array('created_by_name'=>'date_entered', 'modified_by_name'=>'date_modified'),
 			'ProspectLists' => array('created_by_name'=>'date_entered', 'modified_by_name'=>'date_modified'),
            'Prospects' => array('created_by_name'=>'date_entered', 'modified_by_name'=>'date_modified'),
	)'

Special case conversion

Default value

array(
			'Campaigns' => array('created_by_name'=>'date_entered', 'modified_by_name'=>'date_modified'),
            'Cases' => array('created_by_name'=>'date_entered', 'modified_by_name'=>'date_modified'),
			'Contracts' => array('created_by_name'=>'date_entered', 'modified_by_name'=>'date_modified'),
			'Leads' => array('created_by'=>'date_entered'),
            'Meetings' => array('created_by_name'=>'date_entered', 'modified_by_name'=>'date_modified'),
 			'ProspectLists' => array('created_by_name'=>'date_entered', 'modified_by_name'=>'date_modified'),
            'Prospects' => array('created_by_name'=>'date_entered', 'modified_by_name'=>'date_modified'),
	)

Details

Type: n/a

\FILEPOINTER
                 $fp= 'NULL'

The file pointer to log to if set to NULL it will use the GLOBALS['log'] if available and log to debug

Default valueNULLDetails

Type: \FILEPOINTER

BOOLEAN
                 $isMultiPanel= 'true'

If true then it works as though it's a multipanel

Default valuetrueDetails

Type: BOOLEAN

INT
                 $maxCols= '2'

the max number of columns for this view

Default value2Details

Type: INT

ARRAY
                 $mergedFields= 'array()'

this will store an associative array contianing all the merged fields

Default valuearray()Details

Type: ARRAY

STRING
                 $module= ''module''

the name of the module to be merged

Default value'module'Details

Type: STRING

ARRAY
                 $newData= 'array()'

this will store the meta data for the new file

Default valuearray()Details

Type: ARRAY

ARRAY
                 $newFields= 'array()'

this will store an associative array contianing all the fields that are used in the new meta data file

Default valuearray()Details

Type: ARRAY


                 $newPanelIds= 'array()'

The ids of the panels found in original metadata fuke

Default valuearray()Details

Type: n/a

ARRAY
                 $originalData= 'array()'

this will store the meta data for the original file

Default valuearray()Details

Type: ARRAY

ARRAY
                 $originalFields= 'array()'

this will store an associative array contianing all the fields that are used in the original meta data file

Default valuearray()Details

Type: ARRAY


                 $originalPanelIds= 'array()'

The ids of the panels found in original metadata fuke

Default valuearray()Details

Type: n/a

STRING
                 $panelName= ''panels''

The name of the panels section in the meta data

Default value'panels'Details

Type: STRING

\unknown_type
                 $scanForMultiPanel= 'true'

Determines if getFields should analyze panels to determine if it is a MultiPanel

Default valuetrueDetails

Type: \unknown_type


                 $templateMetaName= ''templateMeta''

The name of the templateMeta data secion in the meta data

Default value'templateMeta'Details

Type: n/a

STRING
                 $varName= ''viewdefs''

The variable name that is used with the file for example in editviewdefs and detailviewdefs it is $viewdefs

Default value'viewdefs'Details

Type: STRING

STRING
                 $viewDefs= ''EditView''

Enter the name of the parameter used in the $varName for example in editviewdefs and detailviewdefs it is 'EditView' and 'DetailView' respectively - $viewdefs['EditView']

Default value'EditView'Details

Type: STRING

Methods

areMatchingValues(
          \MULTI $val1, \MULTI $val2
          )
        
        :
          BOOLEAN

returns true if $val1 and $val2 match otherwise it returns false

Parameters

Name	Type	Description
$val1	\MULTI	a value to compare to val2
$val2	\MULTI	a value to compare to val1

Returns

Type	Description
BOOLEAN	- if $val1 and $val2 match

arrayMerge(
          ARRAY $gimp, ARRAY $dom
          )
        
        :
          ARRAY

Recursiveley merges two arrays

Parameters

Name	Type	Description
$gimp	ARRAY	if keys match this arrays values are overriden
$dom	ARRAY	if keys match this arrays values will override the others

Returns

Type	Description
ARRAY	$merged - the merges array

buildPanels(
          
          )
        
        :
          ARRAY

Walks through the merged fields and places them in the appropriate place based on their location parameter as well as the choosen algorithim

Returns

Type	Description
ARRAY	$panels - the new panels section for the merged file

Clears out the values of the arrays so that the same object can be utilized

getData(
          
          )
        
        :
          ARRAY

This will return the meta data of the merged file

Returns

Type	Description
ARRAY	- the meta data of the merged file

getFields(
          ARRAY $panels
          )
        
        :
          ARRAY

This takes in a list of panels and returns an associative array of field names to the meta-data of the field as well as the locations of that field

Parameters

Name	Type	Description
$panels	ARRAY	this is the 'panel' section of the meta-data

Returns

Type	Description
ARRAY	$fields - an associate array of fields and their meta-data as well as their location

getPanelIds(
           $panels
          )
        
        :
          void

getPanelIds

Parameters

Name	Type	Description
$panels

loadData(
          STRING $module, STRING $original_file, STRING $new_file, STRING $custom_file
          )
        
        :
          void

Loads the meta data of the original, new, and custom file into the variables originalData, newData, and customData respectively

Parameters

Name	Type	Description
$module	STRING	name of the module's files that are to be merged
$original_file	STRING	path to the file that originally shipped with sugar
$new_file	STRING	path to the new file that is shipping with the patch
$custom_file	STRING	path to the custom file

log(
          \MULTI $message
          )
        
        :
          void

Logs the given message if the message is not a string it will export it first. If $this->fp is NULL then it will try to log to the $GLOBALS['log'] if it is available

Parameters

Name	Type	Description
$message	\MULTI

merge(
          STRING $module, STRING $original_file, STRING $new_file, STRING $custom_file
              =
              false, BOOLEAN $save
              =
              true
          )
        
        :
          BOOLEAN

public function that will merge meta data from an original sugar file that shipped with the product, a customized file, and a new file shipped with an upgrade

Parameters

Name	Type	Description
$module	STRING	name of the module's files that are to be merged
$original_file	STRING	path to the file that originally shipped with sugar
$new_file	STRING	path to the new file that is shipping with the patch
$custom_file	STRING	path to the custom file
$save	BOOLEAN	boolean on if it should save the results to the custom file or not

Returns

Type	Description
BOOLEAN	- if the merged file was saved if false is passed in for the save parameter it always returns true

mergeField(
          ARRAY $orig, ARRAY $new, ARRAY $custom
          )
        
        :
          ARRAY

Merges the meta data of a single field

Parameters

Name	Type	Description
$orig	ARRAY	the original meta-data for this field
$new	ARRAY	the new meta-data for this field
$custom	ARRAY	the custom meta-data for this field

Returns

Type	Description
ARRAY	$merged - the merged meta-data

mergeFields(
          
          )
        
        :
          void

Merges the fields together and stores them in $this->mergedFields

mergeMetaData(
          
          )
        
        :
          void

Parses out the fields for each files meta data and then calls on mergeFields and setPanels

mergeTemplateMeta(
          
          )
        
        :
          void

Merge the templateMeta entry for the view defs. Also assume that any changes made in the custom files should have precedence since they must be changed manually, even over new files that may be provided in the upgarde patch.

save(
          STRING $to
          )
        
        :
          BOOLEAN

This will save the merged data to a file

Parameters

Name	Type	Description
$to	STRING	path of the file to save it to

Returns

Type	Description
BOOLEAN	- success or failure of the save

setBestMatch(
          BOOLEAN $on
              =
              true
          )
        
        :
          void

Allows the user to choose to use the best match algorithim or not

Parameters

Name	Type	Description
$on	BOOLEAN

setDefaultPanel(
          STRING $name
              =
              'default'
          )
        
        :
          void

Allows users to set the name to use as the default panel in the meta data

Parameters

Name	Type	Description
$name	STRING	name of the default panel

setLogFile(
          STRING $file
          )
        
        :
          void

opens the file with the 'a' parameter and use it to log messages to

Parameters

Name	Type	Description
$file	STRING	path to file we wish to log to

setLogFilePointer(
          \FILEPOINTER $fp
          )
        
        :
          void

Allows the user to set a filepointer that is already open to log to

Parameters

Name	Type	Description
$fp	\FILEPOINTER

setPanels(
          
          )
        
        :
          void

Sets the panel section for the meta-data after it has been merged

modules/UpgradeWizard/SugarMerge/EditViewMerge.php

\EditViewMergejump to top

Properties

Methods

\EditViewMerge
jump to top