Skip to content

findologic/plugin-shopware-5

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

FINDOLOGIC Shopware 5 Plugin

PHPUnit (SW 5.7) PHPUnit (SW 5.6) PHPUnit (SW 5.2 - 5.5)

Needs to be installed in Shopware 5 eShop in order to export products and its data for a successful integration of the FINDOLOGIC search.

This plugin goes through all the shop's data to find suitable products for the export. Following conditions must be met:

  • Product must be active
  • Product must have a title
  • Product stock must be greater than zero
  • Product must not be configured as variant
  • Product categories must be active

Installation

FINDOLOGIC Shopware 5 plugin installation procedure is basically the same as for any other Shopware plugin. It can be summed up in a few simple steps:

  • In the admin panel click on Configuration → Plugin Manager
  • In the left side menu, click on "Installed"
  • Upload the packaged plugin using the "Upload plugin" button
  • The plugin should be listed in the section for uninstalled plugins
  • Click on the green circle to install it
  • Confirm when you are asked to clear caches
  • Enter your shopkey in the plugin's configuration tab
  • Set the field "Active" to "Yes"
  • Click "Save"
  • Finally, the shop's cache must be cleared

Export

Each export method supports three parameters:

  • shopkey (required) → provided by FINDOLOGIC
  • start (optional) → must not be lower than zero
  • count (optional) → must not be lower than zero
  • language (optional) → respective ISO code

Frontend

FINDOLOGIC starts the export by calling an appropriate URL e.g.:

<SHOPURL>/findologic?shopkey=SHOPKEY

Console command

The following command can be executed manually or using a cron job to store export data locally on the filesystem:

$ php bin/console findologic:export SHOPKEY

Customization

The plugin's search and export components are registered as services. If those do not meet your requirements, it is advised to implement a basic plugin which extends/decorates the mentioned services. FINDOLOGIC also provides an extension plugin which can be used to test customizations.

See the official Shopware documentation for more information.

Deployment & Release

Before starting the deployment make sure that a release is already created.

  1. Merge everything into the develop branch and update the version in FinSearchUnified/plugin.xml.
  2. Add another <changelog> tag, containing all changes made in this release.
  3. Run git fetch and ensure that the release tag is available locally. Make sure that the file ./FinSearchUnified/plugin.xml contains the correct version constraint.
  4. Run ./archive.sh which will automatically create a plugin zip.
  5. Upload this version to Google Drive Development/Plugins/Shopware/Shopware 5 DI & API Plugin and move the old version to alte Versionen.
  6. Go to https://account.shopware.com and login. Go to Manufacturer area > Plugins > FINDOLOGIC Search & Navigation and select Versions. Click on Upload new version and fill out all necessary fields. In the second step mark the plugin as compatible for Shopware 5.3 and newer. Last but not least upload the plugins' zip file and mark all required checkboxes.
  7. Once the release is available require an automatic code review.
  8. Notify everyone in Slack #releases.

License

Please see License File for more information.