Saphi Magento Theme Documentation for Magento 2 CE

Getting Started

Welcome to Saphi Magento 2 Theme!

Firstly, a huge thanks for purchasing this theme, your support is truly appreciated!

This document covers the installation and use of this theme, reveals some answers to common problems and issues. We encourage you to read throughout this document if you are experiencing any difficulties.

Compatible with Magento

Saphi Magento Theme is fully compatible with Magento Community Edition version 2.1.x, 2.2.x, 2.3.x, 2.4.x.

Version Magento	Link Documentation
Version 2.1.x to 2.3.x	Click Here
Ver 2.4.x	Click Here

Magento Information

To install this theme you must have a working version of Magento already installed. If you need help installing Magento, follow below sites and tutorials from magento.com, hope everything that you need are there.

System Requirements - Required system credentials for your magento installation.
Installation Guide - Installation guide that describes how to install magento2.
Online Magento 2 guide - Online magento documentation that describes about magento2 in detail.
Magento Forum - Magento forum site.
stackoverflow.com - You can also get some useful articles from stackoverflow.

Installation

Elasticsearch

As of Magento 2.4.0, MySQL is no longer used for search. You must use Elasticsearch. Magento supports Elasticsearch 7.6.x.

Note: Magento no longer supports Elasticsearch 2.x, 5.x, and 6.x.

Prepare Installation

There are two ways to install a Magento Theme:

Quickstart Installation: Suitable if you have your first installation and want to get a whole new fresh site as our Demo.
Manual Installation (including Theme Installation): Manual Installation (including Theme Installation): Suitable if your store is full with data/content (category, products...) that you don't want to overwrite.

Note:

To use magento 2.2.4+ most effectively we recommend using PHP 7.1

To use magento 2.3.x most effectively we recommend using PHP 7.1.3+

To use magento 2.4.x most effectively we recommend using PHP 7.4.0

Quickstart Installation

Magentech provides SM Quickstart package for each theme which aims to ease the installation for users. If you plan to start your site from the beginning, it will help you save much time of installing and configuring. Please follow steps below:

Important: You must use the command line to install Magento 2.4+.

Step 1: Download the quickstart package named as sm_saphi_quickstart_pl_m2.4.0_v4.0.0
Step 2: Upload and Extract the whole Quickstart package to your server. In Quickstart folder you will see the extracted folder that include all sample data

unzip file.zip

Step 3: Create a Database for your Magento site

Important!
You need to remember the database name to use in the next steps
Step 4: Import database sample_data.sql under the folder sm_saphi_quickstart_pl_m2.4.0_v4.0.0\data_quickstart
Note: You can import database by run this command mysql -u root -p database_name < sample_data.sql
Step 5: Install Magento
This example assumes that the Magento install directory is named sm_saphi, the db-host is on the same machine (localhost), and that the db-name, db-user, and db-password are all magento:

php bin/magento setup:install --base-url=http://192.168.1.220/ytc_templates/magento/sm_saphi --base-url-secure=https://192.168.1.220/ytc_templates/magento/sm_saphi --db-host=localhost --db-name=magento --db-user=magento --db-password=magento --admin-firstname=admin --admin-lastname=admin --admin-email=admin@admin.com --admin-user=admin --admin-password=admin123 --language=en_US --currency=USD --timezone=America/Chicago --use-rewrites=1 --backend-frontname="admin" --search-engine=elasticsearch7 --elasticsearch-index-prefix=saphi

Messages similar to the following display to indicate a successful installation:
Post installation file permissions check...
For security, remove write permissions from these directories: '/var/www/html/ytc_templates/magento/sm_saphi/app/etc'
[Progress: 274 / 274]
[SUCCESS]: Magento installation complete.
[SUCCESS]: Admin Panel URI: /admin_puu71q

Note: You can customize the Admin URI with the --backend-frontname option. However, we recommend omitting this option and allowing the installation command to automatically generate a random URI. A random URI is harder for hackers or malicious software to exploit. The URI displays in your console when installation is complete.
Step 6: Can't login to admin panel
When you login to admin will be display like this image:

Please open file app/etc/config.php and change 'Magento_TwoFactorAuth' => 1 to 'Magento_TwoFactorAuth' => 0

After that run these command:
1. php bin/magento setup:upgrade
2. php bin/magento setup:static-content:deploy -f
3. php bin/magento indexer:reindex
Step 7: Finally, permissions for the following folders by run these commands:
chmod -R 777 pub
chmod -R 777 generated
chmod -R 777 var

Manual Installation

Important!

- We recommend you to duplicate your live store on a development store and try installation on it in advance.

- Backup magento files and the store database.

It's very important to backup all of themes and extensions in Magento before installation, especially when you are working on a live server. We strongly recommend you to do not omit this step.

- Note: Manual Installation can only import CMS Page and Static Block. Products, Categories, Megamenu may not display when you use Manual Installation, you need to configure manually (by yourself >> please read documentation carefully)

Step 1: Download Magento 2.4.x https://magento.com/tech-resources/download and install on your server
Step 2: Please download 'sm_saphi_theme_m2.1.x-2.4.x_v4.0.0.zip' file and upload to the root of your magento site folder on your server, after that unzip by command unzip name_file.zip.
Step 3: Active SM Extensions, open command line in folder root of magento and run commands via ssh using putty or others php bin/magento setup:upgrade

Step 4: Run deploy command: php bin/magento setup:static-content:deploy -f

Finally, permissions for the following folders by run these commands:
chmod -R 777 pub
chmod -R 777 generated
chmod -R 777 var

Step 5: Navigate to Content > Design > Configuration > Edit Default Store > Select "SM saphi" theme.

Important!
For Magento 2.2.4, 2.2.5: Something went wrong while saving this configuration: Area is already set. Don't worry, please click here to fix this issues
Step 5: Click "Save Configuarion" button to save your changes.
Step 6: Navigate to Stores>> Settings>> Configuration >> MAGENTECH.COM >> Sm saphi >> Theme Installation. Press the buttons named 'Static Blocks' and 'Pages' to import all default blocks and pages. Click "Save Configuarion" button to save your changes.
Step 7: Click "Demo X" button to install demo version that you prefer to install. After that, click "Save config" button on the top.

Note. Please remember that: If you have imported these Static Blocks, Pages successfully, you would have all blocks and pages provided with this theme and you do not need to create any static blocks or pages manually as the following instruction of this document.

Step 8: Flush Cache: After successfully import your demo, save Theme Settings and Design Settings and clear the cache by using this command as php bin/magento cache:flush in Command Prompt. Or you could go to System >> Tools >> Cache Management, click 'Flush Cache Storage' button to flush all the cache.

Layout Position

Position Home page

Home Style 1

Homepage Configuration

Set Default Page

To configure the default home page for your store, please go to Stores>> Settings >>Configuration>>General>>Web>>Default Pages tab, select the desired page in the CMS Home Page field and save configuration.

You need to change to the website / store view that you want to change (the dropdown menu in the upper left corner). You will probably have to create a new CMS page if you want to have something different from your default home page.

Edit Homepage

From the top menu, please select Content >> Elements >> Pages. Here you can find all the store pages that you have imported, so you don't need to add them. You only need to update the pages HTML and XML content as you wish.

Step 1. Open any of them in order to get the access to the content.

Step 2. Edit the content as you desire

Step 3. Press Save Page button to save your configuration

How to show "Image Slider" in homepage?

Please try to use below example code in your cms contents.

<div class="slideshow" style="background-color: #eee;">
<div class="container">{{block class="Sm\ImageSlider\Block\ImageSlider" template="Sm_ImageSlider::default.phtml"}}</div>
</div>

How to show "Banner" in homepage?

Please try to use below example code in your cms contents.

<div class="container">
<div class="banner-home">
<div class="row">
<div class="col-lg-4 col-md-4 col-sm-4 col-xs-4 item-banner-col">
<div class="banner-item"><a title="Banner" href="#"><img src="{{media url="wysiwyg/baner-home/img1.png"}}" alt="Banner Image" /></a> <a class="shopnow" title="Shop Now" href="#">Shop Now <em class="fa fa-arrow-circle-right"></em></a></div>
</div>
<div class="col-lg-4 col-md-4 col-sm-4 col-xs-4 item-banner-col">
<div class="banner-item"><a title="Banner" href="#"><img src="{{media url="wysiwyg/baner-home/img2.png"}}" alt="Banner Image" /></a> <a class="shopnow" title="Shop Now" href="#">Shop Now <em class="fa fa-arrow-circle-right"></em></a></div>
</div>
<div class="col-lg-4 col-md-4 col-sm-4 col-xs-4 item-banner-col">
<div class="banner-item"><a title="Banner" href="#"><img src="{{media url="wysiwyg/baner-home/img3.png"}}" alt="Banner Image" /></a> <a class="shopnow" title="Shop Now" href="#">Shop Now <em class="fa fa-arrow-circle-right"></em></a></div>
</div>
</div>
</div>

How to show "Product" in homepage?

Please try to use below example code in your cms contents.

{{block class="Sm\ListingTabs\Block\ListingTabs" template="Sm_ListingTabs::default.phtml"}}

How to show "About Us" in homepage?

Please try to use below example code in your cms contents.

<div class="col-lg-4 col-md-4">
<div class="about-us-home">
<div class="home-title">
<h2>About Us</h2>
</div>
<div class="home-content">
<p>Lorem ipsum dolor sit amet, consectetur adipiscing elit. Suspendisse sagittis lobortis libero commodo ultricies. Cum ipsum dolor sit amet, consectetur adipiscing elit. Suspendisse sagittis lobortis libero commodo ultricies.</p>
<p>Lorem ipsum dolor sit amet, consectetur adipiscing elit. Suspendisse sagittis lobortis libero commodo ultricies. Cum ipsum dolor sit amet, consectetur adipiscing elit. Suspendisse sagittis lobortis libero commodo ultricies. <br /> Qui an voluptaria comprehensam interpretaris, falli nonumes petentium pri ad. Has et scaevola perpetua, justo tacimates invenire ei usu. Congue nemore sea id. Vix ferri aeterno et. Tempor eloquentiam interpretaris nec in, te stet ullum referrentur nam, novum possim eu vis. No per doming minimum moderatius, tation definitiones et sit.</p>
</div>
</div>
</div>

How to show "Services" in homepage?

Please try to use below example code in your cms contents.

<div class="col-lg-3 col-md-3">{{block class="Magento\\Cms\\Block\\Block" block_id="slider-services"}}</div>

How to show "Brands" in homepage?

Please try to use below example code in your cms contents.

<div class="slider-brands">
<div class="item"><a title="Brand Image" href="#"><img src="{{media url="wysiwyg/brands/logo.png"}}" alt="Brand Image" /></a></div>
<div class="item"><a title="Brand Image" href="#"><img src="{{media url="wysiwyg/brands/logo.png"}}" alt="Brand Image" /></a></div>
<div class="item"><a title="Brand Image" href="#"><img src="{{media url="wysiwyg/brands/logo.png"}}" alt="Brand Image" /></a></div>
<div class="item"><a title="Brand Image" href="#"><img src="{{media url="wysiwyg/brands/logo.png"}}" alt="Brand Image" /></a></div>
<div class="item"><a title="Brand Image" href="#"><img src="{{media url="wysiwyg/brands/logo.png"}}" alt="Brand Image" /></a></div>
<div class="item"><a title="Brand Image" href="#"><img src="{{media url="wysiwyg/brands/logo.png"}}" alt="Brand Image" /></a></div>
<div class="item"><a title="Brand Image" href="#"><img src="{{media url="wysiwyg/brands/logo.png"}}" alt="Brand Image" /></a></div>
</div>

How to show "Footer Links" in homepage?

To create the "sp-footer-links" block, please go to Admin Panel > Content > Elements > Blocks > Add new block with Identifier "sp-footer-links" block.
Please try to use below example code in your cms contents.

<div class="slider-brands">
<div class="item"><a title="Brand Image" href="#"><img src="{{media url="wysiwyg/brands/logo.png"}}" alt="Brand Image" /></a></div>
<div class="item"><a title="Brand Image" href="#"><img src="{{media url="wysiwyg/brands/logo.png"}}" alt="Brand Image" /></a></div>
<div class="item"><a title="Brand Image" href="#"><img src="{{media url="wysiwyg/brands/logo.png"}}" alt="Brand Image" /></a></div>
<div class="item"><a title="Brand Image" href="#"><img src="{{media url="wysiwyg/brands/logo.png"}}" alt="Brand Image" /></a></div>
<div class="item"><a title="Brand Image" href="#"><img src="{{media url="wysiwyg/brands/logo.png"}}" alt="Brand Image" /></a></div>
<div class="item"><a title="Brand Image" href="#"><img src="{{media url="wysiwyg/brands/logo.png"}}" alt="Brand Image" /></a></div>
<div class="item"><a title="Brand Image" href="#"><img src="{{media url="wysiwyg/brands/logo.png"}}" alt="Brand Image" /></a></div>
</div>
<script type="text/javascript" xml="space">// <![CDATA[
	require([
		'jquery',
		'owlcarousel'
	], function ($) {
				$(".slider-brands").owlCarousel({
					responsive:{
						0:{
							items:2
						},
						480:{
							items:3
						},
						768:{
							items:4
						},
						992:{
							items:6
						},
						1200:{
							items:6
						}
					},
					
					autoplay:false,
					loop:true,
					nav : true, 
					dots: false,
					autoplaySpeed : 500,
					navSpeed : 500,
					dotsSpeed : 500,
					autoplayHoverPause: true,
					margin:0,
				});	  
			});	
		
// ]]></script>

Theme Setting

Configuration

In Magento admin panel, navigate to Stores>> Settings>> Configuration >> MAGENTECH.COM >> SM Saphi and configure its settings as you want.

Please click Here to view the theme settings.

General Options

Theme Color: In this option, you can set main color of entire page.

Body Font

In these options, you can change main font, font size, link color, text color, background, etc.

Image Box

Thumbs Styles: This option allow you choose thumb style types that you want.
Enable Loop: Choose "Yes" to repeat your loop.
Enable Keyboard Trigger: Choose "Yes/No" to "Enable/Disable" keyboard trigger feature.
Show Navigation: Choose "Yes/No" to "Show/Hide" navigation.
Enable Popup Fullscreen: Choose "Yes" to show fullscreen popup when you mouse click on the product detail.
Show Thumbs Navigation: Choose "Yes/No" to "Show/Hide" thumb navigation.
Thumbs Margin: Distance between the thumb images.
Thumbs Border Active Width: You can change width of thumb boder when active.
Breakpoints: Breakpoints are used to set up the screen width at which the design of thumbnails changes.

Image Zoom

Enable Product Image Zoom: Choose "Yes/No" to "Allow/Not Allow" show product image zoom when you mouse hover on the product image.

Related - Upsell Product

In these options, you can choose "Yes/No" to "Show/Hide" and set limit quantity for related and upsell products.

Tab

Choose tab style types that you want.

Custom Tab

Choose "Yes", you can change name and add content for Custom Tab.

Socials

Choose "Yes" to show socials. When you choose "Yes", you can change name and link of socials.

Advanced

Choose "Yes/No" to "Show/Hide" Go to Top, Add to Cart, Add to Wishlist, Add to Compare, Newsletter Popup, Copyright, etc.

Developer

To custom Css or Javascript

Theme Installation

Import Static Blocks

By clicking this button, you can import all static blocks that are used for our demo site.

Import Pages

By clicking this button, you can import all pages that are used for our demo site.

Import Demos

Click "Demo X" button to install demo version that you prefer to install.

Note: When you click "Demo X" button, the administration page will reload automatically. After it finishes reloading, please click "Save Config" button and refesh cache.

Extensions

Magentech Extensions

1. SM Mega Menu

Enable Extensions: Allow to enable/disable the module. If choose "Disable", magento's default menu style will be applied.
Select Mega Menu: Allow to choose Mega Menu.
Select Template: This module support 2 templates for presenting of menu (Horizontal and Vertical).
Select Effect: We support effects for Mega menu (CSS/Animation/Toggle)

Advanced Options

Allow to choose to cache the content of module.

How to create list Menu Items for your menu?

Step 1: Log in to Admin, navigate to SM Megamenu >> Add New Menu (add group: "Mega Menu Demo")

Step 2: Navigate to SM Megamenu >> Configuration & fill the ID number for the created menu in step 1

Step 3: In order to add menu items, go to SM Megamenu >> Menu Manager >> click on 'Edit' to open Menu Items to add items as you want.

For example about megamenu:

Sortable Categories Items: Please click Here to view.

Backend Settings: Please click Here to view.

2. SM Basic Product

General Settings

Enabled Extensions: Allow to enable/disable the module.
Display Title: Allow to show/hide the title.
Title: Enter the title of the module.
Target: Allow to display the target link in Same Window/ New Window/ Popup Window
Column: Set the number of columns for each type of devices.

Source Options

Select Source: Allow you to select source: catalog/ media or Product IDs.
Select Category: Allow you to select Category.
Child Category Products: Include or Exclude Products from Child Categories.
Category Depth: Allow to change the number of child category levels to return.
Featured Products: Allow to Show/Hide/Only Featured Products.
Product Field to Order By: Set Product Field to Order By.
Ordering Direction: Allow to order ascending/descending direction.
Product Limitation: Allow to set product limitation.

Categories Title Options

Categories Title Display: Allow show/hide title of category.

Title Max Chars: Allow to enter max chars of category title.

Product Options

Allow show/hide product title, product description, price.

Image Options

Allow get image from product image or product description when you choose "Yes".
Order to Get: Allow to order to get image with options such as product_image, product_description.
Resize: Allow you resize product image when you choose "Yes".
Image Width: You can set image's width.
Image Height: You can set image's height.
Background Color: You can set background color.
Image Replacement: Only when the product has no image, the module will take photos from placeholder to replace.

Advanced Options

Pre-text: The content to show at the top of module.
Pre-text: The content to show at the end of module.
Caching: Allow to choose to cache the content of module. If you choose "Yes", you can set the time before the module is recached.

3. SM Shop By

Enabled Extensions: Allow to enable/disable the module.
Display Title: Allow to show/hide the title.
Title: Enter the title of the module.
User Ajax: Choose "Yes" to use ajax when filter instead the homepage will reload automatically.
Use Price Slider: Choose "Yes" to use price slider.

4. SM Image Slider

General Settings

Source Options

Input title, link, media, content. Please go to the installation directory to get the image’s source as you want.
For example: wysiwyg/slideshow/slide-1.jpg

Product Options - For Theme 2

If you select theme 2, you can config show/hide product title or product description and set the max length of product title here.

Image Options

You can set width, height, background color, image replacement of images.

Effect Options

Auto Play: Allow to Enable/Disable auto play.
Start: Allow to set the first image of slideshow.
Step: Set the number of items for each slide transition.
Speed: Allow to set the speed of slide.
Interval: The duration to change to next slide.
Stop on hover: Allow to Stop effects when users hover.
Navigation: Allow to show/hide the next/previous button.
Loop: Choose "Yes" to loop items when you click next/previous button.
Dots: Allow to show/hide dots navigation style.
Margin-Right: Allow to set right margin of the image.
Nav Speed: Allow to set the speed of Navigation
Mouse Drag: Allow to use the cursor to navigate pages in this module.
Dots Speed: Allow to set the speed of dots navigation style.

Advanced Options

Pre-text: The content to show at the top of module.
Post-text: The content to show at the end of module.
Caching: Allow to choose to cache the content of module. If you choose "Yes", you can set the time before the module is recached.

5. SM Listing Tabs

General Options

Enabled Extensions: Allow to enable/disable the module.
Display Title: Allow to show/hide the title
Title: Enter the title of the module.
Target: Allow to display the target link in Same Window/ New Window/ Popup Window
Class Suffix: Allow uses to add suffix for class.
Columns: Set the number of columns for each type of devices.

Source Options

Fiter Type: Allow you to select Type of Filter.
Select Category: Allow you to select Category.
Child Category Products: Include or Exclude Products from Child Categories.
Featured Products: Set Product Field to Order By.
Product Field to Order By: Set Product Field to Order By.
Ordering Direction: Allow to order ascending/descending direction.
Product Limitation: Allow to set product limitation.

Tabs Options

Tab All Display: Allow to choose tab all display or not.
Category title max length: Allow to set the max length of category title
Categories Order By: Set Categories Order By: Name/Position/Random.
Categories Ordering Direction: Allow to order ASC(ascending)/ DESC(descending) direction.
Display Icon: Allow to show/ hide icon.
Get Image From Category Image: Allow get image from category image
Get Image From Category Description: Allow get image from description image
Order to Get: Allow to order to get image with options such as category_description,category_image.
Resize: Allow you resize product image when you choose "Yes".
Image Width: You can set image's width.
Image Height: You can set image's height.
Background Color: You can set background color.
Placeholder: Only when the product has no image, the module will take photos from placeholder to replace.

Product Options

Allow show/hide product title, product description, price.

Image Options

Effect Options

Effect: Allow to select effect that you want.
Speed: Allow to set speed of slide.
Interval: Allow to set interval timer.
Config When Type Module Is Slider.
Display Navigation: Allow to show/hide the next/previous button.
Display Loop: Choose "Yes" to loop items when you click next/previous button.
Margin-Items: Allow to set margin of the image.
Slide By: Allow to choose the number of products displayed when clicking next/previous button.
Auto Play: Allow to Enable/Disable auto play.
Pause On Hover: Allow to Pause effects when users hover.
Auto Play Speed: Allow to set speed of timer (larger = slower).
Navigation Speed: Allow to set the speed of Navigation.
Start Position Item: Allow to choose the first item by position number.
Mouse Drag: Allow to use the cursor to navigate pages in this module.
Touch Drag: Allow to Enable/Disable Touch Drag.

Advanced Options

6. SM Cart Pro

Enabled Extensions: Allow to enable/disable the module.
Enable Ajax Cart: Choose "Yes" to use ajax box when you add cart instead the homepage will reload automatically.
Enable Ajax for Compare: Choose "Yes" to use ajax box when you add compare instead the homepage will reload automatically.
Enable Ajax for Wishlit: Choose "Yes" to use ajax box when you add wishlist instead the homepage will reload automatically.
Countdown Number: The time of ajax box displaying on the screen.
Effect Selector: You can use effects “Click” or ” Hover”.

Other Extensions

SM Saphi is compatible with MageFan_Blog extension. You can show Latest Blog, after install this extension.

Please try to use below example code in your cms contents.

<div class="col-lg-5 col-md-5">{{widget type="Magefan\Blog\Block\Widget\Recent" title="Latest Blog" number_of_posts="6" custom_template="Magefan_Blog::widget/latest-post-index.phtml"}}</div>