[Summary view] [Print] [Text view]

   1  <?php
   2  
   3  /*
   4   * This file is part of JSON-API.
   5   *
   6   * (c) Toby Zerner <[email protected]>
   7   *
   8   * For the full copyright and license information, please view the LICENSE
   9   * file that was distributed with this source code.
  10   */
  11  
  12  namespace Tobscure\JsonApi;
  13  
  14  interface ElementInterface
  15  {
  16      /**
  17       * Get the resources array.
  18       *
  19       * @return array
  20       */
  21      public function getResources();
  22  
  23      /**
  24       * Map to a "resource object" array.
  25       *
  26       * @return array
  27       */
  28      public function toArray();
  29  
  30      /**
  31       * Map to a "resource object identifier" array.
  32       *
  33       * @return array
  34       */
  35      public function toIdentifier();
  36  
  37      /**
  38       * Request a relationship to be included.
  39       *
  40       * @param string|array $relationships
  41       *
  42       * @return $this
  43       */
  44      public function with($relationships);
  45  
  46      /**
  47       * Request a restricted set of fields.
  48       *
  49       * @param array|null $fields
  50       *
  51       * @return $this
  52       */
  53      public function fields($fields);
  54  }