Aimeos\Admin\JsonAdm\Factory::createClientNew()

Complexity

Conditions	8
Paths	10

Size

Total Lines	153
Code Lines	21

Duplication

Lines	0
Ratio	0 %

Importance

Changes

0

<?php
	protected static function createClientNew( \Aimeos\MShop\Context\Item\Iface $context,
		array $templatePaths, $path, $name )
	{
		if( !empty( $path ) )
		{
			$parts = explode( '/', $path );

			foreach( $parts as $key => $part )
			{
				if( ctype_alnum( $part ) === false )
				{
					$msg = sprintf( 'Invalid client "%1$s" in "%2$s"', $part, $path );
					throw new \Aimeos\Admin\JsonAdm\Exception( $msg, 400 );
				}

				$parts[$key] = ucwords( $part );
			}

			$name = ( $name ?: $context->getConfig()->get( 'admin/jsonadm/' . $path . '/name', 'Standard' ) );
			$classname = '\\Aimeos\\Admin\\JsonAdm\\' . join( '\\', $parts ) . '\\' . $name;
		}
		else
		{
			/** admin/jsonadm/name
			 * Class name of the used JSON API client implementation
			 *
			 * Each default JSON API client can be replace by an alternative imlementation.
			 * To use this implementation, you have to set the last part of the class
			 * name as configuration value so the client factory knows which class it
			 * has to instantiate.
			 *
			 * For example, if the name of the default class is
			 *
			 *  \Aimeos\Admin\JsonAdm\Standard
			 *
			 * and you want to replace it with your own version named
			 *
			 *  \Aimeos\Admin\JsonAdm\Mycntl
			 *
			 * then you have to set the this configuration option:
			 *
			 *  admin/jsonadm/name = Mycntl
			 *
			 * The value is the last part of your own class name and it's case sensitive,
			 * so take care that the configuration value is exactly named like the last
			 * part of the class name.
			 *
			 * The allowed characters of the class name are A-Z, a-z and 0-9. No other
			 * characters are possible! You should always start the last part of the class
			 * name with an upper case character and continue only with lower case characters
			 * or numbers. Avoid chamel case names like "MyCntl"!
			 *
			 * @param string Last part of the class name
			 * @since 2015.12
			 * @category Developer
			 */

			$name = ( $name ?: $context->getConfig()->get( 'admin/jsonadm/name', 'Standard' ) );
			$classname = '\\Aimeos\\Admin\\JsonAdm\\' . $name;
		}


		if( ctype_alnum( $name ) === false )
		{
			$classname = is_string( $name ) ? $classname : '<not a string>';
			throw new \Aimeos\Admin\JsonAdm\Exception( sprintf( 'Invalid class name "%1$s"', $classname ) );
		}

		$view = $context->getView();
		$iface = '\\Aimeos\\Admin\\JsonAdm\\Iface';

		$client = self::createClientBase( $classname, $iface, $context, $view, $templatePaths, $path );

		/** admin/jsonadm/decorators/excludes
		 * Excludes decorators added by the "common" option from the JSON API clients
		 *
		 * 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
		 * "admin/jsonadm/common/decorators/default" before they are wrapped
		 * around the Jsonadm client.
		 *
		 *  admin/jsonadm/decorators/excludes = array( 'decorator1' )
		 *
		 * This would remove the decorator named "decorator1" from the list of
		 * common decorators ("\Aimeos\Admin\JsonAdm\Common\Decorator\*") added via
		 * "admin/jsonadm/common/decorators/default" for the JSON API client.
		 *
		 * @param array List of decorator names
		 * @since 2016.01
		 * @category Developer
		 * @see admin/jsonadm/common/decorators/default
		 * @see admin/jsonadm/decorators/global
		 * @see admin/jsonadm/decorators/local
		 */

		/** admin/jsonadm/decorators/global
		 * Adds a list of globally available decorators only to the Jsonadm 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\Admin\Jsonadm\Common\Decorator\*") around the Jsonadm
		 * client.
		 *
		 *  admin/jsonadm/product/decorators/global = array( 'decorator1' )
		 *
		 * This would add the decorator named "decorator1" defined by
		 * "\Aimeos\Admin\Jsonadm\Common\Decorator\Decorator1" only to the
		 * "product" Jsonadm client.
		 *
		 * @param array List of decorator names
		 * @since 2016.01
		 * @category Developer
		 * @see admin/jsonadm/common/decorators/default
		 * @see admin/jsonadm/decorators/excludes
		 * @see admin/jsonadm/decorators/local
		 */

		/** admin/jsonadm/decorators/local
		 * Adds a list of local decorators only to the Jsonadm 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\Admin\Jsonadm\Product\Decorator\*") around the Jsonadm
		 * client.
		 *
		 *  admin/jsonadm/product/decorators/local = array( 'decorator2' )
		 *
		 * This would add the decorator named "decorator2" defined by
		 * "\Aimeos\Admin\Jsonadm\Product\Decorator\Decorator2" only to the
		 * "product" Jsonadm client.
		 *
		 * @param array List of decorator names
		 * @since 2016.01
		 * @category Developer
		 * @see admin/jsonadm/common/decorators/default
		 * @see admin/jsonadm/decorators/excludes
		 * @see admin/jsonadm/decorators/global
		 */

		return self::addClientDecorators( $client, $context, $view, $templatePaths, $path );
	}
}