Jak programowo dodać blok CMS w Magento 2?

13

Muszę dodać blok CMS za pomocą skryptu instalacji / aktualizacji. Już wymyśliłem, jak dodać „normalne” strony CMS, jak widać w skrypcie poniżej. Ale ponieważ nie mogę znaleźć żadnego sposobu na dodanie bloków CMS w kodzie Magento 2, w Google lub tutaj, jestem dość zablokowany.

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();
    }
}

Rozumiem, że nie potrzebuję wszystkich wartości zdefiniowanych w $testPagetablicy, więc zredukowałem to do następujących:

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

Czy ktoś wie, co muszę zmienić, aby ta strona testowa stała się blokiem testowym?

Uwaga: Oparłem skrypt na skrypcie danych instalacyjnych w module Magento 2 CMS znajdującym się w vendor/magento/module-cms/Setup/InstallData.php.

7ochem
źródło
To nie jest „blok CMS”, ale „strona CMS” .. mylący tytuł ..
OZZIE
@OZZIE To nie jest. Gdybyście przeczytali opis, wiedzielibyście, że powyższy kod rzeczywiście dodaje stronę, ale pytanie polega na zmianie jej na instalator bloku CMS.

Odpowiedzi:

20

dodaj to do swojej klasy:

private $blockFactory;

i spraw, aby Twój konstruktor wyglądał tak:

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

możesz nawet usunąć $pageFactoryzależność, jeśli już jej nie potrzebujesz.

Następnie zamień:

$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();

z

$testBlock = [
    'title' => 'Test block title',
    'identifier' => 'test-block',
    'stores' => [0],
    'is_active' => 1,
];
$this->blockFactory->create()->setData($testBlock)->save();
Marius
źródło
2
Coś we mnie mówi mi, że sam mogłem to zrozumieć. Ładna i łatwa odpowiedź. Dziękuję Ci bardzo. PS: Chciałbym podnieść głos na twoją odpowiedź, ale moja reputacja mi na to nie pozwala.
Proste ale efektywne. @KeesHak Głosowałem za tobą: P
7ochem
@KeesHak lepiej używać interfejsu danych (BlockInterface) i repozytoriów (BlockRepositoryInterface) zamiast fabryk.
Vasilii Burlacu
@VasiliiBurlacu Masz rację. Napisałem to 1,5 roku temu, gdy repozytoria nie zostały jeszcze ukończone.
Marius
13

Możesz wypróbować następujące rozwiązanie:

Dodaj 2 klasy do konstruktora:

/**
 * @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;
}

I użyj ich w następujący sposób:

$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);

Kod działa. Oto wynik tego bloku:

wprowadź opis zdjęcia tutaj

MageWorx
źródło
Zaimplementowałem również funkcję repozytorium bloków, aby zapisać blok. Wydaje się to nieco lepszą praktyką. Dziękuję Ci.
0

Jeśli moduł wymaga aktualizacji, użyj UpgradeData.php i wykonaj poniższe kroki.

  1. zwiększ setup_version w module.xml
  2. Przejdź do katalogu instalacyjnego i utwórz UpgradeData.php
  3. Zaimportuj jego zależności w następujący sposób,

    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();
       }
    }
    
TS Guhan
źródło