Как программно добавить блок CMS в Magento 2?


13

Мне нужно добавить блок CMS через скрипт установки / обновления. Я уже разобрался, как добавить «нормальные» страницы CMS, как показано в скрипте ниже. Но так как я не могу найти способ добавить блоки CMS в код Magento 2, в Google или здесь, я довольно застрял.

namespace [Vendor]\[Module]\Setup;

use Magento\Cms\Model\Page;
use Magento\Cms\Model\PageFactory;
use Magento\Framework\Setup\ModuleContextInterface;
use Magento\Framework\Setup\ModuleDataSetupInterface;
use Magento\Framework\Setup\UpgradeDataInterface;

class UpgradeData implements UpgradeDataInterface
{
    /**
     * Page factory.
     *
     * @var PageFactory
     */
    private $pageFactory;

    /**
     * Init.
     *
     * @param PageFactory $pageFactory
     */
    public function __construct(PageFactory $pageFactory)
    {
        $this->pageFactory = $pageFactory;
    }

    /**
     * Upgrade.
     *
     * @param ModuleDataSetupInterface $setup
     * @param ModuleContextInterface $context
     */
    public function upgrade(ModuleDataSetupInterface $setup, ModuleContextInterface $context)
    {
        $setup->startSetup();

        if (version_compare($context->getVersion(), '0.0.1') < 0) {
            $testPage = [
                'title' => 'Test page title',
                'identifier' => 'test-page',
                'stores' => [0],
                'is_active' => 1,
                'content_heading' => 'Test page heading',
                'content' => 'Test page content',
                'page_layout' => '1column'
            ];

            $this->pageFactory->create()->setData($testPage)->save();
        }

        $setup->endSetup();
    }
}

Я понимаю, что мне не нужны все значения, определенные в $testPageмассиве, поэтому я сократил его до следующего:

$testPage = [
    'title' => 'Test block title',
    'identifier' => 'test-block',
    'stores' => [0],
    'is_active' => 1
    'content' => 'Test block content'
];

Кто-нибудь знает, что мне нужно изменить, чтобы превратить эту тестовую страницу в тестовый блок?

Примечание: мой сценарий основан на сценарии данных установки в модуле CMS Magento 2, расположенном в vendor/magento/module-cms/Setup/InstallData.php.


Это не «блок CMS», а «страница CMS» .. вводящее в заблуждение название ..
OZZIE

@ OZZIE Это не так. Если бы вы прочитали описание, вы бы знали, что приведенный выше код действительно добавляет страницу, но вопрос заключается в том, чтобы изменить ее на установщик блока CMS.

Ответы:


20

добавьте это к вашему классу:

private $blockFactory;

и сделайте ваш конструктор похожим на это:

public function __construct(
    PageFactory $pageFactory,
    \Magento\Cms\Model\BlockFactory $blockFactory
  )
{
    $this->pageFactory = $pageFactory;
    $this->blockFactory = $blockFactory;
}

Вы даже можете удалить $pageFactoryзависимость, если она вам больше не нужна.

Затем замените:

$testPage = [
    'title' => 'Test page title',
    'identifier' => 'test-page',
    'stores' => [0],
    'is_active' => 1,
    'content_heading' => 'Test page heading',
    'content' => 'Test page content',
    'page_layout' => '1column'
];

$this->pageFactory->create()->setData($testPage)->save();

с

$testBlock = [
    'title' => 'Test block title',
    'identifier' => 'test-block',
    'stores' => [0],
    'is_active' => 1,
];
$this->blockFactory->create()->setData($testBlock)->save();

2
Что-то внутри меня говорит мне, что я сам мог бы это понять. Хороший и простой ответ. Большое спасибо. PS: Я бы хотел, чтобы ты проголосовал за тебя, но моя репутация не позволит мне.

Простой, но эффективный. @KeesHak Я проголосовал за это за вас: P
7ochem

@KeesHak лучше использовать интерфейс данных (BlockInterface) и репозитории (BlockRepositoryInterface) вместо фабрик.
Василий Бурлаку

@VasiliiBurlacu Вы правы. Я написал это 1,5 года назад, когда хранилища еще не были закончены.
Мариус

13

Вы можете попробовать следующее решение:

Добавьте 2 класса в конструктор:

/**
 * @var \Magento\Cms\Model\BlockFactory
 */
protected $blockFactory;

/**
 * @var \Magento\Cms\Model\BlockRepository
 */
protected $blockRepository;

/**
 * @param PageFactory $resultPageFactory
 * @param \Magento\Cms\Model\BlockFactory $blockFactory
 * @param \Magento\Cms\Model\BlockRepository $blockRepository
 */
public function __construct(
    PageFactory $resultPageFactory,
    \Magento\Cms\Model\BlockFactory $blockFactory,
    \Magento\Cms\Model\BlockRepository $blockRepository
) {
    $this->resultPageFactory = $resultPageFactory;
    $this->blockFactory = $blockFactory;
    $this->blockRepository = $blockRepository;
}

И используйте их следующим образом:

$data = [
    'title' => 'Test block title',
    'identifier' => 'test-block',
    'stores' => ['0'],
    'is_active' => 1,
    'content' => 'Test block content'
];
$newBlock = $this->blockFactory->create(['data' => $data]);
$this->blockRepository->save($newBlock);

Код работает. Вот результат для этого блока:

введите описание изображения здесь


Я также реализовал функциональность хранилища блоков, чтобы сохранить блок. Кажется, немного лучше практики. Спасибо.

0

Если ваш модуль требует обновления, используйте UpgradeData.php и выполните следующие шаги.

  1. увеличить setup_version в module.xml
  2. Goto Настройка каталога и создать UpgradeData.php
  3. Импортируйте его зависимости следующим образом:

    namespace Vendor\YourModule\Setup;
    
    use Magento\Framework\Setup\UpgradeDataInterface;
    use Magento\Framework\Setup\ModuleContextInterface;
    use Magento\Framework\Setup\ModuleDataSetupInterface;
    use Magento\Cms\Model\BlockFactory;
    
    class UpgradeData implements UpgradeDataInterface {
    
    private $blockFactory;
    
    public function __construct(LoggerInterface $logger, BlockFactory $blockFactory) {
        $this->blockFactory = $blockFactory;
    }
    
    public function upgrade(ModuleDataSetupInterface $setup, ModuleContextInterface $context) {
    
        $setup->startSetup();
    
        if (version_compare($context->getVersion(), '1.1.0') < 0) {
            try{
              $staticBlockInfo = [
                        'title' => 'Title of Sample block',
                        'identifier' => 'sample_block',
                        'stores' => ['0'],
                        'is_active' => 1,
                        'content' => 'This is the sample block content'
                      ];
                $this->blockFactory->create()->setData($staticBlockInfo)->save();
            }catch (Exception $e){
                echo $e->getMessage();
            }
         }
    
         $setup->endSetup();
       }
    }
Используя наш сайт, вы подтверждаете, что прочитали и поняли нашу Политику в отношении файлов cookie и Политику конфиденциальности.
Licensed under cc by-sa 3.0 with attribution required.