Jsonadm::createClient() - Code Metrics - Inspection of "Adapted code to moved Jsonadm" - aimeos/aimeos-slim - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 96c485...89068a )

by Aimeos

created 2016-03-23 13:43 UTC

Jsonadm::createClient() A

↳ Parent: Jsonadm

Complexity

Conditions	4
Paths	8

Size

Total Lines	16
Code Lines	10

Duplication

Lines	0
Ratio	0 %

Importance

Changes	1
Bugs	0	Features	0

Metric	Value
c	1
b	0
f	0
dl	0
loc	16
rs	9.2
cc	4
eloc	10
nc	8
nop	4

<?php

/**
 * @license LGPLv3, http://opensource.org/licenses/LGPL-3.0
 * @copyright Aimeos (aimeos.org), 2016
 * @package Slim
 * @subpackage Controller
 */


namespace Aimeos\Slim\Controller;

use Interop\Container\ContainerInterface;
use Psr\Http\Message\ServerRequestInterface;
use Psr\Http\Message\ResponseInterface;


/**
 * Aimeos controller for the JSON REST API
 *
 * @package Slim
 * @subpackage Controller
 */
class Jsonadm
{
	/**
	 * Deletes the resource object or a list of resource objects
	 *
	 * @param ContainerInterface $container Dependency injection container
	 * @param ServerRequestInterface $request Request object
	 * @param ResponseInterface $response Response object
	 * @param array $args Associative list of route parameters
	 * @return ResponseInterface $response Modified response object with generated output
	 */
	public static function deleteAction( ContainerInterface $container, ServerRequestInterface $request, ResponseInterface $response, array $args )
	{
		$status = 500;
		$header = $request->getHeaders();

		$client = self::createClient( $container, $request, $response, $args );
		$result = $client->delete( (string) $request->getBody(), $header, $status );

		return self::withResponse( $response, $result, $status, $header );
	}


	/**
	 * Returns the requested resource object or list of resource objects
	 *
	 * @param ContainerInterface $container Dependency injection container
	 * @param ServerRequestInterface $request Request object
	 * @param ResponseInterface $response Response object
	 * @param array $args Associative list of route parameters
	 * @return ResponseInterface $response Modified response object with generated output
	 */
	public static function getAction( ContainerInterface $container, ServerRequestInterface $request, ResponseInterface $response, array $args )
	{
		$status = 500;
		$header = $request->getHeaders();

		$client = self::createClient( $container, $request, $response, $args );
		$result = $client->get( (string) $request->getBody(), $header, $status );

		return self::withResponse( $response, $result, $status, $header );
	}


	/**
	 * Updates a resource object or a list of resource objects
	 *
	 * @param ContainerInterface $container Dependency injection container
	 * @param ServerRequestInterface $request Request object
	 * @param ResponseInterface $response Response object
	 * @param array $args Associative list of route parameters
	 * @return ResponseInterface $response Modified response object with generated output
	 */
	public static function patchAction( ContainerInterface $container, ServerRequestInterface $request, ResponseInterface $response, array $args )
	{
		$status = 500;
		$header = $request->getHeaders();

		$client = self::createClient( $container, $request, $response, $args );
		$result = $client->patch( (string) $request->getBody(), $header, $status );

		return self::withResponse( $response, $result, $status, $header );
	}


	/**
	 * Creates a new resource object or a list of resource objects
	 *
	 * @param ContainerInterface $container Dependency injection container
	 * @param ServerRequestInterface $request Request object
	 * @param ResponseInterface $response Response object
	 * @param array $args Associative list of route parameters
	 * @return ResponseInterface $response Modified response object with generated output
	 */
	public static function postAction( ContainerInterface $container, ServerRequestInterface $request, ResponseInterface $response, array $args )
	{
		$status = 500;
		$header = $request->getHeaders();

		$client = self::createClient( $container, $request, $response, $args );
		$result = $client->post( (string) $request->getBody(), $header, $status );

		return self::withResponse( $response, $result, $status, $header );
	}


	/**
	 * Creates or updates a single resource object
	 *
	 * @param ContainerInterface $container Dependency injection container
	 * @param ServerRequestInterface $request Request object
	 * @param ResponseInterface $response Response object
	 * @param array $args Associative list of route parameters
	 * @return ResponseInterface $response Modified response object with generated output
	 */
	public static function putAction( ContainerInterface $container, ServerRequestInterface $request, ResponseInterface $response, array $args )
	{
		$status = 500;
		$header = $request->getHeaders();

		$client = self::createClient( $container, $request, $response, $args );
		$result = $client->put( (string) $request->getBody(), $header, $status );

		return self::withResponse( $response, $result, $status, $header );
	}


	/**
	 * Returns the available HTTP verbs and the resource URLs
	 *
	 * @param ContainerInterface $container Dependency injection container
	 * @param ServerRequestInterface $request Request object
	 * @param ResponseInterface $response Response object
	 * @param array $args Associative list of route parameters
	 * @return ResponseInterface $response Modified response object with generated output
	 */
	public static function optionsAction( ContainerInterface $container, ServerRequestInterface $request, ResponseInterface $response, array $args )
	{
		$status = 500;
		$header = $request->getHeaders();

		$client = self::createClient( $container, $request, $response, $args );
		$result = $client->options( (string) $request->getBody(), $header, $status );

		return self::withResponse( $response, $result, $status, $header );
	}


	/**
	 * Returns the resource controller
	 *
	 * @param ContainerInterface $container Dependency injection container
	 * @param ServerRequestInterface $request Request object
	 * @param ResponseInterface $response Response object
	 * @param array $args Associative list of route parameters
	 * @return \Aimeos\Controller\JsonAdm\Iface JSON admin controller
	 */
	protected static function createClient( ContainerInterface $container, ServerRequestInterface $request, ResponseInterface $response, array $args )
	{
		$resource = ( isset( $args['resource'] ) ? $args['resource'] : null );
		$site = ( isset( $args['site'] ) ? $args['site'] : 'default' );
		$lang = ( isset( $args['lang'] ) ? $args['lang'] : 'en' );

		$templatePaths = $container->get( 'aimeos' )->getCustomPaths( 'admin/jsonadm/templates' );

		$context = $container->get( 'aimeos_context' )->get( false, $args );
		$context = self::setLocale( $container->get( 'aimeos_i18n' ), $context, $site, $lang );

		$view = $container->get( 'aimeos_view' )->create( $request, $response, $args, $templatePaths, $lang );
		$context->setView( $view );

		return \Aimeos\Admin\JsonAdm\Factory::createClient( $context, $templatePaths, $resource );
	}


	/**
	 * Populates the response object
	 *
	 * @param ResponseInterface $response Response object
	 * @param string $content Body of the HTTP response
	 * @param integer $status HTTP status
	 * @param array $header List of HTTP headers
	 * @return ResponseInterface $response Populated response object
	 */
	protected static function withResponse( ResponseInterface $response, $content, $status, array $header )
	{
		$response->getBody()->write( $content );
		$response = $response->withStatus( $status );

		foreach( $header as $key => $value ) {
			$response->withHeader( $key, $value );
		}

		return $response;
	}


	/**
	 * Sets the locale item in the given context
	 *
	 * @param \Aimeos\Slim\Base\I18n $i18n Aimeos translation object builder
	 * @param \Aimeos\MShop\Context\Item\Iface $context Context object
	 * @param string $sitecode Unique site code
	 * @param string $lang ISO language code, e.g. "en" or "en_GB"
	 * @return \Aimeos\MShop\Context\Item\Iface Modified context object
	 */
	protected static function setLocale( \Aimeos\Slim\Base\I18n $i18n, \Aimeos\MShop\Context\Item\Iface $context, $sitecode, $lang )

	{
		$localeManager = \Aimeos\MShop\Factory::createManager( $context, 'locale' );

		try
		{
			$localeItem = $localeManager->bootstrap( $sitecode, '', '', false );
			$localeItem->setLanguageId( null );
			$localeItem->setCurrencyId( null );
		}
		catch( \Aimeos\MShop\Locale\Exception $e )
		{
			$localeItem = $localeManager->createItem();
		}

		$context->setLocale( $localeItem );
		$context->setI18n( $i18n->get( array( $lang ) ) );

		return $context;
	}
}


1		<?php
2
3		/**
4		* @license LGPLv3, http://opensource.org/licenses/LGPL-3.0
5		* @copyright Aimeos (aimeos.org), 2016
6		* @package Slim
7		* @subpackage Controller
8		*/
9
10
11		namespace Aimeos\Slim\Controller;
12
13		use Interop\Container\ContainerInterface;
14		use Psr\Http\Message\ServerRequestInterface;
15		use Psr\Http\Message\ResponseInterface;
16
17
18		/**
19		* Aimeos controller for the JSON REST API
20		*
21		* @package Slim
22		* @subpackage Controller
23		*/
24		class Jsonadm
25		{
26		/**
27		* Deletes the resource object or a list of resource objects
28		*
29		* @param ContainerInterface $container Dependency injection container
30		* @param ServerRequestInterface $request Request object
31		* @param ResponseInterface $response Response object
32		* @param array $args Associative list of route parameters
33		* @return ResponseInterface $response Modified response object with generated output
34		*/
35		public static function deleteAction( ContainerInterface $container, ServerRequestInterface $request, ResponseInterface $response, array $args )
36		{
37		$status = 500;
38		$header = $request->getHeaders();
39
40		$client = self::createClient( $container, $request, $response, $args );
41		$result = $client->delete( (string) $request->getBody(), $header, $status );
42
43		return self::withResponse( $response, $result, $status, $header );
44		}
45
46
47		/**
48		* Returns the requested resource object or list of resource objects
49		*
50		* @param ContainerInterface $container Dependency injection container
51		* @param ServerRequestInterface $request Request object
52		* @param ResponseInterface $response Response object
53		* @param array $args Associative list of route parameters
54		* @return ResponseInterface $response Modified response object with generated output
55		*/
56		public static function getAction( ContainerInterface $container, ServerRequestInterface $request, ResponseInterface $response, array $args )
57		{
58		$status = 500;
59		$header = $request->getHeaders();
60
61		$client = self::createClient( $container, $request, $response, $args );
62		$result = $client->get( (string) $request->getBody(), $header, $status );
63
64		return self::withResponse( $response, $result, $status, $header );
65		}
66
67
68		/**
69		* Updates a resource object or a list of resource objects
70		*
71		* @param ContainerInterface $container Dependency injection container
72		* @param ServerRequestInterface $request Request object
73		* @param ResponseInterface $response Response object
74		* @param array $args Associative list of route parameters
75		* @return ResponseInterface $response Modified response object with generated output
76		*/
77		public static function patchAction( ContainerInterface $container, ServerRequestInterface $request, ResponseInterface $response, array $args )
78		{
79		$status = 500;
80		$header = $request->getHeaders();
81
82		$client = self::createClient( $container, $request, $response, $args );
83		$result = $client->patch( (string) $request->getBody(), $header, $status );
84
85		return self::withResponse( $response, $result, $status, $header );
86		}
87
88
89		/**
90		* Creates a new resource object or a list of resource objects
91		*
92		* @param ContainerInterface $container Dependency injection container
93		* @param ServerRequestInterface $request Request object
94		* @param ResponseInterface $response Response object
95		* @param array $args Associative list of route parameters
96		* @return ResponseInterface $response Modified response object with generated output
97		*/
98		public static function postAction( ContainerInterface $container, ServerRequestInterface $request, ResponseInterface $response, array $args )
99		{
100		$status = 500;
101		$header = $request->getHeaders();
102
103		$client = self::createClient( $container, $request, $response, $args );
104		$result = $client->post( (string) $request->getBody(), $header, $status );
105
106		return self::withResponse( $response, $result, $status, $header );
107		}
108
109
110		/**
111		* Creates or updates a single resource object
112		*
113		* @param ContainerInterface $container Dependency injection container
114		* @param ServerRequestInterface $request Request object
115		* @param ResponseInterface $response Response object
116		* @param array $args Associative list of route parameters
117		* @return ResponseInterface $response Modified response object with generated output
118		*/
119		public static function putAction( ContainerInterface $container, ServerRequestInterface $request, ResponseInterface $response, array $args )
120		{
121		$status = 500;
122		$header = $request->getHeaders();
123
124		$client = self::createClient( $container, $request, $response, $args );
125		$result = $client->put( (string) $request->getBody(), $header, $status );
126
127		return self::withResponse( $response, $result, $status, $header );
128		}
129
130
131		/**
132		* Returns the available HTTP verbs and the resource URLs
133		*
134		* @param ContainerInterface $container Dependency injection container
135		* @param ServerRequestInterface $request Request object
136		* @param ResponseInterface $response Response object
137		* @param array $args Associative list of route parameters
138		* @return ResponseInterface $response Modified response object with generated output
139		*/
140		public static function optionsAction( ContainerInterface $container, ServerRequestInterface $request, ResponseInterface $response, array $args )
141		{
142		$status = 500;
143		$header = $request->getHeaders();
144
145		$client = self::createClient( $container, $request, $response, $args );
146		$result = $client->options( (string) $request->getBody(), $header, $status );
147
148		return self::withResponse( $response, $result, $status, $header );
149		}
150
151
152		/**
153		* Returns the resource controller
154		*
155		* @param ContainerInterface $container Dependency injection container
156		* @param ServerRequestInterface $request Request object
157		* @param ResponseInterface $response Response object
158		* @param array $args Associative list of route parameters
159		* @return \Aimeos\Controller\JsonAdm\Iface JSON admin controller
160		*/
161		protected static function createClient( ContainerInterface $container, ServerRequestInterface $request, ResponseInterface $response, array $args )
162		{
163		$resource = ( isset( $args['resource'] ) ? $args['resource'] : null );
164		$site = ( isset( $args['site'] ) ? $args['site'] : 'default' );
165		$lang = ( isset( $args['lang'] ) ? $args['lang'] : 'en' );
166
167		$templatePaths = $container->get( 'aimeos' )->getCustomPaths( 'admin/jsonadm/templates' );
168
169		$context = $container->get( 'aimeos_context' )->get( false, $args );
170		$context = self::setLocale( $container->get( 'aimeos_i18n' ), $context, $site, $lang );
171
172		$view = $container->get( 'aimeos_view' )->create( $request, $response, $args, $templatePaths, $lang );
173		$context->setView( $view );
174
175		return \Aimeos\Admin\JsonAdm\Factory::createClient( $context, $templatePaths, $resource );
176		}
177
178
179		/**
180		* Populates the response object
181		*
182		* @param ResponseInterface $response Response object
183		* @param string $content Body of the HTTP response
184		* @param integer $status HTTP status
185		* @param array $header List of HTTP headers
186		* @return ResponseInterface $response Populated response object
187		*/
188		protected static function withResponse( ResponseInterface $response, $content, $status, array $header )
189		{
190		$response->getBody()->write( $content );
191		$response = $response->withStatus( $status );
192
193		foreach( $header as $key => $value ) {
194		$response->withHeader( $key, $value );
195		}
196
197		return $response;
198		}
199
200
201		/**
202		* Sets the locale item in the given context
203		*
204		* @param \Aimeos\Slim\Base\I18n $i18n Aimeos translation object builder
205		* @param \Aimeos\MShop\Context\Item\Iface $context Context object
206		* @param string $sitecode Unique site code
207		* @param string $lang ISO language code, e.g. "en" or "en_GB"
208		* @return \Aimeos\MShop\Context\Item\Iface Modified context object
209		*/
210	View Code Duplication	protected static function setLocale( \Aimeos\Slim\Base\I18n $i18n, \Aimeos\MShop\Context\Item\Iface $context, $sitecode, $lang )
		0 ignored issues – show Duplication introduced 2016-03-07 23:33 UTC by Report Bug Copy Issue Report This method seems to be duplicated in your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
211		{
212		$localeManager = \Aimeos\MShop\Factory::createManager( $context, 'locale' );
213
214		try
215		{
216		$localeItem = $localeManager->bootstrap( $sitecode, '', '', false );
217		$localeItem->setLanguageId( null );
218		$localeItem->setCurrencyId( null );
219		}
220		catch( \Aimeos\MShop\Locale\Exception $e )
221		{
222		$localeItem = $localeManager->createItem();
223		}
224
225		$context->setLocale( $localeItem );
226		$context->setI18n( $i18n->get( array( $lang ) ) );
227
228		return $context;
229		}
230		}
231

aimeos / aimeos-slim

Push — master ( 96c485...89068a )

Jsonadm::createClient() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like