Skip to content
  • Documentation >
  • Guide >
  • Shop elements >
  • Catalog >
  • Catalog element

Catalog element

The CatalogElement class defines the generic product and category model.

All parts of the catalog, such as products, product categories or product types inherit from CatalogElement.

Properties

Each CatalogElement has predefined properties. These properties are validated automatically by the validateProperties() method.

Identifier Type Description
name string A name of the element
text string A short introduction text for the element
image ImageField (FieldInterface) An image for the element
path array A path to the element (array of identifiers)
url string An internal URL of the element. Do not use this URL for generating links. Use seoUrl instead
seoUrl string A human-readable URL of the element
permanentUrl string An internal permanent URL
parentElementIdentifier string A unique identifier of the parent element
identifier string A unique identifier
dataMap FieldInterface[] A list of Fields
cacheIdentifier int|string A cache identifier of the element. Used as key in cache storage

There are four public methods that you can use to set the properties:

  • setImage()
  • setName()
  • setText()
  • setCacheIdentifier()

Validators

The following validators can be used when attributes are set in CatalogElement:

Name Parameters Description
validateStringAttribute $value,
$attribute		 Checks whether the value is a valid string
validateBooleanAttribute $value,
$attribute		 Checks if the value is a valid boolean
validateFloatAttribute $value,
$attribute		 Checks if the value is a valid float
validateIntegerAttribute $value,
$attribute		 Checks if the value is a valid integer
validateFieldAttribute $value,
$attribute,
$fieldType		 Checks if the value is of given Field Type
validateArrayAttribute $value,
$attribute		 Checks if the value is an array
validateArrayOfAttribute $value,
$attribute,
$class		 Checks if the value is an array of specified class (interface)

Concrete implementations of the CatalogElement class require you to extend validateProperties().

Fetching a catalog element

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
/** @var $catalogService \Silversolutions\Bundle\EshopBundle\Services\Catalog\CatalogDataProviderService */
$catalogService = $this->get('silver_catalog.data_provider_service');
try {
    /** @var EzHelperService $ezHelper */
    $ezHelper = $this->get('silver_tools.ez_helper');
    /** @var $catalogElement \Silversolutions\Bundle\EshopBundle\Catalog\CatalogElement */
    $catalogElement = $catalogService->getDataProvider()->fetchElementByIdentifier(
        200,
        $ezHelper->getCurrentLanguageCode()
    );
 } catch (\Exception $e) {
    return $this->render(
        'SilversolutionsEshopBundle:Catalog:exception.html.twig',
        array(
            'exception' => $e
        ),
        $response
    );
}

Fetching a list of catalog elements

The fetchChildrenList() method enables listing CatalogElement or ProductNode objects for a given Location ID.

The following example fetches products directly assigned to a CatalogElement starting from the first element (offset=0, limit=100). The shop uses the language of the current SiteAccess.

1
2
$catalogList = $catalogService->getDataProvider()
        ->fetchChildrenList($locationId, 1, array(), null, 0, 100);

The following example fetches a list of products using a productList filter.

1
2
$catalogList = $catalogService->getDataProvider()
            ->fetchChildrenList($locationId, 1, array('filterType' => 'productList'), null, 0, 100);