Base::get() - Code Metrics - Inspection of "Moved translatePluginErrorCodes() from basket base..." - aimeos/ai-client-jsonapi - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Push — master ( 8d04e7...7deac0 )

by Aimeos

created 2023-11-21 16:52 UTC

Base::get() A

↳ Parent: Base

Complexity

Conditions	1
Paths	1

Size

Total Lines	3
Code Lines	1

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
eloc	1
dl	0
loc	3
c	0
b	0
f	0
rs	10
cc	1
nc	1
nop	2

<?php

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


namespace Aimeos\Client\JsonApi;

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


/**
 * JSON API common client
 *
 * @package Client
 * @subpackage JsonApi
 */
abstract class Base
	implements \Aimeos\Client\JsonApi\Iface, \Aimeos\Macro\Iface
{
	use \Aimeos\Macro\Macroable;


	private \Aimeos\MShop\ContextIface $context;
	private ?\Aimeos\Base\View\Iface $view = null;


	/**
	 * Initializes the client
	 *
	 * @param \Aimeos\MShop\ContextIface $context MShop context object
	 */
	public function __construct( \Aimeos\MShop\ContextIface $context )
	{
		$this->context = $context;
	}


	/**
	 * Deletes 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 delete( ServerRequestInterface $request, ResponseInterface $response ) : \Psr\Http\Message\ResponseInterface
	{
		return $this->defaultAction( $request, $response );
	}


	/**
	 * Retrieves 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 ) : \Psr\Http\Message\ResponseInterface
	{
		return $this->defaultAction( $request, $response );
	}


	/**
	 * Updates the resource or the resource list partitially
	 *
	 * @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 patch( ServerRequestInterface $request, ResponseInterface $response ) : \Psr\Http\Message\ResponseInterface
	{
		return $this->defaultAction( $request, $response );
	}


	/**
	 * Creates or updates 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 post( ServerRequestInterface $request, ResponseInterface $response ) : \Psr\Http\Message\ResponseInterface
	{
		return $this->defaultAction( $request, $response );
	}


	/**
	 * Creates or updates 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 put( ServerRequestInterface $request, ResponseInterface $response ) : \Psr\Http\Message\ResponseInterface
	{
		return $this->defaultAction( $request, $response );
	}


	/**
	 * Creates or updates 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 options( ServerRequestInterface $request, ResponseInterface $response ) : \Psr\Http\Message\ResponseInterface
	{
		return $this->defaultAction( $request, $response );
	}


	/**
	 * Sets the view object that will generate the admin output.
	 *
	 * @param \Aimeos\Base\View\Iface $view The view object which generates the admin output
	 * @return \Aimeos\Client\JsonApi\Iface Reference to this object for fluent calls
	 */
	public function setView( \Aimeos\Base\View\Iface $view ) : \Aimeos\Client\JsonApi\Iface
	{
		$this->view = $view;
		return $this;
	}


	/**
	 * Returns the default response for the resource
	 *
	 * @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 defaultAction( ServerRequestInterface $request, ResponseInterface $response ) : \Psr\Http\Message\ResponseInterface
	{
		$status = 403;
		$view = $this->view();

		$view->errors = [['title' => 'Not allowed for this resource']];

		/** client/jsonapi/template-error
		 * Relative path to the default 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 templates/client/jsonapi).
		 *
		 * 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 "standard" 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 JSON API response
		 * @since 2017.02
		 * @category Developer
		 * @see client/jsonapi/template-delete
		 * @see client/jsonapi/template-patch
		 * @see client/jsonapi/template-post
		 * @see client/jsonapi/template-get
		 * @see client/jsonapi/template-options
		 */
		$tplconf = 'client/jsonapi/template-error';
		$default = 'error-standard';

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

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


	/**
	 * Returns the context item object
	 *
	 * @return \Aimeos\MShop\ContextIface Context object
	 */
	protected function context() : \Aimeos\MShop\ContextIface
	{
		return $this->context;
	}


	/**
	 * Returns the translated title and the details of the error
	 *
	 * @param \Exception $e Thrown exception
	 * @param string|null $domain Translation domain
	 * @param string|null $msg Additional error details
	 * @return array Associative list with "title" and "detail" key (if debug config is enabled)
	 */
	protected function getErrorDetails( \Exception $e, string $domain = null ) : array
	{
		$details = [];

		if( $domain !== null ) {
			$details['title'] = $this->context->translate( $domain, $e->getMessage() );
		} else {
			$details['title'] = $this->context->translate( 'admin', 'An error occured and has been added to the logs' );
			$this->context->logger()->log( $e->getMessage() . PHP_EOL . $e->getTraceAsString() );
		}

		if( $e instanceof \Aimeos\MShop\Plugin\Provider\Exception ) {
			$details['detail'] = join( "\n", $this->translatePluginErrorCodes( $e->getErrorCodes() ) );
		}

		/** client/jsonapi/debug
		 * Send debug information withing responses to clients if an error occurrs
		 *
		 * By default, the Aimeos client JSON REST API won't send any details
		 * besides the error message to the client if an error occurred. This
		 * prevents leaking sensitive information to attackers. For debugging
		 * your requests it's helpful to see the stack strace. If you set this
		 * configuration option to true, the stack trace will be returned too.
		 *
		 * @param boolean True to return the stack trace in JSON response, false for error message only
		 * @since 2017.07
		 * @category Developer
		 */
		if( $this->context->config()->get( 'client/jsonapi/debug', false ) == true )
		{
			$details['title'] = $e->getMessage();
			$details['detail'] = ( isset( $details['detail'] ) ? $details['detail'] . "\n" : '' ) . $e->getTraceAsString();
		}

		return [$details]; // jsonapi.org requires a list of error objects
	}


	/**
	 * Initializes the criteria object based on the given parameter
	 *
	 * @param \Aimeos\Base\Criteria\Iface $criteria Criteria object
	 * @param array $params List of criteria data with condition, sorting and paging
	 * @return \Aimeos\Base\Criteria\Iface Initialized criteria object
	 */
	protected function initCriteria( \Aimeos\Base\Criteria\Iface $criteria, array $params ) : \Aimeos\Base\Criteria\Iface
	{
		return $criteria->order( $params['sort'] ?? [] )
			->add( $criteria->parse( $params['filter'] ?? [] ) )
			->slice( $params['page']['offset'] ?? 0, $params['page']['limit'] ?? 25 );
	}


	/**
	 * 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 $allow Allowed HTTP methods
	 * @return \Psr\Http\Message\ResponseInterface Modified response object
	 */
	public function getOptionsResponse( ServerRequestInterface $request, ResponseInterface $response, string $allow ) : \Psr\Http\Message\ResponseInterface
	{
		$view = $this->view();

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

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

		return $response->withHeader( 'Allow', $allow )
			->withHeader( 'Cache-Control', 'max-age=300' )
			->withHeader( 'Content-Type', 'application/vnd.api+json' )
			->withBody( $view->response()->createStreamFromString( $body ) )
			->withStatus( 200 );
	}


	/**
	 * Translates the plugin error codes to human readable error strings.
	 *
	 * @param array $codes Associative list of scope and object as key and error code as value
	 * @return array List of translated error messages
	 */
	protected function translatePluginErrorCodes( array $codes ) : array
	{
		$errors = [];
		$i18n = $this->context()->i18n();

		foreach( $codes as $scope => $list )
		{
			foreach( $list as $object => $errcode )
			{
				$key = $scope . ( !in_array( $scope, ['coupon', 'product'] ) ? '.' . $object : '' ) . '.' . $errcode;
				$errors[] = sprintf( $i18n->dt( 'mshop/code', $key ), $object );
			}
		}

		return array_unique( $errors );
	}


	/**
	 * Returns the view object that will generate the admin output.
	 *
	 * @return \Aimeos\Base\View\Iface The view object which generates the admin output
	 */
	protected function view() : \Aimeos\Base\View\Iface
	{
		if( !isset( $this->view ) ) {
			throw new \Aimeos\Admin\JsonAdm\Exception( 'No view available' );
filter:
    dependency_paths: ["lib/*"]
		}

		return $this->view;
	}
}


1			<?php
2
3			/**
4			* @license LGPLv3, http://opensource.org/licenses/LGPL-3.0
5			* @copyright Aimeos (aimeos.org), 2017-2023
6			* @package Client
7			* @subpackage JsonApi
8			*/
9
10
11			namespace Aimeos\Client\JsonApi;
12
13			use Psr\Http\Message\ResponseInterface;
14			use Psr\Http\Message\ServerRequestInterface;
15
16
17			/**
18			* JSON API common client
19			*
20			* @package Client
21			* @subpackage JsonApi
22			*/
23			abstract class Base
24			implements \Aimeos\Client\JsonApi\Iface, \Aimeos\Macro\Iface
25			{
26			use \Aimeos\Macro\Macroable;
27
28
29			private \Aimeos\MShop\ContextIface $context;
30			private ?\Aimeos\Base\View\Iface $view = null;
31
32
33			/**
34			* Initializes the client
35			*
36			* @param \Aimeos\MShop\ContextIface $context MShop context object
37			*/
38			public function __construct( \Aimeos\MShop\ContextIface $context )
39			{
40			$this->context = $context;
41			}
42
43
44			/**
45			* Deletes the resource or the resource list
46			*
47			* @param \Psr\Http\Message\ServerRequestInterface $request Request object
48			* @param \Psr\Http\Message\ResponseInterface $response Response object
49			* @return \Psr\Http\Message\ResponseInterface Modified response object
50			*/
51			public function delete( ServerRequestInterface $request, ResponseInterface $response ) : \Psr\Http\Message\ResponseInterface
52			{
53			return $this->defaultAction( $request, $response );
54			}
55
56
57			/**
58			* Retrieves the resource or the resource list
59			*
60			* @param \Psr\Http\Message\ServerRequestInterface $request Request object
61			* @param \Psr\Http\Message\ResponseInterface $response Response object
62			* @return \Psr\Http\Message\ResponseInterface Modified response object
63			*/
64			public function get( ServerRequestInterface $request, ResponseInterface $response ) : \Psr\Http\Message\ResponseInterface
65			{
66			return $this->defaultAction( $request, $response );
67			}
68
69
70			/**
71			* Updates the resource or the resource list partitially
72			*
73			* @param \Psr\Http\Message\ServerRequestInterface $request Request object
74			* @param \Psr\Http\Message\ResponseInterface $response Response object
75			* @return \Psr\Http\Message\ResponseInterface Modified response object
76			*/
77			public function patch( ServerRequestInterface $request, ResponseInterface $response ) : \Psr\Http\Message\ResponseInterface
78			{
79			return $this->defaultAction( $request, $response );
80			}
81
82
83			/**
84			* Creates or updates the resource or the resource list
85			*
86			* @param \Psr\Http\Message\ServerRequestInterface $request Request object
87			* @param \Psr\Http\Message\ResponseInterface $response Response object
88			* @return \Psr\Http\Message\ResponseInterface Modified response object
89			*/
90			public function post( ServerRequestInterface $request, ResponseInterface $response ) : \Psr\Http\Message\ResponseInterface
91			{
92			return $this->defaultAction( $request, $response );
93			}
94
95
96			/**
97			* Creates or updates the resource or the resource list
98			*
99			* @param \Psr\Http\Message\ServerRequestInterface $request Request object
100			* @param \Psr\Http\Message\ResponseInterface $response Response object
101			* @return \Psr\Http\Message\ResponseInterface Modified response object
102			*/
103			public function put( ServerRequestInterface $request, ResponseInterface $response ) : \Psr\Http\Message\ResponseInterface
104			{
105			return $this->defaultAction( $request, $response );
106			}
107
108
109			/**
110			* Creates or updates the resource or the resource list
111			*
112			* @param \Psr\Http\Message\ServerRequestInterface $request Request object
113			* @param \Psr\Http\Message\ResponseInterface $response Response object
114			* @return \Psr\Http\Message\ResponseInterface Modified response object
115			*/
116			public function options( ServerRequestInterface $request, ResponseInterface $response ) : \Psr\Http\Message\ResponseInterface
117			{
118			return $this->defaultAction( $request, $response );
119			}
120
121
122			/**
123			* Sets the view object that will generate the admin output.
124			*
125			* @param \Aimeos\Base\View\Iface $view The view object which generates the admin output
126			* @return \Aimeos\Client\JsonApi\Iface Reference to this object for fluent calls
127			*/
128			public function setView( \Aimeos\Base\View\Iface $view ) : \Aimeos\Client\JsonApi\Iface
129			{
130			$this->view = $view;
131			return $this;
132			}
133
134
135			/**
136			* Returns the default response for the resource
137			*
138			* @param \Psr\Http\Message\ServerRequestInterface $request Request object
139			* @param \Psr\Http\Message\ResponseInterface $response Response object
140			* @return \Psr\Http\Message\ResponseInterface Modified response object
141			*/
142			protected function defaultAction( ServerRequestInterface $request, ResponseInterface $response ) : \Psr\Http\Message\ResponseInterface
143			{
144			$status = 403;
145			$view = $this->view();
146
147			$view->errors = [['title' => 'Not allowed for this resource']];
148
149			/** client/jsonapi/template-error
150			* Relative path to the default JSON API template
151			*
152			* The template file contains the code and processing instructions
153			* to generate the result shown in the JSON API body. The
154			* configuration string is the path to the template file relative
155			* to the templates directory (usually in templates/client/jsonapi).
156			*
157			* You can overwrite the template file configuration in extensions and
158			* provide alternative templates. These alternative templates should be
159			* named like the default one but with the string "standard" replaced by
160			* an unique name. You may use the name of your project for this. If
161			* you've implemented an alternative client class as well, "standard"
162			* should be replaced by the name of the new class.
163			*
164			* @param string Relative path to the template creating the body for the JSON API response
165			* @since 2017.02
166			* @category Developer
167			* @see client/jsonapi/template-delete
168			* @see client/jsonapi/template-patch
169			* @see client/jsonapi/template-post
170			* @see client/jsonapi/template-get
171			* @see client/jsonapi/template-options
172			*/
173			$tplconf = 'client/jsonapi/template-error';
174			$default = 'error-standard';
175
176			$body = $view->render( $view->config( $tplconf, $default ) );
177
178			return $response->withHeader( 'Content-Type', 'application/vnd.api+json' )
179			->withBody( $view->response()->createStreamFromString( $body ) )
180			->withStatus( $status );
181			}
182
183
184			/**
185			* Returns the context item object
186			*
187			* @return \Aimeos\MShop\ContextIface Context object
188			*/
189			protected function context() : \Aimeos\MShop\ContextIface
190			{
191			return $this->context;
192			}
193
194
195			/**
196			* Returns the translated title and the details of the error
197			*
198			* @param \Exception $e Thrown exception
199			* @param string\|null $domain Translation domain
200			* @param string\|null $msg Additional error details
201			* @return array Associative list with "title" and "detail" key (if debug config is enabled)
202			*/
203			protected function getErrorDetails( \Exception $e, string $domain = null ) : array
204			{
205			$details = [];
206
207			if( $domain !== null ) {
208			$details['title'] = $this->context->translate( $domain, $e->getMessage() );
209			} else {
210			$details['title'] = $this->context->translate( 'admin', 'An error occured and has been added to the logs' );
211			$this->context->logger()->log( $e->getMessage() . PHP_EOL . $e->getTraceAsString() );
212			}
213
214			if( $e instanceof \Aimeos\MShop\Plugin\Provider\Exception ) {
215			$details['detail'] = join( "\n", $this->translatePluginErrorCodes( $e->getErrorCodes() ) );
216			}
217
218			/** client/jsonapi/debug
219			* Send debug information withing responses to clients if an error occurrs
220			*
221			* By default, the Aimeos client JSON REST API won't send any details
222			* besides the error message to the client if an error occurred. This
223			* prevents leaking sensitive information to attackers. For debugging
224			* your requests it's helpful to see the stack strace. If you set this
225			* configuration option to true, the stack trace will be returned too.
226			*
227			* @param boolean True to return the stack trace in JSON response, false for error message only
228			* @since 2017.07
229			* @category Developer
230			*/
231			if( $this->context->config()->get( 'client/jsonapi/debug', false ) == true )
232			{
233			$details['title'] = $e->getMessage();
234			$details['detail'] = ( isset( $details['detail'] ) ? $details['detail'] . "\n" : '' ) . $e->getTraceAsString();
235			}
236
237			return [$details]; // jsonapi.org requires a list of error objects
238			}
239
240
241			/**
242			* Initializes the criteria object based on the given parameter
243			*
244			* @param \Aimeos\Base\Criteria\Iface $criteria Criteria object
245			* @param array $params List of criteria data with condition, sorting and paging
246			* @return \Aimeos\Base\Criteria\Iface Initialized criteria object
247			*/
248			protected function initCriteria( \Aimeos\Base\Criteria\Iface $criteria, array $params ) : \Aimeos\Base\Criteria\Iface
249			{
250			return $criteria->order( $params['sort'] ?? [] )
251			->add( $criteria->parse( $params['filter'] ?? [] ) )
252			->slice( $params['page']['offset'] ?? 0, $params['page']['limit'] ?? 25 );
253			}
254
255
256			/**
257			* Returns the available REST verbs and the available parameters
258			*
259			* @param \Psr\Http\Message\ServerRequestInterface $request Request object
260			* @param \Psr\Http\Message\ResponseInterface $response Response object
261			* @param string $allow Allowed HTTP methods
262			* @return \Psr\Http\Message\ResponseInterface Modified response object
263			*/
264			public function getOptionsResponse( ServerRequestInterface $request, ResponseInterface $response, string $allow ) : \Psr\Http\Message\ResponseInterface
265			{
266			$view = $this->view();
267
268			$tplconf = 'client/jsonapi/template-options';
269			$default = 'options-standard';
270
271			$body = $view->render( $view->config( $tplconf, $default ) );
272
273			return $response->withHeader( 'Allow', $allow )
274			->withHeader( 'Cache-Control', 'max-age=300' )
275			->withHeader( 'Content-Type', 'application/vnd.api+json' )
276			->withBody( $view->response()->createStreamFromString( $body ) )
277			->withStatus( 200 );
278			}
279
280
281			/**
282			* Translates the plugin error codes to human readable error strings.
283			*
284			* @param array $codes Associative list of scope and object as key and error code as value
285			* @return array List of translated error messages
286			*/
287			protected function translatePluginErrorCodes( array $codes ) : array
288			{
289			$errors = [];
290			$i18n = $this->context()->i18n();
291
292			foreach( $codes as $scope => $list )
293			{
294			foreach( $list as $object => $errcode )
295			{
296			$key = $scope . ( !in_array( $scope, ['coupon', 'product'] ) ? '.' . $object : '' ) . '.' . $errcode;
297			$errors[] = sprintf( $i18n->dt( 'mshop/code', $key ), $object );
298			}
299			}
300
301			return array_unique( $errors );
302			}
303
304
305			/**
306			* Returns the view object that will generate the admin output.
307			*
308			* @return \Aimeos\Base\View\Iface The view object which generates the admin output
309			*/
310			protected function view() : \Aimeos\Base\View\Iface
311			{
312			if( !isset( $this->view ) ) {
313			throw new \Aimeos\Admin\JsonAdm\Exception( 'No view available' );
			0 ignored issues – show Bug introduced 2019-01-18 12:19 UTC by Report Bug Copy Issue Report The type `Aimeos\Admin\JsonAdm\Exception` was not found. Maybe you did not declare it correctly or list all dependencies? The issue could also be caused by a filter entry in the build configuration. If the path has been excluded in your configuration, e.g. `excluded_paths: ["lib/"]`, you can move it to the dependency path list as follows: filter: dependency_paths: ["lib/"] For further information see https://scrutinizer-ci.com/docs/tools/php/php-scrutinizer/#list-dependency-paths Loading history...
314			}
315
316			return $this->view;
317			}
318			}
319

aimeos / ai-client-jsonapi

Push — master ( 8d04e7...7deac0 )

Base::get() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like