service/core/SugarRestUtils.php
Show:
inherited
inherited
Classes
\SugarRestUtils
Package:
- Parent(s)
- \SoapHelperWebServices
Methods
add_create_account(
$seed
)
:
void
inherited
Inherited from:
\SoapHelperWebServices::add_create_account()
Parameters
| Name | Type | Description |
|---|---|---|
| $seed |
array_get_name_value_list(
$array
)
:
void
inherited
Inherited from:
\SoapHelperWebServices::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()
Parameters
| Name | Type | Description |
|---|---|---|
| $array |
array_get_return_value(
$array, $module
)
:
void
inherited
Inherited from:
\SoapHelperWebServices::array_get_return_value()
Parameters
| Name | Type | Description |
|---|---|---|
| $array | ||
| $module |
checkACLAccess(
$bean, $viewType, $errorObject, $error_key
)
:
void
inherited
Inherited from:
\SoapHelperWebServices::checkACLAccess()
Parameters
| Name | Type | Description |
|---|---|---|
| $bean | ||
| $viewType | ||
| $errorObject | ||
| $error_key |
checkQuery(
$errorObject, $query, $order_by
=
''
)
:
void
inherited
Inherited from:
\SoapHelperWebServices::checkQuery()
Parameters
| Name | Type | Description |
|---|---|---|
| $errorObject | ||
| $query | ||
| $order_by |
checkSessionAndModuleAccess(
$session, $login_error_key, $module_name, $access_level, $module_access_level_error_key, $errorObject
)
:
void
inherited
Inherited from:
\SoapHelperWebServices::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()
Parameters
| Name | Type | Description |
|---|---|---|
| $seed |
check_modules_access(
$user, $module_name, $action
=
'write'
)
:
void
inherited
Inherited from:
\SoapHelperWebServices::check_modules_access()
Parameters
| Name | Type | Description |
|---|---|---|
| $user | ||
| $module_name | ||
| $action |
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()
Parameters
Returns
| Name | Type | Description |
|---|---|---|
| $string | \$string |
|
| Type | Description |
|---|---|
| \a | decrypted string if we can decrypt, the original string otherwise |
filter_fields(
$value, $fields
)
:
void
inherited
Inherited from:
\SoapHelperWebServices::filter_fields()
Parameters
| Name | Type | Description |
|---|---|---|
| $value | ||
| $fields |
getRelationshipResults(
String $bean, String $link_field_name, Array $link_module_fields, String $optional_where
=
''
)
:
Array
inherited
Fetch and array of related records
Inherited from: \SoapHelperWebServices::getRelationshipResults()
Parameters
Returns
| 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 |
| 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
inherited
Inherited from:
\SoapHelperWebServices::get_field_list()
Parameters
| Name | Type | Description |
|---|---|---|
| $value | ||
| $fields | ||
| $translate |
get_name_value(
$field, $value
)
:
void
inherited
Inherited from:
\SoapHelperWebServices::get_name_value()
Parameters
| Name | Type | Description |
|---|---|---|
| $field | ||
| $value |
get_name_value_list(
$value
)
:
void
inherited
Inherited from:
\SoapHelperWebServices::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()
Parameters
| Name | Type | Description |
|---|---|---|
| $value | ||
| $fields |
get_report_value(
\SavedReport $seed, $select_fields
)
:
array
Parameters
Returns
| Name | Type | Description |
|---|---|---|
| $seed | \SavedReport | |
| $select_fields |
| Type | Description |
|---|---|
| array | - output_list - the rows of the reports, field_list - the fields in the report. |
get_return_module_fields(
$value, $module, $fields, $translate
=
true
)
:
void
inherited
Inherited from:
\SoapHelperWebServices::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()
Parameters
| Name | Type | Description |
|---|---|---|
| $value | ||
| $module |
get_return_value_for_fields(
$value, $module, $fields
)
:
void
inherited
Inherited from:
\SoapHelperWebServices::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()
Parameters
| Name | Type | Description |
|---|---|---|
| $bean | ||
| $module | ||
| $link_name_to_value_fields_array |
get_user_module_list(
$user
)
:
void
inherited
Inherited from:
\SoapHelperWebServices::get_user_module_list()
Parameters
| Name | Type | Description |
|---|---|---|
| $user |
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()
Parameters
Returns
| Name | Type | Description |
|---|---|---|
| $session_var | string |
| 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()
Parameters
| Name | Type | Description |
|---|---|---|
| $name_value_list |
name_value_lists_get_array(
$list
)
:
void
inherited
Inherited from:
\SoapHelperWebServices::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:
\SoapHelperWebServices::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()
Parameters
Returns
| 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 |
|
| $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 |
| Type | Description |
|---|---|
| true | on success, false on failure |
returnFieldsWithAccess(
object $seed, array $select_fields
=
array()
)
:
array
Parameters
Returns
| Name | Type | Description |
|---|---|---|
| $seed | object | an instance of the bean we are checking acl's on |
| $select_fields | array | array of fields being explicitly checked for access, empty array means check all |
| Type | Description |
|---|---|
| array | Array of the fields for this bean that passed the acl filter test |
setFaultObject(
$errorObject
)
:
void
inherited
Inherited from:
\SoapHelperWebServices::setFaultObject()
Parameters
| Name | Type | Description |
|---|---|---|
| $errorObject |
validate_authenticated(
String $session_id
)
:
truefalse
inherited
Validate the provided session information is correct and current. Load the session.
Inherited from: \SoapHelperWebServices::validate_authenticated()
Parameters
Returns
| Name | Type | Description |
|---|---|---|
| $session_id | String | -- The session ID that was returned by a call to login. |
| 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()
Parameters
Returns
| Name | Type | Description |
|---|---|---|
| $user_name | string | -- The user name to create a session for |
| $password | string | -- The MD5 sum of the user's password |
| Type | Description |
|---|---|
| truefalse | -- If the session is created-- If the session is not created |