description
Returns the description of a product, identified by code,
as found in one of the products tables.
Summary
| Parameter
|
Description
|
Default
|
| code |
The key value to look up in the table(s). |
None |
| base |
The database table to which the search should be constrained. |
None |
| hide |
Suppress any output text that would ordinarily be returned from this tag.
(This universal parameter was introduced with Interchange version 5.5.2.) |
No
|
| interpolate |
Process any Interchange tags found in the text output from this tag. |
Yes
|
Examples
Perl example
$Tag->default({
code => $key,
base => $table,
});
|
or similarly with positional parameters:
|
$Tag->description($key, $table);
|
Description
This tag returns the description of a product, identified by code,
as found in one of the products tables.
This is the value of the database column that corresponds to the
DescriptionField directive in the catalog.cfg file.
If there is more than one products file/table defined in the
DefaultTables directive,
they will be searched in the specified order unless constrained by
the optional base parameter.
This tag is especially useful for multi-language websites
The DescriptionField directive can be set for each locale
and point to a different table column.
For example desc_en
for English, desc_fr for French, etc.
Parameters
code
The key value to look up in the table(s).
base
The database table to which the search should be constrained.
