aimeos / ai-client-jsonapi

 * @package Client

 * @subpackage JsonApi

 */

class Factory

	extends \Aimeos\Client\JsonApi\Common\Factory\Base

	implements \Aimeos\Client\JsonApi\Common\Factory\Iface

{

	/**

	 * Creates a attribute client object.

	 *

	 * @param \Aimeos\MShop\Context\Item\Iface $context Shop context instance with necessary objects

	 * @param array $templatePaths List of file system paths where the templates are stored

	 * @param string $path Name of the client separated by slashes, e.g "product"

	 * @param string|null $name Client name (default: "Standard")

	 * @return \Aimeos\Client\JsonApi\Iface JSON API client

	 * @throws \Aimeos\Client\JsonApi\Exception If requested client implementation couldn't be found or initialisation fails

	 */

	public static function createClient( \Aimeos\MShop\Context\Item\Iface $context, array $templatePaths, $path, $name = null )

	{

		if( ctype_alnum( $path ) === false )

		{

			$path = ( is_string( $path ) ? $path : '<not a string>' );

			throw new \Aimeos\Client\JsonApi\Exception( sprintf( 'Invalid client "%1$s"', $path ), 400 );

		}

		/** client/jsonapi/attribute/name

		 * Class name of the used attribute 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\Client\JsonApi\Attribute\Standard

		 *

		 * and you want to replace it with your own version named

		 *

		 *  \Aimeos\Client\JsonApi\Attribute\Myattribute

		 *

		 * then you have to set the this configuration option:

		 *

		 *  client/jsonapi/attribute/name = Myattribute

		 *

		 * 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 "MyAttribute"!

		 *

		 * @param string Last part of the class name

		 * @since 2017.03

		 * @category Developer

		 */

		if( $name === null ) {

			$name = $context->getConfig()->get( 'client/jsonapi/attribute/name', 'Standard' );

		}

		if( ctype_alnum( $name ) === false )

		{

			$classname = is_string( $name ) ? '\\Aimeos\\Client\\JsonApi\\Attribute\\' . $name : '<not a string>';

			throw new \Aimeos\Client\JsonApi\Exception( sprintf( 'Invalid characters in class name "%1$s"', $classname ) );

		}

		$view = $context->getView();

		$iface = '\\Aimeos\\Client\\JsonApi\\Iface';

		$classname = '\\Aimeos\\Client\\JsonApi\\Attribute\\' . $name;

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

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

	}

}

 * @package Client

 * @subpackage JsonApi

 */

class Factory

	extends \Aimeos\Client\JsonApi\Common\Factory\Base

	implements \Aimeos\Client\JsonApi\Common\Factory\Iface

{

	/**

	 * Creates a catalog client object.

	 *

	 * @param \Aimeos\MShop\Context\Item\Iface $context Shop context instance with necessary objects

	 * @param array $templatePaths List of file system paths where the templates are stored

	 * @param string $path Name of the client separated by slashes, e.g "product"

	 * @param string|null $name Client name (default: "Standard")

	 * @return \Aimeos\Client\JsonApi\Iface JSON API client

	 * @throws \Aimeos\Client\JsonApi\Exception If requested client implementation couldn't be found or initialisation fails

	 */

	public static function createClient( \Aimeos\MShop\Context\Item\Iface $context, array $templatePaths, $path, $name = null )

	{

		if( ctype_alnum( $path ) === false )

		{

			$path = ( is_string( $path ) ? $path : '<not a string>' );

			throw new \Aimeos\Client\JsonApi\Exception( sprintf( 'Invalid client "%1$s"', $path ), 400 );

		}

		/** client/jsonapi/catalog/name

		 * Class name of the used catalog 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\Client\JsonApi\Catalog\Standard

		 *

		 * and you want to replace it with your own version named

		 *

		 *  \Aimeos\Client\JsonApi\Catalog\Mycatalog

		 *

		 * then you have to set the this configuration option:

		 *

		 *  client/jsonapi/catalog/name = Mycatalog

		 *

		 * 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 "MyCatalog"!

		 *

		 * @param string Last part of the class name

		 * @since 2017.03

		 * @category Developer

		 */

		if( $name === null ) {

			$name = $context->getConfig()->get( 'client/jsonapi/catalog/name', 'Standard' );

		}

		if( ctype_alnum( $name ) === false )

		{

			$classname = is_string( $name ) ? '\\Aimeos\\Client\\JsonApi\\Catalog\\' . $name : '<not a string>';

			throw new \Aimeos\Client\JsonApi\Exception( sprintf( 'Invalid characters in class name "%1$s"', $classname ) );

		}

		$view = $context->getView();

		$iface = '\\Aimeos\\Client\\JsonApi\\Iface';

		$classname = '\\Aimeos\\Client\\JsonApi\\Catalog\\' . $name;

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

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

	}

}

 * @package Client

 * @subpackage JsonApi

 */

class Factory

	extends \Aimeos\Client\JsonApi\Common\Factory\Base

	implements \Aimeos\Client\JsonApi\Common\Factory\Iface

{

	/**

	 * Creates a product client object.

	 *

	 * @param \Aimeos\MShop\Context\Item\Iface $context Shop context instance with necessary objects

	 * @param array $templatePaths List of file system paths where the templates are stored

	 * @param string $path Name of the client separated by slashes, e.g "product"

	 * @param string|null $name Client name (default: "Standard")

	 * @return \Aimeos\Client\JsonApi\Iface JSON API client

	 * @throws \Aimeos\Client\JsonApi\Exception If requested client implementation couldn't be found or initialisation fails

	 */

	public static function createClient( \Aimeos\MShop\Context\Item\Iface $context, array $templatePaths, $path, $name = null )

	{

		if( ctype_alnum( $path ) === false )

		{

			$path = ( is_string( $path ) ? $path : '<not a string>' );

			throw new \Aimeos\Client\JsonApi\Exception( sprintf( 'Invalid client "%1$s"', $path ), 400 );

		}

		/** client/jsonapi/product/name

		 * Class name of the used product 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\Client\JsonApi\Product\Standard

		 *

		 * and you want to replace it with your own version named

		 *

		 *  \Aimeos\Client\JsonApi\Product\Myproduct

		 *

		 * then you have to set the this configuration option:

		 *

		 *  client/jsonapi/product/name = Myproduct

		 *

		 * 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 "MyProduct"!

		 *

		 * @param string Last part of the class name

		 * @since 2017.03

		 * @category Developer

		 */

		if( $name === null ) {

			$name = $context->getConfig()->get( 'client/jsonapi/product/name', 'Standard' );

		}

		if( ctype_alnum( $name ) === false )

		{

			$classname = is_string( $name ) ? '\\Aimeos\\Client\\JsonApi\\Product\\' . $name : '<not a string>';

			throw new \Aimeos\Client\JsonApi\Exception( sprintf( 'Invalid characters in class name "%1$s"', $classname ) );

		}

		$view = $context->getView();

		$iface = '\\Aimeos\\Client\\JsonApi\\Iface';

		$classname = '\\Aimeos\\Client\\JsonApi\\Product\\' . $name;

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

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

	}

}

 * @package Client

 * @subpackage JsonApi

 */

class Factory

	extends \Aimeos\Client\JsonApi\Common\Factory\Base

	implements \Aimeos\Client\JsonApi\Common\Factory\Iface

{

	/**

	 * Creates a stock client object.

	 *

	 * @param \Aimeos\MShop\Context\Item\Iface $context Shop context instance with necessary objects

	 * @param array $templatePaths List of file system paths where the templates are stored

	 * @param string $path Name of the client separated by slashes, e.g "product"

	 * @param string|null $name Client name (default: "Standard")

	 * @return \Aimeos\Client\JsonApi\Iface JSON API client

	 * @throws \Aimeos\Client\JsonApi\Exception If requested client implementation couldn't be found or initialisation fails

	 */

	public static function createClient( \Aimeos\MShop\Context\Item\Iface $context, array $templatePaths, $path, $name = null )

	{

		if( ctype_alnum( $path ) === false )

		{

			$path = ( is_string( $path ) ? $path : '<not a string>' );

			throw new \Aimeos\Client\JsonApi\Exception( sprintf( 'Invalid client "%1$s"', $path ), 400 );

		}

		/** client/jsonapi/stock/name

		 * Class name of the used stock 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\Client\JsonApi\Stock\Standard

		 *

		 * and you want to replace it with your own version named

		 *

		 *  \Aimeos\Client\JsonApi\Stock\Mystock

		 *

		 * then you have to set the this configuration option:

		 *

		 *  client/jsonapi/stock/name = Mystock

		 *

		 * 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 "MyStock"!

		 *

		 * @param string Last part of the class name

		 * @since 2017.03

		 * @category Developer

		 */

		if( $name === null ) {

			$name = $context->getConfig()->get( 'client/jsonapi/stock/name', 'Standard' );

		}

		if( ctype_alnum( $name ) === false )

		{

			$classname = is_string( $name ) ? '\\Aimeos\\Client\\JsonApi\\Stock\\' . $name : '<not a string>';

			throw new \Aimeos\Client\JsonApi\Exception( sprintf( 'Invalid characters in class name "%1$s"', $classname ) );

		}

		$view = $context->getView();

		$iface = '\\Aimeos\\Client\\JsonApi\\Iface';

		$classname = '\\Aimeos\\Client\\JsonApi\\Stock\\' . $name;

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

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

	}

}

 * @package Client

 * @subpackage JsonApi

 */

class Factory

	extends \Aimeos\Client\JsonApi\Common\Factory\Base

	implements \Aimeos\Client\JsonApi\Common\Factory\Iface

{

	/**

	 * Creates a locale client object.

	 *

	 * @param \Aimeos\MShop\Context\Item\Iface $context Shop context instance with necessary objects

	 * @param array $templatePaths List of file system paths where the templates are stored

	 * @param string $path Name of the client separated by slashes, e.g "product"

	 * @param string|null $name Client name (default: "Standard")

	 * @return \Aimeos\Client\JsonApi\Iface JSON API client

	 * @throws \Aimeos\Client\JsonApi\Exception If requested client implementation couldn't be found or initialisation fails

	 */

	public static function createClient( \Aimeos\MShop\Context\Item\Iface $context, array $templatePaths, $path, $name = null )

	{

		if( ctype_alnum( $path ) === false )

		{

			$path = ( is_string( $path ) ? $path : '<not a string>' );

			throw new \Aimeos\Client\JsonApi\Exception( sprintf( 'Invalid client "%1$s"', $path ), 400 );

		}

		/** client/jsonapi/locale/name

		 * Class name of the used locale 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\Client\JsonApi\Locale\Standard

		 *

		 * and you want to replace it with your own version named

		 *

		 *  \Aimeos\Client\JsonApi\Locale\Mylocale

		 *

		 * then you have to set the this configuration option:

		 *

		 *  client/jsonapi/locale/name = Mylocale

		 *

		 * 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 "MyLocale"!

		 *

		 * @param string Last part of the class name

		 * @since 2017.03

		 * @category Developer

		 */

		if( $name === null ) {

			$name = $context->getConfig()->get( 'client/jsonapi/locale/name', 'Standard' );

		}

		if( ctype_alnum( $name ) === false )

		{

			$classname = is_string( $name ) ? '\\Aimeos\\Client\\JsonApi\\Locale\\' . $name : '<not a string>';

			throw new \Aimeos\Client\JsonApi\Exception( sprintf( 'Invalid characters in class name "%1$s"', $classname ) );

		}

		$view = $context->getView();

		$iface = '\\Aimeos\\Client\\JsonApi\\Iface';

		$classname = '\\Aimeos\\Client\\JsonApi\\Locale\\' . $name;

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

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

	}

}