You are here

interface ResourceFieldEnhancerInterface in JSON:API Extras 8.2

Same name and namespace in other branches
  1. 8.3 src/Plugin/ResourceFieldEnhancerInterface.php \Drupal\jsonapi_extras\Plugin\ResourceFieldEnhancerInterface
  2. 8 src/Plugin/ResourceFieldEnhancerInterface.php \Drupal\jsonapi_extras\Plugin\ResourceFieldEnhancerInterface

Provides an interface defining a ResourceFieldEnhancer entity.

Hierarchy

  • interface \Drupal\jsonapi_extras\Plugin\ResourceFieldEnhancerInterface extends \Shaper\Transformation\TransformationInterface \Shaper\DataAdaptor\ReversibleTransformationInterface \Shaper\Transformation\TransformationValidationInterface \Shaper\DataAdaptor\ReversibleTransformationValidationInterface

Expanded class hierarchy of ResourceFieldEnhancerInterface

All classes that implement ResourceFieldEnhancerInterface

File

src/Plugin/ResourceFieldEnhancerInterface.php, line 14

Namespace

Drupal\jsonapi_extras\Plugin
View source
interface ResourceFieldEnhancerInterface extends TransformationInterface, ReversibleTransformationInterface, TransformationValidationInterface, ReversibleTransformationValidationInterface {

  /**
   * Get the JSON Schema for the new output.
   *
   * @return array
   *   An structured array representing the JSON Schema of the new output.
   */
  public function getOutputJsonSchema();

  /**
   * Get a form element to render the settings.
   *
   * @param array $resource_field_info
   *   The resource field info.
   *
   * @return array
   *   The form element array.
   */
  public function getSettingsForm(array $resource_field_info);

}

Members

Namesort descending Modifiers Type Description Overrides
ResourceFieldEnhancerInterface::getOutputJsonSchema public function Get the JSON Schema for the new output. 4
ResourceFieldEnhancerInterface::getSettingsForm public function Get a form element to render the settings. 1