Skip to content

Installation

Item Requirement
Platform CS-Cart and Multi-Vendor 4.17.2 – 4.21.x (tested on CS-Cart 4.17.2, Multi-Vendor 4.17.2 and Multi-Vendor 4.21.2 with PHP 8.3)
PHP PHP 7.4 – 8.3, as supported by your CS-Cart version
Theme Responsive or any theme based on it (Bright theme included)
Outgoing HTTPS Optional. Used once per saved YouTube/Vimeo video to copy its title and preview image
Uploads Optional. To upload video files, raise upload_max_filesize and post_max_size in PHP to fit your files
  1. Go to Add-ons → Manage add-ons.
  2. Click the gear button, then Manual installation, and upload the add-on archive (kv_product_videos-1.0.0.zip).
  3. Find Product Videos Gallery in the list and click Install.
  4. Open the add-on settings to review the defaults (see Configuration).
  5. On the License tab of the settings, enter your license key and save. If you bought the add-on on the CS-Cart Marketplace and entered the license number in Add-ons → Manage add-ons, you can skip this step. Until a key is verified, the add-on works for 14 days (see License).

On install the add-on:

  • creates the tables cscart_kv_product_videos and cscart_kv_product_videos_descriptions;
  • copies its storefront templates from var/themes_repository/responsive to every installed theme;
  • registers the “Videos” product tab (Website → Themes → Product tabs). The tab is shown only if Also show a separate “Videos” product tab is on, or if Show videos is set to the tab only.

No core file is changed.

The storefront templates are shipped for the Responsive theme. Themes based on Responsive, including Bright theme, inherit them. If your theme replaces views/products/components/product_images.tpl or common/product_data.tpl, keep the hooks products:product_images and products:product_data in your copies. See the FAQ for themes with a different gallery.

  1. In Add-ons → Manage add-ons, upload the new package with Manual installation.
  2. CS-Cart sees that the add-on is already installed and offers two ways:
    • Use the dangerous way (tick I know the risks… first) replaces the add-on files and keeps all add-on data. Choose this one. Despite its name, it is the normal way to upgrade this add-on.
    • Use the safe way uninstalls the add-on first. That deletes the settings, the videos and their uploaded files, then installs the new version from scratch.
  3. Open any page of the admin panel. On that first page view the add-on completes the upgrade by itself. It adds any new database tables and columns, new settings (with their default values), new language variables and e-mail templates. It also updates the version shown in Add-ons → Manage add-ons. Existing data and setting values are kept.

When files are uploaded over an installed add-on, CS-Cart resets the add-on’s language variables to the texts in the package. If you edited them in Administration → Languages → Translations, apply your edits again.

If you bought the add-on on the CS-Cart Marketplace, you can also upgrade it in Administration → Upgrade center. Steps 2 and 3 then happen automatically. The Upgrade center closes the storefront while it works. Reopen the storefront afterwards; the e-mail the Upgrade center sends links to the right page.

Upgrading to 1.2.0: this version adds the license check. After the upgrade the add-on keeps working for 14 days; enter your license key on the License tab of the settings within that time.

See the CHANGELOG for what changed in each version.

Add-ons → Manage add-ons → Product Videos Gallery → Uninstall.

Uninstalling permanently removes:

  • all videos (tables cscart_kv_product_videos*);
  • the preview images of the videos (image pairs with the object type kv_product_video);
  • uploaded video files (images/kv_product_videos/);
  • the add-on settings, language variables and the “Videos” product tab.

Export your products with the “Videos” column first if you may need the videos again.

In developer mode (DEVELOPMENT defined), CS-Cart keeps the copied theme templates after uninstall. This is core behavior.