• v5.0
    • Versions
    • master

 

  • Install Akeneo PIM
    • Install Akeneo PIM for development with Docker
    • Install Akeneo PIM manually
      • System Requirements
      • System installation on Debian 10 (Buster)
      • System installation on Ubuntu 18.04 (Bionic Beaver)
      • System installation on Ubuntu 20.04 (Focal Fossa)
      • Installing Akeneo PIM Community Edition (CE)
      • Installing Akeneo PIM Enterprise Edition (EE) with the Archive
      • Setting up the job queue daemon
      • Setting up the Events API
    • How to customize the Dataset
    • How to Add Translation Packs
  • Upgrade Akeneo PIM projects
    • How to apply a patch?
      • How to apply a patch - Community Edition
      • How to apply a patch - Enterprise Edition - Flexibility Cloud offer
      • How to apply a patch - Enterprise Edition - On Premise offer
    • Where is the Changelog?
    • How to upgrade to a minor version?
    • How to upgrade to a major version?
      • Upgrade from 3.2 to 4.0
      • Upgrade from 4.0 to 5.0
  • Import and Export data
    • How import works
    • Understanding the Product Import
    • Understanding the Product Export
    • Formats
      • Localized labels
      • Scopable labels
      • Association types data structure
      • Attribute data structure
      • Category data structure
      • Family data structure
      • Family variant data structure
      • Group data structure
      • Options data structure
      • Product data structure
      • Product model data structure
    • Akeneo Connectors
    • How to Customize Import / Export
      • How to create a new Connector
      • How to import Products from a XML file
      • How to clean a CSV file during a Product import
      • How to automate imports/exports
  • Manipulate the Akeneo PIM data
    • How to Customize Mass Edit Operations
      • How to register a new bulk action
      • How to Register a New Mass Edit Action on Products
    • How to Manipulate Products
      • How to Query Products
      • How to Create Products
      • How to Update Products
      • How to Validate Products
      • How to Save Products
      • How to Remove Products
    • How to Manipulate Non-Product Objects
      • How to Query Non-Product Objects
      • How to Create Non-Product Objects
      • How to Update Non-Product Objects
      • How to Validate Non-Product Objects
      • How to Save Non-Product Objects
      • How to Remove Non-Product Objects
    • How to add a custom action rule
      • General information about rule format
      • How to add a custom action in the rule engine
    • How to Define Access Control List
    • How to Customize the Catalog Structure
      • How to Create a Reference Data
    • How To Customize Teamwork Assistant (Enterprise Edition)
      • Customize notifications
      • Add a calculation step
      • How to log calculation step
      • Remove projects impacted by a custom catalog update
    • How to store assets externally
    • How to Configure Measurement Limits
  • Maintain Akeneo PIM projects
    • First aid kit
    • Bug qualification
    • Common issues
    • Scalability Guide
      • Audit with 3 Representative Catalogs
      • More than 10k attributes?
      • More than 10k families?
      • More than 10k categories?
      • More than 500 attributes usable in the product grids?
      • More than 100k products to export?
      • More than 1GB of product media to export?
    • How to purge history
      • How to Purge jobs executions
      • How to adapt the version purger to your needs
  • Contribute to Akeneo PIM
    • How to report an issue?
    • How to translate the user interface?
    • How to enhance the documentation?
    • How to contribute to a Connector?
    • How to submit a patch to the PIM?
    • How to contribute to the frontend part of the application
    • How behavior tests are architectured in the PIM?
      • Establishing Decorator Pattern
      • Using Spin In Behat
  • Use SSO authentication locally
  • Reference Entities
    • Configure Entity Limits
    • Create a new Reference Entity Attribute type
    • Enrich Records with a new Reference Entity Attribute type
    • Add a Custom Property to Your Custom Attribute Type
    • Refresh records completeness
  • Troubleshooting guide
  • Technical overview
    • Product Information
    • Teamwork Assistant (Enterprise Edition)
      • Project creation
      • Project completeness
      • Project Completeness widget
      • Catalog update impact
      • Scalability guide
      • Users permission summary for Behat tests
    • Collaborative workflow
      • Simple workflow
      • Partial workflow
  • Technical architecture
    • Best Practices
      • Create a project
      • Create a reusable bundle
      • Code Conventions
      • Coding Standards
    • How to implement your business logic using the event system
    • Events
      • Storage events
      • Workflow events (Enterprise Edition only)
    • How to Localize your data
      • How to change the PIM locale
      • How to Use Localizers
      • How to use Presenters
    • How to Add a Notification
    • Performances Guide
      • Memory usage of rules execution (Enterprise Edition)
      • Memory leak fix in Rules Engine (ORM)
      • More than 100 WYSIWYG editors in a page
      • PHP7 and HHVM Compatibility?
      • Job product batch size
    • How to Use the Web REST API
    • Standard format
      • Products
      • Other entities
      • Usage
    • Application Technical Information
      • Application Technical Dependencies
      • Server side set up for hosting
      • System Requirements
      • Recommended configuration
      • Client side configuration and compatibilities
      • Operation processes
      • Flow Matrix
  • Akeneo Cloud Edition
    • Flexibility
      • Environment accesses
      • System Administration & Services Management
      • Periodic tasks & Crontab configuration
      • Composer settings
      • Queue Management & Workers
      • Disk Usage Management
    • Serenity
  • Akeneo Onboarder
    • Prerequisites
    • How to install the Onboarder bundle
    • Synchronization
    • How to update a minor version or to apply a patch
      • How to update the Onboarder bundle - Enterprise Edition - Flexibility Cloud offer
      • How to update the Onboarder bundle - Enterprise Edition - On Premise offer
    • How to upgrade to a major version
    • Troubleshooting
    • How to uninstall the Onboarder bundle
    • Environment variables
      • Using the DotEnv file
      • Using environment variables

How To Remove A Project On A Custom Catalog Update?¶

Several catalog updates can have an impact on project integrity. In this case we need to remove the impacted projects. Akeneo PIM already manages its own catalog updates. The list is available in Teamwork Assistant reference part.

How does It Work?¶

A subscriber handles catalog structure updates by listening to Akeneo\Tool\Component\StorageUtils\StorageEvents::POST_SAVE and Akeneo\Tool\Component\StorageUtils\StorageEvents::PRE_REMOVE on all entities and by dispatching them to the Akeneo\Pim\WorkOrganization\TeamWorkAssistant\Component\Remover\ChainedProjectRemover. This chained project remover contains all project removers and guesses which one has the responsibility to handle both the entity and the action it received.

A ProjectRemover has the responsibility to find and to remove all projects impacted by an entity and action pair.

How To Add A Custom Project Remover?¶

Reference data will be a good example to demonstrate how to add a ProjectRemover. We will take the example of the Color reference data which is provided by default. See pim-community-dev repository app/config.yml and app/AppKernel.php to enable it.

Each project remover must implement the Akeneo\Pim\WorkOrganization\TeamWorkAssistant\Component\Remover\ProjectRemoverInterface interface and be tagged pimee_activity_manager.project_remover.

<?php // src/AcmeEnterprise/Bundle/AppBundle/Remover/ColorProjectRemover.php

namespace AcmeEnterprise\Bundle\AppBundle\Remover;

use AcmeEnterprise\Bundle\AppBundle\Entity\Color;
use Akeneo\Tool\Component\StorageUtils\Detacher\ObjectDetacherInterface;
use Akeneo\Tool\Component\StorageUtils\Remover\RemoverInterface;
use Akeneo\Tool\Component\StorageUtils\StorageEvents;
use Doctrine\Common\Persistence\ObjectRepository;
use Akeneo\Pim\WorkOrganization\TeamworkAssistant\Component\Model\ProjectInterface;
use Akeneo\Pim\WorkOrganization\TeamworkAssistant\Component\Remover\ProjectRemoverInterface;

class ColorProjectRemover implements ProjectRemoverInterface
{
    /** @var RemoverInterface */
    protected $projectRemover;

    /** @var ObjectRepository */
    protected $projectRepository;

    /** @var ObjectDetacherInterface */
    protected $detacher;

    /**
     * @param ObjectRepository        $projectRepository
     * @param RemoverInterface        $projectRemover
     * @param ObjectDetacherInterface $detacher
     */
    public function __construct(
        ObjectRepository $projectRepository,
        RemoverInterface $projectRemover,
        ObjectDetacherInterface $detacher
    ) {
        $this->projectRepository = $projectRepository;
        $this->projectRemover = $projectRemover;
        $this->detacher = $detacher;
    }

    /**
     * This method is called by the ChainedProjectRemover to determine which ProjectRemover matches the
     * entity/action pair it receives.
     *
     * Does this project remover support the given entity/action?
     *
     * @param mixed  $entity (here renamed as $color)
     * @param string $action
     *
     * @return bool
     */
    public function isSupported($color, $action = null)
    {
        return $color instanceof Color && StorageEvents::PRE_REMOVE === $action;
    }

    /**
     * A project is removed if it uses a Color ReferenceData as product filter that is removed.
     *
     * Removes projects that have to be removed in terms of the given entity and action.
     *
     * @param mixed  $entity (here renamed as $color)
     * @param string $action
     */
    public function removeProjectsImpactedBy($color, $action = null)
    {
        /**
         * Don't be afraid to use `projectRepository->findAll()` as this method has been rewritten in
         * our repository to return a `Akeneo\Tool\Component\StorageUtils\Cursor\CursorInterface`. It does not hydrate
         * all projects at the same time. But don't forget to detach projects that are not removed to avoid
         * memory leaks.
         */
        foreach ($this->projectRepository->findAll() as $project) {
            if ($this->hasToBeRemoved($project, $color)) {
                $this->projectRemover->remove($project);
            } else {
                $this->detacher->detach($project);
            }
        }
    }

    /**
     * Determines if passed project has to be removed.
     *
     * @param ProjectInterface $project
     * @param Color            $color
     *
     * @return bool
     */
    protected function hasToBeRemoved(ProjectInterface $project, Color $color)
    {
        $colorCode = $color->getCode();
        $filters = $project->getProductFilters();
        foreach ($filters as $filter) {
            if (is_array($filter['value']) && in_array($colorCode, $filter['value'])) {
                return true;
            }
        }

        return false;
    }
}

Once your ProjectRemover is done you need to register it in the dependency injection and tag it.

# src/AcmeEnterprise/Bundle/AppBundle/Resources/config/services.yml
services:
    acme_app.project_remover.color:
        class: 'AcmeEnterprise\Bundle\AppBundle\Remover\ColorProjectRemover'
        arguments:
            - '@pimee_activity_manager.repository.project'
            - '@pimee_activity_manager.remover.project'
            - '@akeneo_storage_utils.doctrine.object_detacher'
        public: false
        # All project removers MUST be tagged as follows to be managed by the ChainedProjectRemover
        tags:
            - { name: pimee_activity_manager.project_remover }

Now, when a user removes a Color that is used in projects as product filter, they are removed to avoid project integrity alteration.


Found a typo or a hole in the documentation and feel like contributing?
Join us on Github!