Installation
Requirements
Section titled “Requirements”| Item | Requirement |
|---|---|
| Platform | CS-Cart Multi-Vendor 4.17.2 – 4.21.x (tested on Multi-Vendor 4.17.2 and 4.21.2 with PHP 8.3). The add-on will not install on CS-Cart (Ultimate) because vacation mode only makes sense for vendors. |
| PHP | PHP 7.4 – 8.3, as supported by your CS-Cart version. The code avoids PHP 8-only syntax. |
| Other add-ons | None required. Works alongside Vendor panel configurator, Vendor privileges, Common products for vendors (master products), Product variations and Direct customer-to-vendor payments. |
Install from the archive
Section titled “Install from the archive”- In the admin panel, go to Add-ons → Manage add-ons.
- Use the page’s upload option (Manual installation / Upload & install add-on, depending on the version).
- Select
kv_vendor_holiday_mode-1.0.0.zipand confirm the upload. - The add-on installs as Active. Open its settings to review the defaults (see Configuration).
- 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).
What the installer does:
- Creates two tables:
cscart_kv_vendor_holiday_modeandcscart_kv_vendor_holiday_mode_descriptions. Core tables are not altered. - Adds two privileges in the Vendors section: Vacation mode: Can view and Vacation mode: Can edit.
- Adds the email template Vendor vacation mode: vendor went on vacation (Design → Email templates).
- Copies the storefront templates and styles to every installed theme.
- Installs the English language variables.
Install manually (FTP)
Section titled “Install manually (FTP)”- Unpack the archive. It mirrors the CS-Cart root:
app/,design/,var/. - Upload these folders to the store root, keeping the structure.
- Go to Add-ons → Manage add-ons, find Vendor Vacation Mode in the Not installed list and click Install.
If you upload files by hand to a store with custom themes, CS-Cart still copies var/themes_repository/responsive/... into every theme during installation, so you don’t need to copy the templates to design/themes/ yourself.
After installing
Section titled “After installing”- Clear the cache (Administration → Storage → Clear cache) if you had already uploaded an older copy of the files.
- If you use Vendor privileges, grant Vacation mode privileges to the vendor user groups that should manage it (Customers → User groups → group → Privileges). Root vendor administrators without a user group always have access.
- If your theme overrides
buttons/add_to_cart.tplor the product templates heavily, check the product page once (see FAQ).
Upgrading
Section titled “Upgrading”- In Add-ons → Manage add-ons, upload the new package with Manual installation.
- 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 and the vendors’ vacation schedules and messages, then installs the new version from scratch.
- 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.1.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.
Uninstalling
Section titled “Uninstalling”Add-ons → Manage add-ons → Vendor Vacation Mode → Uninstall removes:
- both add-on tables, with all vacation records and messages;
- the add-on privileges and their assignments to user groups;
- the add-on settings, language variables and email template;
- the storefront templates copied to the themes.
Products are never modified by the add-on, so nothing has to be restored after uninstalling. Hidden products reappear at once.