Come aggiungere un blocco CMS a livello di codice in Magento 2?


13

Devo aggiungere un blocco CMS tramite uno script di installazione / aggiornamento. Ho già capito come aggiungere pagine CMS "normali" come si vede nello script qui sotto. Ma dal momento che non riesco a trovare alcun modo per aggiungere blocchi CMS nel codice di Magento 2, su Google o qui, sono abbastanza bloccato.

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

Capisco che non ho bisogno di tutti i valori definiti $testPagenell'array, quindi l'ho ridotto a quanto segue:

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

Qualcuno sa cosa devo modificare per trasformare questa pagina di test in un blocco di test?

Nota: ho basato il mio script sullo script di dati di installazione nel modulo CMS Magento 2 situato in vendor/magento/module-cms/Setup/InstallData.php.


Questo non è un "blocco CMS" ma una "pagina CMS" .. titolo fuorviante ..
OZZIE

@OZZIE Non lo è. Se avessi letto la descrizione, avresti saputo che il codice sopra è quello di aggiungere una pagina, ma la domanda è cambiarla in un programma di installazione del blocco CMS.

Risposte:


20

aggiungi questo alla tua classe:

private $blockFactory;

e fai apparire il tuo costruttore così:

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

puoi persino rimuovere la $pageFactorydipendenza se non ti serve più.

Quindi sostituire:

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

con

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

2
Qualcosa dentro di me mi dice che avrei potuto capirlo da solo. Risposta semplice e piacevole. Grazie mille. PS: Vorrei votare la tua risposta, ma la mia reputazione non mi permette.

Semplice ma efficace. @KeesHak L'ho votato per te: P
ottobre

@KeesHak utilizza meglio l'interfaccia dati (BlockInterface) e i repository (BlockRepositoryInterface) anziché le fabbriche.
Vasilii Burlacu,

@VasiliiBurlacu Hai ragione. L'ho scritto 1,5 anni fa quando i repository non erano ancora finiti.
Marius

13

Puoi provare la seguente soluzione:

Aggiungi 2 classi al costruttore:

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

E usali nel modo seguente:

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

Il codice funziona. Ecco il risultato per questo blocco:

inserisci qui la descrizione dell'immagine


Ho implementato anche la funzionalità del repository di blocchi per salvare il blocco. Sembra una pratica leggermente migliore. Grazie.

0

Se il tuo modulo richiede l'aggiornamento, utilizza UpgradeData.php e segui i passaggi seguenti.

  1. aumentare setup_version in module.xml
  2. Vai alla directory di installazione e crea UpgradeData.php
  3. Importa le sue dipendenze come segue,

    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();
       }
    }
Utilizzando il nostro sito, riconosci di aver letto e compreso le nostre Informativa sui cookie e Informativa sulla privacy.
Licensed under cc by-sa 3.0 with attribution required.