service/v4_1/SugarWebServiceUtilv4_1.php

Show:

inherited

Classes
- \SugarWebServiceUtilv4_1

Table of Contents

\SugarWebServiceUtilv4_1
jump to top

Package:

Parent(s): \SugarWebServiceUtilv4 < \SugarWebServiceUtilv3_1 < \SugarWebServiceUtilv3 < \SoapHelperWebServices

Methods

addFieldLevelACLs(
          String $module_name, String $view_type, String $view, array $metadata
          )
        
        :
          \unknown

inherited

Add ACL values to metadata files.

Inherited from: \SugarWebServiceUtilv3_1::addFieldLevelACLs()\SugarWebServiceUtilv4::addFieldLevelACLs()

Parameters

Name	Type	Description
$module_name	String
$view_type	String
$view	String	(list, detail,edit, etc)
$metadata	array	The metadata for the view type and view.

Returns

Type	Description
\unknown

add_create_account(
           $seed
          )
        
        :
          void

inherited

Inherited from: \SoapHelperWebServices::add_create_account()\SugarWebServiceUtilv3::add_create_account()\SugarWebServiceUtilv3_1::add_create_account()\SugarWebServiceUtilv4::add_create_account()

Parameters

Name	Type	Description
$seed

array_get_name_value_list(
           $array
          )
        
        :
          void

inherited

Inherited from: \SoapHelperWebServices::array_get_name_value_list()\SugarWebServiceUtilv3::array_get_name_value_list()\SugarWebServiceUtilv3_1::array_get_name_value_list()\SugarWebServiceUtilv4::array_get_name_value_list()

Parameters

Name	Type	Description
$array

array_get_name_value_lists(
           $array
          )
        
        :
          void

inherited

Inherited from: \SoapHelperWebServices::array_get_name_value_lists()\SugarWebServiceUtilv3::array_get_name_value_lists()\SugarWebServiceUtilv3_1::array_get_name_value_lists()\SugarWebServiceUtilv4::array_get_name_value_lists()

Parameters

Name	Type	Description
$array

array_get_return_value(
           $array,  $module
          )
        
        :
          void

inherited

Inherited from: \SoapHelperWebServices::array_get_return_value()\SugarWebServiceUtilv3::array_get_return_value()\SugarWebServiceUtilv3_1::array_get_return_value()\SugarWebServiceUtilv4::array_get_return_value()

Parameters

Name	Type	Description
$array
$module

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

inherited

Inherited from: \SoapHelperWebServices::checkACLAccess()\SugarWebServiceUtilv3::checkACLAccess()\SugarWebServiceUtilv3_1::checkACLAccess()\SugarWebServiceUtilv4::checkACLAccess()

Parameters

Name	Type	Description
$bean
$viewType
$errorObject
$error_key

checkModuleRoleAccess(
          string $module
          )
        
        :
          array

inherited

Check a module for acces to a set of available actions.

Inherited from: \SugarWebServiceUtilv3_1::checkModuleRoleAccess()\SugarWebServiceUtilv4::checkModuleRoleAccess()

Parameters

Name	Type	Description
$module	string

Returns

Type	Description
array	results containing access and boolean indicating access

checkOAuthAccess(
           $errorObject
          )
        
        :
          void

inherited

Inherited from: \SugarWebServiceUtilv4::checkOAuthAccess()

Parameters

Name	Type	Description
$errorObject

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

inherited

Inherited from: \SoapHelperWebServices::checkQuery()\SugarWebServiceUtilv3::checkQuery()\SugarWebServiceUtilv3_1::checkQuery()\SugarWebServiceUtilv4::checkQuery()

Parameters

Name	Type	Description
$errorObject
$query
$order_by

checkSaveOnNotify(
          
          )
        
        :
          void

inherited

Inherited from: \SoapHelperWebServices::checkSaveOnNotify()\SugarWebServiceUtilv3::checkSaveOnNotify()\SugarWebServiceUtilv3_1::checkSaveOnNotify()\SugarWebServiceUtilv4::checkSaveOnNotify()

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

inherited

Inherited from: \SugarWebServiceUtilv4::checkSessionAndModuleAccess()

Parameters

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

check_for_duplicate_contacts(
           $seed
          )
        
        :
          void

inherited

Inherited from: \SoapHelperWebServices::check_for_duplicate_contacts()\SugarWebServiceUtilv3::check_for_duplicate_contacts()\SugarWebServiceUtilv3_1::check_for_duplicate_contacts()\SugarWebServiceUtilv4::check_for_duplicate_contacts()

Parameters

Name	Type	Description
$seed

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

Parameters

Name	Type	Description
$user
$module_name
$action

cmp_datedue(
          array $a, array $b
          )
        
        :
          int

staticinherited

Sort the array for upcoming activities based on the date due flag ascending.

Inherited from: \SugarWebServiceUtilv3::cmp_datedue()\SugarWebServiceUtilv3_1::cmp_datedue()\SugarWebServiceUtilv4::cmp_datedue()

Parameters

Name	Type	Description
$a	array
$b	array

Returns

Type	Description
int	Indicates equality for date due flag

decrypt_string(
          \$string $string
          )
        
        :
          \a

inherited

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

Inherited from: \SoapHelperWebServices::decrypt_string()\SugarWebServiceUtilv3::decrypt_string()\SugarWebServiceUtilv3_1::decrypt_string()\SugarWebServiceUtilv4::decrypt_string()

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

inherited

Inherited from: \SugarWebServiceUtilv3::filter_fields()\SugarWebServiceUtilv3_1::filter_fields()\SugarWebServiceUtilv4::filter_fields()

Parameters

Name	Type	Description
$value
$fields

filter_fields_for_query(
          object $value, array $fields
          )
        
        :
          array

inherited

Processes the filter_fields attribute to use with SugarBean::create_new_list_query()

Inherited from: \SugarWebServiceUtilv4::filter_fields_for_query()

Parameters

Name	Type	Description
$value	object	SugarBean
$fields	array

Returns

Type	Description
array

format_upcoming_activities_entries(
          array $list, string $date_field
          )
        
        :
          array

inherited

Given a list of bean entries, format the expected response.

Inherited from: \SugarWebServiceUtilv3::format_upcoming_activities_entries()\SugarWebServiceUtilv3_1::format_upcoming_activities_entries()\SugarWebServiceUtilv4::format_upcoming_activities_entries()

Parameters

Name	Type	Description
$list	array	An array containing a bean list.
$date_field	string	Name of the field storing the date field we are examining

Returns

Type	Description
array	The results.

generateUnifiedSearchFields(
          string $moduleName
          )
        
        :
          array

inherited

Generate unifed search fields for a particular module even if the module does not participate in the unified search.

Inherited from: \SugarWebServiceUtilv3_1::generateUnifiedSearchFields()\SugarWebServiceUtilv4::generateUnifiedSearchFields()

Parameters

Name	Type	Description
$moduleName	string

Returns

Type	Description
array	An array of fields to be searched against.

generateUpcomingActivitiesWhereClause(
           $seed,  $meta
          )
        
        :
          void

inherited

Inherited from: \SugarWebServiceUtilv3::generateUpcomingActivitiesWhereClause()\SugarWebServiceUtilv3_1::generateUpcomingActivitiesWhereClause()\SugarWebServiceUtilv4::generateUpcomingActivitiesWhereClause()

Parameters

Name	Type	Description
$seed
$meta

getFieldLevelACLValue(
          String $module, String $field,  $current_user
              =
              null
          )
        
        :
          int

inherited

Return the field level acl raw value. We cannot use the hasAccess call as we do not have a valid bean record at the moment and therefore can not specify the is_owner flag. We need the raw access value so we can do the computation on the client side. TODO: Move function into ACLField class.

Inherited from: \SugarWebServiceUtilv3_1::getFieldLevelACLValue()\SugarWebServiceUtilv4::getFieldLevelACLValue()

Parameters

Name	Type	Description
$module	String	Name of the module
$field	String	Name of the field
$current_user

Returns

Type	Description
int

getModulesFromList(
          array $list, array $availModules
          )
        
        :
          void

inherited

Convert modules list to Web services result

Inherited from: \SugarWebServiceUtilv4::getModulesFromList()

Parameters

Name	Type	Description
$list	array	List of module candidates (only keys are used)
$availModules	array	List of module availability from Session

getRelationshipResults(
          Mixed $bean, String $link_field_name, Array $link_module_fields, string $optional_where
              =
              '', string $order_by
              =
              '', \Number $offset
              =
              0, \Number $limit
              =
              ''
          )
        
        :
          array | bool

getRelationshipResults Returns the

Parameters

Name	Type	Description
$bean	Mixed	The SugarBean instance to retrieve relationships from
$link_field_name	String	The name of the relationship entry to fetch relationships for
$link_module_fields	Array	Array of fields of relationship entries to return
$optional_where	string	String containing an optional WHERE select clause
$order_by	string	String containing field to order results by
$offset	\Number	-- where to start in the return (defaults to 0)
$limit	\Number	-- number of results to return (defaults to all)

Returns

Type	Description
array \| bool	Returns an Array of relationship results; false if relationship could not be retrieved

get_data_list(
           $seed,  $order_by
              =
              "",  $where
              =
              "",  $row_offset
              =
              0,  $limit
              =
              -1,  $max
              =
              -1,  $show_deleted
              =
              0,  $favorites
              =
              false
          )
        
        :
          void

inherited

Equivalent of get_list function within SugarBean but allows the possibility to pass in an indicator if the list should filter for favorites. Should eventually update the SugarBean function as well.

Inherited from: \SugarWebServiceUtilv4::get_data_list()

Parameters

Name	Type	Description
$seed
$order_by
$where
$row_offset
$limit
$max
$show_deleted
$favorites

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

inherited

Inherited from: \SugarWebServiceUtilv4::get_field_list()

Parameters

Name	Type	Description
$value
$fields
$translate

get_file_contents_base64(
          string $filename, bool $remove
              =
              FALSE
          )
        
        :
          string

inherited

Return the contents of a file base64 encoded

Inherited from: \SugarWebServiceUtilv3_1::get_file_contents_base64()\SugarWebServiceUtilv4::get_file_contents_base64()

Parameters

Name	Type	Description
$filename	string	Full path of filename
$remove	bool	Indicates if the file should be removed after the contents is retrieved.

Returns

Type	Description
string	- Contents base64'd.

get_module_view_defs(
           $moduleName,  $type,  $view
          )
        
        :
          void

inherited

Inherited from: \SugarWebServiceUtilv4::get_module_view_defs()

Parameters

Name	Type	Description
$moduleName
$type
$view

get_name_value(
           $field,  $value
          )
        
        :
          void

inherited

Inherited from: \SugarWebServiceUtilv3::get_name_value()\SugarWebServiceUtilv3_1::get_name_value()\SugarWebServiceUtilv4::get_name_value()

Parameters

Name	Type	Description
$field
$value

get_name_value_list(
           $value
          )
        
        :
          void

inherited

Inherited from: \SoapHelperWebServices::get_name_value_list()\SugarWebServiceUtilv3::get_name_value_list()\SugarWebServiceUtilv3_1::get_name_value_list()\SugarWebServiceUtilv4::get_name_value_list()

Parameters

Name	Type	Description
$value

get_name_value_list_for_fields(
           $value,  $fields
          )
        
        :
          void

inherited

Inherited from: \SoapHelperWebServices::get_name_value_list_for_fields()\SugarWebServiceUtilv3::get_name_value_list_for_fields()\SugarWebServiceUtilv3_1::get_name_value_list_for_fields()\SugarWebServiceUtilv4::get_name_value_list_for_fields()

Parameters

Name	Type	Description
$value
$fields

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

inherited

Inherited from: \SugarWebServiceUtilv3_1::get_return_module_fields()\SugarWebServiceUtilv4::get_return_module_fields()

Parameters

Name	Type	Description
$value
$module
$fields
$translate

get_return_value(
           $value,  $module
          )
        
        :
          void

inherited

Inherited from: \SoapHelperWebServices::get_return_value()\SugarWebServiceUtilv3::get_return_value()\SugarWebServiceUtilv3_1::get_return_value()\SugarWebServiceUtilv4::get_return_value()

Parameters

Name	Type	Description
$value
$module

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

inherited

Inherited from: \SoapHelperWebServices::get_return_value_for_fields()\SugarWebServiceUtilv3::get_return_value_for_fields()\SugarWebServiceUtilv3_1::get_return_value_for_fields()\SugarWebServiceUtilv4::get_return_value_for_fields()

Parameters

Name	Type	Description
$value
$module
$fields

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

inherited

Inherited from: \SoapHelperWebServices::get_return_value_for_link_fields()\SugarWebServiceUtilv3::get_return_value_for_link_fields()\SugarWebServiceUtilv3_1::get_return_value_for_link_fields()\SugarWebServiceUtilv4::get_return_value_for_link_fields()

Parameters

Name	Type	Description
$bean
$module
$link_name_to_value_fields_array

get_subpanel_defs(
          String $module, String $type
          )
        
        :
          array

inherited

get_subpanel_defs

Inherited from: \SugarWebServiceUtilv4::get_subpanel_defs()

Parameters

Name	Type	Description
$module	String	The name of the module to get the subpanel definition for
$type	String	The type of subpanel definition ('wireless' or 'default')

Returns

Type	Description
array	Array of the subpanel definition; empty array if no matching definition found

get_upcoming_activities(
          
          )
        
        :
          array

inherited

Retrieve all of the upcoming activities for a particular user.

Inherited from: \SugarWebServiceUtilv3::get_upcoming_activities()\SugarWebServiceUtilv3_1::get_upcoming_activities()\SugarWebServiceUtilv4::get_upcoming_activities()

Returns

Type	Description
array

get_user_module_list(
           $user
          )
        
        :
          void

inherited

Inherited from: \SoapHelperWebServices::get_user_module_list()\SugarWebServiceUtilv3::get_user_module_list()\SugarWebServiceUtilv3_1::get_user_module_list()\SugarWebServiceUtilv4::get_user_module_list()

Parameters

Name	Type	Description
$user

get_visible_modules(
          array $availModules
          )
        
        :
          array

inherited

Examine the application to determine which modules have been enabled..

Inherited from: \SugarWebServiceUtilv3_1::get_visible_modules()\SugarWebServiceUtilv4::get_visible_modules()

Parameters

Name	Type	Description
$availModules	array	An array of all the modules the user already has access to.

Returns

Type	Description
array	Modules enabled within the application.

isLogLevelDebug(
          
          )
        
        :
          void

inherited

Inherited from: \SoapHelperWebServices::isLogLevelDebug()\SugarWebServiceUtilv3::isLogLevelDebug()\SugarWebServiceUtilv3_1::isLogLevelDebug()\SugarWebServiceUtilv4::isLogLevelDebug()

is_favorites_enabled(
          string $module_name
          )
        
        :
          bool

inherited

Return a boolean indicating if the bean name is favorites enabled.

Inherited from: \SugarWebServiceUtilv4::is_favorites_enabled()

Parameters

Name	Type	Description
$module_name	string	The module name

Returns

Type	Description
bool	true indicating bean is favorites enabled

is_valid_ip_address(
          string $session_var
          )
        
        :
          bool

inherited

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

Inherited from: \SoapHelperWebServices::is_valid_ip_address()\SugarWebServiceUtilv3::is_valid_ip_address()\SugarWebServiceUtilv3_1::is_valid_ip_address()\SugarWebServiceUtilv4::is_valid_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

inherited

Inherited from: \SoapHelperWebServices::login_success()\SugarWebServiceUtilv3::login_success()\SugarWebServiceUtilv3_1::login_success()\SugarWebServiceUtilv4::login_success()

Parameters

Name	Type	Description
$name_value_list

name_value_lists_get_array(
           $list
          )
        
        :
          void

inherited

Inherited from: \SoapHelperWebServices::name_value_lists_get_array()\SugarWebServiceUtilv3::name_value_lists_get_array()\SugarWebServiceUtilv3_1::name_value_lists_get_array()\SugarWebServiceUtilv4::name_value_lists_get_array()

Parameters

Name	Type	Description
$list

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

inherited

Inherited from: \SugarWebServiceUtilv4::new_handle_set_entries()

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

inherited

Inherited from: \SoapHelperWebServices::new_handle_set_relationship()\SugarWebServiceUtilv3::new_handle_set_relationship()\SugarWebServiceUtilv3_1::new_handle_set_relationship()\SugarWebServiceUtilv4::new_handle_set_relationship()

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

inherited

Inherited from: \SoapHelperWebServices::setFaultObject()\SugarWebServiceUtilv3::setFaultObject()\SugarWebServiceUtilv3_1::setFaultObject()\SugarWebServiceUtilv4::setFaultObject()

Parameters

Name	Type	Description
$errorObject

trackView(
          \SugarBean $seed, string $current_view
          )
        
        :
          void

inherited

Track a view for a particular bean.

Inherited from: \SugarWebServiceUtilv3_1::trackView()\SugarWebServiceUtilv4::trackView()

Parameters

Name	Type	Description
$seed	\SugarBean
$current_view	string

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

inherited

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

Inherited from: \SoapHelperWebServices::validate_user()\SugarWebServiceUtilv3::validate_user()\SugarWebServiceUtilv3_1::validate_user()\SugarWebServiceUtilv4::validate_user()

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/v4_1/SugarWebServiceUtilv4_1.php

\SugarWebServiceUtilv4_1jump to top

Methods

\SugarWebServiceUtilv4_1
jump to top