Aimeos\Client\Html\Checkout\Standard\Payment\Standard

Complexity

Total Complexity

28

Size/Duplication

Total Lines	335
Duplicated Lines	0 %

Importance

Changes	2
Bugs	0	Features	0

7 Methods

Rating	Name	Duplication	Size	Complexity
A	getSubClient()	0	77	1
A	header()	0	11	4
A	body()	0	40	5
B	init()	0	43	7
A	getSubClientNames()	0	3	1
A	isAvailable()	0	3	1
B	data()	0	54	9

<?php

/**
 * @license LGPLv3, http://opensource.org/licenses/LGPL-3.0
 * @copyright Metaways Infosystems GmbH, 2013
 * @copyright Aimeos (aimeos.org), 2015-2021
 * @package Client
 * @subpackage Html
 */


namespace Aimeos\Client\Html\Checkout\Standard\Payment;


// Strings for translation
sprintf( 'payment' );


/**
 * Default implementation of checkout payment HTML client.
 *
 * @package Client
 * @subpackage Html
 */
class Standard
	extends \Aimeos\Client\Html\Common\Client\Factory\Base
	implements \Aimeos\Client\Html\Common\Client\Factory\Iface
{
	/** client/html/checkout/standard/payment/subparts
	 * List of HTML sub-clients rendered within the checkout standard payment section
	 *
	 * The output of the frontend is composed of the code generated by the HTML
	 * clients. Each HTML client can consist of serveral (or none) sub-clients
	 * that are responsible for rendering certain sub-parts of the output. The
	 * sub-clients can contain HTML clients themselves and therefore a
	 * hierarchical tree of HTML clients is composed. Each HTML client creates
	 * the output that is placed inside the container of its parent.
	 *
	 * At first, always the HTML code generated by the parent is printed, then
	 * the HTML code of its sub-clients. The order of the HTML sub-clients
	 * determines the order of the output of these sub-clients inside the parent
	 * container. If the configured list of clients is
	 *
	 *  array( "subclient1", "subclient2" )
	 *
	 * you can easily change the order of the output by reordering the subparts:
	 *
	 *  client/html/<clients>/subparts = array( "subclient1", "subclient2" )
	 *
	 * You can also remove one or more parts if they shouldn't be rendered:
	 *
	 *  client/html/<clients>/subparts = array( "subclient1" )
	 *
	 * As the clients only generates structural HTML, the layout defined via CSS
	 * should support adding, removing or reordering content by a fluid like
	 * design.
	 *
	 * @param array List of sub-client names
	 * @since 2014.03
	 * @category Developer
	 */
	private $subPartPath = 'client/html/checkout/standard/payment/subparts';
	private $subPartNames = [];


	/**
	 * Returns the HTML code for insertion into the body.
	 *
	 * @param string $uid Unique identifier for the output if the content is placed more than once on the same page
	 * @return string HTML code
	 */
	public function body( string $uid = '' ) : string
	{
		$view = $this->view();
		$step = $view->get( 'standardStepActive' );
		$onepage = $view->config( 'client/html/checkout/standard/onepage', [] );

		if( $step != 'payment' && !( in_array( 'payment', $onepage ) && in_array( $step, $onepage ) ) ) {
			return '';
		}

		$html = '';
		foreach( $this->getSubClients() as $subclient ) {
			$html .= $subclient->setView( $view )->body( $uid );
		}
		$view->paymentBody = $html;

		/** client/html/checkout/standard/payment/template-body
		 * Relative path to the HTML body template of the checkout standard payment client.
		 *
		 * The template file contains the HTML code and processing instructions
		 * to generate the result shown in the body of the frontend. The
		 * configuration string is the path to the template file relative
		 * to the templates directory (usually in client/html/templates).
		 *
		 * 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 code for the HTML page body
		 * @since 2014.03
		 * @category Developer
		 * @see client/html/checkout/standard/payment/template-header
		 */
		$tplconf = 'client/html/checkout/standard/payment/template-body';
		$default = 'checkout/standard/payment-body-standard';

		return $view->render( $view->config( $tplconf, $default ) );
	}


	/**
	 * Returns the HTML string for insertion into the header.
	 *
	 * @param string $uid Unique identifier for the output if the content is placed more than once on the same page
	 * @return string|null String including HTML tags for the header on error
	 */
	public function header( string $uid = '' ) : ?string
	{
		$view = $this->view();
		$step = $view->get( 'standardStepActive' );
		$onepage = $view->config( 'client/html/checkout/standard/onepage', [] );

		if( $step != 'payment' && !( in_array( 'payment', $onepage ) && in_array( $step, $onepage ) ) ) {
			return '';
		}

		return parent::header( $uid );
	}


	/**
	 * Returns the sub-client given by its name.
	 *
	 * @param string $type Name of the client type
	 * @param string|null $name Name of the sub-client (Default if null)
	 * @return \Aimeos\Client\Html\Iface Sub-client object
	 */
	public function getSubClient( string $type, string $name = null ) : \Aimeos\Client\Html\Iface
	{
		/** client/html/checkout/standard/payment/decorators/excludes
		 * Excludes decorators added by the "common" option from the checkout standard payment html client
		 *
		 * Decorators extend the functionality of a class by adding new aspects
		 * (e.g. log what is currently done), executing the methods of the underlying
		 * class only in certain conditions (e.g. only for logged in users) or
		 * modify what is returned to the caller.
		 *
		 * This option allows you to remove a decorator added via
		 * "client/html/common/decorators/default" before they are wrapped
		 * around the html client.
		 *
		 *  client/html/checkout/standard/payment/decorators/excludes = array( 'decorator1' )
		 *
		 * This would remove the decorator named "decorator1" from the list of
		 * common decorators ("\Aimeos\Client\Html\Common\Decorator\*") added via
		 * "client/html/common/decorators/default" to the html client.
		 *
		 * @param array List of decorator names
		 * @since 2015.08
		 * @category Developer
		 * @see client/html/common/decorators/default
		 * @see client/html/checkout/standard/payment/decorators/global
		 * @see client/html/checkout/standard/payment/decorators/local
		 */

		/** client/html/checkout/standard/payment/decorators/global
		 * Adds a list of globally available decorators only to the checkout standard payment html client
		 *
		 * Decorators extend the functionality of a class by adding new aspects
		 * (e.g. log what is currently done), executing the methods of the underlying
		 * class only in certain conditions (e.g. only for logged in users) or
		 * modify what is returned to the caller.
		 *
		 * This option allows you to wrap global decorators
		 * ("\Aimeos\Client\Html\Common\Decorator\*") around the html client.
		 *
		 *  client/html/checkout/standard/payment/decorators/global = array( 'decorator1' )
		 *
		 * This would add the decorator named "decorator1" defined by
		 * "\Aimeos\Client\Html\Common\Decorator\Decorator1" only to the html client.
		 *
		 * @param array List of decorator names
		 * @since 2015.08
		 * @category Developer
		 * @see client/html/common/decorators/default
		 * @see client/html/checkout/standard/payment/decorators/excludes
		 * @see client/html/checkout/standard/payment/decorators/local
		 */

		/** client/html/checkout/standard/payment/decorators/local
		 * Adds a list of local decorators only to the checkout standard payment html client
		 *
		 * Decorators extend the functionality of a class by adding new aspects
		 * (e.g. log what is currently done), executing the methods of the underlying
		 * class only in certain conditions (e.g. only for logged in users) or
		 * modify what is returned to the caller.
		 *
		 * This option allows you to wrap local decorators
		 * ("\Aimeos\Client\Html\Checkout\Decorator\*") around the html client.
		 *
		 *  client/html/checkout/standard/payment/decorators/local = array( 'decorator2' )
		 *
		 * This would add the decorator named "decorator2" defined by
		 * "\Aimeos\Client\Html\Checkout\Decorator\Decorator2" only to the html client.
		 *
		 * @param array List of decorator names
		 * @since 2015.08
		 * @category Developer
		 * @see client/html/common/decorators/default
		 * @see client/html/checkout/standard/payment/decorators/excludes
		 * @see client/html/checkout/standard/payment/decorators/global
		 */

		return $this->createSubClient( 'checkout/standard/payment/' . $type, $name );
	}


	/**
	 * Processes the input, e.g. store given values.
	 *
	 * A view must be available and this method doesn't generate any output
	 * besides setting view variables.
	 */
	public function init()
	{
		$view = $this->view();
		$context = $this->context();

		try
		{
			$basketCtrl = \Aimeos\Controller\Frontend::create( $context, 'basket' );
			$servCtrl = \Aimeos\Controller\Frontend::create( $context, 'service' )->uses( ['media', 'price', 'text'] );

			// only start if there's something to do
			if( ( $serviceIds = $view->param( 'c_paymentoption', null ) ) !== null )
			{
				$basketCtrl->deleteService( 'payment' );

				foreach( (array) $serviceIds as $idx => $id )
				{
					try
					{
						$basketCtrl->addService( $servCtrl->get( $id ), $view->param( 'c_payment/' . $id, [] ), $idx );
					}
					catch( \Aimeos\Controller\Frontend\Basket\Exception $e )
					{
						$view->deliveryError = $e->getErrors();
						$view->standardErrorList = array_merge( $view->get( 'standardErrorList', [] ), $e->getErrors() );

						throw $e;
					}
				}
			}


			parent::init();


			if( !isset( $view->standardStepActive ) && !$this->call( 'isAvailable', $basketCtrl->get() ) ) {
				$view->standardStepActive = 'payment';
			}
		}
		catch( \Exception $e )
		{
			$view->standardStepActive = 'payment';
			throw $e;
		}
	}


	/**
	 * Returns the list of sub-client names configured for the client.
	 *
	 * @return array List of HTML client names
	 */
	protected function getSubClientNames() : array
	{
		return $this->context()->config()->get( $this->subPartPath, $this->subPartNames );
	}


	/**
	 * Sets the necessary parameter values in the view.
	 *
	 * @param \Aimeos\MW\View\Iface $view The view object which generates the HTML output
	 * @param array &$tags Result array for the list of tags that are associated to the output
	 * @param string|null &$expire Result variable for the expiration date of the output (null for no expiry)
	 * @return \Aimeos\MW\View\Iface Modified view object
	 */
	public function data( \Aimeos\MW\View\Iface $view, array &$tags = [], string &$expire = null ) : \Aimeos\MW\View\Iface
	{
		$context = $this->context();
		$domains = ['media', 'price', 'text'];

		/** client/html/checkout/standard/payment/domains
		 * List of domain names whose items should be available in the checkout payment templates
		 *
		 * The templates rendering checkout payment related data usually add the
		 * images, prices and texts associated to each item. If you want to display
		 * additional content like the attributes, you can configure your own list
		 * of domains (attribute, media, price, text, etc. are domains) whose items
		 * are fetched from the storage.
		 *
		 * @param array List of domain names
		 * @since 2019.04
		 * @category Developer
		 * @see client/html/checkout/standard/delivery/domains
		 */
		$domains = $context->config()->get( 'client/html/checkout/standard/payment/domains', $domains );

		$basketCntl = \Aimeos\Controller\Frontend::create( $context, 'basket' );
		$serviceCntl = \Aimeos\Controller\Frontend::create( $context, 'service' );

		$services = [];
		$basket = $basketCntl->get();
		$providers = $serviceCntl->uses( $domains )->type( 'payment' )->getProviders();
		$orderServices = map( $basket->getService( 'payment' ) )->col( null, 'order.base.service.serviceid' );

		foreach( $providers as $id => $provider )
		{
			if( $provider->isAvailable( $basket ) === true )
			{
				$attr = $provider->getConfigFE( $basket );

				if( $oservice = $orderServices->get( $id ) )
				{
					foreach( $attr as $key => $item )
					{
						$value = is_array( $item->getDefault() ) ? key( $item->getDefault() ) : $item->getDefault();
						$value = $oservice->getAttribute( $key, 'payment' ) ?: $value;
						$item->value = $oservice->getAttribute( $key . '/hidden', 'payment' ) ?: $value;
					}
				}

				$services[$id] = $provider->getServiceItem()->set( 'attributes', $attr )
					->set( 'price', $provider->calcPrice( $basket ) );
			}
		}

		$view->paymentServices = $services;
		$view->paymentOption = $view->param( 'c_paymentoption', $orderServices->firstKey() ?: key( $services ) );

		return parent::data( $view, $tags, $expire );
	}


	/**
	 * Tests if an item is available and the step can be skipped
	 *
	 * @param \Aimeos\MShop\Order\Item\Base\Iface $basket Basket object
	 * @return bool TRUE if step can be skipped, FALSE if not
	 */
	protected function isAvailable( \Aimeos\MShop\Order\Item\Base\Iface $basket ) : bool
	{
		return !empty( $basket->getService( 'payment' ) );
	}
}