OpenStack\Common\Resource\ResourceInterface

Size/Duplication

Total Lines	27
Duplicated Lines	0 %

Importance

Changes

0

3 Methods

Rating	Name	Duplication	Size	Complexity
	populateFromResponse()	0	1	?
	populateFromArray()	0	1	?
	model()	0	1	?

<?php declare(strict_types=1);

namespace OpenStack\Common\Resource;

use Psr\Http\Message\ResponseInterface;

/**
 * Represents an API resource.
 *
 * @package OpenStack\Common\Resource
 */
interface ResourceInterface
{
    /**
     * All models which represent an API resource should be able to be populated
     * from a {@see ResponseInterface} object.
     *
     * @param ResponseInterface $response
     *
     * @return self
     */
    public function populateFromResponse(ResponseInterface $response);

    /**
     * @param array $data
     * @return mixed
     */
    public function populateFromArray(array $data);

    /**
     * @param string $name The name of the model class.

There is no parameter named $name. Was it maybe removed?

     * @param mixed  $data Either a {@see ResponseInterface} or data array that will populate the newly
     *                     created model class.
     *
     * @return \OpenStack\Common\Resource\ResourceInterface
     */
    public function model(string $class, $data = null): ResourceInterface;
}