ResourceInterface::getResourceAttributes()

Passed

Push — master ( d16bab...9efe7c )

by Anton

created 2017-09-20 08:56 UTC

↳ Parent: ResourceInterface

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
dl	0
loc	1
c	0
b	0
f	0

<?php
/**
 * @author Anton Tuyakhov <[email protected]>
 */

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);


}

1			<?php
2			/**
3			* @author Anton Tuyakhov <[email protected]>
4			*/
5
6			namespace tuyakhov\jsonapi;
7
8			/**
9			* Interface for a “resource object” that represent an individual resource.
10			*/
11			interface ResourceInterface extends ResourceIdentifierInterface
12			{
13			/**
14			* The "attributes" member of the resource object representing some of the resource’s data.
15			* @param array $fields specific fields that a client has requested.
16			* @return array an array of attributes that represent information about the resource object in which it’s defined.
17			*/
18			public function getResourceAttributes(array $fields = []);
19
20			/**
21			* The "relationships" member of the resource object describing relationships between the resource and other JSON API resources.
22			* @param null\|array $linked specific resource linkage that a client has requested.
23			* @return ResourceIdentifierInterface[] represent references from the resource object in which it’s defined to other resource objects.
24			*/
25			public function getResourceRelationships(array $linked = null);
26
27			public function setResourceRelationship($name, $relationship);
			0 ignored issues – show Documentation introduced 2017-08-31 10:33 UTC by Report Bug Copy Issue Report 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. For interface and abstract methods, it is impossible to infer the return type from the immediate code. In these cases, it is generally advisible to explicitly annotate these methods with a `@return` doc comment to communicate to implementors of these methods what they are expected to return. Loading history...
28
29			}

tuyakhov / yii2-json-api

Push — master ( d16bab...9efe7c )

ResourceInterface::getResourceAttributes()

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like