Chris@18: <?php
Chris@18: 
Chris@18: namespace Drupal\jsonapi\JsonApiResource;
Chris@18: 
Chris@18: use Drupal\Component\Assertion\Inspector;
Chris@18: use Symfony\Component\HttpKernel\Exception\HttpExceptionInterface;
Chris@18: 
Chris@18: /**
Chris@18:  * To be used when the primary data is `errors`.
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:  * (The spec says the top-level `data` and `errors` members MUST NOT coexist.)
Chris@18:  * @see http://jsonapi.org/format/#document-top-level
Chris@18:  *
Chris@18:  * @see http://jsonapi.org/format/#error-objects
Chris@18:  */
Chris@18: class ErrorCollection implements \IteratorAggregate {
Chris@18: 
Chris@18:   /**
Chris@18:    * The HTTP exceptions.
Chris@18:    *
Chris@18:    * @var \Symfony\Component\HttpKernel\Exception\HttpExceptionInterface[]
Chris@18:    */
Chris@18:   protected $errors;
Chris@18: 
Chris@18:   /**
Chris@18:    * Instantiates an ErrorCollection object.
Chris@18:    *
Chris@18:    * @param \Symfony\Component\HttpKernel\Exception\HttpExceptionInterface[] $errors
Chris@18:    *   The errors.
Chris@18:    */
Chris@18:   public function __construct(array $errors) {
Chris@18:     assert(Inspector::assertAll(function ($error) {
Chris@18:       return $error instanceof HttpExceptionInterface;
Chris@18:     }, $errors));
Chris@18:     $this->errors = $errors;
Chris@18:   }
Chris@18: 
Chris@18:   /**
Chris@18:    * Returns an iterator for errors.
Chris@18:    *
Chris@18:    * @return \ArrayIterator
Chris@18:    *   An \ArrayIterator instance
Chris@18:    */
Chris@18:   public function getIterator() {
Chris@18:     return new \ArrayIterator($this->errors);
Chris@18:   }
Chris@18: 
Chris@18: }