Skip to content

Latest commit

 

History

History
143 lines (100 loc) · 4.21 KB

supplier.md

File metadata and controls

143 lines (100 loc) · 4.21 KB
Raw

decorators

excludes

Excludes decorators added by the "common" option from the supplier frontend controllers

controller/frontend/supplier/decorators/excludes =
  • Type: array - List of decorator names
  • Since: 2018.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 "controller/frontend/common/decorators/default" before they are wrapped around the frontend controller.

 controller/frontend/supplier/decorators/excludes = array( 'decorator1' )

This would remove the decorator named "decorator1" from the list of common decorators ("\Aimeos\Controller\Frontend\Common\Decorator*") added via "controller/frontend/common/decorators/default" for the supplier frontend controller.

See also:

  • controller/frontend/common/decorators/default
  • controller/frontend/supplier/decorators/global
  • controller/frontend/supplier/decorators/local

global

Adds a list of globally available decorators only to the supplier frontend controllers

controller/frontend/supplier/decorators/global =
  • Type: array - List of decorator names
  • Since: 2018.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\Controller\Frontend\Common\Decorator*") around the frontend controller.

 controller/frontend/supplier/decorators/global = array( 'decorator1' )

This would add the decorator named "decorator1" defined by "\Aimeos\Controller\Frontend\Common\Decorator\Decorator1" only to the frontend controller.

See also:

  • controller/frontend/common/decorators/default
  • controller/frontend/supplier/decorators/excludes
  • controller/frontend/supplier/decorators/local

local

Adds a list of local decorators only to the supplier frontend controllers

controller/frontend/supplier/decorators/local =
  • Type: array - List of decorator names
  • Since: 2018.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\Controller\Frontend\Supplier\Decorator*") around the frontend controller.

 controller/frontend/supplier/decorators/local = array( 'decorator2' )

This would add the decorator named "decorator2" defined by "\Aimeos\Controller\Frontend\Supplier\Decorator\Decorator2" only to the frontend controller.

See also:

  • controller/frontend/common/decorators/default
  • controller/frontend/supplier/decorators/excludes
  • controller/frontend/supplier/decorators/global

name

Class name of the used supplier frontend controller implementation

controller/frontend/supplier/name =
  • Type: string - Last part of the class name
  • Since: 2018.07

Each default frontend 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\Frontend\Supplier\Standard

and you want to replace it with your own version named

 \Aimeos\Controller\Frontend\Supplier\Mysupplier

then you have to set the this configuration option:

 controller/jobs/frontend/supplier/name = Mysupplier

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