ScannerPluginInterface.php in Search and Replace Scanner 8
Namespace
Drupal\scanner\PluginFile
src/Plugin/ScannerPluginInterface.phpView source
<?php
namespace Drupal\scanner\Plugin;
use Drupal\Core\Plugin\ContainerFactoryPluginInterface;
use Drupal\Component\Plugin\PluginInspectionInterface;
/**
* Plugin for ScannerPluginInterface.
*/
interface ScannerPluginInterface extends PluginInspectionInterface, ContainerFactoryPluginInterface {
/**
* Performs the search operation and returns the results..
*
* @param string $field
* The fully qualified name of the field (entityType:bundle:fieldname).
* @param string $values
* The input values from the form ($form_state values).
*
* @return array
* An array containing the entity titles and an array of matches in the
* entity.
*/
public function search($field, array $values);
/**
* Performs the replace operation and returns the results.
*
* @param string $field
* The fully qualified name of the field (entityType:bundle:fieldname).
* @param string $values
* The input values from the form ($form_state values).
* @param array $undo_data
* The array for data values.
*
* @return array
* An array containing both the old and new revision IDs for each affected
* entity.
*/
public function replace($field, array $values, array $undo_data);
/**
* Performs the undo operation.
*
* @param array $data
* An array containing the old and new revision id for the enttiy.
*/
public function undo(array $data);
}
Interfaces
Name | Description |
---|---|
ScannerPluginInterface | Plugin for ScannerPluginInterface. |