swissup/core

Swissup core module. It's purpose is to add menu and config placeholders

1.12.21 2024-12-12 09:05 UTC

Requires

• swissup/module-core: ^1.12.21

OSL-3.0

README

Contents

1. Installation
2. Swissup Installer Usage
3. Swissup Upgrade Class
4. Popup Message Manager

Installation

cd <magento_root>
composer require swissup/core
bin/magento module:enable Swissup_Core
bin/magento setup:upgrade

Swissup Installer Usage

Swissup installer is a class that collects Swissup Upgrades from all module dependencies and run them, if needed.

Lets see the example of how the Argento theme installer is working:

$module = $this->_objectManager->create('Swissup\Core\Model\Module');
$module->load('Swissup_ArgentoDefault')
    ->setNewStores([0])
    ->up();

What does this code do?

1. Create Swissup\Core\Model\Module object.
2. Load module info for Swissup_ArgentoDefault module from composer.json file.
3. Set the store to use (All Stores).
4. Run installer:
   1. Search for Swissup\Upgrade classes for all depends of Swissup_ArgentoDefault module.
   2. Run getOperations and up command for each of the found upgrade class.
   3. Run getOperations and up command of Swissup_ArgentoDefault upgrade class.

Swissup Upgrade Class

When module or theme needs to run some extra logic for specified store views, it's very handy to use Swissup\Upgrade class, which allows to create and automatically backup various content types and configuration.

Why not to use Magento DataUpgrade?

• It does not allow to run upgrade multiple times (reinstall)
• It does not have built-in methods to change store configuration
• It does not support content backups

Swissup upgrades — are migrations, located at <module_dir>/Upgrades directory. Upgrade class must implement Swissup\Core\Api\Data\ModuleUpgradeInterface.

Upgrade examples:

Swissup/ArgentoDefault/Upgrades/1.0.0_initial_installation.php
Swissup/ArgentoDefault/Upgrades/1.0.1_add_callout_blocks.php
Swissup/ArgentoDefault/Upgrades/1.1.0_create_featured_products.php

Upgrade naming conventions

1.0.0       _               initial_installation   .php
^ version   ^ Separator     ^ ClassName            ^ file extension

Class example:

<?php

namespace Swissup\ArgentoDefault\Upgrades;

class InitialInstallation extends \Swissup\Core\Model\Module\Upgrade
{
    public function up()
    {
        // This method is optional.
        // Additional logic may be placed here.
    }

    public function getCommands()
    {
        return [
            'Configuration' => [
                'prolabels/on_sale/product/active'  => 1,
                'prolabels/on_sale/category/active' => 1,
                'prolabels/is_new/product/active'   => 1,
                'prolabels/is_new/category/active'  => 1,
            ],

            'CmsBlock' => [
                'header_callout' => [
                    'title' => 'header_callout',
                    'identifier' => 'header_callout',
                    'is_active' => 1,
                    'content' => 'content'
                ]
            ]

            'ProductAttribute' => [
                [
                    'attribute_code' => 'featured',
                    'frontend_label' => array('Featured'),
                    'default_value'  => 0
                ]
            ],

            'Products' => [
                'featured'       => 6,
                'news_from_date' => 6
            ]
        ];
    }
}

Supported Commands

Popup Message Manager

Popup message manager allows to show regular Magento messages with additional information in popup window.

Usage example

Inject \Swissup\Helper\PopupMessageManager component into your controller action and use it instead of built-in \Magento\Framework\Message\Manager:

$this->popupMessageManager->addError(
    __('Decoding failed: Syntax error'),
    $popupText,
    $popupTitle
);