JqadmController::exportction() - Code Metrics - Inspection of "Improved JQAdm controller, routes and added export..." - aimeos/aimeos-flow - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 24633a...ec1538 )

by Aimeos

created 2017-08-21 12:06 UTC

JqadmController::exportction() A

↳ Parent: JqadmController

Complexity

Conditions	2
Paths	2

Size

Total Lines	10
Code Lines	5

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
dl	0
loc	10
rs	9.4285
c	0
b	0
f	0
cc	2
eloc	5
nc	2
nop	2

<?php

/**
 * @license LGPLv3, http://www.gnu.org/copyleft/lgpl.html
 * @copyright Aimeos (aimeos.org), 2015-2016
 * @package flow
 * @subpackage Controller
 */


namespace Aimeos\Shop\Controller;

use Neos\Flow\Annotations as Flow;


/**
 * Controller for JQuery based adminisration interface.
 * @package flow
 * @subpackage Controller
 */
class JqadmController extends \Neos\Flow\Mvc\Controller\ActionController
{
	/**
	 * @var \Aimeos\Shop\Base\Aimeos
	 * @Flow\Inject
	 */
	protected $aimeos;

	/**
	 * @var \Aimeos\Shop\Base\Context
	 * @Flow\Inject
	 */
	protected $context;

	/**
	 * @var \Aimeos\Shop\Base\I18n
	 * @Flow\Inject
	 */
	protected $i18n;

	/**
	 * @var \Aimeos\Shop\Base\Locale
	 * @Flow\Inject
	 */
	protected $locale;

	/**
	 * @var \Aimeos\Shop\Base\View
	 * @Flow\Inject
	 */
	protected $viewbase;


	/**
	 * Returns the JS file content
	 *
	 * @return \Neos\Flow\Http\Response Response object
	 */
	public function fileAction()
	{
		$files = array();
		$aimeos = $this->aimeos->get();
		$type = $this->request->getArgument( 'type' );

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

		foreach( $files as $file )
		{
			if( ( $content = file_get_contents( $file ) ) !== false ) {
				$this->response->appendContent( $content );
			}
		}

		if( $type === 'js' ) {
			$this->response->setHeader( 'Content-Type', 'application/javascript' );
		} elseif( $type === 'css' ) {
			$this->response->setHeader( 'Content-Type', 'text/css' );
		}
	}


	/**
	 * Returns the HTML code for a copy of a resource object
	 *
	 * @param string Resource location, e.g. "product"
	 * @param string $site Unique site code
	 * @return string Generated output
	 */
	public function copyAction( $resource, $site = 'default' )
	{
		$cntl = $this->createClient( $site, $resource );

		if( ( $html = $cntl->copy() ) == '' ) {

			return $this->setPsrResponse( $cntl->getView()->response() );
		}

		return $this->getHtml( $html );
	}


	/**
	 * Returns the HTML code for a new resource object
	 *
	 * @param string Resource location, e.g. "product"
	 * @param string $site Unique site code
	 * @return string Generated output
	 */
	public function createAction( $resource, $site = 'default' )
	{
		$cntl = $this->createClient( $site, $resource );

		if( ( $html = $cntl->create() ) == '' ) {

			return $this->setPsrResponse( $cntl->getView()->response() );
		}

		return $this->getHtml( $html );
	}


	/**
	 * Deletes the resource object or a list of resource objects
	 *
	 * @param string Resource location, e.g. "product"
	 * @param string $site Unique site code
	 * @return string Generated output
	 */
	public function deleteAction( $resource, $site = 'default' )
	{
		$cntl = $this->createClient( $site, $resource );

		if( ( $html = $cntl->delete() ) == '' ) {

			return $this->setPsrResponse( $cntl->getView()->response() );
		}

		return $this->getHtml( $html );
	}


	/**
	 * Exports the resource object
	 *
	 * @param string Resource location, e.g. "order"
	 * @param string $site Unique site code
	 * @return string Generated output
	 */
	public function exportction( $resource, $site = 'default' )
	{
		$cntl = $this->createClient( $site, $resource );

		if( ( $html = $cntl->export() ) == '' ) {

			return $this->setPsrResponse( $cntl->getView()->response() );
		}

		return $this->getHtml( $html );
	}


	/**
	 * Returns the HTML code for the requested resource object
	 *
	 * @param string Resource location, e.g. "product"
	 * @param string $site Unique site code
	 * @return string Generated output
	 */
	public function getAction( $resource, $site = 'default' )
	{
		$cntl = $this->createClient( $site, $resource );

		if( ( $html = $cntl->get() ) == '' ) {

			return $this->setPsrResponse( $cntl->getView()->response() );
		}

		return $this->getHtml( $html );
	}


	/**
	 * Saves a new resource object
	 *
	 * @param string Resource location, e.g. "product"
	 * @param string $site Unique site code
	 * @return string Generated output
	 */
	public function saveAction( $resource, $site = 'default' )
	{
		$cntl = $this->createClient( $site, $resource );

		if( ( $html = $cntl->save() ) == '' ) {

			return $this->setPsrResponse( $cntl->getView()->response() );
		}

		return $this->getHtml( $html );
	}


	/**
	 * Returns the HTML code for a list of resource objects
	 *
	 * @param string Resource location, e.g. "product"
	 * @param string $site Unique site code
	 * @return string Generated output
	 */
	public function searchAction( $resource, $site = 'default' )
	{
		$cntl = $this->createClient( $site, $resource );

		if( ( $html = $cntl->search() ) == '' ) {

			return $this->setPsrResponse( $cntl->getView()->response() );
		}

		return $this->getHtml( $html );
	}


	/**
	 * Returns the resource controller
	 *
	 * @param string $sitecode Unique site code
	 * @return \Aimeos\MShop\Context\Item\Iface Context item
	 */
	protected function createClient( $sitecode, $resource )
	{
		$aimeos = $this->aimeos->get();
		$lang = ( $this->request->hasArgument( 'lang' ) ? $this->request->getArgument( 'lang' ) : 'en' );
		$templatePaths = $aimeos->getCustomPaths( 'admin/jqadm/templates' );

		$context = $this->context->get( null, 'backend' );
		$context->setI18n( $this->i18n->get( array( $lang, 'en' ) ) );
		$context->setLocale( $this->locale->getBackend( $context, $sitecode ) );
		$context->setView( $this->viewbase->create( $context, $this->uriBuilder, $templatePaths, $this->request, $lang ) );

		return \Aimeos\Admin\JQAdm\Factory::createClient( $context, $templatePaths, $resource )->setAimeos( $aimeos );
	}


	/**
	 * Returns the generated view including the HTML code
	 *
	 * @param string $content Content from admin client
	 */
	protected function getHtml( $content )
	{
		$version = $this->aimeos->getVersion();
		$extnames = implode( ',', $this->aimeos->get()->getExtensions() );
		$content = str_replace( ['{type}', '{version}', '{extensions}'], ['Flow', $version, $extnames], $content );

		$this->view->assign( 'content', $content );
		return $this->view->render( 'index' );

	}


	/**
	 * Set the response data from a PSR-7 response object
	 *
	 * @param \Psr\Http\Message\ResponseInterface $response PSR-7 response object
	 * @return string Response message content
	 */
	protected function setPsrResponse( \Psr\Http\Message\ResponseInterface $response )
	{
		$this->response->setStatus( $response->getStatusCode() );

		foreach( $response->getHeaders() as $key => $value ) {
			$this->response->setHeader( $key, $value );
		}

		return (string) $response->getBody();
	}
}


1			<?php
2
3			/**
4			* @license LGPLv3, http://www.gnu.org/copyleft/lgpl.html
5			* @copyright Aimeos (aimeos.org), 2015-2016
6			* @package flow
7			* @subpackage Controller
8			*/
9
10
11			namespace Aimeos\Shop\Controller;
12
13			use Neos\Flow\Annotations as Flow;
14
15
16			/**
17			* Controller for JQuery based adminisration interface.
18			* @package flow
19			* @subpackage Controller
20			*/
21			class JqadmController extends \Neos\Flow\Mvc\Controller\ActionController
22			{
23			/**
24			* @var \Aimeos\Shop\Base\Aimeos
25			* @Flow\Inject
26			*/
27			protected $aimeos;
28
29			/**
30			* @var \Aimeos\Shop\Base\Context
31			* @Flow\Inject
32			*/
33			protected $context;
34
35			/**
36			* @var \Aimeos\Shop\Base\I18n
37			* @Flow\Inject
38			*/
39			protected $i18n;
40
41			/**
42			* @var \Aimeos\Shop\Base\Locale
43			* @Flow\Inject
44			*/
45			protected $locale;
46
47			/**
48			* @var \Aimeos\Shop\Base\View
49			* @Flow\Inject
50			*/
51			protected $viewbase;
52
53
54			/**
55			* Returns the JS file content
56			*
57			* @return \Neos\Flow\Http\Response Response object
58			*/
59			public function fileAction()
60			{
61			$files = array();
62			$aimeos = $this->aimeos->get();
63			$type = $this->request->getArgument( 'type' );
64
65			foreach( $aimeos->getCustomPaths( 'admin/jqadm' ) as $base => $paths )
66			{
67			foreach( $paths as $path )
68			{
69			$jsbAbsPath = $base . '/' . $path;
70			$jsb2 = new \Aimeos\MW\Jsb2\Standard( $jsbAbsPath, dirname( $jsbAbsPath ) );
71			$files = array_merge( $files, $jsb2->getFiles( $type ) );
72			}
73			}
74
75			foreach( $files as $file )
76			{
77			if( ( $content = file_get_contents( $file ) ) !== false ) {
78			$this->response->appendContent( $content );
79			}
80			}
81
82			if( $type === 'js' ) {
83			$this->response->setHeader( 'Content-Type', 'application/javascript' );
84			} elseif( $type === 'css' ) {
85			$this->response->setHeader( 'Content-Type', 'text/css' );
86			}
87			}
88
89
90			/**
91			* Returns the HTML code for a copy of a resource object
92			*
93			* @param string Resource location, e.g. "product"
94			* @param string $site Unique site code
95			* @return string Generated output
96			*/
97			public function copyAction( $resource, $site = 'default' )
98			{
99			$cntl = $this->createClient( $site, $resource );
100
101			if( ( $html = $cntl->copy() ) == '' ) {
			0 ignored issues – show Bug introduced 2017-08-21 12:18 UTC by Report Bug Copy Issue Report The method `copy()` does not seem to exist on `object<Aimeos\MShop\Context\Item\Iface>`. This check looks for calls to methods that do not seem to exist on a given type. It looks for the method on the type itself as well as in inherited classes or implemented interfaces. This is most likely a typographical error or the method has been renamed. Loading history...
102			return $this->setPsrResponse( $cntl->getView()->response() );
103			}
104
105			return $this->getHtml( $html );
106			}
107
108
109			/**
110			* Returns the HTML code for a new resource object
111			*
112			* @param string Resource location, e.g. "product"
113			* @param string $site Unique site code
114			* @return string Generated output
115			*/
116			public function createAction( $resource, $site = 'default' )
117			{
118			$cntl = $this->createClient( $site, $resource );
119
120			if( ( $html = $cntl->create() ) == '' ) {
			0 ignored issues – show Bug introduced 2017-08-21 12:18 UTC by Report Bug Copy Issue Report The method `create()` does not seem to exist on `object<Aimeos\MShop\Context\Item\Iface>`. This check looks for calls to methods that do not seem to exist on a given type. It looks for the method on the type itself as well as in inherited classes or implemented interfaces. This is most likely a typographical error or the method has been renamed. Loading history...
121			return $this->setPsrResponse( $cntl->getView()->response() );
122			}
123
124			return $this->getHtml( $html );
125			}
126
127
128			/**
129			* Deletes the resource object or a list of resource objects
130			*
131			* @param string Resource location, e.g. "product"
132			* @param string $site Unique site code
133			* @return string Generated output
134			*/
135			public function deleteAction( $resource, $site = 'default' )
136			{
137			$cntl = $this->createClient( $site, $resource );
138
139			if( ( $html = $cntl->delete() ) == '' ) {
			0 ignored issues – show Bug introduced 2017-07-10 12:49 UTC by Report Bug Copy Issue Report The method `delete()` does not seem to exist on `object<Aimeos\MShop\Context\Item\Iface>`. This check looks for calls to methods that do not seem to exist on a given type. It looks for the method on the type itself as well as in inherited classes or implemented interfaces. This is most likely a typographical error or the method has been renamed. Loading history...
140			return $this->setPsrResponse( $cntl->getView()->response() );
141			}
142
143			return $this->getHtml( $html );
144			}
145
146
147			/**
148			* Exports the resource object
149			*
150			* @param string Resource location, e.g. "order"
151			* @param string $site Unique site code
152			* @return string Generated output
153			*/
154			public function exportction( $resource, $site = 'default' )
155			{
156			$cntl = $this->createClient( $site, $resource );
157
158			if( ( $html = $cntl->export() ) == '' ) {
			0 ignored issues – show Bug introduced 2017-08-21 12:18 UTC by Report Bug Copy Issue Report The method `export()` does not seem to exist on `object<Aimeos\MShop\Context\Item\Iface>`. This check looks for calls to methods that do not seem to exist on a given type. It looks for the method on the type itself as well as in inherited classes or implemented interfaces. This is most likely a typographical error or the method has been renamed. Loading history...
159			return $this->setPsrResponse( $cntl->getView()->response() );
160			}
161
162			return $this->getHtml( $html );
163			}
164
165
166			/**
167			* Returns the HTML code for the requested resource object
168			*
169			* @param string Resource location, e.g. "product"
170			* @param string $site Unique site code
171			* @return string Generated output
172			*/
173			public function getAction( $resource, $site = 'default' )
174			{
175			$cntl = $this->createClient( $site, $resource );
176
177			if( ( $html = $cntl->get() ) == '' ) {
			0 ignored issues – show Bug introduced 2017-08-21 12:18 UTC by Report Bug Copy Issue Report The method `get()` does not seem to exist on `object<Aimeos\MShop\Context\Item\Iface>`. This check looks for calls to methods that do not seem to exist on a given type. It looks for the method on the type itself as well as in inherited classes or implemented interfaces. This is most likely a typographical error or the method has been renamed. Loading history...
178			return $this->setPsrResponse( $cntl->getView()->response() );
179			}
180
181			return $this->getHtml( $html );
182			}
183
184
185			/**
186			* Saves a new resource object
187			*
188			* @param string Resource location, e.g. "product"
189			* @param string $site Unique site code
190			* @return string Generated output
191			*/
192			public function saveAction( $resource, $site = 'default' )
193			{
194			$cntl = $this->createClient( $site, $resource );
195
196			if( ( $html = $cntl->save() ) == '' ) {
			0 ignored issues – show Bug introduced 2017-07-10 12:49 UTC by Report Bug Copy Issue Report The method `save()` does not seem to exist on `object<Aimeos\MShop\Context\Item\Iface>`. This check looks for calls to methods that do not seem to exist on a given type. It looks for the method on the type itself as well as in inherited classes or implemented interfaces. This is most likely a typographical error or the method has been renamed. Loading history...
197			return $this->setPsrResponse( $cntl->getView()->response() );
198			}
199
200			return $this->getHtml( $html );
201			}
202
203
204			/**
205			* Returns the HTML code for a list of resource objects
206			*
207			* @param string Resource location, e.g. "product"
208			* @param string $site Unique site code
209			* @return string Generated output
210			*/
211			public function searchAction( $resource, $site = 'default' )
212			{
213			$cntl = $this->createClient( $site, $resource );
214
215			if( ( $html = $cntl->search() ) == '' ) {
			0 ignored issues – show Bug introduced 2017-08-21 12:18 UTC by Report Bug Copy Issue Report The method `search()` does not seem to exist on `object<Aimeos\MShop\Context\Item\Iface>`. This check looks for calls to methods that do not seem to exist on a given type. It looks for the method on the type itself as well as in inherited classes or implemented interfaces. This is most likely a typographical error or the method has been renamed. Loading history...
216			return $this->setPsrResponse( $cntl->getView()->response() );
217			}
218
219			return $this->getHtml( $html );
220			}
221
222
223			/**
224			* Returns the resource controller
225			*
226			* @param string $sitecode Unique site code
227			* @return \Aimeos\MShop\Context\Item\Iface Context item
228			*/
229			protected function createClient( $sitecode, $resource )
230			{
231			$aimeos = $this->aimeos->get();
232			$lang = ( $this->request->hasArgument( 'lang' ) ? $this->request->getArgument( 'lang' ) : 'en' );
233			$templatePaths = $aimeos->getCustomPaths( 'admin/jqadm/templates' );
234
235			$context = $this->context->get( null, 'backend' );
236			$context->setI18n( $this->i18n->get( array( $lang, 'en' ) ) );
237			$context->setLocale( $this->locale->getBackend( $context, $sitecode ) );
238			$context->setView( $this->viewbase->create( $context, $this->uriBuilder, $templatePaths, $this->request, $lang ) );
239
240			return \Aimeos\Admin\JQAdm\Factory::createClient( $context, $templatePaths, $resource )->setAimeos( $aimeos );
241			}
242
243
244			/**
245			* Returns the generated view including the HTML code
246			*
247			* @param string $content Content from admin client
248			*/
249			protected function getHtml( $content )
250			{
251			$version = $this->aimeos->getVersion();
252			$extnames = implode( ',', $this->aimeos->get()->getExtensions() );
253			$content = str_replace( ['{type}', '{version}', '{extensions}'], ['Flow', $version, $extnames], $content );
254
255			$this->view->assign( 'content', $content );
256			return $this->view->render( 'index' );
			0 ignored issues – show Unused Code introduced 2016-01-23 12:44 UTC by Report Bug Copy Issue Report The call to `ViewInterface::render()` has too many arguments starting with `'index'`. This check compares calls to functions or methods with their respective definitions. If the call has more arguments than are defined, it raises an issue. If a function is defined several times with a different number of parameters, the check may pick up the wrong definition and report false positives. One codebase where this has been known to happen is Wordpress. In this case you can add the `@ignore` PhpDoc annotation to the duplicate definition and it will be ignored. Loading history...
257			}
258
259
260			/**
261			* Set the response data from a PSR-7 response object
262			*
263			* @param \Psr\Http\Message\ResponseInterface $response PSR-7 response object
264			* @return string Response message content
265			*/
266			protected function setPsrResponse( \Psr\Http\Message\ResponseInterface $response )
267			{
268			$this->response->setStatus( $response->getStatusCode() );
269
270			foreach( $response->getHeaders() as $key => $value ) {
271			$this->response->setHeader( $key, $value );
272			}
273
274			return (string) $response->getBody();
275			}
276			}
277

aimeos / aimeos-flow

Push — master ( 24633a...ec1538 )

JqadmController::exportction() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like