tuyakhov / yii2-json-api

src/ResourceInterface.php

<?php
/**
 * @author Anton Tuyakhov <atuyakhov@gmail.com>
 */

namespace tuyakhov\jsonapi;

/**
 * Interface for a “resource object” that represent an individual resource.
 */
interface ResourceInterface extends ResourceIdentifierInterface
{
    /**
     * The "attributes" member of the resource object representing some of the resource’s data.
     * @param array $fields specific fields that a client has requested.
     * @return array an array of attributes that represent information about the resource object in which it’s defined.
     */
    public function getResourceAttributes(array $fields = []);

    /**
     * The "relationships" member of the resource object describing relationships between the resource and other JSON API resources.
     * @param null|array $linked specific resource linkage that a client has requested.
     * @return ResourceIdentifierInterface[] represent references from the resource object in which it’s defined to other resource objects.
     */
    public function getResourceRelationships(array $linked = null);

    public function setResourceRelationship($name, $relationship);

For interfaces and abstract methods it is generally a good practice to add a @return annotation even if it is just @return void or @return null, so that implementors know what to do in the overridden method.

}