class Soap in Migrate Plus 8.5
Same name and namespace in other branches
- 8.2 src/Plugin/migrate_plus/data_parser/Soap.php \Drupal\migrate_plus\Plugin\migrate_plus\data_parser\Soap
- 8.3 src/Plugin/migrate_plus/data_parser/Soap.php \Drupal\migrate_plus\Plugin\migrate_plus\data_parser\Soap
- 8.4 src/Plugin/migrate_plus/data_parser/Soap.php \Drupal\migrate_plus\Plugin\migrate_plus\data_parser\Soap
Obtain SOAP data for migration.
Plugin annotation
@DataParser(
id = "soap",
title = @Translation("SOAP")
)
Hierarchy
- class \Drupal\Component\Plugin\PluginBase implements DerivativeInspectionInterface, PluginInspectionInterface
- class \Drupal\Core\Plugin\PluginBase uses DependencySerializationTrait, MessengerTrait, StringTranslationTrait
- class \Drupal\migrate_plus\DataParserPluginBase implements DataParserPluginInterface
- class \Drupal\migrate_plus\Plugin\migrate_plus\data_parser\Soap implements ContainerFactoryPluginInterface
- class \Drupal\migrate_plus\DataParserPluginBase implements DataParserPluginInterface
- class \Drupal\Core\Plugin\PluginBase uses DependencySerializationTrait, MessengerTrait, StringTranslationTrait
Expanded class hierarchy of Soap
File
- src/
Plugin/ migrate_plus/ data_parser/ Soap.php, line 18
Namespace
Drupal\migrate_plus\Plugin\migrate_plus\data_parserView source
class Soap extends DataParserPluginBase implements ContainerFactoryPluginInterface {
/**
* Iterator over the SOAP data.
*
* @var \Iterator
*/
protected $iterator;
/**
* Method to call on the SOAP service.
*
* @var string
*/
protected $function;
/**
* Parameters to pass to the SOAP service function.
*
* @var array
*/
protected $parameters;
/**
* Form of the function response - 'xml', 'object', or 'array'.
*
* @var string
*/
protected $responseType;
/**
* {@inheritdoc}
*
* @throws \Drupal\migrate\Exception\RequirementsException
* If PHP SOAP extension is not installed.
*/
public function __construct(array $configuration, $plugin_id, $plugin_definition) {
if (!class_exists('\\SoapClient')) {
throw new RequirementsException('The PHP SOAP extension is not installed');
}
parent::__construct($configuration, $plugin_id, $plugin_definition);
$this->function = $configuration['function'];
$this->parameters = $configuration['parameters'];
$this->responseType = $configuration['response_type'];
}
/**
* {@inheritdoc}
*
* @throws \SoapFault
* If there's an error in a SOAP call.
* @throws \Drupal\migrate\MigrateException
* If we can't resolve the SOAP function or its response property.
*/
protected function openSourceUrl($url) {
// Will throw SoapFault if there's an error in a SOAP call.
$client = new \SoapClient($url);
// Determine the response property name.
$function_found = FALSE;
foreach ($client
->__getFunctions() as $function_signature) {
// E.g., "GetWeatherResponse GetWeather(GetWeather $parameters)".
$response_type = strtok($function_signature, ' ');
$function_name = strtok('(');
if (strcasecmp($function_name, $this->function) === 0) {
$function_found = TRUE;
foreach ($client
->__getTypes() as $type_info) {
// E.g., "struct GetWeatherResponse {\n string GetWeatherResult;\n}".
if (preg_match('|struct (.*?) {\\s*[a-z]+ (.*?);|is', $type_info, $matches)) {
if ($matches[1] == $response_type) {
$response_property = $matches[2];
}
}
}
break;
}
}
if (!$function_found) {
throw new MigrateException("SOAP function {$this->function} not found.");
}
elseif (!isset($response_property)) {
throw new MigrateException("Response property not found for SOAP function {$this->function}.");
}
$response = $client
->{$this->function}($this->parameters);
$response_value = $response->{$response_property};
switch ($this->responseType) {
case 'xml':
$xml = simplexml_load_string($response_value);
$this->iterator = new \ArrayIterator($xml
->xpath($this->itemSelector));
break;
case 'object':
$this->iterator = new \ArrayIterator($response_value->{$this->itemSelector});
break;
case 'array':
$this->iterator = new \ArrayIterator($response_value[$this->itemSelector]);
break;
}
return TRUE;
}
/**
* {@inheritdoc}
*/
protected function fetchNextRow() {
$current = $this->iterator
->current();
if ($current) {
foreach ($this
->fieldSelectors() as $field_name => $selector) {
$this->currentItem[$field_name] = $current->{$selector};
}
$this->iterator
->next();
}
}
}
Members
Name | Modifiers | Type | Description | Overrides |
---|---|---|---|---|
DataParserPluginBase:: |
protected | property | Index of the currently-open url. | |
DataParserPluginBase:: |
protected | property | Value of the ID for the current item when iterating. | |
DataParserPluginBase:: |
protected | property | Current item when iterating. | |
DataParserPluginBase:: |
protected | property | The data retrieval client. | |
DataParserPluginBase:: |
protected | property | String indicating how to select an item's data from the source. | |
DataParserPluginBase:: |
protected | property | List of source urls. | |
DataParserPluginBase:: |
public | function | ||
DataParserPluginBase:: |
public static | function | ||
DataParserPluginBase:: |
public | function | ||
DataParserPluginBase:: |
protected | function | Return the selectors used to populate each configured field. | |
DataParserPluginBase:: |
public | function | Returns the initialized data fetcher plugin. | |
DataParserPluginBase:: |
public | function | ||
DataParserPluginBase:: |
public | function | Implementation of Iterator::next(). | |
DataParserPluginBase:: |
protected | function | Advances the data parser to the next source url. | 1 |
DataParserPluginBase:: |
public | function | 1 | |
DataParserPluginBase:: |
public | function | ||
DependencySerializationTrait:: |
protected | property | An array of entity type IDs keyed by the property name of their storages. | |
DependencySerializationTrait:: |
protected | property | An array of service IDs keyed by property name used for serialization. | |
DependencySerializationTrait:: |
public | function | 1 | |
DependencySerializationTrait:: |
public | function | 2 | |
MessengerTrait:: |
protected | property | The messenger. | 29 |
MessengerTrait:: |
public | function | Gets the messenger. | 29 |
MessengerTrait:: |
public | function | Sets the messenger. | |
PluginBase:: |
protected | property | Configuration information passed into the plugin. | 1 |
PluginBase:: |
protected | property | The plugin implementation definition. | 1 |
PluginBase:: |
protected | property | The plugin_id. | |
PluginBase:: |
constant | A string which is used to separate base plugin IDs from the derivative ID. | ||
PluginBase:: |
public | function |
Gets the base_plugin_id of the plugin instance. Overrides DerivativeInspectionInterface:: |
|
PluginBase:: |
public | function |
Gets the derivative_id of the plugin instance. Overrides DerivativeInspectionInterface:: |
|
PluginBase:: |
public | function |
Gets the definition of the plugin implementation. Overrides PluginInspectionInterface:: |
3 |
PluginBase:: |
public | function |
Gets the plugin_id of the plugin instance. Overrides PluginInspectionInterface:: |
|
PluginBase:: |
public | function | Determines if the plugin is configurable. | |
Soap:: |
protected | property | Method to call on the SOAP service. | |
Soap:: |
protected | property | Iterator over the SOAP data. | |
Soap:: |
protected | property | Parameters to pass to the SOAP service function. | |
Soap:: |
protected | property | Form of the function response - 'xml', 'object', or 'array'. | |
Soap:: |
protected | function |
Retrieves the next row of data. populating currentItem. Overrides DataParserPluginBase:: |
|
Soap:: |
protected | function |
Overrides DataParserPluginBase:: |
|
Soap:: |
public | function |
Overrides DataParserPluginBase:: |
|
StringTranslationTrait:: |
protected | property | The string translation service. | 1 |
StringTranslationTrait:: |
protected | function | Formats a string containing a count of items. | |
StringTranslationTrait:: |
protected | function | Returns the number of plurals supported by a given language. | |
StringTranslationTrait:: |
protected | function | Gets the string translation service. | |
StringTranslationTrait:: |
public | function | Sets the string translation service to use. | 2 |
StringTranslationTrait:: |
protected | function | Translates a string to the current language or to a given language. |