Magento 2でプログラムでCMSブロックを追加する方法は?


13

インストール/アップグレードスクリプトを使用してCMSブロックを追加する必要があります。以下のスクリプトに見られるように、「通常の」CMSページを追加する方法をすでに理解しています。しかし、Magento 2のコード(Googleまたはここ)にCMSブロックを追加する方法を見つけることができないため、非常に困っています。

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'
];

このテストページをテストブロックにするために何を変更する必要があるか、誰にもわかりますか?

注:スクリプトは、にあるMagento 2 CMSモジュールのインストールデータスクリプトに基づいていますvendor/magento/module-cms/Setup/InstallData.php


これは「CMSブロック」ではなく、「CMSページ」..誤解を招くタイトルです
。-オジー

@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();
       }
    }
弊社のサイトを使用することにより、あなたは弊社のクッキーポリシーおよびプライバシーポリシーを読み、理解したものとみなされます。
Licensed under cc by-sa 3.0 with attribution required.