[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 SerializerInterface
  15  {
  16      /**
  17       * Get the type.
  18       *
  19       * @param mixed $model
  20       *
  21       * @return string
  22       */
  23      public function getType($model);
  24  
  25      /**
  26       * Get the id.
  27       *
  28       * @param mixed $model
  29       *
  30       * @return string
  31       */
  32      public function getId($model);
  33  
  34      /**
  35       * Get the attributes array.
  36       *
  37       * @param mixed $model
  38       * @param array|null $fields
  39       *
  40       * @return array
  41       */
  42      public function getAttributes($model, array $fields = null);
  43  
  44      /**
  45       * Get the links array.
  46       *
  47       * @param mixed $model
  48       *
  49       * @return array
  50       */
  51      public function getLinks($model);
  52  
  53      /**
  54       * Get the meta.
  55       *
  56       * @param mixed $model
  57       *
  58       * @return array
  59       */
  60      public function getMeta($model);
  61  
  62      /**
  63       * Get a relationship.
  64       *
  65       * @param mixed $model
  66       * @param string $name
  67       *
  68       * @return \Tobscure\JsonApi\Relationship|null
  69       */
  70      public function getRelationship($model, $name);
  71  }