Is Indexable Determiner

3min
Determiners
If an entity is indexable is determined by Klevu\Indexing\Service\Determiner\IsIndexableDeterminer
This determiner loops through all injected Klevu\IndexingApi\Service\Determiner\IsIndexableDeterminerInterface classes.
If any of these return false; then the entity is set to not indexable and will not be indexed with Klevu. 
If they all return true; then the entity is indexable and can be indexed with Klevu.
All entity types module-ms-indexing-categories, module-ms-indexing-cms and module-m2-indexing-products create virtualTypes of this class and inject an array of determiners.
e.g. for products the virtualType in di.xml looks like this
module-m2-indexing-products/etc/di.xml
<virtualType name="Klevu\IndexingProducts\Service\Determiner\IsIndexableDeterminer"
             type="Klevu\Indexing\Service\Determiner\IsIndexableDeterminer">
    <arguments>
        <argument name="isIndexableDeterminers" xsi:type="array">
            <item name="disabledProductsIsIndexableDeterminer"
                  xsi:type="object">Klevu\IndexingProducts\Service\Determiner\DisabledProductsIsIndexableDeterminer</item>
            <item name="oosProductsIsIndexableDeterminer"
                  xsi:type="object">Klevu\IndexingProducts\Service\Determiner\OutOfStockProductsIsIndexableDeterminer</item>
        </argument>
    </arguments>
</virtualType>
<virtualType name="Klevu\IndexingProducts\Service\Determiner\IsIndexableDeterminer"
             type="Klevu\Indexing\Service\Determiner\IsIndexableDeterminer">
    <arguments>
        <argument name="isIndexableDeterminers" xsi:type="array">
            <item name="disabledProductsIsIndexableDeterminer"
                  xsi:type="object">Klevu\IndexingProducts\Service\Determiner\DisabledProductsIsIndexableDeterminer</item>
            <item name="oosProductsIsIndexableDeterminer"
                  xsi:type="object">Klevu\IndexingProducts\Service\Determiner\OutOfStockProductsIsIndexableDeterminer</item>
        </argument>
    </arguments>
</virtualType>
﻿
﻿
Custom Determiners
You can add determiners to amend the default behaviour.
Let's say you only wanted to index products when the attribute color was pink.
You’d inject your determiner in to the IsIndexableDeterminer via the isIndexableDeterminers array in your di.xml
Vendor/Module/etc/di.xml
<virtualType name="Klevu\IndexingProducts\Service\Determiner\IsIndexableDeterminer">
    <arguments>
        <argument name="isIndexableDeterminers" xsi:type="array">
            <item name="pinkProductIsIndexableDeterminer"
                  xsi:type="object">Vendor\Module\Service\Determiner\PinkProductIsIndexableDeterminer</item>
        </argument>
    </arguments>
</virtualType>
<virtualType name="Klevu\IndexingProducts\Service\Determiner\IsIndexableDeterminer">
    <arguments>
        <argument name="isIndexableDeterminers" xsi:type="array">
            <item name="pinkProductIsIndexableDeterminer"
                  xsi:type="object">Vendor\Module\Service\Determiner\PinkProductIsIndexableDeterminer</item>
        </argument>
    </arguments>
</virtualType>
﻿
Create that class, which must implement the IsIndexableDeterminerInterface 
Vendor/Module/Service/Determiner/PinkProductIsIndexableDeterminer.php
<?php

namespace Vendor\Module\Service\Determiner;

use Klevu\IndexingApi\Service\Determiner\IsIndexableDeterminerInterface;

class PinkProductIsIndexableDeterminer implements IsIndexableDeterminerInterface
{
    public function execute(
        ExtensibleDataInterface|PageInterface $entity,
        StoreInterface $store,
    ): bool {
        if (!($entity instanceof ProductInterface)) {
            throw new \InvalidArgumentException(
                sprintf(
                    'Invalid argument provided for "$entity". Expected %s, received %s.',
                    ProductInterface::class,
                    get_debug_type($entity),
                ),
            );
        }
        
        return $entity->getAttributeText('color') === 'pink';
    }
}

<?php

namespace Vendor\Module\Service\Determiner;

use Klevu\IndexingApi\Service\Determiner\IsIndexableDeterminerInterface;

class PinkProductIsIndexableDeterminer implements IsIndexableDeterminerInterface
{
    public function execute(
        ExtensibleDataInterface|PageInterface $entity,
        StoreInterface $store,
    ): bool {
        if (!($entity instanceof ProductInterface)) {
            throw new \InvalidArgumentException(
                sprintf(
                    'Invalid argument provided for "$entity". Expected %s, received %s.',
                    ProductInterface::class,
                    get_debug_type($entity),
                ),
            );
        }
        
        return $entity->getAttributeText('color') === 'pink';
    }
}
﻿
See Klevu\IndexingProducts\Service\Determiner\DisabledProductsIsIndexableDeterminer as an example of a determiner.
Updated 23 Sep 2024
Did this page help you?
Update
Sync