Skip to content

Modules

Sergii Ivashchenko edited this page May 3, 2019 · 14 revisions

Modules

Magento Adobe Stock Integration modules are provided via magento/adobe-stock-integration metapackage that contains:

  • magento/module-adobe-stock-integration-api module responsible for the general api declaration
  • magento/module-adobe-stock-integration module responsible for the general api implementation
  • magento/module-adobe-stock-image-api module responsible for the image api declaration
  • magento/module-adobe-stock-image module responsible for the image api implementation
  • magento/module-adobe-stock-image-admin-ui module responsible for the admin panel UI implementation

Modules structure

module-adobe-stock-integration-api

Responsibility

Provides Magento API for general interaction with Adobe Stock API

Contents

Apart from the basic Magento module structure and tests, the module includes:

  • Api namespace containing granular interfaces for each necessary operation with Adobe Stock API
    • Api\Data namespace containing data interfaces describing entities
  • WebAPI declaration

Dependencies

  • magento/framework only

module-adobe-stock-integration

Responsibility

Provides an implementation for module-adobe-stock-integration-api interfaces

Contents

Apart from the basic Magento module structure and tests, the module includes:

  • Setup namespace containing all necessary setup scripts
  • Model namespace containing the implementation of module-adobe-stock-integration-api interfaces

Dependencies

  • magento/module-adobe-stock-integration-api
  • adobe/stock-api-libphp

module-adobe-stock-image-admin-ui

Responsibility

The module integrates a UI into Magento media gallery UI and contains:

  • a slider window with an image grid UI component including search field, filters and pagination
  • image preview screen with the controls to save the preview or licensed version of the image to Magento media gallery
  • Controls displaying the Adobe Stock authentication status and basic Adobe Stock profile information

Contents

Apart from the basic Magento module structure and tests, the module includes:

  • view directory containing layout and ui_component XML files, dynamic and static presentation layer files
  • Ui namespacee containing PHP implementation of necessary UI components

Dependencies

  • magento/module-adobe-stock-image-api
  • magento/module-adobe-stock-integration-api
  • magento/module-ui

module-adobe-stock-image-api

Responsibility

Provides Magento API for interaction with Adobe Stock API and Magento media gallery

Contents

Apart from the basic Magento module structure and tests, the module includes:

  • Api namespace containing granular interfaces for each necessary operation with Adobe Stock API and Magento images and metadata storage
    • Api\Data namespace containing data interfaces describing entities
  • WebAPI declaration

Dependencies

  • magento/framework only

module-adobe-stock-image

Responsibility

Provides an implementation for module-adobe-stock-image-api interfaces

Contents

Apart from the basic Magento module structure and tests, the module includes:

  • Setup namespace containing all necessary setup scripts
  • Model namespace containing the implementation of module-adobe-stock-image-api interfaces

Dependencies

  • magento/module-adobe-stock-image-api
  • magento/module-media-storage
  • adobe/stock-api-libphp
Clone this wiki locally