当前位置: 技术文章>> magento2中的InstallSchema脚本-installschema.php文件介绍

文章标题:magento2中的InstallSchema脚本-installschema.php文件介绍
  • 文章分类: Magento
  • 20429 阅读
系统学习magento二次开发,推荐小册:《Magento中文全栈二次开发 》

本小册面向Magento2以上版本,书代码及示例兼容magento2.0-2.4版本。涵盖了magento前端开发,后端开发,magento2主题,magento2重写,magento2 layout,magento2控制器,magento2 block等相关内容,带领您成为magento开发技术专家。


当我们希望向现有表添加新列或创建新表时,将使用InstallSchema脚本。此脚本仅在启用模块时运行。

一旦启用,模块就会在setup_module.schema_version表列下获得相应的条目。

此条目阻止InstallSchema脚本在模块的setup_version保持不变的任何后续setup:upgrade命令上运行。

让我们继续创建<MAGELICIOUS_DIR>/Core/Setup/InstallSchema.php文件,其中包含以下内容:

use\ Magento\ Framework\ Setup\ InstallSchemaInterface;
use Magento\ Framework\ Setup\ ModuleContextInterface;
use Magento\ Framework\ Setup\ SchemaSetupInterface;
class InstallSchema implements InstallSchemaInterface {
    public function install(SchemaSetupInterface $setup, ModuleContextInterface $context) {
        $setup - > startSetup();
        echo 'InstallSchema->install()'.PHP_EOL;
        $setup - > endSetup();
    }
}

使用$setup->startSetup();和$setup->endSetup();是大多数设置脚本中的常见做法。

这两种方法的实现涉及运行额外的环境设置步骤,例如设置SQL_MODE和FOREIGN_KEY_CHECKS,如在Magento\Framework\DB\Adapter\Pdo\Mysql下所示。

为了从中获得有用的东西,让我们继续使用实际创建我们的magelicious_core_log表的代码来替换echo行:


<?php
$table = $setup->getConnection()->newTable($setup->getTable('magelicious_core_log'))
    ->addColumn('entity_id', \Magento\Framework\DB\Ddl\Table::TYPE_INTEGER, null,
        ['identity' => true, 'unsigned' => true, 'nullable' => false, 'primary' => true],
        'Entity ID')
   
    ->addColumn('severity_level', \Magento\Framework\DB\Ddl\Table::TYPE_TEXT,
    24, ['nullable' => false], 'Severity Level')
   
    ->addColumn('note', \Magento\Framework\DB\Ddl\Table::TYPE_TEXT,
    null, ['nullable' => false], 'Note')
   
    ->addColumn('created_at', \Magento\Framework\DB\Ddl\Table::TYPE_TIMESTAMP, null,
    ['nullable' => false], 'Created At')
   
    ->setComment('Magelicious Core Log Table');
    $setup->getConnection()->createTable($table);

$setup->getConnection()为我们获取数据库适配器实例。从那时起,我们可以访问创建数据库表所需的方法。

当涉及到InstallSchema脚本时,大多数情况下,以下方法可以完成任务:


newTable:为新表检索DDL对象

addColumn:向表中添加列

addIndex:向表添加索引

addForeignKey:向表添加外键

comment:为表设置注释

createTable:从DDL对象创建表此处的magelicious_core_log表本质上是magelicious\core\Model\log简单模型后面的存储。

如果我们的模型是EAV模型,我们将使用相同的InstallSchema脚本来创建如下表:


log_entity

log_entity_datetime

log_entity_decimal

log_entity_int

log_entity_text

log_entity_varchar


然而,在EAV模型的情况下,实际的属性severity_level和note可能会通过InstallData脚本添加。

这是因为属性定义本质上是eav_attribute_*表下的数据,主要是eav_attribute表。

因此,属性是在InstallData和UpgradeData脚本内部创建的。


推荐文章