Як програмно додати блок 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. Перейдіть у каталог налаштувань та створіть 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.