include/QuickSearchDefaults.php
inherited
Classes
\QuickSearchDefaults
QuickSearchDefaults class, outputs default values for setting up quicksearch
- Copyright
- 2004-2007 SugarCRM Inc.
- License
- SugarCRM Professional End User License
- Since
- Class available since Release 4.0
Properties
Methods
getQSAccount(
$nameKey, $idKey, $billingKey
=
null, $shippingKey
=
null, $additionalFields
=
null
)
:
void| Name | Type | Description |
|---|---|---|
| $nameKey | ||
| $idKey | ||
| $billingKey | ||
| $shippingKey | ||
| $additionalFields |
getQSCampaigns(
$c_name
=
'campaign_name', $c_id
=
'campaign_id'
)
:
void| Name | Type | Description |
|---|---|---|
| $c_name | ||
| $c_id |
getQSContact(
$name, $idName
)
:
\ThegetQSContact This is a customized method to handle returning in JSON notation the QuickSearch formats for searching the Contacts module for a contact name. The method takes into account the locale settings (s = salutation, f = first name, l = last name) that are permissible.
It should be noted though that any other characters present in the formatting will render this widget non-functional.
| Name | Type | Description |
|---|---|---|
| $name | ||
| $idName |
| Type | Description |
|---|---|
| \The | JSON format of a QuickSearch definition for the Contacts module |
getQSParent(
$parent
=
'Accounts'
)
:
void| Name | Type | Description |
|---|---|---|
| $parent |
getQSScripts(
)
:
voidgetQSScriptsJSONAlreadyDefined(
)
:
voidgetQSScriptsNoServer(
)
:
voidgetQSUser(
$p_name
=
'assigned_user_name', $p_id
=
'assigned_user_id'
)
:
void| Name | Type | Description |
|---|---|---|
| $p_name | ||
| $p_id |
getQuickSearchDefaults(
array $lookup
=
array()
)
:
\QuickSearchDefaultsgetQuickSearchDefaults
This is a static function to get an instance of QuickSearchDefaults object
| Name | Type | Description |
|---|---|---|
| $lookup | array | Array with custom files and class names for custom QuickSearchDefaults classes, optional |
| Type | Description |
|---|---|
| \QuickSearchDefaults |
loadQSObject(
string $module, string $object, string $relationName, \type $nameField, \type $idField
)
:
voidLoads Quick Search Object for any object (if suitable method is defined)
| Name | Type | Description |
|---|---|---|
| $module | string | the given module we want to load the vardefs for |
| $object | string | the given object we wish to load the vardefs for |
| $relationName | string | the name of the relation between entities |
| $nameField | \type | the name of the field to populate |
| $idField | \type | the id of the field to populate |
setFormName(
$name
=
'EditView'
)
:
void| Name | Type | Description |
|---|---|---|
| $name |