Catalog stock
level#
low#
The number of products in stock below it's considered a low stock level
client/html/catalog/stock/level/low = 5
- Default: 5
- Type: integer - Number of products in stock
- Since: 2014.03
There are four stock levels available:
- unlimited
- high
- low
- out
If no stock information is available, the number of products is considered unlimited, which is useful for digital products. Zero or less products in stock means out of stock while a quantity of products above the option value represents a high stock value.
There can be the case that a stock level is sometimes negative even if only products that are in stock can be bought. This is due to the time difference the product is actually ordered and the stock level is decreased. If you've configured the stock level update every minute, within this minute another customer can buy the same product that is considered to be still in stock at this time.
See also:
- client/html/catalog/stock/sort
name#
Class name of the used catalog stock client implementation
client/html/catalog/stock/name =
- Default:
- Type: string - Last part of the class name
- Since: 2014.03
Each default HTML 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\Html\Catalog\Stock\Standard
and you want to replace it with your own version named
\Aimeos\Client\Html\Catalog\Stock\Mystock
then you have to set the this configuration option:
client/html/catalog/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"!
sort#
Sortation key if stock levels for different types exist
client/html/catalog/stock/sort = stock.type
- Default: stock.type
- Type: array - List of key/value pairs for sorting
- Since: 2017.01
Products can be shipped from several warehouses with a different stock level for each one. The stock levels for each warehouse will be shown in the product detail page. To get a consistent sortation of this list, the configured key will be used by the stock manager.
Possible keys for sorting are ("-stock.type" for descending order):
- stock.productid
- stock.stocklevel
- stock.type
- stock.dateback
See also:
- client/html/catalog/stock/level/low
template-body#
Relative path to the HTML body template of the catalog stock client.
client/html/catalog/stock/template-body =
- Default:
- Type: string - Relative path to the template creating code for the HTML page body
- Since: 2014.03
The template file contains the HTML code and processing instructions to generate the result shown in the body of the frontend. The configuration string is the path to the template file relative to the templates directory (usually in templates/client/html).
You can overwrite the template file configuration in extensions and provide alternative templates. These alternative templates should be named like the default one but suffixed by an unique name. You may use the name of your project for this. If you've implemented an alternative client class as well, it should be suffixed by the name of the new class.
See also:
- client/html/catalog/stock/template-header
template-header#
Relative path to the HTML header template of the catalog stock client.
client/html/catalog/stock/template-header =
- Default:
- Type: string - Relative path to the template creating code for the HTML page head
- Since: 2014.03
The template file contains the HTML code and processing instructions to generate the HTML code that is inserted into the HTML page header of the rendered page in the frontend. The configuration string is the path to the template file relative to the templates directory (usually in templates/client/html).
You can overwrite the template file configuration in extensions and provide alternative templates. These alternative templates should be named like the default one but suffixed by an unique name. You may use the name of your project for this. If you've implemented an alternative client class as well, it should be suffixed by the name of the new class.
See also:
- client/html/catalog/stock/template-body
url#
action#
Name of the action that should create the output
client/html/catalog/stock/url/action = stock
- Default: stock
- Type: string - Name of the action
- Since: 2014.03
In Model-View-Controller (MVC) applications, actions are the methods of a controller that create parts of the output displayed in the generated HTML page. Action names are usually alpha-numeric.
See also:
- client/html/catalog/stock/url/target
- client/html/catalog/stock/url/controller
- client/html/catalog/stock/url/config
- client/html/catalog/stock/url/max-items
config#
Associative list of configuration options used for generating the URL
client/html/catalog/stock/url/config = Array
(
)
-
Default: Array ( )
-
Type: string - Associative list of configuration options
- Since: 2014.03
You can specify additional options as key/value pairs used when generating the URLs, like
client/html/<clientname>/url/config = array( 'absoluteUri' => true )
The available key/value pairs depend on the application that embeds the e-commerce framework. This is because the infrastructure of the application is used for generating the URLs. The full list of available config options is referenced in the "see also" section of this page.
See also:
- client/html/catalog/stock/url/target
- client/html/catalog/stock/url/controller
- client/html/catalog/stock/url/action
- client/html/catalog/stock/url/max-items
controller#
Name of the controller whose action should be called
client/html/catalog/stock/url/controller = Catalog
- Default: Catalog
- Type: string - Name of the controller
- Since: 2014.03
In Model-View-Controller (MVC) applications, the controller contains the methods that create parts of the output displayed in the generated HTML page. Controller names are usually alpha-numeric.
See also:
- client/html/catalog/stock/url/target
- client/html/catalog/stock/url/action
- client/html/catalog/stock/url/config
- client/html/catalog/stock/url/max-items
filter#
client/html/catalog/stock/url/filter = Array
(
)
- Default: Array ( )
max-items#
Maximum number of product stock levels per request
client/html/catalog/stock/url/max-items = 100
- Default: 100
- Type: integer - Maximum number of product codes per request
- Since: 2018.10
To avoid URLs that exceed the maximum amount of characters (usually 8190), each request contains only up to the configured amount of product codes. If more product codes are available, several requests will be sent to the server.
See also:
- client/html/catalog/stock/url/target
- client/html/catalog/stock/url/controller
- client/html/catalog/stock/url/action
- client/html/catalog/stock/url/config
target#
Destination of the URL where the controller specified in the URL is known
client/html/catalog/stock/url/target =
- Default:
- Type: string - Destination of the URL
- Since: 2014.03
The destination can be a page ID like in a content management system or the module of a software development framework. This "target" must contain or know the controller that should be called by the generated URL.
See also:
- client/html/catalog/stock/url/controller
- client/html/catalog/stock/url/action
- client/html/catalog/stock/url/config
- client/html/catalog/stock/url/max-items