aimeos / aimeos-slim

src/Controller/Jqadm.php

<?php

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


namespace Aimeos\Slim\Controller;

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


/**
 * Aimeos controller for the JQuery admin interface
 *
 * @package Slim
 * @subpackage Controller
 */
class Jqadm
{
	/**
	 * 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 Modified response object with generated output
	 */
	public static function fileAction( ContainerInterface $container, ServerRequestInterface $request,
		ResponseInterface $response, array $args ) : ResponseInterface
	{
		$contents = '';
		$files = array();
		$aimeos = $container->get( 'aimeos' );
		$type = ( isset( $args['type'] ) ? $args['type'] : 'js' );

		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 ) {
				$contents .= $content;
			}
		}

		$response->getBody()->write( $contents );

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

		return $response;
	}


	/**
	 * Returns the HTML code for a copy of a 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 Modified response object with generated output
	 */
	public static function copyAction( ContainerInterface $container, ServerRequestInterface $request,
		ResponseInterface $response, array $args ) : ResponseInterface
	{
		$cntl = self::createAdmin( $container, $request, $response, $args );

		if( ( $html = $cntl->copy() ) == '' ) {
			return $cntl->getView()->response();
		}

		return self::getHtml( $container, $response, $html );

It seems like $html can also be of type null; however, parameter $content of Aimeos\Slim\Controller\Jqadm::getHtml() does only seem to accept string, maybe add an additional type check?

	}


	/**
	 * Returns the HTML code for a new 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 Modified response object with generated output
	 */
	public static function createAction( ContainerInterface $container, ServerRequestInterface $request,
		ResponseInterface $response, array $args ) : ResponseInterface
	{
		$cntl = self::createAdmin( $container, $request, $response, $args );

		if( ( $html = $cntl->create() ) == '' ) {
			return $cntl->getView()->response();
		}

		return self::getHtml( $container, $response, $html );

It seems like $html can also be of type null; however, parameter $content of Aimeos\Slim\Controller\Jqadm::getHtml() does only seem to accept string, maybe add an additional type check?

	}


	/**
	 * 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 Modified response object with generated output
	 */
	public static function deleteAction( ContainerInterface $container, ServerRequestInterface $request,
		ResponseInterface $response, array $args ) : ResponseInterface
	{
		$cntl = self::createAdmin( $container, $request, $response, $args );

		if( ( $html = $cntl->delete() ) == '' ) {
			return $cntl->getView()->response();
		}

		return self::getHtml( $container, $response, $html );

It seems like $html can also be of type null; however, parameter $content of Aimeos\Slim\Controller\Jqadm::getHtml() does only seem to accept string, maybe add an additional type check?

	}


	/**
	 * Exports the requested 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 Modified response object with generated output
	 */
	public static function exportAction( ContainerInterface $container, ServerRequestInterface $request,
		ResponseInterface $response, array $args ) : ResponseInterface
	{
		$cntl = self::createAdmin( $container, $request, $response, $args );

		if( ( $html = $cntl->export() ) == '' ) {
			return $cntl->getView()->response();
		}

		return self::getHtml( $container, $response, $html );

It seems like $html can also be of type null; however, parameter $content of Aimeos\Slim\Controller\Jqadm::getHtml() does only seem to accept string, maybe add an additional type check?

	}


	/**
	 * Returns the HTML code for the requested 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 Modified response object with generated output
	 */
	public static function getAction( ContainerInterface $container, ServerRequestInterface $request,
		ResponseInterface $response, array $args ) : ResponseInterface
	{
		$cntl = self::createAdmin( $container, $request, $response, $args );

		if( ( $html = $cntl->get() ) == '' ) {
			return $cntl->getView()->response();
		}

		return self::getHtml( $container, $response, $html );

It seems like $html can also be of type null; however, parameter $content of Aimeos\Slim\Controller\Jqadm::getHtml() does only seem to accept string, maybe add an additional type check?

	}


	/**
	 * Saves a new 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 Modified response object with generated output
	 */
	public static function saveAction( ContainerInterface $container, ServerRequestInterface $request,
		ResponseInterface $response, array $args ) : ResponseInterface
	{
		$cntl = self::createAdmin( $container, $request, $response, $args );

		if( ( $html = $cntl->save() ) == '' ) {
			return $cntl->getView()->response();
		}

		return self::getHtml( $container, $response, $html );

It seems like $html can also be of type null; however, parameter $content of Aimeos\Slim\Controller\Jqadm::getHtml() does only seem to accept string, maybe add an additional type check?

	}


	/**
	 * Returns the HTML code for 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 Modified response object with generated output
	 */
	public static function searchAction( ContainerInterface $container, ServerRequestInterface $request,
		ResponseInterface $response, array $args ) : ResponseInterface
	{
		$cntl = self::createAdmin( $container, $request, $response, $args );

		if( ( $html = $cntl->search() ) == '' ) {
			return $cntl->getView()->response();
		}

		return self::getHtml( $container, $response, $html );

It seems like $html can also be of type null; however, parameter $content of Aimeos\Slim\Controller\Jqadm::getHtml() does only seem to accept string, maybe add an additional type check?

	}


	/**
	 * 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\Admin\JQAdm\Iface JQAdm client
	 */
	protected static function createAdmin( ContainerInterface $container, ServerRequestInterface $request,
		ResponseInterface $response, array $args ) : \Aimeos\Admin\JQAdm\Iface
	{
		$aimeos = $container->get( 'aimeos' );
		$templatePaths = $aimeos->getCustomPaths( 'admin/jqadm/templates' );
		$params = $args + (array) $request->getParsedBody() + (array) $request->getQueryParams();

		$resource = ( isset( $params['resource'] ) ? $params['resource'] : null );
		$site = ( isset( $params['site'] ) ? $params['site'] : 'default' );
		$lang = ( isset( $params['lang'] ) ? $params['lang'] : 'en' );

		$context = $container->get( 'aimeos.context' )->get( false, $args, 'backend' );
		$context->setI18n( $container->get( 'aimeos.i18n' )->get( array( $lang, 'en' ) ) );
		$context->setLocale( $container->get( 'aimeos.locale' )->getBackend( $context, $site ) );

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

		$view->aimeosType = 'Slim';
		$view->aimeosVersion = \Aimeos\Slim\Bootstrap::getVersion();
		$view->aimeosExtensions = implode( ',', $aimeos->getExtensions() );

		$context->setView( $view );

		return \Aimeos\Admin\JQAdm::create( $context, $aimeos, $resource );
	}


	/**
	 * Returns the generated HTML code
	 *
	 * @param ContainerInterface $container Dependency injection container
	 * @param ResponseInterface $response Response object
	 * @param string $content Content from admin client
	 * @return ResponseInterface Modified response object with generated output
	 */
	protected static function getHtml( ContainerInterface $container, ResponseInterface $response,
		string $content ) : ResponseInterface
	{
		return $container->get( 'view' )->render( $response, 'Jqadm/index.html.twig', array( 'content' => $content ) );
	}
}