1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 <?php
/**
* BEdita, API-first content management framework
* Copyright 2017 ChannelWeb Srl, Chialab Srl
*
* This file is part of BEdita: you can redistribute it and/or modify
* it under the terms of the GNU Lesser General Public License as published
* by the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* See LICENSE.LGPL or <http://gnu.org/licenses/lgpl-3.0.html> for more details.
*/
namespace BEdita\Core\Utility;
/**
* Interface for serializing JSON API objects.
*
* @since 4.0.0
*/
interface JsonApiSerializable
{
/**
* Tell JSON API serializer to exclude `attributes` from resource.
*
* @var int
*/
public const JSONAPIOPT_EXCLUDE_ATTRIBUTES = 1;
/**
* Tell JSON API serializer to exclude `meta` from resource.
*
* @var int
*/
public const JSONAPIOPT_EXCLUDE_META = 2;
/**
* Tell JSON API serializer to exclude `links` from resource.
*
* @var int
*/
public const JSONAPIOPT_EXCLUDE_LINKS = 4;
/**
* Tell JSON API serializer to exclude `relationships` from resource.
*
* @var int
*/
public const JSONAPIOPT_EXCLUDE_RELATIONSHIPS = 8;
/**
* Tell JSON API serializer to exclude all (`attributes`, `meta`, `links`, `relationships`) from resource
*
* @var int
*/
public const JSONAPIOPT_BASIC = 15;
/**
* JSON API serializer.
*
* This method **MUST** return a resource object as per JSON API specifications.
*
* @param int $options Options for serializing. Can be any combination of `JSONAPIOPT_*` constants.
* @param array $fields Selected fields to view in `attributes` and `meta`, default empty => all fields are serialized
* @return array
*/
public function jsonApiSerialize($options = 0, $fields = []);
/**
* Get prefix used for `_name` in routing urls creation.
*
* @return string
*/
public function routeNamePrefix();
}