Aimeos\Controller\Common\Media\Factory::create()

Complexity

Conditions	4
Paths	6

Size

Total Lines	51
Code Lines	9

Duplication

Lines	0
Ratio	0 %

Importance

Changes

0

<?php
	public static function create( \Aimeos\MShop\ContextIface $context, string $name = null ) : Iface
	{
		/** controller/common/media/name
		 * Class name of the used media common controller implementation
		 *
		 * Each default common controller 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 controller factory knows which class it
		 * has to instantiate.
		 *
		 * For example, if the name of the default class is
		 *
		 *  \Aimeos\Controller\Common\Media\Standard
		 *
		 * and you want to replace it with your own version named
		 *
		 *  \Aimeos\Controller\Common\Media\Mymedia
		 *
		 * then you have to set the this configuration option:
		 *
		 *  controller/common/media/name = Mymedia
		 *
		 * 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 "MyMedia"!
		 *
		 * @param string Last part of the class name
		 * @since 2016.01
		 * @category Developer
		 */
		if( $name === null ) {
			$name = $context->config()->get( 'controller/common/media/name', 'Standard' );
		}

		if( ctype_alnum( $name ) === false ) {
			throw new \LogicException( sprintf( 'Invalid characters in class name "%1$s"', $name ), 400 );
		}

		$classname = 'Aimeos\Controller\Common\Media\\' . $name;
		$interface = \Aimeos\Controller\Common\Media\Iface::class;

		if( isset( self::$objects[$classname] ) ) {
			return self::$objects[$classname];
		}

		return \Aimeos\Utils::create( $classname, [$context], $interface );
	}