interface JsonSchemaProviderSerializerInterface

Interface for JSON schema provider.

Hierarchy

Expanded class hierarchy of JsonSchemaProviderSerializerInterface

All classes that implement JsonSchemaProviderSerializerInterface

4 files declare their use of JsonSchemaProviderSerializerInterface
FieldItemNormalizer.php in core/modules/jsonapi/src/Normalizer/FieldItemNormalizer.php
FieldNormalizer.php in core/modules/jsonapi/src/Normalizer/FieldNormalizer.php
JsonApiDocumentTopLevelNormalizer.php in core/modules/jsonapi/src/Normalizer/JsonApiDocumentTopLevelNormalizer.php
Serializer.php in core/modules/jsonapi/src/Serializer/Serializer.php

File

core/modules/serialization/src/Serializer/JsonSchemaProviderSerializerInterface.php, line 10

Namespace

Drupal\serialization\Serializer
View on git.drupalcode.org
View source 
interface JsonSchemaProviderSerializerInterface {
  
  /**
   * Convenience method to get a JSON schema.
   *
   * Unlike calling ::normalize() with $format of 'json_schema' directly, this
   * method always returns a schema, even if it's empty.
   *
   * @param mixed $object
   *   Object or interface/class name for which to retrieve a schema.
   * @param array $context
   *   Normalization context.
   *
   * @return array
   *   Schema.
   */
  public function getJsonSchema(mixed $object, array $context) : array;

}

Members

Title Modifiers Object type Summary
JsonSchemaProviderSerializerInterface::getJsonSchema public function Convenience method to get a JSON schema.

Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.