include/connectors/sources/loc/xml.php

Show:

inherited

Classes
- \loc_xml

Table of Contents

\loc_xml
jump to top

Package: SugarCRM

Local XML source

Parent(s): \source
Api

Properties


                 $_config= ''

inheritedInherited from: \source::$$_config

Details

Type: n/a
Inherited_from: \source::$$_config

\_eapm
                 $_eapm= 'null'

inherited

The ExternalAPI Base that instantiated this connector.

Inherited from: \source::$$_eapm

Default valuenullDetails

Type: \_eapm
Inherited_from: \source::$$_eapm

bool
                 $_enable_in_admin_display= 'true'

inherited

enable_in_admin_display Boolean value marking whether or not this connector should appear in the Enable Connectors viewInherited from: \source::$$_enable_in_admin_display

Default valuetrueDetails

Type: bool
Inherited_from: \source::$$_enable_in_admin_display

bool
                 $_enable_in_admin_mapping= 'true'

inherited

enable_in_admin_mapping Boolean value marking whether or not this connector should be shown in the Modify Mapping viewInherited from: \source::$$_enable_in_admin_mapping

Default valuetrueDetails

Type: bool
Inherited_from: \source::$$_enable_in_admin_mapping

bool
                 $_enable_in_admin_properties= 'true'

inherited

enable_in_admin_properties Boolean value marking whether or not this connector should appear in the Set Connector Properties viewInherited from: \source::$$_enable_in_admin_properties

Default valuetrueDetails

Type: bool
Inherited_from: \source::$$_enable_in_admin_properties

bool
                 $_enable_in_admin_search= 'true'

inherited

enable_in_admin_search Boolean value marking whether or not this connector should appear in the Manage Connector Search viewInherited from: \source::$$_enable_in_admin_search

Default valuetrueDetails

Type: bool
Inherited_from: \source::$$_enable_in_admin_search

bool
                 $_enable_in_hover= 'false'

inherited

enable_in_hover Boolean value marking whether or not a hover link could be applied to the connectorInherited from: \source::$$_enable_in_hover

Default valuefalseDetails

Type: bool
Inherited_from: \source::$$_enable_in_hover

bool
                 $_enable_in_wizard= 'true'

inherited

enable_in_wizard Boolean value marking whether or not the connector may appear in the wizard (Get Data) viewsInherited from: \source::$$_enable_in_wizard

Default valuetrueDetails

Type: bool
Inherited_from: \source::$$_enable_in_wizard


                 $_field_defs= ''

inheritedInherited from: \source::$$_field_defs

Details

Type: n/a
Inherited_from: \source::$$_field_defs

bool
                 $_has_testing_enabled= 'false'

inherited

has_testing_enabled Boolean value marking whether or not the connector should display the test button in administration viewInherited from: \source::$$_has_testing_enabled

Default valuefalseDetails

Type: bool
Inherited_from: \source::$$_has_testing_enabled


                 $_mapping= ''

inheritedInherited from: \source::$$_mapping

Details

Type: n/a
Inherited_from: \source::$$_mapping


                 $_required_config_fields= 'array()'

inheritedInherited from: \source::$$_required_config_fields

Default valuearray()Details

Type: n/a
Inherited_from: \source::$$_required_config_fields


                 $_required_config_fields_for_button= 'array()'

inheritedInherited from: \source::$$_required_config_fields_for_button

Default valuearray()Details

Type: n/a
Inherited_from: \source::$$_required_config_fields_for_button


                 $config_decrypted= 'false'

inheritedInherited from: \source::$$config_decrypted

Default valuefalseDetails

Type: n/a
Inherited_from: \source::$$config_decrypted


                 $wrapperName= ''

inherited

The name of an wrapper to use if the class wants to provide an override

Inherited from: \source::$$wrapperName

Details

Type: n/a
Inherited_from: \source::$$wrapperName

Methods

__construct(
          
          )
        
        :
          void

inherited

Inherited from: \source::__construct()

__destruct(
          
          )
        
        :
          void

inherited

Default destructor

Inherited from: \source::__destruct()

__parse(
           $file
          )
        
        :
          void

Parameters

Name	Type	Description
$file

filterAllowedModules(
          array $moduleList
          )
        
        :
          array

inherited

Filter which modules are allowed to connect

Inherited from: \source::filterAllowedModules()

Parameters

Name	Type	Description
$moduleList	array

Returns

Type	Description
array	Allowed modules

getConfig(
          
          )
        
        :
          void

inherited

Inherited from: \source::getConfig()

getEAPM(
          
          )
        
        :
          void

inherited

Inherited from: \source::getEAPM()

getFieldDefs(
          
          )
        
        :
          void

inherited

Inherited from: \source::getFieldDefs()

getFieldsWithParams(
          string $param_name, string $param_value
          )
        
        :
          array

inherited

Given a parameter in a vardef field, return the list of fields that match the param and value

Inherited from: \source::getFieldsWithParams()

Parameters

Name	Type	Description
$param_name	string
$param_value	string

Returns

Type	Description
array

getItem(
          \$args $args
              =
              array(), \$module $module
              =
              null
          )
        
        :
          Array

abstractinherited

getItem Returns an array containing a key/value pair(s) of a connector record. To be overridden by the implementation source.

Inherited from: \source::getItem()

Parameters

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

Returns

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
          )
        
        :
          Array

abstractinherited

getList Returns a nested array containing a key/value pair(s) of a connector record. To be overridden by the implementation source.

Inherited from: \source::getList()

Parameters

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

Returns

Type	Description
Array	of key/value pair(s) of connector record; empty Array if no results are found

getMapping(
          
          )
        
        :
          void

inherited

Inherited from: \source::getMapping()

getOriginalMapping(
          
          )
        
        :
          void

inherited

Inherited from: \source::getOriginalMapping()

getProperties(
          
          )
        
        :
          void

inherited

Inherited from: \source::getProperties()

getProperty(
           $name
          )
        
        :
          void

inherited

Inherited from: \source::getProperty()

Parameters

Name	Type	Description
$name

getRequiredConfigFields(
          
          )
        
        :
          \$fields

inherited

getRequiredConfigFields This method returns an Array of the configuration keys that are required for the Connector.

Inherited from: \source::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.

Returns

Type	Description
\$fields	Array of Connector config fields that are required

getRequiredConfigFieldsForButton(
          
          )
        
        :
          \$fields

inherited

getRequiredConfigFieldsForButton 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()

Returns

Type	Description
\$fields	Array of Connector config fields that are required to be set for the "Get Data" button to appear

hasTestingEnabled(
          
          )
        
        :
          \enabled

inherited

hasTestingEnabled 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()

Returns

Type	Description
\enabled	boolean value indicating whether or not testing is enabled

inherited

Inherited from: \source::init()

initConfig(
          
          )
        
        :
          void

inherited

Initialize config - decrypt encrypted fields

Inherited from: \source::initConfig()

isEnabledInAdminDisplay(
          
          )
        
        :
          boolean

inherited

isEnabledInAdminDisplay This method indicates whether or not the connector should be shown in the Enable Connectors view.

Inherited from: \source::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.

Returns

Type	Description
boolean	value indicating whether or not the connector is enabled for admin views

isEnabledInAdminMapping(
          
          )
        
        :
          boolean

inherited

isEnabledInAdminMapping This method indicates whether or not the connector should be shown in the Map Connector Fields view.

Inherited from: \source::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.

Returns

Type	Description
boolean	value indicating whether or not the connector is enabled for admin views

isEnabledInAdminProperties(
          
          )
        
        :
          boolean

inherited

isEnabledInAdminProperties This method indicates whether or not the connector should be shown in the Set Connector Properties view.

Inherited from: \source::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.

Returns

Type	Description
boolean	value indicating whether or not the connector is enabled for admin views

isEnabledInAdminSearch(
          
          )
        
        :
          boolean

inherited

isEnabledInAdminSearch This method indicates whether or not the connector should be shown in the Manage Connectors Search view.

Inherited from: \source::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.

Returns

Type	Description
boolean	value indicating whether or not the connector is enabled for admin views

isEnabledInHover(
          
          )
        
        :
          \$enabled

inherited

isEnabledInHover 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()

Returns

Type	Description
\$enabled	boolean variable indicating whether or not the connector is enabled for the hover links

isEnabledInWizard(
          
          )
        
        :
          \$enabled

inherited

isEnabledInWizard 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()

Returns

Type	Description
\$enabled	boolean variable indicating whether or not the connector is enabled for the wizard

isRequiredConfigFieldsForButtonSet(
          
          )
        
        :
          \$set

inherited

isRequiredConfigFieldsForButtonSet 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()

Returns

Type	Description
\$set	boolean value indicating whether or not the required config fields are set

isRequiredConfigFieldsSet(
          
          )
        
        :
          \$set

inherited

isRequiredConfigFieldsSet This method checks the configuration parameters against the required config fields to see if they are set

Inherited from: \source::isRequiredConfigFieldsSet()

Returns

Type	Description
\$set	boolean value indicating whether or not the required config fields are set

loadConfig(
          
          )
        
        :
          void

inherited

Load config.php for this source

Inherited from: \source::loadConfig()

loadMapping(
          
          )
        
        :
          void

inherited

Inherited from: \source::loadMapping()

loadVardefs(
          
          )
        
        :
          void

inherited

Load source's vardef file

Inherited from: \source::loadVardefs()

log(
          string $log_data
          )
        
        :
          void

inherited

Allow data sources to log information

Inherited from: \source::log()

Parameters

Name	Type	Description
$log_data	string

propertyExists(
          string $name
          )
        
        :
          bool

inherited

Check if certain property contains non-empty value

Inherited from: \source::propertyExists()

Parameters

Name	Type	Description
$name	string

Returns

Type	Description
bool

saveConfig(
          
          )
        
        :
          void

inherited

Save source's config to custom directory

Inherited from: \source::saveConfig()

saveMappingHook(
           $mapping
          )
        
        :
          void

inherited

Inherited from: \source::saveMappingHook()

Parameters

Name	Type	Description
$mapping

setConfig(
           $config
          )
        
        :
          void

inherited

Inherited from: \source::setConfig()

Parameters

Name	Type	Description
$config

setEAPM(
           $eapm
          )
        
        :
          void

inherited

Inherited from: \source::setEAPM()

Parameters

Name	Type	Description
$eapm

setMapping(
           $mapping
          )
        
        :
          void

inherited

Inherited from: \source::setMapping()

Parameters

Name	Type	Description
$mapping

setProperties(
           $properties
              =
              array()
          )
        
        :
          void

inherited

Inherited from: \source::setProperties()

Parameters

Name	Type	Description
$properties

test(
          
          )
        
        :
          \result

inherited

test 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()

Returns

Type	Description
\result	boolean result of the test function

include/connectors/sources/loc/xml.php

\loc_xmljump to top

Properties

Methods

\loc_xml
jump to top