soap/SoapHelperFunctions.php

Show:

inherited

Table of Contents

Functions

add_create_account(
           $seed
          )
        
        :
          void

Parameters

Name	Type	Description
$seed

apply_values(
          Mixed $seed, Array $dataValues, boolean $firstSync
          )
        
        :
          void

apply_values

This function applies the given values to the bean object. If it is a first time sync then empty values will not be copied over.

Parameters

Name	Type	Description
$seed	Mixed	Object representing SugarBean instance
$dataValues	Array	Array of fields/values to set on the SugarBean instance
$firstSync	boolean	Boolean indicating whether or not this is a first time sync

array_get_name_value_list(
           $array
          )
        
        :
          void

Parameters

Name	Type	Description
$array

array_get_name_value_lists(
           $array
          )
        
        :
          void

Parameters

Name	Type	Description
$array

array_get_return_value(
           $array,  $module
          )
        
        :
          void

Parameters

Name	Type	Description
$array
$module

canViewPath(
           $path,  $base
          )
        
        :
          void

Parameters

Name	Type	Description
$path
$base

checkACLAccess(
           $bean,  $viewType,  $errorObject,  $error_key
          )
        
        :
          void

Parameters

Name	Type	Description
$bean
$viewType
$errorObject
$error_key

checkSessionAndModuleAccess(
           $session,  $login_error_key,  $module_name,  $access_level,  $module_access_level_error_key,  $errorObject
          )
        
        :
          void

Parameters

Name	Type	Description
$session
$login_error_key
$module_name
$access_level
$module_access_level_error_key
$errorObject

check_for_duplicate_contacts(
           $seed
          )
        
        :
          void

Parameters

Name	Type	Description
$seed

check_modules_access(
           $user,  $module_name,  $action
              =
              'write'
          )
        
        :
          void

Parameters

Name	Type	Description
$user
$module_name
$action

decrypt_string(
          \$string $string
          )
        
        :
          \a

decrypt a string use the TripleDES algorithm. This meant to be modified if the end user chooses a different algorithm

Parameters

Name	Type	Description
$string	\$string	the string to decrypt

Returns

Type	Description
\a	decrypted string if we can decrypt, the original string otherwise

filter_field_list(
           $field_list,  $select_fields,  $module_name
          )
        
        :
          void

Parameters

Name	Type	Description
$field_list
$select_fields
$module_name

filter_fields(
           $value,  $fields
          )
        
        :
          void

Parameters

Name	Type	Description
$value
$fields

filter_return_list(
          Array $output_list, Array $select_fields, String $module_name
          )
        
        :
          \The

Filter the results of a list query. Limit the fields returned.

Parameters

Name	Type	Description
$output_list	Array	-- The array of list data
$select_fields	Array	-- The list of fields that should be returned. If this array is specfied, only the fields in the array will be returned.
$module_name	String	-- The name of the module this being worked on

Returns

Type	Description
\The	filtered array of list data.

getFile(
           $zip_file,  $file_in_zip
          )
        
        :
          void

Parameters

Name	Type	Description
$zip_file
$file_in_zip

getManifest(
           $zip_file
          )
        
        :
          void

Parameters

Name	Type	Description
$zip_file

getRelationshipResults(
           $bean,  $link_field_name,  $link_module_fields
          )
        
        :
          void

Parameters

Name	Type	Description
$bean
$link_field_name
$link_module_fields

get_decoded(
           $object
          )
        
        :
          void

Parameters

Name	Type	Description
$object

get_encoded(
           $object
          )
        
        :
          void

Parameters

Name	Type	Description
$object

get_encoded_Value(
           $value
          )
        
        :
          void

Parameters

Name	Type	Description
$value

get_field_list(
          \SugarBean $value,  $translate
              =
              true
          )
        
        :
          Array

Retrieve field data for a provided SugarBean.

Parameters

Name	Type	Description
$value	\SugarBean	-- The bean to retrieve the field information for.
$translate

Returns

Type	Description
Array	-- 'field'=> 'name' -- the name of the field 'type' -- the data type of the field 'label' -- the translation key for the label of the field 'required' -- Is the field required? 'options' -- Possible values for a drop down field

get_name_value(
           $field,  $value
          )
        
        :
          void

Parameters

Name	Type	Description
$field
$value

get_name_value_list(
           $value,  $returnDomValue
              =
              false
          )
        
        :
          void

Parameters

Name	Type	Description
$value
$returnDomValue

get_name_value_list_for_fields(
           $value,  $fields
          )
        
        :
          void

Parameters

Name	Type	Description
$value
$fields

get_name_value_xml(
           $val,  $module_name
          )
        
        :
          void

Parameters

Name	Type	Description
$val
$module_name

get_report_value(
          \SavedReport $seed
          )
        
        :
          array

Return the data from a report

Parameters

Name	Type	Description
$seed	\SavedReport

Returns

Type	Description
array	- output_list - the rows of the reports, field_list - the fields in the report.

get_return_error_value(
           $error_num,  $error_name,  $error_description
          )
        
        :
          void

Parameters

Name	Type	Description
$error_num
$error_name
$error_description

get_return_module_fields(
           $value,  $module,  $error,  $translate
              =
              true
          )
        
        :
          void

Parameters

Name	Type	Description
$value
$module
$error
$translate

get_return_value(
           $value,  $module,  $returnDomValue
              =
              false
          )
        
        :
          void

Parameters

Name	Type	Description
$value
$module
$returnDomValue

get_return_value_for_fields(
           $value,  $module,  $fields
          )
        
        :
          void

Parameters

Name	Type	Description
$value
$module
$fields

get_return_value_for_link_fields(
           $bean,  $module,  $link_name_to_value_fields_array
          )
        
        :
          void

Parameters

Name	Type	Description
$bean
$module
$link_name_to_value_fields_array

get_user_module_list(
           $user
          )
        
        :
          void

Parameters

Name	Type	Description
$user

is_server_version_greater(
           $left,  $right
          )
        
        :
          void

Parameters

Name	Type	Description
$left
$right

login_success(
          
          )
        
        :
          void

name_value_lists_get_array(
           $list
          )
        
        :
          void

Parameters

Name	Type	Description
$list

new_get_field_list(
           $value,  $translate
              =
              true
          )
        
        :
          void

Parameters

Name	Type	Description
$value
$translate

new_get_return_module_fields(
           $value,  $module,  $translate
              =
              true
          )
        
        :
          void

Parameters

Name	Type	Description
$value
$module
$translate

new_handle_set_entries(
           $module_name,  $name_value_lists,  $select_fields
              =
              FALSE
          )
        
        :
          void

Parameters

Name	Type	Description
$module_name
$name_value_lists
$select_fields

new_handle_set_relationship(
          String $module_name, String $module_id, String $link_field_name, Array $related_ids
          )
        
        :
          true

Parameters

Name	Type	Description
$module_name	String	-- The name of the module that the primary record is from. This name should be the name the module was developed under (changing a tab name is studio does not affect the name that should be passed into this method).
$module_id	String	-- The ID of the bean in the specified module
$link_field_name	String	The relationship name for which to create realtionships.
$related_ids	Array	-- The array of ids for which we want to create relationships

Returns

Type	Description
true	on success, false on failure

setFaultObject(
           $errorObject
          )
        
        :
          void

Parameters

Name	Type	Description
$errorObject