Serializer::serializeModel() - Code Metrics - Inspection of "Fix #11328 PSR-7 HTTP Message Integration (#14701)" - yiisoft/yii2 - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — 2.1 ( dc42a5...e82b9c )

unknown

created 2017-09-06 12:57 UTC

Serializer::serializeModel() A

↳ Parent: Serializer

Complexity

Conditions	2
Paths	2

Size

Total Lines	9
Code Lines	5

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	4
CRAP Score	2.032

Importance

Changes

Metric	Value
dl	0
loc	9
ccs	4
cts	5
cp	0.8
rs	9.6666
c	0
b	0
f	0
cc	2
eloc	5
nc	2
nop	1
crap	2.032

<?php
/**
 * @link http://www.yiiframework.com/
 * @copyright Copyright (c) 2008 Yii Software LLC
 * @license http://www.yiiframework.com/license/
 */

namespace yii\rest;

use Yii;
use yii\base\Arrayable;
use yii\base\Component;
use yii\base\Model;
use yii\data\DataProviderInterface;
use yii\data\Pagination;
use yii\helpers\ArrayHelper;
use yii\web\Link;
use yii\web\Request;
use yii\web\Response;

/**
 * Serializer converts resource objects and collections into array representation.
 *
 * Serializer is mainly used by REST controllers to convert different objects into array representation
 * so that they can be further turned into different formats, such as JSON, XML, by response formatters.
 *
 * The default implementation handles resources as [[Model]] objects and collections as objects
 * implementing [[DataProviderInterface]]. You may override [[serialize()]] to handle more types.
 *
 * @author Qiang Xue <[email protected]>
 * @since 2.0
 */
class Serializer extends Component
{
    /**
     * @var string the name of the query parameter containing the information about which fields should be returned
     * for a [[Model]] object. If the parameter is not provided or empty, the default set of fields as defined
     * by [[Model::fields()]] will be returned.
     */
    public $fieldsParam = 'fields';
    /**
     * @var string the name of the query parameter containing the information about which fields should be returned
     * in addition to those listed in [[fieldsParam]] for a resource object.
     */
    public $expandParam = 'expand';
    /**
     * @var string the name of the HTTP header containing the information about total number of data items.
     * This is used when serving a resource collection with pagination.
     */
    public $totalCountHeader = 'X-Pagination-Total-Count';
    /**
     * @var string the name of the HTTP header containing the information about total number of pages of data.
     * This is used when serving a resource collection with pagination.
     */
    public $pageCountHeader = 'X-Pagination-Page-Count';
    /**
     * @var string the name of the HTTP header containing the information about the current page number (1-based).
     * This is used when serving a resource collection with pagination.
     */
    public $currentPageHeader = 'X-Pagination-Current-Page';
    /**
     * @var string the name of the HTTP header containing the information about the number of data items in each page.
     * This is used when serving a resource collection with pagination.
     */
    public $perPageHeader = 'X-Pagination-Per-Page';
    /**
     * @var string the name of the envelope (e.g. `items`) for returning the resource objects in a collection.
     * This is used when serving a resource collection. When this is set and pagination is enabled, the serializer
     * will return a collection in the following format:
     *
     * ```php
     * [
     *     'items' => [...],  // assuming collectionEnvelope is "items"
     *     '_links' => {  // pagination links as returned by Pagination::getLinks()
     *         'self' => '...',
     *         'next' => '...',
     *         'last' => '...',
     *     },
     *     '_meta' => {  // meta information as returned by Pagination::toArray()
     *         'totalCount' => 100,
     *         'pageCount' => 5,
     *         'currentPage' => 1,
     *         'perPage' => 20,
     *     },
     * ]
     * ```
     *
     * If this property is not set, the resource arrays will be directly returned without using envelope.
     * The pagination information as shown in `_links` and `_meta` can be accessed from the response HTTP headers.
     */
    public $collectionEnvelope;
    /**
     * @var string the name of the envelope (e.g. `_links`) for returning the links objects.
     * It takes effect only, if `collectionEnvelope` is set.
     * @since 2.0.4
     */
    public $linksEnvelope = '_links';
    /**
     * @var string the name of the envelope (e.g. `_meta`) for returning the pagination object.
     * It takes effect only, if `collectionEnvelope` is set.
     * @since 2.0.4
     */
    public $metaEnvelope = '_meta';
    /**
     * @var Request the current request. If not set, the `request` application component will be used.
     */
    public $request;
    /**
     * @var Response the response to be sent. If not set, the `response` application component will be used.
     */
    public $response;
    /**
     * @var bool whether to preserve array keys when serializing collection data.
     * Set this to `true` to allow serialization of a collection as a JSON object where array keys are
     * used to index the model objects. The default is to serialize all collections as array, regardless
     * of how the array is indexed.
     * @see serializeDataProvider()
     * @since 2.0.10
     */
    public $preserveKeys = false;


    /**
     * @inheritdoc
     */
    public function init()
    {
        if ($this->request === null) {
            $this->request = Yii::$app->getRequest();
        }
        if ($this->response === null) {
            $this->response = Yii::$app->getResponse();
        }
    }

    /**
     * Serializes the given data into a format that can be easily turned into other formats.
     * This method mainly converts the objects of recognized types into array representation.
     * It will not do conversion for unknown object types or non-object data.
     * The default implementation will handle [[Model]] and [[DataProviderInterface]].
     * You may override this method to support more object types.
     * @param mixed $data the data to be serialized.
     * @return mixed the converted data.
     */
    public function serialize($data)
    {
        if ($data instanceof Model && $data->hasErrors()) {
            return $this->serializeModelErrors($data);
        } elseif ($data instanceof Arrayable) {
            return $this->serializeModel($data);
        } elseif ($data instanceof DataProviderInterface) {
            return $this->serializeDataProvider($data);
        }

        return $data;
    }

    /**
     * @return array the names of the requested fields. The first element is an array
     * representing the list of default fields requested, while the second element is
     * an array of the extra fields requested in addition to the default fields.
     * @see Model::fields()
     * @see Model::extraFields()
     */
    protected function getRequestedFields()
    {
        $fields = $this->request->get($this->fieldsParam);
        $expand = $this->request->get($this->expandParam);

        return [
            is_string($fields) ? preg_split('/\s*,\s*/', $fields, -1, PREG_SPLIT_NO_EMPTY) : [],
            is_string($expand) ? preg_split('/\s*,\s*/', $expand, -1, PREG_SPLIT_NO_EMPTY) : [],
        ];
    }

    /**
     * Serializes a data provider.
     * @param DataProviderInterface $dataProvider
     * @return array the array representation of the data provider.
     */
    protected function serializeDataProvider($dataProvider)
    {
        if ($this->preserveKeys) {
            $models = $dataProvider->getModels();
        } else {
            $models = array_values($dataProvider->getModels());
        }
        $models = $this->serializeModels($models);

        if (($pagination = $dataProvider->getPagination()) !== false) {
            $this->addPaginationHeaders($pagination);
        }

        if ($this->request->getIsHead()) {
            return null;
        } elseif ($this->collectionEnvelope === null) {
            return $models;
        }

        $result = [
            $this->collectionEnvelope => $models,
        ];
        if ($pagination !== false) {
            return array_merge($result, $this->serializePagination($pagination));
        }

        return $result;
    }

    /**
     * Serializes a pagination into an array.
     * @param Pagination $pagination
     * @return array the array representation of the pagination
     * @see addPaginationHeaders()
     */
    protected function serializePagination($pagination)
    {
        return [
            $this->linksEnvelope => Link::serialize($pagination->getLinks(true)),
            $this->metaEnvelope => [
                'totalCount' => $pagination->totalCount,
                'pageCount' => $pagination->getPageCount(),
                'currentPage' => $pagination->getPage() + 1,
                'perPage' => $pagination->getPageSize(),
            ],
        ];
    }

    /**
     * Adds HTTP headers about the pagination to the response.
     * @param Pagination $pagination
     */
    protected function addPaginationHeaders($pagination)
    {
        $links = [];
        foreach ($pagination->getLinks(true) as $rel => $url) {
            $links[] = "<$url>; rel=$rel";
        }

        $this->response->setHeader($this->totalCountHeader, $pagination->totalCount);
        $this->response->setHeader($this->pageCountHeader, $pagination->getPageCount());
        $this->response->setHeader($this->currentPageHeader, $pagination->getPage() + 1);
        $this->response->setHeader($this->perPageHeader, $pagination->pageSize);
        $this->response->setHeader('Link', implode(', ', $links));
    }

    /**
     * Serializes a model object.
     * @param Arrayable $model
     * @return array the array representation of the model
     */
    protected function serializeModel($model)
    {
        if ($this->request->getIsHead()) {
            return null;
        }

        [$fields, $expand] = $this->getRequestedFields();

        return $model->toArray($fields, $expand);
    }

    /**
     * Serializes the validation errors in a model.
     * @param Model $model
     * @return array the array representation of the errors
     */
    protected function serializeModelErrors($model)
    {
        $this->response->setStatusCode(422, 'Data Validation Failed.');
        $result = [];
        foreach ($model->getFirstErrors() as $name => $message) {
            $result[] = [
                'field' => $name,
                'message' => $message,
            ];
        }

        return $result;
    }

    /**
     * Serializes a set of models.
     * @param array $models
     * @return array the array representation of the models
     */
    protected function serializeModels(array $models)
    {
        [$fields, $expand] = $this->getRequestedFields();

        foreach ($models as $i => $model) {
            if ($model instanceof Arrayable) {
                $models[$i] = $model->toArray($fields, $expand);
            } elseif (is_array($model)) {
                $models[$i] = ArrayHelper::toArray($model);
            }
        }

        return $models;
    }
}


1		<?php
2		/**
3		* @link http://www.yiiframework.com/
4		* @copyright Copyright (c) 2008 Yii Software LLC
5		* @license http://www.yiiframework.com/license/
6		*/
7
8		namespace yii\rest;
9
10		use Yii;
11		use yii\base\Arrayable;
12		use yii\base\Component;
13		use yii\base\Model;
14		use yii\data\DataProviderInterface;
15		use yii\data\Pagination;
16		use yii\helpers\ArrayHelper;
17		use yii\web\Link;
18		use yii\web\Request;
19		use yii\web\Response;
20
21		/**
22		* Serializer converts resource objects and collections into array representation.
23		*
24		* Serializer is mainly used by REST controllers to convert different objects into array representation
25		* so that they can be further turned into different formats, such as JSON, XML, by response formatters.
26		*
27		* The default implementation handles resources as [[Model]] objects and collections as objects
28		* implementing [[DataProviderInterface]]. You may override [[serialize()]] to handle more types.
29		*
30		* @author Qiang Xue <[email protected]>
31		* @since 2.0
32		*/
33		class Serializer extends Component
34		{
35		/**
36		* @var string the name of the query parameter containing the information about which fields should be returned
37		* for a [[Model]] object. If the parameter is not provided or empty, the default set of fields as defined
38		* by [[Model::fields()]] will be returned.
39		*/
40		public $fieldsParam = 'fields';
41		/**
42		* @var string the name of the query parameter containing the information about which fields should be returned
43		* in addition to those listed in [[fieldsParam]] for a resource object.
44		*/
45		public $expandParam = 'expand';
46		/**
47		* @var string the name of the HTTP header containing the information about total number of data items.
48		* This is used when serving a resource collection with pagination.
49		*/
50		public $totalCountHeader = 'X-Pagination-Total-Count';
51		/**
52		* @var string the name of the HTTP header containing the information about total number of pages of data.
53		* This is used when serving a resource collection with pagination.
54		*/
55		public $pageCountHeader = 'X-Pagination-Page-Count';
56		/**
57		* @var string the name of the HTTP header containing the information about the current page number (1-based).
58		* This is used when serving a resource collection with pagination.
59		*/
60		public $currentPageHeader = 'X-Pagination-Current-Page';
61		/**
62		* @var string the name of the HTTP header containing the information about the number of data items in each page.
63		* This is used when serving a resource collection with pagination.
64		*/
65		public $perPageHeader = 'X-Pagination-Per-Page';
66		/**
67		* @var string the name of the envelope (e.g. `items`) for returning the resource objects in a collection.
68		* This is used when serving a resource collection. When this is set and pagination is enabled, the serializer
69		* will return a collection in the following format:
70		*
71		* ```php
72		* [
73		* 'items' => [...], // assuming collectionEnvelope is "items"
74		* '_links' => { // pagination links as returned by Pagination::getLinks()
75		* 'self' => '...',
76		* 'next' => '...',
77		* 'last' => '...',
78		* },
79		* '_meta' => { // meta information as returned by Pagination::toArray()
80		* 'totalCount' => 100,
81		* 'pageCount' => 5,
82		* 'currentPage' => 1,
83		* 'perPage' => 20,
84		* },
85		* ]
86		* ```
87		*
88		* If this property is not set, the resource arrays will be directly returned without using envelope.
89		* The pagination information as shown in `_links` and `_meta` can be accessed from the response HTTP headers.
90		*/
91		public $collectionEnvelope;
92		/**
93		* @var string the name of the envelope (e.g. `_links`) for returning the links objects.
94		* It takes effect only, if `collectionEnvelope` is set.
95		* @since 2.0.4
96		*/
97		public $linksEnvelope = '_links';
98		/**
99		* @var string the name of the envelope (e.g. `_meta`) for returning the pagination object.
100		* It takes effect only, if `collectionEnvelope` is set.
101		* @since 2.0.4
102		*/
103		public $metaEnvelope = '_meta';
104		/**
105		* @var Request the current request. If not set, the `request` application component will be used.
106		*/
107		public $request;
108		/**
109		* @var Response the response to be sent. If not set, the `response` application component will be used.
110		*/
111		public $response;
112		/**
113		* @var bool whether to preserve array keys when serializing collection data.
114		* Set this to `true` to allow serialization of a collection as a JSON object where array keys are
115		* used to index the model objects. The default is to serialize all collections as array, regardless
116		* of how the array is indexed.
117		* @see serializeDataProvider()
118		* @since 2.0.10
119		*/
120		public $preserveKeys = false;
121
122
123		/**
124		* @inheritdoc
125		*/
126	33	public function init()
127		{
128	33	if ($this->request === null) {
129	33	$this->request = Yii::$app->getRequest();
130		}
131	33	if ($this->response === null) {
132	33	$this->response = Yii::$app->getResponse();
133		}
134	33	}
135
136		/**
137		* Serializes the given data into a format that can be easily turned into other formats.
138		* This method mainly converts the objects of recognized types into array representation.
139		* It will not do conversion for unknown object types or non-object data.
140		* The default implementation will handle [[Model]] and [[DataProviderInterface]].
141		* You may override this method to support more object types.
142		* @param mixed $data the data to be serialized.
143		* @return mixed the converted data.
144		*/
145	33	public function serialize($data)
146		{
147	33	if ($data instanceof Model && $data->hasErrors()) {
148	1	return $this->serializeModelErrors($data);
149	32	} elseif ($data instanceof Arrayable) {
150	3	return $this->serializeModel($data);
151	29	} elseif ($data instanceof DataProviderInterface) {
152	6	return $this->serializeDataProvider($data);
153		}
154
155	23	return $data;
156		}
157
158		/**
159		* @return array the names of the requested fields. The first element is an array
160		* representing the list of default fields requested, while the second element is
161		* an array of the extra fields requested in addition to the default fields.
162		* @see Model::fields()
163		* @see Model::extraFields()
164		*/
165	9	protected function getRequestedFields()
166		{
167	9	$fields = $this->request->get($this->fieldsParam);
168	9	$expand = $this->request->get($this->expandParam);
169
170		return [
171	9	is_string($fields) ? preg_split('/\s,\s/', $fields, -1, PREG_SPLIT_NO_EMPTY) : [],
172	9	is_string($expand) ? preg_split('/\s,\s/', $expand, -1, PREG_SPLIT_NO_EMPTY) : [],
173		];
174		}
175
176		/**
177		* Serializes a data provider.
178		* @param DataProviderInterface $dataProvider
179		* @return array the array representation of the data provider.
180		*/
181	6	protected function serializeDataProvider($dataProvider)
182		{
183	6	if ($this->preserveKeys) {
184	2	$models = $dataProvider->getModels();
185		} else {
186	4	$models = array_values($dataProvider->getModels());
187		}
188	6	$models = $this->serializeModels($models);
189
190	6	if (($pagination = $dataProvider->getPagination()) !== false) {
191	6	$this->addPaginationHeaders($pagination);
192		}
193
194	6	if ($this->request->getIsHead()) {
195		return null;
196	6	} elseif ($this->collectionEnvelope === null) {
197	6	return $models;
198		}
199
200		$result = [
201		$this->collectionEnvelope => $models,
202		];
203		if ($pagination !== false) {
204		return array_merge($result, $this->serializePagination($pagination));
205		}
206
207		return $result;
208		}
209
210		/**
211		* Serializes a pagination into an array.
212		* @param Pagination $pagination
213		* @return array the array representation of the pagination
214		* @see addPaginationHeaders()
215		*/
216		protected function serializePagination($pagination)
217		{
218		return [
219		$this->linksEnvelope => Link::serialize($pagination->getLinks(true)),
220		$this->metaEnvelope => [
221		'totalCount' => $pagination->totalCount,
222		'pageCount' => $pagination->getPageCount(),
223		'currentPage' => $pagination->getPage() + 1,
224		'perPage' => $pagination->getPageSize(),
225		],
226		];
227		}
228
229		/**
230		* Adds HTTP headers about the pagination to the response.
231		* @param Pagination $pagination
232		*/
233	6	protected function addPaginationHeaders($pagination)
234		{
235	6	$links = [];
236	6	foreach ($pagination->getLinks(true) as $rel => $url) {
237	6	$links[] = "<$url>; rel=$rel";
238		}
239
240	6	$this->response->setHeader($this->totalCountHeader, $pagination->totalCount);
241	6	$this->response->setHeader($this->pageCountHeader, $pagination->getPageCount());
242	6	$this->response->setHeader($this->currentPageHeader, $pagination->getPage() + 1);
243	6	$this->response->setHeader($this->perPageHeader, $pagination->pageSize);
244	6	$this->response->setHeader('Link', implode(', ', $links));
245	6	}
246
247		/**
248		* Serializes a model object.
249		* @param Arrayable $model
250		* @return array the array representation of the model
251		*/
252	3	protected function serializeModel($model)
253		{
254	3	if ($this->request->getIsHead()) {
255		return null;
256		}
257
258	3	[$fields, $expand] = $this->getRequestedFields();
		0 ignored issues – show Bug introduced 2017-04-23 07:03 UTC by Report Bug Copy Issue Report The variable `$fields` does not exist. Did you forget to declare it? This check marks access to variables or properties that have not been declared yet. While PHP has no explicit notion of declaring a variable, accessing it before a value is assigned to it is most likely a bug. Loading history... Bug introduced 2017-04-23 07:03 UTC by Report Bug Copy Issue Report The variable `$expand` does not exist. Did you forget to declare it? This check marks access to variables or properties that have not been declared yet. While PHP has no explicit notion of declaring a variable, accessing it before a value is assigned to it is most likely a bug. Loading history...
259	3	return $model->toArray($fields, $expand);
260		}
261
262		/**
263		* Serializes the validation errors in a model.
264		* @param Model $model
265		* @return array the array representation of the errors
266		*/
267	1	protected function serializeModelErrors($model)
268		{
269	1	$this->response->setStatusCode(422, 'Data Validation Failed.');
270	1	$result = [];
271	1	foreach ($model->getFirstErrors() as $name => $message) {
272	1	$result[] = [
273	1	'field' => $name,
274	1	'message' => $message,
275		];
276		}
277
278	1	return $result;
279		}
280
281		/**
282		* Serializes a set of models.
283		* @param array $models
284		* @return array the array representation of the models
285		*/
286	6	protected function serializeModels(array $models)
287		{
288	6	[$fields, $expand] = $this->getRequestedFields();
		0 ignored issues – show Bug introduced 2017-04-23 07:03 UTC by Report Bug Copy Issue Report The variable `$fields` does not exist. Did you forget to declare it? This check marks access to variables or properties that have not been declared yet. While PHP has no explicit notion of declaring a variable, accessing it before a value is assigned to it is most likely a bug. Loading history... Bug introduced 2017-04-23 07:03 UTC by Report Bug Copy Issue Report The variable `$expand` does not exist. Did you forget to declare it? This check marks access to variables or properties that have not been declared yet. While PHP has no explicit notion of declaring a variable, accessing it before a value is assigned to it is most likely a bug. Loading history...
289	6	foreach ($models as $i => $model) {
290	6	if ($model instanceof Arrayable) {
291		$models[$i] = $model->toArray($fields, $expand);
292	6	} elseif (is_array($model)) {
293	6	$models[$i] = ArrayHelper::toArray($model);
294		}
295		}
296
297	6	return $models;
298		}
299		}
300

yiisoft / yii2

Push — 2.1 ( dc42a5...e82b9c )

Serializer::serializeModel() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like