Powerful E-commerce module for Yii2 framework.
Run command
composer require albert-sointula/yii2-shop
or add
"albert-sointula/yii2-shop": "*"to the require section of your composer.json.
'authManager' => [
'class' => 'yii\rbac\DbManager',
],
'components' => [
'urlManager' => [
'class' => bl\multilang\MultiLangUrlManager::className(),
'baseUrl' => '/admin',
'enablePrettyUrl' => true,
'showScriptName' => false,
'rules' => [
],
],
'urlManagerFrontend' => [
'class' => bl\multilang\MultiLangUrlManager::className(),
'baseUrl' => '/',
'showScriptName' => false,
'enablePrettyUrl' => true,
'enableDefaultLanguageUrlCode' => false,
'rules' => [
[
'class' => bl\articles\UrlRule::className()
],
[
'class' => xalberteinsteinx\shop\UrlRule::className(),
'prefix' => 'shop'
],
]
],
]
'components' => [
'urlManager' => [
'class' => bl\locale\UrlManager::className(),
'baseUrl' => '/',
'showScriptName' => false,
'detectInSession' => false,
'detectInCookie' => false,
'enablePrettyUrl' => true,
'languageProvider' => [
'class' => bl\locale\provider\DbLanguageProvider::className(),
'db' => 'db',
'table' => 'language',
'localeField' => 'lang_id',
'languageCondition' => ['active' => true],
],
'lowerCase' => true,
'useShortSyntax' => false,
'languageKey' => 'language',
'showDefault' => false,
'rules' => [
[
'class' => albertgeeca\shop\UrlRule::className(),
'prefix' => 'shop'
],
[
'class' => bl\seo\UniqueUrlRule::class,
'destination' => 'cart',
'duplicate' => [
'cart/cart/show',
'cart/cart'
]
],
]
],
]
in frontend config:
'modules' => [
...
'user' => [
'modelMap' => [
'RegistrationForm' => albertgeeca\shop\common\components\user\models\RegistrationForm::className(),
'RecoveryForm' => albertgeeca\shop\common\components\user\models\RecoveryForm::className(),
'LoginForm' => albertgeeca\shop\common\components\user\models\LoginForm::className(),
'SettingsForm' => albertgeeca\shop\common\components\user\models\SettingsForm::className(),
],
'controllerMap' => [
'registration' => albertgeeca\shop\frontend\components\user\controllers\RegistrationController::className(),
'settings' => albertgeeca\shop\frontend\components\user\controllers\SettingsController::className(),
'security' => albertgeeca\shop\frontend\components\user\controllers\SecurityController::className(),
'recovery' => albertgeeca\shop\frontend\components\user\controllers\RecoveryController::className()
],
'as frontend' => dektrium\user\filters\FrontendFilter::className(),
'enableFlashMessages' => false
],
...
],
'components' => [
...
'user' => [
'identityClass' => albertgeeca\shop\common\components\user\models\User::className(),
'enableAutoLogin' => true,
'identityCookie' => [
'name' => '_frontendIdentity',
'path' => '/',
'httpOnly' => true,
],
'on afterLogin' => function() {
if (Yii::$app->cart->saveToDataBase) Yii::$app->cart->transportSessionDataToDB();
},
'on afterConfirm' => function() {
if (Yii::$app->cart->saveToDataBase) Yii::$app->cart->transportSessionDataToDB();
},
],
...
],
in backend config:
'modules' => [
...
'user' => [
'enableRegistration' => false,
'enableConfirmation' => false,
'admins' => ['admin'],
'adminPermission' => 'rbacManager',
'controllerMap' => [
'admin' => albertgeeca\shop\backend\components\user\controllers\AdminController::className(),
'security' => albertgeeca\shop\frontend\components\user\controllers\SecurityController::className()
],
'as backend' => [
'class' => 'dektrium\user\filters\BackendFilter',
'only' => ['register'], // Block View Register Backend
],
],
...
],
'components' => [
...
'user' => [
'identityClass' => dektrium\user\models\User::className(),
'enableAutoLogin' => true,
'returnUrl' => '/',
'identityCookie' => [
'name' => '_backendIdentity',
'path' => '/admin',
'httpOnly' => true,
],
],
...
'view' => [
'theme' => [
'basePath' => '@backend/themes/' . $params['themeName'],
'baseUrl' => '@web/themes/' . $params['themeName'],
'pathMap' => [
'@dektrium/user/views' => '@vendor/sointula/yii2-shop/backend/views/user',
],
],
],
],
in common configuration file:
'modules' => [
'user' => [
'class' => dektrium\user\Module::className(),
'modelMap' => [
'Profile' => albertgeeca\shop\common\components\user\models\Profile::className(),
'User' => albertgeeca\shop\common\components\user\models\User::className()
],
],
- php yii migrate --migrationPath=@vendor/dektrium/yii2-user/migrations
- php yii migrate --migrationPath=@yii/rbac/migrations
- php yii migrate --migrationPath=@vendor/black-lamp/yii2-multi-lang/migration
- php yii migrate --migrationPath=@vendor/black-lamp/yii2-seo/migrations
- php yii migrate --migrationPath=@vendor/black-lamp/blcms-staticpage/migrations
- php yii migrate --migrationPath=@vendor/black-lamp/yii2-email-templates/src/migrations
- php yii migrate --migrationPath=@vendor/albert-sointula/yii2-shop/migrations
'shop_imagable' => [
'class' => bl\imagable\Imagable::className(),
'imageClass' => \bl\imagable\instances\CreateImageImagine::className(),
'nameClass' => bl\imagable\name\CRC32Name::className(),
'imagesPath' => '@frontend/web/images',
'categories' => [
'origin' => false,
'category' => [
'shop-product' => [
'origin' => false,
'size' => [
'big' => [
'width' => 1500,
'height' => 500
],
'thumb' => [
'width' => 500,
'height' => 500,
],
'small' => [
'width' => 150,
'height' => 150
]
]
],
'shop-vendors' => [
'origin' => false,
'size' => [
'big' => [
'width' => 1500,
'height' => 500
],
'thumb' => [
'width' => 320,
'height' => 240,
],
'small' => [
'width' => 150,
'height' => 150
]
]
],
'delivery' => [
'origin' => false,
'size' => [
'big' => [
'width' => 1500,
'height' => 500
],
'thumb' => [
'width' => 500,
'height' => 500,
],
'small' => [
'width' => 150,
'height' => 150
]
]
],
'shop-category/cover' => [
'origin' => false,
'size' => [
'big' => [
'width' => 1500,
'height' => 500
],
'thumb' => [
'width' => 500,
'height' => 500,
],
'small' => [
'width' => 150,
'height' => 150
]
]
],
'shop-category/thumbnail' => [
'origin' => false,
'size' => [
'big' => [
'width' => 1500,
'height' => 500
],
'thumb' => [
'width' => 500,
'height' => 500,
],
'small' => [
'width' => 150,
'height' => 150
]
]
],
'shop-category/menu_item' => [
'origin' => false,
'size' => [
'big' => [
'width' => 1500,
'height' => 500
],
'thumb' => [
'width' => 500,
'height' => 500,
],
'small' => [
'width' => 150,
'height' => 150
]
]
],
'payment' => [
'origin' => false,
'size' => [
'big' => [
'width' => 1500,
'height' => 500
],
'thumb' => [
'width' => 500,
'height' => 500,
],
'small' => [
'width' => 150,
'height' => 150
]
]
],
]
]
],
'bootstrap' => [
//'albertgeeca\shop\backend\components\events\PartnersBootstrap',
'albertgeeca\shop\backend\components\events\ShopLogBootstrap',
'albertgeeca\shop\backend\components\events\CartBootstrap',
],
'modules' => [
'shop' => [
'class' => 'albertgeeca\shop\backend\Module',
'enableCurrencyConversion' => true
]
] 'modules' => [
...
'shop' => [
'class' => albertgeeca\shop\frontend\Module::className(),
'enableCurrencyConversion' => true,
'partnerManagerEmail' => $params['partnerManagerEmail'],
'senderEmail' => $params['senderEmail'],
'showChildCategoriesProducts' => false
],
...
],
'components' => [
...
'partnerMailer' => [
'class' => yii\swiftmailer\Mailer::className(),
'useFileTransport' => false,
'messageConfig' => [
'charset' => 'UTF-8',
],
'viewPath' => '@vendor/albert-sointula/yii2-shop/frontend/views/partner-request/mail',
'htmlLayout' => '@vendor/albert-sointula/yii2-shop/frontend/views/partner-request/mail/layout',
'transport' => [
'class' => 'Swift_SmtpTransport',
'username' => 'info@mail.com',
'password' => '55555555',
'host' => 'pop.mail.com',
'port' => '587',
],
],
...
]
'bootstrap' => [
'albertgeeca\shop\frontend\components\events\PartnersBootstrap',
'albertgeeca\shop\frontend\components\events\UserRegistrationBootstrap'
],https://github.com/black-lamp/yii2-email-templates
Add StaticPageManager role to your admin user in auth_assignment table. Create new static pages with page keys "shop" and "cart". In your backend configuration file add this:
'seo' => [
'class' => 'bl\cms\seo\backend\Module'
],
],
- PHP-version: 7.0 or later
- PHP-extensions: file-info, imagick, intl
attributeManager
- addAttributeValue
- deleteAttribute
- saveAttribute
- viewAttributeList
countryManager
- saveCountry
- viewCountryList
- deleteCountry
currencyManager
- updateCurrency
- viewCurrencyList
- deleteCurrency
deliveryMethodManager
- saveDeliveryMethod
- viewDeliveryMethodList
- deleteDeliveryMethod
orderManager
- deleteOrder
- deleteOrderProduct
- viewOrder
- viewOrderList
orderStatusManager
- saveOrderStatus
- viewOrderStatusList
- deleteOrderStatus
productAvailabilityManager
- saveProductAvailability
- viewProductAvailabilityList
- deleteProductAvailability
productManager
- createProduct
- createProductWithoutModeration
- deleteOwnProduct
- deleteProduct
- updateOwnProduct
- updateProduct
- viewCompleteProductList
- viewProductList
productPartner
- accessAdminPanel
- createProduct
- createProductWithoutModeration
- deleteOwnProduct
- deleteProduct
- updateOwnProduct
- updateProduct
- viewCompleteProductList
- viewProductList
shopCategoryManager
- saveShopCategory
- viewShopCategoryList
vendorManager
- saveVendor
- viewVendorList
- deleteVendor
paymentManager
- viewPaymentMethodList
- savePaymentMethod
- deletePaymentMethod
shopAdministrator extends permissions from all managers.
Recommended products
Example:
<?= \albertgeeca\shop\widgets\RecommendedProducts::widget([
'id' => $product->id,
]); ?>
Also you may use albertgeeca\shop\widgets\assets\RecommendedProductsAsset in your view.
Filtration widget
To use the widget, you must have set up relations in the models. For example in model Product:
/**
* @return \yii\db\ActiveQuery
*/
public function getProductCountry()
{
return $this->hasOne(ProductCountry::className(), ['id' => 'country_id']);
}Your application can record how many people watched a particular product. To enable logging, you must add the following settings in the frontend configuration file:
public $log = [
'enabled' => true,
'maxProducts' => 10 // Max number of viewed products by one user.
];
In it, you specify the number of products, which is stored in the table shop_product_views for one user. This value can be 'all', ie infinitely.
If the 'maxProducts' property value is "all", the "views" of Product object increases by one for a registered user once. Otherwise it will increase by one each time when registered user views product.
The module has translations on several languages. If there is not your language or if you would like change its on your own, you can configure it in backend or frontend configuration file:
'i18n' => [
'translations' => [
'shop' => [
'class' => 'yii\i18n\PhpMessageSource',
'basePath' => '@backend/messages',
'sourceLanguage' => 'en-us',
]
],
],
- Shop main static page /admin/seo/static/save-page?page_key=shop&languageId=2
- Categories /admin/shop/category/index
- Products /admin/shop/product/index
- Countries /admin/shop/country/index
- Vendors /admin/shop/vendor/index
- Attributes /admin/shop/attribute/index
- Availability statuses /admin/shop/product-availability/index
- Currency /admin/shop/currency/index
- "Class 'Imagick' not found"
If you use OpenServer with PHP 7, you must install Imagick extension like here http://open-server.ru/forum/viewtopic.php?f=4&t=2897&hilit=imagick
Products displaying
You can select one of two modes: showing products of current category and its children or only current category. Use property $showChildCategoriesProducts in frontend Module class configuration. migration:
Logging This configuration is for Shop module and Cart module.
For enable logging add log component to your common configuration file:
'components' => [
'log' => [
'targets' => [
[
'logTable' => 'shop_log',
'class' => 'yii\log\DbTarget',
'levels' => ['info'],
'categories' => [
'afterCreateProduct', 'afterDeleteProduct', 'afterEditProduct',
'afterCreateCategory', 'afterEditCategory', 'afterDeleteCategory',
],
],
[
'logTable' => 'cart_log',
'class' => 'yii\log\DbTarget',
'levels' => ['info'],
'categories' => [
'afterChangeOrderStatus'
],
],
[
'logTable' => 'user_log',
'class' => 'yii\log\DbTarget',
'levels' => ['info'],
'categories' => [
'afterRegister', 'afterConfirm'
],
],
],
],
Then apply migration, but only after you will configure your app. The migration will create tables for log targets, which are listed in configuration.
php yii migrate --migrationPath=@yii/log/migrations/
In backend and frontend configuration of your module add
'enableLog' => true,
Vendor list
- /shop/vendor
Partner requests email Create new templates 'partner-request-manager' and 'partner-request-partner': /admin/email-templates/default/list
You can use next variables: '{contact_person}', '{company_name}', '{website}', '{message}', '{name}', '{surname}', '{patronymic}', '{info}'
Also create template 'partner-request-accept' without variables.
Information about new product by product partner to manager - template 'new-product-to-manager'. You can use next variables: {productId}, {title}, {ownerId}, {ownerEmail}, {owner}, {link} For sending information abount new product to partner which created this product, add template 'new-product-to-partner' with variables {productId}, {title}, {ownerId}, {ownerEmail}, {owner}, {link}.
If product is moderated and status is 'accept' the mail 'accept-product-to-owner' will be sent. You may use variables: {title}, {ownerEmail}, {owner}, {link}
Dektrium-User module: https://github.com/dektrium/yii2-user