Skip to content

Latest commit

 

History

History
255 lines (194 loc) · 10.3 KB

previously-purchased-products.md

File metadata and controls

255 lines (194 loc) · 10.3 KB
Raw

Previously Purchased Products

Overview

Previously Purchased Products functionality adds the previously purchased products grid to the customer pages under Account > Previously Purchased on the frontend. By default, previously purchased products are disabled. To enable this fuctionality, go to System > Configuration > Orders > Purchase History > Enabled Purchase History in the admin panel.

Config

Here is an example of the system config section.

purchase_history:
    children:
         purchase_history:
             children:
                 - oro_order.enable_purchase_history
                 - oro_order.order_previously_purchased_period

The oro_order.enable_purchase_history option turns the feature on or off. The oro_order.order_previously_purchased_period option contains the number of days used to filter products by date in the previously purchased products grid

If you need more information about system_config.yml, please see the relevant documentation.

Website Search Index

Class Oro\Bundle\OrderBundle\EventListener\WebsiteSearchProductIndexerListener

This listener contains methods which are called when reindex process is running.

onWebsiteSearchIndex

public function onWebsiteSearchIndex(IndexEntityEvent $event)

This method is triggered when search reindex process starts running. For example, we can start reindex process with the oro:website-search:reindex command. This method adds new columns to the records with the oro_product_WEBSITE_ID index and based on order created_at, customer_id and product_id.

Index field

website_search.yml

Oro\Bundle\ProductBundle\Entity\Product:
    alias: oro_product_WEBSITE_ID
    fields:
      -
        name: ordered_at_by_CUSTOMER_ID
        type: datetime

We also added index field which saves information about the date of the last purchase of the product.

This field is used to select a query in the grid config for select, filter and sort data. For more information, please see datagrids.yml.

    query:
        select:
            - datetime.ordered_at_by_CUSTOMER_ID as recency
        where:
            and:
                - datetime.ordered_at_by_CUSTOMER_ID >= @oro_order.previously_purchased.configuration->getPreviouslyPurchasedStartDateString()

Reindex Listeners

ReindexProductLineItemListener

Class Oro\Bundle\OrderBundle\EventListener\ORM\ReindexProductLineItemListener

This listener contains methods which are called when the OrderLineItem entity is changed, and if all conditions are correct, a message is sent to the message queue to reindex product data.

reindexProductOnLineItemCreateOrDelete
public function reindexProductOnLineItemCreateOrDelete(OrderLineItem $lineItem, LifecycleEventArgs $args)

This method is triggered when we create or delete an order line item and send a message to the message queue informing that reindex for a product entity is required. But if the order has unsuitable status, or the feature has been disabled, the message for reindex is not sent.

reindexProductOnLineItemUpdate
public function reindexProductOnLineItemUpdate(OrderLineItem $lineItem, PreUpdateEventArgs $event)

This method is triggered when we update the "product" field in the order line item entity and send a message to the message queue that reindex for the product entity is required. But if the order has unsuitable status, or the feature has been disabled, the message is not sent for reindex.

ReindexProductOrderListener

Class Oro\Bundle\OrderBundle\EventListener\ORM\ReindexProductOrderListener

This listener contains methods which are called when Order entity is changed, and if all conditions are correct, a message is sent to message queue to reindex product data.

processIndexOnOrderStatusChange
public function processIndexOnOrderStatusChange(Order $order, PreUpdateEventArgs $event)

This method is triggered when order status is changed. But if order status is not applicable, the message for reindex is not sent.

processIndexOnOrderWebsiteChange
public function processIndexOnOrderWebsiteChange(Order $order, PreUpdateEventArgs $event)

This method is triggered when order website is changed. But if order status is not applicable, the message for reindex is not sent.

processOrderRemove
public function processOrderRemove(Order $order)

This method is triggered when an order is removed. But if order status is not applicable, the message for reindex process is not sent.

processIndexOnCustomerUserChange
public function processIndexOnCustomerUserChange(Order $order, PreUpdateEventArgs $event)

This method is triggered when order was updated and field customerUser was changed. But if order status is not applicable, the message for reindex process is not sent.

processIndexOnOrderCreatedAtChange
public function processIndexOnOrderCreatedAtChange(Order $order, PreUpdateEventArgs $event)

This method is triggered when order was updated and field createdAt was changed. But if order status is not applicable, the message for reindex process is not sent.

PreviouslyPurchasedFeatureToggleListener

Class Oro\Bundle\OrderBundle\EventListener\PreviouslyPurchasedFeatureToggleListener

This listener contains methods which are called when we turn the feature on or off from the system config.

reindexProducts

public function reindexProducts(ConfigUpdateEvent $event)

This method is triggered when we change the config setting enable_purchase_history and send a message to reindex products in the global or website scope.

Managers

ProductReindexManager

Class Oro\Bundle\ProductBundle\Search\Reindex\ProductReindexManager

This manager contains methods which are used when we need to reindex a product or a collection of products. Please use it when you need to reindex product data.

reindexProduct
public function reindexProduct(Product $product, $websiteId = null)

This method triggers reindex process for the current product. If websiteId is not present, this method takes the default website id.

triggerReindexationRequestEvent
public function triggerReindexationRequestEvent(array $productIds, $websiteId = null, $isScheduled = true)

This method triggers reindex process for a collection of product ids.

Providers

PreviouslyPurchasedConfigProvider

The Oro\Bundle\OrderBundle\Provider\PreviouslyPurchasedConfigProvider class

This provider provides you with the configuration for previously purchased products.

Here is a quick overview of its usage:

getDaysPeriod
$this->get('oro_order.previously_purchased.configuration')->getDaysPeriod();

Returns the count of days for previously purchased products.

getPreviouslyPurchasedStartDateString
$this->get('oro_order.previously_purchased.configuration')->getPreviouslyPurchasedStartDateString()

Returns the start date in string format for previously purchased products.

LatestOrderedProductsInfoProvider

Class Oro\Bundle\OrderBundle\Provider\LatestOrderedProductsInfoProvider

This provider is used when we need more information who and when bought products in the order.

getLatestOrderedProductsInfo

/**
 * Returns information about who and when bought those products
 * [
 *      product id => [
 *          'customer_id' => customer user who bought,
 *          'created_at'  => order create \DateTime,
 *      ],
 *      ...
 * ]
 *
 * @param array $productIds
 * @param int   $websiteId
 *
 * @return array
 */
public function getLatestOrderedProductsInfo(array $productIds, $websiteId)

Returns information about who and when bought those products.

PreviouslyPurchasedOrderStatusesProvider

Class Oro\Bundle\OrderBundle\Provider\PreviouslyPurchasedOrderStatusesProvider

This service implements OrderStatusesProviderInterface and contains methods which returned applicable statuses for the order. For example:

/**
 * @param AbstractEnumValue|null $status
 * @return bool
 */
protected function isAllowedStatus(AbstractEnumValue $status = null)
{
    // statusProvider implements OrderStatusesProviderInterface
    $availableStatuses = $this->statusesProvider->getAvailableStatuses();
    $statusId = $status !== null ? $status->getId() : null;

    return in_array($statusId, $availableStatuses);
}
getAvailableStatuses
public function getAvailableStatuses()

This method returns an array of applicable statuses for an order. It is used in ReindexProductOrderListener ReindexProductLineItemListener and LatestOrderedProductsInfoProvider