Extadm::getJsonClientConfig() - Code Metrics - Inspection of "Merge branch 'master' of https://github.com/aimeos..." - aimeos/aimeos-slim - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( f48078...c7b4d8 )

by Aimeos

created 2016-03-07 23:31 UTC

Extadm::getJsonClientConfig() A

↳ Parent: Extadm

Complexity

Conditions	1
Paths	1

Size

Total Lines	5
Code Lines	3

Duplication

Lines	0
Ratio	0 %

Importance

Changes	1
Bugs	0	Features	1

Metric	Value
c	1
b	0
f	1
dl	0
loc	5
rs	9.4285
cc	1
eloc	3
nc	1
nop	1

<?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 ExtJS admin interface
 *
 * @package Slim
 * @subpackage Controller
 */
class Extadm
{
	/**
	 * Returns the view for the ExtJS admin interface
	 *
	 * @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 indexAction( ContainerInterface $container, ServerRequestInterface $request, ResponseInterface $response, array $args )
	{
		$site = ( isset( $args['site'] ) ? $args['site'] : 'default' );
		$lang = ( isset( $args['lang'] ) ? $args['lang'] : 'en' );
		$tab = ( isset( $args['tab'] ) ? $args['tab'] : 0 );

		$aimeos = $container->get( 'aimeos' );
		$cntlPaths = $aimeos->getCustomPaths( 'controller/extjs' );

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

		$controller = new \Aimeos\Controller\ExtJS\JsonRpc( $context, $cntlPaths );
		$cssFiles = array();

		foreach( $aimeos->getCustomPaths( 'admin/extjs' ) as $base => $paths )
		{
			foreach( $paths as $path )
			{
				$jsbAbsPath = $base . '/' . $path;

				if( !is_file( $jsbAbsPath ) ) {
					throw new \Exception( sprintf( 'JSB2 file "%1$s" not found', $jsbAbsPath ) );
				}

				$jsb2 = new \Aimeos\MW\Jsb2\Standard( $jsbAbsPath, dirname( $path ) );
				$cssFiles = array_merge( $cssFiles, $jsb2->getUrls( 'css' ) );
			}
		}

		$csrfname = $request->getAttribute( 'csrf_name' );
		$csrfvalue = $request->getAttribute( 'csrf_value' );

		$router = $container->get( 'router' );
		$jqadmUrl = $router->pathFor( 'aimeos_shop_jqadm_search', array( 'site' => $site, 'resource' => 'product' ) );
		$jsonUrl = $router->pathFor( 'aimeos_shop_extadm_json', array( 'site' => $site, $csrfname => $csrfvalue ) );
		$adminUrl = $router->pathFor( 'aimeos_shop_extadm', array( 'site' => '<site>', 'lang' => '<lang>', 'tab' => '<tab>' ) );

		$vars = array(
			'lang' => $lang,
			'cssFiles' => $cssFiles,
			'languages' => self::getJsonLanguages( $aimeos ),
			'config' => self::getJsonClientConfig( $context ),
			'site' => self::getJsonSiteItem( $context, $site ),
			'i18nContent' => self::getJsonClientI18n( $aimeos->getI18nPaths(), $lang ),
			'uploaddir' => $context->getConfig()->get( 'uploaddir', '/' ),
			'searchSchemas' => $controller->getJsonSearchSchemas(),
			'itemSchemas' => $controller->getJsonItemSchemas(),
			'smd' => $controller->getJsonSmd( $jsonUrl ),
			'urlTemplate' => $adminUrl,
			'jqadmurl' => $jqadmUrl,
			'activeTab' => $tab,
			'version' => \Aimeos\Slim\Bootstrap::getVersion(),
		);

		return $container->get( 'view' )->render( $response, 'Extadm/index.html.twig', $vars );
	}


	/**
	 * Single entry point for all JSON admin requests
	 *
	 * @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 doAction( ContainerInterface $container, ServerRequestInterface $request, ResponseInterface $response, array $args )
	{
		$cntlPaths = $container->get( 'aimeos' )->getCustomPaths( 'controller/extjs' );

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

		$params = $request->getQueryParams();
		if( ( $post = $request->getParsedBody() ) !== null ) {
			$params = array_merge( $params, (array) $post );
		}

		$controller = new \Aimeos\Controller\ExtJS\JsonRpc( $context, $cntlPaths );
		$output = $controller->process( $params, (string) $request->getBody() );
		$response->getBody()->write( $output );

		return $response;
	}


	/**
	 * Returns the JS file content
	 *
	 * @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 fileAction( ContainerInterface $container, ServerRequestInterface $request, ResponseInterface $response, array $args )

	{
		$contents = '';
		$jsFiles = array();
		$aimeos = $container->get( 'aimeos' );

		foreach( $aimeos->getCustomPaths( 'admin/extjs' ) as $base => $paths )
		{
			foreach( $paths as $path )
			{
				$jsbAbsPath = $base . '/' . $path;
				$jsb2 = new \Aimeos\MW\Jsb2\Standard( $jsbAbsPath, dirname( $jsbAbsPath ) );
				$jsFiles = array_merge( $jsFiles, $jsb2->getFiles( 'js' ) );
			}
		}

		foreach( $jsFiles as $file )
		{
			if( ( $content = file_get_contents( $file ) ) !== false ) {
				$contents .= $content;
			}
		}

		return $response->withHeader( 'Content-Type', 'application/javascript' )->getBody()->write( $contents );
	}


	/**
	 * Creates a list of all available translations
	 *
	 * @param \Aimeos\Bootstrap $aimeos Aimeos object
	 * @return array List of language IDs with labels
	 */
	protected static function getJsonLanguages( \Aimeos\Bootstrap $aimeos )
	{
		$result = array();

		foreach( $aimeos->getI18nList( 'admin' ) as $id ) {
			$result[] = array( 'id' => $id, 'label' => $id );
		}

		return json_encode( $result );
	}


	/**
	 * Returns the JSON encoded configuration for the ExtJS client.
	 *
	 * @param \Aimeos\MShop\Context\Item\Iface $context Context item object
	 * @return string JSON encoded configuration object
	 */
	protected static function getJsonClientConfig( \Aimeos\MShop\Context\Item\Iface $context )
	{
		$config = $context->getConfig()->get( 'admin/extjs', array() );
		return json_encode( array( 'admin' => array( 'extjs' => $config ) ), JSON_FORCE_OBJECT );
	}


	/**
	 * Returns the JSON encoded translations for the ExtJS client.
	 *
	 * @param array $i18nPaths List of file system paths which contain the translation files
	 * @param string $lang ISO language code like "en" or "en_GB"
	 * @return string JSON encoded translation object
	 */
	protected static function getJsonClientI18n( array $i18nPaths, $lang )
	{
		$i18n = new \Aimeos\MW\Translation\Gettext( $i18nPaths, $lang );

		$content = array(
			'admin' => $i18n->getAll( 'admin' ),
			'admin/ext' => $i18n->getAll( 'admin/ext' ),
		);

		return json_encode( $content, JSON_FORCE_OBJECT );
	}


	/**
	 * Returns the JSON encoded site item.
	 *
	 * @param \Aimeos\MShop\Context\Item\Iface $context Context item object
	 * @param string $site Unique site code
	 * @return string JSON encoded site item object
	 * @throws Exception If no site item was found for the code
	 */
	protected static function getJsonSiteItem( \Aimeos\MShop\Context\Item\Iface $context, $site )
	{
		$manager = \Aimeos\MShop\Factory::createManager( $context, 'locale/site' );

		$criteria = $manager->createSearch();
		$criteria->setConditions( $criteria->compare( '==', 'locale.site.code', $site ) );
		$items = $manager->searchItems( $criteria );

		if( ( $item = reset( $items ) ) === false ) {
			throw new \Exception( sprintf( 'No site found for code "%1$s"', $site ) );
		}

		return json_encode( $item->toArray() );
	}


	/**
	 * Sets the locale item in the given context
	 *
	 * @param \Aimeos\MShop\Context\Item\Iface $context Context object
	 * @param string $sitecode Unique site code
	 * @param string $locale ISO language code, e.g. "en" or "en_GB"
	 * @return \Aimeos\MShop\Context\Item\Iface Modified context object
	 */
	protected static function setLocale( \Aimeos\MShop\Context\Item\Iface $context, $sitecode = 'default', $locale = null )
	{
		$localeManager = \Aimeos\MShop\Factory::createManager( $context, 'locale' );

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

		$context->setLocale( $localeItem );

		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 ExtJS admin interface
20			*
21			* @package Slim
22			* @subpackage Controller
23			*/
24			class Extadm
25			{
26			/**
27			* Returns the view for the ExtJS admin interface
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 indexAction( ContainerInterface $container, ServerRequestInterface $request, ResponseInterface $response, array $args )
36			{
37			$site = ( isset( $args['site'] ) ? $args['site'] : 'default' );
38			$lang = ( isset( $args['lang'] ) ? $args['lang'] : 'en' );
39			$tab = ( isset( $args['tab'] ) ? $args['tab'] : 0 );
40
41			$aimeos = $container->get( 'aimeos' );
42			$cntlPaths = $aimeos->getCustomPaths( 'controller/extjs' );
43
44			$context = $container->get( 'aimeos_context' )->get( false, $args );
45			$context = self::setLocale( $context, $site, $lang );
46
47			$controller = new \Aimeos\Controller\ExtJS\JsonRpc( $context, $cntlPaths );
48			$cssFiles = array();
49
50			foreach( $aimeos->getCustomPaths( 'admin/extjs' ) as $base => $paths )
51			{
52			foreach( $paths as $path )
53			{
54			$jsbAbsPath = $base . '/' . $path;
55
56			if( !is_file( $jsbAbsPath ) ) {
57			throw new \Exception( sprintf( 'JSB2 file "%1$s" not found', $jsbAbsPath ) );
58			}
59
60			$jsb2 = new \Aimeos\MW\Jsb2\Standard( $jsbAbsPath, dirname( $path ) );
61			$cssFiles = array_merge( $cssFiles, $jsb2->getUrls( 'css' ) );
62			}
63			}
64
65			$csrfname = $request->getAttribute( 'csrf_name' );
66			$csrfvalue = $request->getAttribute( 'csrf_value' );
67
68			$router = $container->get( 'router' );
69			$jqadmUrl = $router->pathFor( 'aimeos_shop_jqadm_search', array( 'site' => $site, 'resource' => 'product' ) );
70			$jsonUrl = $router->pathFor( 'aimeos_shop_extadm_json', array( 'site' => $site, $csrfname => $csrfvalue ) );
71			$adminUrl = $router->pathFor( 'aimeos_shop_extadm', array( 'site' => '<site>', 'lang' => '<lang>', 'tab' => '<tab>' ) );
72
73			$vars = array(
74			'lang' => $lang,
75			'cssFiles' => $cssFiles,
76			'languages' => self::getJsonLanguages( $aimeos ),
77			'config' => self::getJsonClientConfig( $context ),
78			'site' => self::getJsonSiteItem( $context, $site ),
79			'i18nContent' => self::getJsonClientI18n( $aimeos->getI18nPaths(), $lang ),
80			'uploaddir' => $context->getConfig()->get( 'uploaddir', '/' ),
81			'searchSchemas' => $controller->getJsonSearchSchemas(),
82			'itemSchemas' => $controller->getJsonItemSchemas(),
83			'smd' => $controller->getJsonSmd( $jsonUrl ),
84			'urlTemplate' => $adminUrl,
85			'jqadmurl' => $jqadmUrl,
86			'activeTab' => $tab,
87			'version' => \Aimeos\Slim\Bootstrap::getVersion(),
88			);
89
90			return $container->get( 'view' )->render( $response, 'Extadm/index.html.twig', $vars );
91			}
92
93
94			/**
95			* Single entry point for all JSON admin requests
96			*
97			* @param ContainerInterface $container Dependency injection container
98			* @param ServerRequestInterface $request Request object
99			* @param ResponseInterface $response Response object
100			* @param array $args Associative list of route parameters
101			* @return ResponseInterface $response Modified response object with generated output
102			*/
103			public static function doAction( ContainerInterface $container, ServerRequestInterface $request, ResponseInterface $response, array $args )
104			{
105			$cntlPaths = $container->get( 'aimeos' )->getCustomPaths( 'controller/extjs' );
106
107			$context = $container->get( 'aimeos_context' )->get( false, $args );
108			$context = self::setLocale( $context );
109
110			$params = $request->getQueryParams();
111			if( ( $post = $request->getParsedBody() ) !== null ) {
112			$params = array_merge( $params, (array) $post );
113			}
114
115			$controller = new \Aimeos\Controller\ExtJS\JsonRpc( $context, $cntlPaths );
116			$output = $controller->process( $params, (string) $request->getBody() );
117			$response->getBody()->write( $output );
118
119			return $response;
120			}
121
122
123			/**
124			* Returns the JS file content
125			*
126			* @param ContainerInterface $container Dependency injection container
127			* @param ServerRequestInterface $request Request object
128			* @param ResponseInterface $response Response object
129			* @param array $args Associative list of route parameters
130			* @return ResponseInterface $response Modified response object with generated output
131			*/
132			public static function fileAction( ContainerInterface $container, ServerRequestInterface $request, ResponseInterface $response, array $args )
			0 ignored issues – show Unused Code introduced 2016-03-07 23:33 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... Unused Code introduced 2016-03-07 23:33 UTC by Report Bug Copy Issue Report The parameter `$args` 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			$contents = '';
135			$jsFiles = array();
136			$aimeos = $container->get( 'aimeos' );
137
138			foreach( $aimeos->getCustomPaths( 'admin/extjs' ) as $base => $paths )
139			{
140			foreach( $paths as $path )
141			{
142			$jsbAbsPath = $base . '/' . $path;
143			$jsb2 = new \Aimeos\MW\Jsb2\Standard( $jsbAbsPath, dirname( $jsbAbsPath ) );
144			$jsFiles = array_merge( $jsFiles, $jsb2->getFiles( 'js' ) );
145			}
146			}
147
148			foreach( $jsFiles as $file )
149			{
150			if( ( $content = file_get_contents( $file ) ) !== false ) {
151			$contents .= $content;
152			}
153			}
154
155			return $response->withHeader( 'Content-Type', 'application/javascript' )->getBody()->write( $contents );
156			}
157
158
159			/**
160			* Creates a list of all available translations
161			*
162			* @param \Aimeos\Bootstrap $aimeos Aimeos object
163			* @return array List of language IDs with labels
164			*/
165			protected static function getJsonLanguages( \Aimeos\Bootstrap $aimeos )
166			{
167			$result = array();
168
169			foreach( $aimeos->getI18nList( 'admin' ) as $id ) {
170			$result[] = array( 'id' => $id, 'label' => $id );
171			}
172
173			return json_encode( $result );
174			}
175
176
177			/**
178			* Returns the JSON encoded configuration for the ExtJS client.
179			*
180			* @param \Aimeos\MShop\Context\Item\Iface $context Context item object
181			* @return string JSON encoded configuration object
182			*/
183			protected static function getJsonClientConfig( \Aimeos\MShop\Context\Item\Iface $context )
184			{
185			$config = $context->getConfig()->get( 'admin/extjs', array() );
186			return json_encode( array( 'admin' => array( 'extjs' => $config ) ), JSON_FORCE_OBJECT );
187			}
188
189
190			/**
191			* Returns the JSON encoded translations for the ExtJS client.
192			*
193			* @param array $i18nPaths List of file system paths which contain the translation files
194			* @param string $lang ISO language code like "en" or "en_GB"
195			* @return string JSON encoded translation object
196			*/
197			protected static function getJsonClientI18n( array $i18nPaths, $lang )
198			{
199			$i18n = new \Aimeos\MW\Translation\Gettext( $i18nPaths, $lang );
200
201			$content = array(
202			'admin' => $i18n->getAll( 'admin' ),
203			'admin/ext' => $i18n->getAll( 'admin/ext' ),
204			);
205
206			return json_encode( $content, JSON_FORCE_OBJECT );
207			}
208
209
210			/**
211			* Returns the JSON encoded site item.
212			*
213			* @param \Aimeos\MShop\Context\Item\Iface $context Context item object
214			* @param string $site Unique site code
215			* @return string JSON encoded site item object
216			* @throws Exception If no site item was found for the code
217			*/
218			protected static function getJsonSiteItem( \Aimeos\MShop\Context\Item\Iface $context, $site )
219			{
220			$manager = \Aimeos\MShop\Factory::createManager( $context, 'locale/site' );
221
222			$criteria = $manager->createSearch();
223			$criteria->setConditions( $criteria->compare( '==', 'locale.site.code', $site ) );
224			$items = $manager->searchItems( $criteria );
225
226			if( ( $item = reset( $items ) ) === false ) {
227			throw new \Exception( sprintf( 'No site found for code "%1$s"', $site ) );
228			}
229
230			return json_encode( $item->toArray() );
231			}
232
233
234			/**
235			* Sets the locale item in the given context
236			*
237			* @param \Aimeos\MShop\Context\Item\Iface $context Context object
238			* @param string $sitecode Unique site code
239			* @param string $locale ISO language code, e.g. "en" or "en_GB"
240			* @return \Aimeos\MShop\Context\Item\Iface Modified context object
241			*/
242			protected static function setLocale( \Aimeos\MShop\Context\Item\Iface $context, $sitecode = 'default', $locale = null )
243			{
244			$localeManager = \Aimeos\MShop\Factory::createManager( $context, 'locale' );
245
246			try {
247			$localeItem = $localeManager->bootstrap( $sitecode, $locale, '', false );
248			} catch( \Aimeos\MShop\Locale\Exception $e ) {
249			$localeItem = $localeManager->createItem();
250			}
251
252			$context->setLocale( $localeItem );
253
254			return $context;
255			}
256			}

aimeos / aimeos-slim

Push — master ( f48078...c7b4d8 )

Extadm::getJsonClientConfig() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like