service/core/SoapHelperWebService.php

Show:

inherited

Classes
- \SoapHelperWebServices

Table of Contents

\SoapHelperWebServices
jump to top

Package:

Children: \SugarWebServiceUtilv3; \SugarRestUtils

Methods

add_create_account(
           $seed
          )
        
        :
          void

Parameters

Name	Type	Description
$seed

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

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

Parameters

Name	Type	Description
$bean
$viewType
$errorObject
$error_key

checkQuery(
           $errorObject,  $query,  $order_by
              =
              ''
          )
        
        :
          void

Parameters

Name	Type	Description
$errorObject
$query
$order_by

checkSaveOnNotify(
          
          )
        
        :
          void

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_fields(
           $value,  $fields
          )
        
        :
          void

Parameters

Name	Type	Description
$value
$fields

getRelationshipResults(
          String $bean, String $link_field_name, Array $link_module_fields, String $optional_where
              =
              ''
          )
        
        :
          Array

Fetch and array of related records

Parameters

Name	Type	Description
$bean	String	-- Primary record
$link_field_name	String	-- The name of the relationship
$link_module_fields	Array	-- The keys of the array are the SugarBean attributes, the values of the array are the values the attributes should have.
$optional_where	String	-- IGNORED

Returns

Type	Description
Array	'rows/fields_set_on_rows' -- The list of records and what fields were actually set for thos erecords

get_field_list(
           $value,  $fields,  $translate
              =
              true
          )
        
        :
          void

Parameters

Name	Type	Description
$value
$fields
$translate

get_name_value(
           $field,  $value
          )
        
        :
          void

Parameters

Name	Type	Description
$field
$value

get_name_value_list(
           $value
          )
        
        :
          void

Parameters

Name	Type	Description
$value

get_name_value_list_for_fields(
           $value,  $fields
          )
        
        :
          void

Parameters

Name	Type	Description
$value
$fields

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

Parameters

Name	Type	Description
$value
$module
$fields
$translate

get_return_value(
           $value,  $module
          )
        
        :
          void

Parameters

Name	Type	Description
$value
$module

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

isLogLevelDebug(
          
          )
        
        :
          void

is_valid_ip_address(
          string $session_var
          )
        
        :
          bool

Use the same logic as in SugarAuthenticate to validate the ip address

Parameters

Name	Type	Description
$session_var	string

Returns

Type	Description
bool	- true if the ip address is valid, false otherwise.

login_success(
           $name_value_list
              =
              array()
          )
        
        :
          void

Parameters

Name	Type	Description
$name_value_list

name_value_lists_get_array(
           $list
          )
        
        :
          void

Parameters

Name	Type	Description
$list

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, Array $name_value_list, int $delete
          )
        
        :
          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
$name_value_list	Array	-- The array of name value pair of additional attributes to be set when adding this relationship
$delete	int	delete -- If 0 then add relationship else delete this relationship data

Returns

Type	Description
true	on success, false on failure

setFaultObject(
           $errorObject
          )
        
        :
          void

Parameters

Name	Type	Description
$errorObject

validate_authenticated(
          String $session_id
          )
        
        :
          truefalse

Validate the provided session information is correct and current. Load the session.

Parameters

Name	Type	Description
$session_id	String	-- The session ID that was returned by a call to login.

Returns

Type	Description
truefalse	-- If the session is valid and loaded.-- if the session is not valid.

validate_user(
          string $user_name, string $password
          )
        
        :
          truefalse

Validate the user session based on user name and password hash.

Parameters

Name	Type	Description
$user_name	string	-- The user name to create a session for
$password	string	-- The MD5 sum of the user's password

Returns

Type	Description
truefalse	-- If the session is created-- If the session is not created

service/core/SoapHelperWebService.php

\SoapHelperWebServicesjump to top

Methods

\SoapHelperWebServices
jump to top