Subscription

decorators#

excludes#

Excludes decorators added by the "common" option from the JSON API clients

client/jsonapi/subscription/decorators/excludes =

Type: array - List of decorator names
Since: 2017.07

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/jsonapi/common/decorators/default" before they are wrapped around the JsonApi client.

 client/jsonapi/decorators/excludes = array( 'decorator1' )

This would remove the decorator named "decorator1" from the list of common decorators ("\Aimeos\Client\JsonApi\Common\Decorator*") added via "client/jsonapi/common/decorators/default" for the JSON API client.

global#

Adds a list of globally available decorators only to the JsonApi client

client/jsonapi/subscription/decorators/global =

Type: array - List of decorator names
Since: 2017.07

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\JsonApi\Common\Decorator*") around the JsonApi client.

 client/jsonapi/subscription/decorators/global = array( 'decorator1' )

This would add the decorator named "decorator1" defined by "\Aimeos\Client\JsonApi\Common\Decorator\Decorator1" only to the "subscription" JsonApi client.

local#

Adds a list of local decorators only to the JsonApi client

client/jsonapi/subscription/decorators/local =

Type: array - List of decorator names
Since: 2017.07

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\JsonApi\Subscription\Decorator*") around the JsonApi client.

 client/jsonapi/subscription/decorators/local = array( 'decorator2' )

This would add the decorator named "decorator2" defined by "\Aimeos\Client\JsonApi\Subscription\Decorator\Decorator2" only to the "subscription" JsonApi client.

name#

Class name of the used subscription client implementation

client/jsonapi/subscription/name =

Type: string - Last part of the class name
Since: 2017.03

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\Subscription\Standard

and you want to replace it with your own version named

 \Aimeos\Client\JsonApi\Subscription\Mysubscription

then you have to set the this configuration option:

 client/jsonapi/subscription/name = Mysubscription

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 "MySubscription"!

template#

Relative path to the subscription JSON API template

client/jsonapi/subscription/template = subscription/standard

Default: subscription/standard
Type: string - Relative path to the template creating the body of the JSON API
Since: 2017.03

The template file contains the code and processing instructions to generate the result shown in the JSON API body. The configuration string is the path to the template file relative to the templates directory (usually in templates/client/jsonapi).

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.

Subscription

decorators#

excludes#

global#

local#

name#

template#

Comments

Become an Aimeos Partner