Chris@18: <?php
Chris@18: 
Chris@18: namespace Drupal\jsonapi\Entity;
Chris@18: 
Chris@18: use Drupal\Core\Entity\EntityInterface;
Chris@18: use Drupal\Core\Entity\FieldableEntityInterface;
Chris@18: use Drupal\jsonapi\Exception\UnprocessableHttpEntityException;
Chris@18: 
Chris@18: /**
Chris@18:  * Provides a method to validate an entity.
Chris@18:  *
Chris@18:  * @internal JSON:API maintains no PHP API. The API is the HTTP API. This class
Chris@18:  *   may change at any time and could break any dependencies on it.
Chris@18:  *
Chris@18:  * @see https://www.drupal.org/project/jsonapi/issues/3032787
Chris@18:  * @see jsonapi.api.php
Chris@18:  */
Chris@18: trait EntityValidationTrait {
Chris@18: 
Chris@18:   /**
Chris@18:    * Verifies that an entity does not violate any validation constraints.
Chris@18:    *
Chris@18:    * @param \Drupal\Core\Entity\EntityInterface $entity
Chris@18:    *   The entity object.
Chris@18:    * @param string[] $field_names
Chris@18:    *   (optional) An array of field names. If specified, filters the violations
Chris@18:    *   list to include only this set of fields. Defaults to NULL,
Chris@18:    *   which means that all violations will be reported.
Chris@18:    *
Chris@18:    * @throws \Drupal\jsonapi\Exception\UnprocessableHttpEntityException
Chris@18:    *   Thrown when violations remain after filtering.
Chris@18:    *
Chris@18:    * @see \Drupal\rest\Plugin\rest\resource\EntityResourceValidationTrait::validate()
Chris@18:    */
Chris@18:   protected static function validate(EntityInterface $entity, array $field_names = NULL) {
Chris@18:     if (!$entity instanceof FieldableEntityInterface) {
Chris@18:       return;
Chris@18:     }
Chris@18: 
Chris@18:     $violations = $entity->validate();
Chris@18: 
Chris@18:     // Remove violations of inaccessible fields as they cannot stem from our
Chris@18:     // changes.
Chris@18:     $violations->filterByFieldAccess();
Chris@18: 
Chris@18:     // Filter violations based on the given fields.
Chris@18:     if ($field_names !== NULL) {
Chris@18:       $violations->filterByFields(
Chris@18:         array_diff(array_keys($entity->getFieldDefinitions()), $field_names)
Chris@18:       );
Chris@18:     }
Chris@18: 
Chris@18:     if (count($violations) > 0) {
Chris@18:       // Instead of returning a generic 400 response we use the more specific
Chris@18:       // 422 Unprocessable Entity code from RFC 4918. That way clients can
Chris@18:       // distinguish between general syntax errors in bad serializations (code
Chris@18:       // 400) and semantic errors in well-formed requests (code 422).
Chris@18:       // @see \Drupal\jsonapi\Normalizer\UnprocessableHttpEntityExceptionNormalizer
Chris@18:       $exception = new UnprocessableHttpEntityException();
Chris@18:       $exception->setViolations($violations);
Chris@18:       throw $exception;
Chris@18:     }
Chris@18:   }
Chris@18: 
Chris@18: }