modules/Connectors/connectors/sources/ext/rest/linkedin/linkedin.php
inherited
Classes
\ext_rest_linkedin
REST generic connector
Properties
\_eapm
$_eapm= 'null'
The ExternalAPI Base that instantiated this connector.
Inherited from: \source::$$_eapm\ext_rest::$$_eapmnullDetails- Type
- \_eapm
- Inherited_from
- \source::$$_eapm
- Inherited_from
- \ext_rest::$$_eapm
bool
$_enable_in_admin_display= 'true'
trueDetails- Type
- bool
- Inherited_from
- \source::$$_enable_in_admin_display
- Inherited_from
- \ext_rest::$$_enable_in_admin_display
bool
$_enable_in_admin_mapping= 'true'
trueDetails- Type
- bool
- Inherited_from
- \source::$$_enable_in_admin_mapping
- Inherited_from
- \ext_rest::$$_enable_in_admin_mapping
bool
$_enable_in_admin_properties= 'true'
trueDetails- Type
- bool
- Inherited_from
- \source::$$_enable_in_admin_properties
- Inherited_from
- \ext_rest::$$_enable_in_admin_properties
bool
$_enable_in_admin_search= 'true'
trueDetails- Type
- bool
- Inherited_from
- \source::$$_enable_in_admin_search
- Inherited_from
- \ext_rest::$$_enable_in_admin_search
bool
$_enable_in_hover= 'false'
falseDetails- Type
- bool
- Inherited_from
- \source::$$_enable_in_hover
- Inherited_from
- \ext_rest::$$_enable_in_hover
bool
$_enable_in_wizard= 'true'
trueDetails- Type
- bool
- Inherited_from
- \source::$$_enable_in_wizard
- Inherited_from
- \ext_rest::$$_enable_in_wizard
$_field_defs= ''
- Type
- n/a
- Inherited_from
- \source::$$_field_defs
- Inherited_from
- \ext_rest::$$_field_defs
bool
$_has_testing_enabled= 'false'
falseDetails- Type
- bool
- Inherited_from
- \source::$$_has_testing_enabled
- Inherited_from
- \ext_rest::$$_has_testing_enabled
$_mapping= ''
- Type
- n/a
- Inherited_from
- \source::$$_mapping
- Inherited_from
- \ext_rest::$$_mapping
$_required_config_fields= 'array()'
array()Details- Type
- n/a
- Inherited_from
- \source::$$_required_config_fields
- Inherited_from
- \ext_rest::$$_required_config_fields
$_required_config_fields_for_button= 'array()'
array()Details- Type
- n/a
- Inherited_from
- \source::$$_required_config_fields_for_button
- Inherited_from
- \ext_rest::$$_required_config_fields_for_button
$_url= ''
- Type
- n/a
- Inherited_from
- \ext_rest::$$_url
$config_decrypted= 'false'
falseDetails- Type
- n/a
- Inherited_from
- \source::$$config_decrypted
- Inherited_from
- \ext_rest::$$config_decrypted
$wrapperName= ''
The name of an wrapper to use if the class wants to provide an override
Inherited from: \source::$$wrapperName\ext_rest::$$wrapperName- Type
- n/a
- Inherited_from
- \source::$$wrapperName
- Inherited_from
- \ext_rest::$$wrapperName
Methods
__construct(
)
:
void__destruct(
)
:
void
convertPersonListResponeToArray(
$xmlResp, $result, $suffix
=
''
)
:
void| Name | Type | Description |
|---|---|---|
| $xmlResp | ||
| $result | ||
| $suffix |
fetchUrl(
$url
)
:
void| Name | Type | Description |
|---|---|---|
| $url |
filterAllowedModules(
array $moduleList
)
:
arrayFilter which modules are allowed to connect
Inherited from: \source::filterAllowedModules()\ext_rest::filterAllowedModules()| Name | Type | Description |
|---|---|---|
| $moduleList | array |
| Type | Description |
|---|---|
| array | Allowed modules |
formatListResponse(
$resp
)
:
void| Name | Type | Description |
|---|---|---|
| $resp |
getFieldsWithParams(
string $param_name, string $param_value
)
:
arrayGiven a parameter in a vardef field, return the list of fields that match the param and value
Inherited from: \source::getFieldsWithParams()\ext_rest::getFieldsWithParams()| Name | Type | Description |
|---|---|---|
| $param_name | string | |
| $param_value | string |
| Type | Description |
|---|---|
| array |
getItem(
\$args $args
=
array(), \$module $module
=
null
)
:
ArraygetItem Returns an array containing a key/value pair(s) of a connector record. To be overridden by the implementation source.
| Name | Type | Description |
|---|---|---|
| $args | \$args | Array of arguments to search/filter by |
| $module | \$module | String optional value of the module that the connector framework is attempting to map to |
| Type | Description |
|---|---|
| Array | of key/value pair(s) of connector record; empty Array if no results are found |
getList(
\$args $args
=
array(), \$module $module
=
null
)
:
ArraygetList Returns a nested array containing a key/value pair(s) of a connector record. To be overridden by the implementation source.
| Name | Type | Description |
|---|---|---|
| $args | \$args | Array of arguments to search/filter by |
| $module | \$module | String optional value of the module that the connector framework is attempting to map to |
| Type | Description |
|---|---|
| Array | of key/value pair(s) of connector record; empty Array if no results are found |
getOriginalMapping(
)
:
void
getProperties(
)
:
void
getProperty(
$name
)
:
void
| Name | Type | Description |
|---|---|---|
| $name |
getRequiredConfigFields(
)
:
\$fieldsgetRequiredConfigFields This method returns an Array of the configuration keys that are required for the Connector.
Inherited from: \source::getRequiredConfigFields()\ext_rest::getRequiredConfigFields()Subclasses should set the class variable _required_config_fields to return an Array of keys as specified in the Connector's config.php that are required.
| Type | Description |
|---|---|
| \$fields | Array of Connector config fields that are required |
getRequiredConfigFieldsForButton(
)
:
\$fieldsgetRequiredConfigFieldsForButton This method returns an Array of the configuration keys that are required before the "Get Data" button will include the Connector. We use it as a subset of the $this->_required_config_fields Array.
Inherited from: \source::getRequiredConfigFieldsForButton()\ext_rest::getRequiredConfigFieldsForButton()| Type | Description |
|---|---|
| \$fields | Array of Connector config fields that are required to be set for the "Get Data" button to appear |
hasTestingEnabled(
)
:
\enabledhasTestingEnabled This method is used to indicate whether or not a data source has testing enabled so that the administration interface may call the test method on the data source instance
Inherited from: \source::hasTestingEnabled()\ext_rest::hasTestingEnabled()| Type | Description |
|---|---|
| \enabled | boolean value indicating whether or not testing is enabled |
initConfig(
)
:
voidInitialize config - decrypt encrypted fields
Inherited from: \source::initConfig()\ext_rest::initConfig()isEnabledInAdminDisplay(
)
:
booleanisEnabledInAdminDisplay This method indicates whether or not the connector should be shown in the Enable Connectors view.
Inherited from: \source::isEnabledInAdminDisplay()\ext_rest::isEnabledInAdminDisplay()The Admin views call each source's isEnabledInAdminDisplay method to verify whether or not the connector should be displayed. Connectors that do not have any administrative display settings should set the protected class variable _enable_in_admin_display to false.
| Type | Description |
|---|---|
| boolean | value indicating whether or not the connector is enabled for admin views |
isEnabledInAdminMapping(
)
:
booleanisEnabledInAdminMapping This method indicates whether or not the connector should be shown in the Map Connector Fields view.
Inherited from: \source::isEnabledInAdminMapping()\ext_rest::isEnabledInAdminMapping()The Admin views call each source's isEnabledInAdminMapping method to verify whether or not the connector should be displayed. Connectors that do not have any administrative mapping properties should set the protected class variable _enable_in_admin_mapping to false.
| Type | Description |
|---|---|
| boolean | value indicating whether or not the connector is enabled for admin views |
isEnabledInAdminProperties(
)
:
booleanisEnabledInAdminProperties This method indicates whether or not the connector should be shown in the Set Connector Properties view.
Inherited from: \source::isEnabledInAdminProperties()\ext_rest::isEnabledInAdminProperties()The Admin views call each source's isEnabledInAdminProperties method to verify whether or not the connector should be displayed. Connectors that do not have any administrative properties should set the protected class variable _enable_in_admin_properties to false.
| Type | Description |
|---|---|
| boolean | value indicating whether or not the connector is enabled for admin views |
isEnabledInAdminSearch(
)
:
booleanisEnabledInAdminSearch This method indicates whether or not the connector should be shown in the Manage Connectors Search view.
Inherited from: \source::isEnabledInAdminSearch()\ext_rest::isEnabledInAdminSearch()The Admin views call each source's isEnabledInAdminSearch method to verify whether or not the connector should be displayed. Connectors that do not have any administrative search settings should set the protected class variable _enable_in_admin_search to false.
| Type | Description |
|---|---|
| boolean | value indicating whether or not the connector is enabled for admin views |
isEnabledInHover(
)
:
\$enabledisEnabledInHover This method indicates whether or not the connector should be enabled for the hover links Connectors that do not provide a formatter implementation should not set the protected class variable _enable_in_hover to true.
Inherited from: \source::isEnabledInHover()\ext_rest::isEnabledInHover()| Type | Description |
|---|---|
| \$enabled | boolean variable indicating whether or not the connector is enabled for the hover links |
isEnabledInWizard(
)
:
\$enabledisEnabledInWizard This method indicates whether or not the connector should be enabled in the wizard Connectors that do not support the getList/getItem methods via API calls should set the protected class variable _enable_in_wizard to false.
Inherited from: \source::isEnabledInWizard()\ext_rest::isEnabledInWizard()| Type | Description |
|---|---|
| \$enabled | boolean variable indicating whether or not the connector is enabled for the wizard |
isRequiredConfigFieldsForButtonSet(
)
:
\$setisRequiredConfigFieldsForButtonSet This method checks the configuration parameters against the required config fields for the "Get Button" to see if they are set
Inherited from: \source::isRequiredConfigFieldsForButtonSet()\ext_rest::isRequiredConfigFieldsForButtonSet()| Type | Description |
|---|---|
| \$set | boolean value indicating whether or not the required config fields are set |
isRequiredConfigFieldsSet(
)
:
\$setisRequiredConfigFieldsSet This method checks the configuration parameters against the required config fields to see if they are set
Inherited from: \source::isRequiredConfigFieldsSet()\ext_rest::isRequiredConfigFieldsSet()| Type | Description |
|---|---|
| \$set | boolean value indicating whether or not the required config fields are set |
loadConfig(
)
:
voidLoad config.php for this source
Inherited from: \source::loadConfig()\ext_rest::loadConfig()loadVardefs(
)
:
void
log(
string $log_data
)
:
void
| Name | Type | Description |
|---|---|---|
| $log_data | string |
propertyExists(
string $name
)
:
boolCheck if certain property contains non-empty value
Inherited from: \source::propertyExists()\ext_rest::propertyExists()| Name | Type | Description |
|---|---|---|
| $name | string |
| Type | Description |
|---|---|
| bool |
saveConfig(
)
:
voidSave source's config to custom directory
Inherited from: \source::saveConfig()\ext_rest::saveConfig()saveMappingHook(
$mapping
)
:
void
| Name | Type | Description |
|---|---|---|
| $mapping |
setConfig(
$config
)
:
void
| Name | Type | Description |
|---|---|---|
| $config |
setEAPM(
$eapm
)
:
void
| Name | Type | Description |
|---|---|---|
| $eapm |
setMapping(
$mapping
)
:
void
| Name | Type | Description |
|---|---|---|
| $mapping |
setProperties(
$properties
=
array()
)
:
void
| Name | Type | Description |
|---|---|---|
| $properties |
setUrl(
$url
)
:
void| Name | Type | Description |
|---|---|---|
| $url |
test(
)
:
\resulttest This method is called from the administration interface to run a test of the service It is up to subclasses to implement a test and set _has_testing_enabled to true so that a test button is rendered in the administration interface
Inherited from: \source::test()\ext_rest::test()| Type | Description |
|---|---|
| \result | boolean result of the test function |