ImportExport Module
AbstractModel
This abstract base class provides common logging functionality for import/export operations in Magento 2. Developers extend this class when creating c...
Api\Data\ExportInfoInterface
This interface defines the data structure for export operations in Magento 2, specifying required information like filename, file format (CSV, XML), c...
Api\Data\ExtendedExportInfoInterface
This interface extends the base ExportInfoInterface to add support for managing skipped attributes during export operations. Developers use this when...
Api\Data\FieldsEnclosureAwareExportInfoInterface
This interface defines methods for managing field enclosure settings in export operations. Developers use this when implementing export functionality...
Api\Data\LocalizedExportInfoInterface
This interface defines a contract for export operations that need to handle locale-specific data formatting, such as dates and numbers. Developers use...
Api\ExportManagementInterface
This interface defines the contract for export management operations in Magento 2. Developers implement this interface to create custom export handler...
Data
This helper class provides utility methods for Magento's import/export functionality. Developers use it to retrieve configuration settings like maximu...
Export
This class handles the export functionality in Magento 2, allowing developers to export entity data (like products, customers, etc.) to various file f...
Export\AbstractEntity
This abstract base class provides the core functionality for exporting Magento 2 entities (like products, customers, categories) to various file forma...
Export\Adapter\AbstractAdapter
This abstract base class provides the foundation for export adapters in Magento 2, handling file writing operations for data export functionality. Dev...
Export\Adapter\Csv
This class handles CSV file generation for Magento 2's export functionality. Developers use it when implementing custom export adapters or when the sy...
Export\Config
This class provides access to Magento 2's export configuration data, including available export entities (like products, customers), their types, and...
Export\Config\Converter
This converter class transforms XML configuration files for Magento's export functionality into PHP arrays. It processes entity definitions, entity ty...
Export\Config\Reader
This class reads and parses export.xml configuration files from Magento modules to define available export entities, entity types, and file formats. I...
Export\Config\SchemaLocator
This class locates and provides paths to XSD schema files used for validating export configuration XML files in Magento 2. Developers use this when wo...
Export\Consumer
This class is a message queue consumer that handles asynchronous export operations in Magento 2. When an export request is queued, this consumer proce...
Export\Entity\AbstractEav
This abstract class provides the foundation for exporting EAV (Entity-Attribute-Value) entities like products and customers in Magento 2. Developers e...
Export\Entity\AbstractEntity
This abstract class serves as the base for all export entity models in Magento 2's import/export functionality. Developers extend this class when crea...
Export\Entity\ExportInfo
This class serves as a data transfer object (DTO) that encapsulates all configuration parameters needed for export operations in Magento 2. Developers...
Export\ExportManagement
This class manages the export process in Magento 2's ImportExport module. Developers use it to execute data exports by providing export configuration...
History
This class manages the history records of import operations in Magento 2. Developers use it to create, update, and track import jobs, including storin...
Import
This class handles the core import functionality in Magento 2, managing the entire import process from file upload and validation to data processing a...
Import\AbstractEntity
This abstract class provides the foundation for implementing custom import entities in Magento 2's ImportExport module. Developers extend this class w...
Import\AbstractSource
This abstract class serves as a base for all import data sources in Magento 2's import/export functionality. Developers extend this class when creatin...
Import\Adapter
This class serves as a factory for creating import adapter instances based on file types (CSV, XML, etc.) used in Magento's import/export functionalit...
Import\Config
This class provides access to Magento 2's import configuration data, which defines available import entities (like products, customers), their types,...
Import\Config\Converter
This converter class transforms XML configuration files defining import/export entities into PHP arrays. Developers use this class to parse import_exp...
Import\Config\Reader
This class reads and parses import.xml configuration files from Magento 2 modules to load import entity definitions. It extends the framework's filesy...
Import\Config\SchemaLocator
This class locates and provides paths to XSD schema files used to validate import configuration XML files in Magento 2. Developers use this when the s...
Import\Entity\AbstractEav
This abstract class provides the foundation for importing EAV (Entity-Attribute-Value) entities in Magento 2, such as products or customers. Developer...
Import\Entity\AbstractEntity
This is the base class for all import entity models in Magento 2's Import/Export functionality. Developers extend this class when creating custom impo...
Import\ErrorProcessing\ProcessingError
This class represents an error that occurs during the import/export process in Magento 2. Developers use it to capture and store detailed error inform...
Import\ErrorProcessing\ProcessingErrorAggregator
This class aggregates and manages errors during Magento 2 import/export operations. Developers use it to collect, track, and validate errors based on...
Import\ImageDirectoryBaseProvider
This class provides the base directory path where users can place images for importing products or other entities in Magento. It retrieves the configu...
Import\RenderErrorMessages
This class handles the rendering and formatting of error messages during the Magento 2 import process. Developers use this service to display import e...
Import\SampleFileProvider
This class provides access to CSV sample files for import entities in Magento 2. Developers use it to retrieve sample import files that demonstrate th...
Import\Source\Csv
This class serves as a CSV file adapter for Magento 2's import/export functionality. Developers use it to read and parse CSV files during data import...
Import\Source\Json
This class serves as an adapter for importing data from JSON format in Magento 2's ImportExport module. Developers use it to convert JSON data into an...
Import\Source\Zip
This class handles importing data from ZIP-compressed CSV files in Magento 2's import/export functionality. It automatically extracts the CSV file fro...
LocaleEmulator
This class temporarily switches Magento's locale/language context while executing a callback function, then restores the original locale afterwards. D...
LocalizedFileName
This class handles the localization of filenames that contain dates by converting UTC timestamps in filenames to the store's configured timezone. Deve...
Model\Export\Adapter\Factory
This factory class creates instances of export adapter objects in Magento 2's import/export system. Developers use this factory to instantiate differe...
Model\Export\ConfigInterface
This interface defines the contract for retrieving export configuration in Magento 2's ImportExport module. Developers use this to access available ex...
Model\Export\Entity\ExportInfoFactory
This factory class creates ExportInfo objects that contain all the necessary configuration for exporting entity data in Magento 2. Developers use this...
Model\Export\Entity\Factory
This factory class creates instances of export entity classes in Magento 2's import/export system. Developers use this when they need to instantiate e...
Model\Export\Factory
This factory class creates and validates data collection instances for Magento's export functionality. Developers use it to instantiate collection obj...
Model\Import\ConfigInterface
This interface defines the contract for accessing Magento 2's import configuration settings. Developers use this to retrieve available import entities...
Model\Import\EntityInterface
This interface defines the contract for Magento 2 import entities that handle importing data from external sources (CSV, XML, etc.) into the system. D...
Model\Import\Entity\Factory
This factory class creates instances of import entity classes in Magento 2's ImportExport module. Developers use it to instantiate different entity im...
Model\Import\ErrorProcessing\ProcessingErrorAggregatorInterface
This interface defines the contract for aggregating and managing errors during Magento 2 import/export operations. Developers use implementations of t...
Model\LocaleEmulatorInterface
This interface defines a contract for temporarily switching locale settings during import/export operations. Developers use this to ensure data is pro...
Model\Report\ReportProcessorInterface
This interface defines a contract for generating error reports during import/export operations in Magento 2. Developers implement this interface to cr...
Model\ResourceModel\Export\AttributeGridCollection
This collection class manages attribute data for the export attributes grid in Magento's Import/Export functionality. Developers use it to display, fi...
Model\ResourceModel\History\Collection
This collection class retrieves and manages import/export history records from the database. It automatically joins with the admin_user table to inclu...
Report
This helper class manages import/export report files and statistics in Magento 2. Developers use it to retrieve execution times, summary statistics (c...
Report\Csv
This class generates CSV error reports for failed import operations in Magento 2. When an import fails, it creates a new CSV file containing all origi...
ResourceModel\CollectionByPagesIterator
This class provides a memory-efficient way to iterate through large Magento collections by loading and processing items in smaller pages (batches). De...
ResourceModel\Helper
This helper class provides database utility methods specifically for import/export operations in Magento 2. Developers use it to determine the maximum...
ResourceModel\History
This resource model manages database operations for the import history table in Magento 2. Developers use this class to interact with import/export op...
ResourceModel\Import\Data
This resource model manages the temporary storage and retrieval of import data during the Magento 2 import/export process. Developers use this class t...
Source\Export\Entity
This source model provides a list of available export entities (like products, customers, etc.) as option values for dropdown fields in the admin expo...
Source\Export\Format
This source model provides available export file format options for Magento's import/export functionality. Developers use this class to populate dropd...
Source\Import\AbstractBehavior
This abstract class serves as a base for defining import behavior options in Magento 2's Import/Export functionality. Developers extend this class to...
Source\Import\Entity
This class provides a list of available import entity types (like products, customers, etc.) as options for dropdown menus in the Magento admin panel....
Source\Upload
This class handles the upload of import source files (CSV or ZIP) in Magento 2's import/export functionality. Developers use this class when implement...