Standard::get() - Code Metrics - Inspection of "Add parameter documentation to OPTIONS" - aimeos/ai-client-jsonapi - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( e8440a...f62092 )

by Aimeos

created 2017-04-24 11:01 UTC

Standard::get() A

↳ Parent: Standard

Complexity

Conditions	4
Paths	8

Size

Total Lines	54
Code Lines	21

Duplication

Lines	0
Ratio	0 %

Importance

Changes	2
Bugs	0	Features	0

Metric	Value
c	2
b	0
f	0
dl	0
loc	54
rs	9.0306
cc	4
eloc	21
nc	8
nop	2

How to fix Long Method

<?php

/**
 * @license LGPLv3, http://opensource.org/licenses/LGPL-3.0
 * @copyright Aimeos (aimeos.org), 2017
 * @package Client
 * @subpackage JsonApi
 */


namespace Aimeos\Client\JsonApi\Stock;

use Psr\Http\Message\ResponseInterface;
use Psr\Http\Message\ServerRequestInterface;


/**
 * JSON API standard client
 *
 * @package Client
 * @subpackage JsonApi
 */
class Standard
	extends \Aimeos\Client\JsonApi\Base
	implements \Aimeos\Client\JsonApi\Iface
{
	/**
	 * Returns the resource or the resource list
	 *
	 * @param \Psr\Http\Message\ServerRequestInterface $request Request object
	 * @param \Psr\Http\Message\ResponseInterface $response Response object
	 * @return \Psr\Http\Message\ResponseInterface Modified response object
	 */
	public function get( ServerRequestInterface $request, ResponseInterface $response )
	{
		$view = $this->getView();

		try
		{
			if( $view->param( 'id' ) != '' ) {
				$response = $this->getItem( $view, $request, $response );
			} else {
				$response = $this->getItems( $view, $request, $response );
			}

			$status = 200;
		}
		catch( \Aimeos\MShop\Exception $e )
		{
			$status = 404;
			$view->errors = $this->getErrorDetails( $e, 'mshop' );
		}
		catch( \Exception $e )
		{
			$status = 500;
			$view->errors = $this->getErrorDetails( $e );
		}

		/** client/jsonapi/stock/standard/template
		 * Relative path to the catalog lists JSON API template
		 *
		 * The template file contains the code and processing instructions
		 * to generate the result shown in the JSON API body. The
		 * configuration string is the path to the template file relative
		 * to the templates directory (usually in client/jsonapi/templates).
		 *
		 * You can overwrite the template file configuration in extensions and
		 * provide alternative templates. These alternative templates should be
		 * named like the default one but with the string "default" replaced by
		 * an unique name. You may use the name of your project for this. If
		 * you've implemented an alternative client class as well, "standard"
		 * should be replaced by the name of the new class.
		 *
		 * @param string Relative path to the template creating the body for the GET method of the JSON API
		 * @since 2017.03
		 * @category Developer
		 */
		$tplconf = 'client/jsonapi/stock/standard/template';
		$default = 'stock/standard.php';

		$body = $view->render( $view->config( $tplconf, $default ) );

		return $response->withHeader( 'Allow', 'GET,OPTIONS' )
			->withHeader( 'Content-Type', 'application/vnd.api+json' )
			->withBody( $view->response()->createStreamFromString( $body ) )
			->withStatus( $status );
	}


	/**
	 * Returns the available REST verbs and the available parameters
	 *
	 * @param \Psr\Http\Message\ServerRequestInterface $request Request object
	 * @param \Psr\Http\Message\ResponseInterface $response Response object
	 * @param string|null $prefix Form parameter prefix when nesting parameters is required
	 * @return \Psr\Http\Message\ResponseInterface Modified response object
	 */
	public function options( ServerRequestInterface $request, ResponseInterface $response, $prefix = null )
	{
		$view = $this->getView();
		$view->filter = [
			's_prodcode' => [
				'label' => 'List of product codes for which the stock level should be returned',
				'type' => 'array', 'default' => '[]', 'required' => false,
			],
			's_typecode' => [
				'label' => 'List of warehouse/location codes (stock type)',
				'type' => 'array', 'default' => '[]', 'required' => false,
			],
		];

		$tplconf = 'client/jsonapi/standard/template-options';
		$default = 'options-standard.php';

		$body = $view->render( $view->config( $tplconf, $default ) );

		return $response->withHeader( 'Allow', 'GET,OPTIONS' )
			->withHeader( 'Content-Type', 'application/vnd.api+json' )
			->withBody( $view->response()->createStreamFromString( $body ) )
			->withStatus( 200 );
	}


	/**
	 * Retrieves the item and adds the data to the view
	 *
	 * @param \Aimeos\MW\View\Iface $view View instance
	 * @param \Psr\Http\Message\ServerRequestInterface $request Request object
	 * @param \Psr\Http\Message\ResponseInterface $response Response object
	 * @return \Psr\Http\Message\ResponseInterface Modified response object
	 */
	protected function getItem( \Aimeos\MW\View\Iface $view, ServerRequestInterface $request, ResponseInterface $response )

	{
		$context = $this->getContext();
		$cntl = \Aimeos\Controller\Frontend\Factory::createController( $context, 'stock' );

		$view->items = $cntl->getItem( $view->param( 'id' ) );
		$view->total = 1;

		return $response;
	}


	/**
	 * Retrieves the items and adds the data to the view
	 *
	 * @param \Aimeos\MW\View\Iface $view View instance
	 * @param \Psr\Http\Message\ServerRequestInterface $request Request object
	 * @param \Psr\Http\Message\ResponseInterface $response Response object
	 * @return \Psr\Http\Message\ResponseInterface Modified response object
	 */
	protected function getItems( \Aimeos\MW\View\Iface $view, ServerRequestInterface $request, ResponseInterface $response )

	{
		$total = 0;
		$params = $view->param( 'filter', [] );
		unset( $params['s_prodcode'], $params['s_typecode'] );

		$cntl = \Aimeos\Controller\Frontend\Factory::createController( $this->getContext(), 'stock' );

		$filter = $cntl->createFilter();
		$filter = $this->initCriteria( $filter, ['filter' => $params] );
		$filter = $cntl->addFilterCodes( $filter, $view->param( 'filter/s_prodcode', [] ) );
		$filter = $cntl->addFilterTypes( $filter, $view->param( 'filter/s_typecode', [] ) );

		$view->items = $cntl->searchItems( $filter, $total );
		$view->total = $total;

		return $response;
	}
}


1			<?php
2
3			/**
4			* @license LGPLv3, http://opensource.org/licenses/LGPL-3.0
5			* @copyright Aimeos (aimeos.org), 2017
6			* @package Client
7			* @subpackage JsonApi
8			*/
9
10
11			namespace Aimeos\Client\JsonApi\Stock;
12
13			use Psr\Http\Message\ResponseInterface;
14			use Psr\Http\Message\ServerRequestInterface;
15
16
17			/**
18			* JSON API standard client
19			*
20			* @package Client
21			* @subpackage JsonApi
22			*/
23			class Standard
24			extends \Aimeos\Client\JsonApi\Base
25			implements \Aimeos\Client\JsonApi\Iface
26			{
27			/**
28			* Returns the resource or the resource list
29			*
30			* @param \Psr\Http\Message\ServerRequestInterface $request Request object
31			* @param \Psr\Http\Message\ResponseInterface $response Response object
32			* @return \Psr\Http\Message\ResponseInterface Modified response object
33			*/
34			public function get( ServerRequestInterface $request, ResponseInterface $response )
35			{
36			$view = $this->getView();
37
38			try
39			{
40			if( $view->param( 'id' ) != '' ) {
41			$response = $this->getItem( $view, $request, $response );
42			} else {
43			$response = $this->getItems( $view, $request, $response );
44			}
45
46			$status = 200;
47			}
48			catch( \Aimeos\MShop\Exception $e )
49			{
50			$status = 404;
51			$view->errors = $this->getErrorDetails( $e, 'mshop' );
52			}
53			catch( \Exception $e )
54			{
55			$status = 500;
56			$view->errors = $this->getErrorDetails( $e );
57			}
58
59			/** client/jsonapi/stock/standard/template
60			* Relative path to the catalog lists JSON API template
61			*
62			* The template file contains the code and processing instructions
63			* to generate the result shown in the JSON API body. The
64			* configuration string is the path to the template file relative
65			* to the templates directory (usually in client/jsonapi/templates).
66			*
67			* You can overwrite the template file configuration in extensions and
68			* provide alternative templates. These alternative templates should be
69			* named like the default one but with the string "default" replaced by
70			* an unique name. You may use the name of your project for this. If
71			* you've implemented an alternative client class as well, "standard"
72			* should be replaced by the name of the new class.
73			*
74			* @param string Relative path to the template creating the body for the GET method of the JSON API
75			* @since 2017.03
76			* @category Developer
77			*/
78			$tplconf = 'client/jsonapi/stock/standard/template';
79			$default = 'stock/standard.php';
80
81			$body = $view->render( $view->config( $tplconf, $default ) );
82
83			return $response->withHeader( 'Allow', 'GET,OPTIONS' )
84			->withHeader( 'Content-Type', 'application/vnd.api+json' )
85			->withBody( $view->response()->createStreamFromString( $body ) )
86			->withStatus( $status );
87			}
88
89
90			/**
91			* Returns the available REST verbs and the available parameters
92			*
93			* @param \Psr\Http\Message\ServerRequestInterface $request Request object
94			* @param \Psr\Http\Message\ResponseInterface $response Response object
95			* @param string\|null $prefix Form parameter prefix when nesting parameters is required
96			* @return \Psr\Http\Message\ResponseInterface Modified response object
97			*/
98			public function options( ServerRequestInterface $request, ResponseInterface $response, $prefix = null )
99			{
100			$view = $this->getView();
101			$view->filter = [
102			's_prodcode' => [
103			'label' => 'List of product codes for which the stock level should be returned',
104			'type' => 'array', 'default' => '[]', 'required' => false,
105			],
106			's_typecode' => [
107			'label' => 'List of warehouse/location codes (stock type)',
108			'type' => 'array', 'default' => '[]', 'required' => false,
109			],
110			];
111
112			$tplconf = 'client/jsonapi/standard/template-options';
113			$default = 'options-standard.php';
114
115			$body = $view->render( $view->config( $tplconf, $default ) );
116
117			return $response->withHeader( 'Allow', 'GET,OPTIONS' )
118			->withHeader( 'Content-Type', 'application/vnd.api+json' )
119			->withBody( $view->response()->createStreamFromString( $body ) )
120			->withStatus( 200 );
121			}
122
123
124			/**
125			* Retrieves the item and adds the data to the view
126			*
127			* @param \Aimeos\MW\View\Iface $view View instance
128			* @param \Psr\Http\Message\ServerRequestInterface $request Request object
129			* @param \Psr\Http\Message\ResponseInterface $response Response object
130			* @return \Psr\Http\Message\ResponseInterface Modified response object
131			*/
132			protected function getItem( \Aimeos\MW\View\Iface $view, ServerRequestInterface $request, ResponseInterface $response )
			0 ignored issues – show Unused Code introduced 2017-03-01 10:27 UTC by Report Bug Copy Issue Report The parameter `$request` is not used and could be removed. This check looks from parameters that have been defined for a function or method, but which are not used in the method body. Loading history...
133			{
134			$context = $this->getContext();
135			$cntl = \Aimeos\Controller\Frontend\Factory::createController( $context, 'stock' );
136
137			$view->items = $cntl->getItem( $view->param( 'id' ) );
138			$view->total = 1;
139
140			return $response;
141			}
142
143
144			/**
145			* Retrieves the items and adds the data to the view
146			*
147			* @param \Aimeos\MW\View\Iface $view View instance
148			* @param \Psr\Http\Message\ServerRequestInterface $request Request object
149			* @param \Psr\Http\Message\ResponseInterface $response Response object
150			* @return \Psr\Http\Message\ResponseInterface Modified response object
151			*/
152			protected function getItems( \Aimeos\MW\View\Iface $view, ServerRequestInterface $request, ResponseInterface $response )
			0 ignored issues – show Unused Code introduced 2017-03-01 10:27 UTC by Report Bug Copy Issue Report The parameter `$request` is not used and could be removed. This check looks from parameters that have been defined for a function or method, but which are not used in the method body. Loading history...
153			{
154			$total = 0;
155			$params = $view->param( 'filter', [] );
156			unset( $params['s_prodcode'], $params['s_typecode'] );
157
158			$cntl = \Aimeos\Controller\Frontend\Factory::createController( $this->getContext(), 'stock' );
159
160			$filter = $cntl->createFilter();
161			$filter = $this->initCriteria( $filter, ['filter' => $params] );
162			$filter = $cntl->addFilterCodes( $filter, $view->param( 'filter/s_prodcode', [] ) );
163			$filter = $cntl->addFilterTypes( $filter, $view->param( 'filter/s_typecode', [] ) );
164
165			$view->items = $cntl->searchItems( $filter, $total );
166			$view->total = $total;
167
168			return $response;
169			}
170			}
171

aimeos / ai-client-jsonapi

Push — master ( e8440a...f62092 )

Standard::get() A

Complexity

Size

Duplication

Importance

How to fix Long Method

Long Method

Duplication Side-by-Side

Filter issues like