¿Cómo agregar un bloque CMS mediante programación en Magento 2?

13

Necesito agregar un bloque CMS a través de un script de instalación / actualización. Ya he descubierto cómo agregar páginas CMS "normales" como se ve en el script a continuación. Pero como no puedo encontrar ninguna forma de agregar bloques CMS en el código de Magento 2, en Google o aquí, estoy bastante atascado.

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

Entiendo que no necesito todos los valores definidos en la $testPagematriz, así que lo reduje a lo siguiente:

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

¿Alguien sabe lo que necesito cambiar para convertir esta página de prueba en un bloque de prueba?

Nota: Basé mi script en el script de datos de instalación en el módulo Magento 2 CMS ubicado en vendor/magento/module-cms/Setup/InstallData.php.

7ochem
fuente
Esto no es un "Bloque CMS" sino una "Página CMS" ... título engañoso ...
OZZIE
@OZZIE No lo es. Si hubiera leído la descripción, habría sabido que el código anterior es para agregar una página, pero la pregunta es cambiarla a un instalador de bloques CMS.

Respuestas:

20

agregue esto a su clase:

private $blockFactory;

y haz que tu constructor se vea así:

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

incluso puede eliminar la $pageFactorydependencia si ya no la necesita.

Luego reemplace:

$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();
Marius
fuente
2
Algo dentro de mí me dice que podría haberlo descubierto yo mismo. Bonita y fácil respuesta. Muchas gracias. PD: Me gustaría votar tu respuesta, pero mi reputación no me lo permite.
Simple pero efectivo. @KeesHak Lo he votado por ti: P
7ochem
@KeesHak utiliza mejor la interfaz de datos (BlockInterface) y los repositorios (BlockRepositoryInterface) en lugar de las fábricas.
Vasilii Burlacu
@VasiliiBurlacu Tienes razón. Escribí esto hace 1,5 años cuando los repositorios aún no estaban terminados.
Marius
13

Puedes probar la siguiente solución:

Agregue 2 clases al constructor:

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

Y úselos de la siguiente manera:

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

El código está funcionando Aquí está el resultado de este bloque:

ingrese la descripción de la imagen aquí

MageWorx
fuente
También implementé la funcionalidad del repositorio de bloques para guardar el bloque. Parece una práctica ligeramente mejor de hecho. Gracias.
0

Si su módulo requiere actualización, use UpgradeData.php y siga los pasos a continuación.

  1. aumentar la versión_configuración en module.xml
  2. Ir al directorio de instalación y crear UpgradeData.php
  3. Importe sus dependencias de la siguiente manera,

    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
fuente