studioespresso / craft-seeder
Craft CMS 的简单条目生成器
Requires
- craftcms/cms: ^3.1.0
- fzaninotto/faker: ^1.7.0
Requires (Dev)
- codeception/codeception: 2.4.2
README
使用方法
Seeder 允许您通过命令行快速创建示例条目。当您完成网站建设后,可以轻松删除示例数据。安装插件后,运行 ./craft help seeder/generate
将显示可用的命令
由于该插件仅在开发过程中有用,而不是在实时网站上,因此为其收费是愚蠢的(您可以每次都免费试用)。相反,您可以免费下载它,如果您想支持未来的开发,您可以在 beerpay.io 上支持它。谢谢!
安装
要安装插件,请按照以下说明操作。
-
打开您的终端并转到您的 Craft 项目
cd /path/to/project
-
然后告诉 Composer 加载插件
composer require studioespresso/craft-seeder
-
在控制面板中,转到设置 → 插件,然后点击 "Seeder" 的 "安装" 按钮。
使用方法
条目(章节 ID/handle,siteId,数量)
使用以下命令,然后跟随着 --section
选项和您想要创建的条目 --number
(如果省略,则默认为 20)。此命令适用于章节 ID 和 handle。
您还可以添加 siteId
参数为特定网站生成条目。这将使用默认网站作为后备。
./craft seeder/generate/entries --section=news --count=15
分类(分类组 ID/handle,数量)
./craft seeder/generate/categories --group=labels --count=10
用户(用户组 ID/handle,数量)
./craft seeder/generate/users --group=editors --count=5
清理
完成网站建设后,插件为您提供了一种轻松删除示例数据(条目、资产、分类和用户)的方法。这可以通过 CP(点击侧边栏的 Seeder 部分)或通过以下命令通过命令行完成
./craft seeder/clean-up/all
配置选项
eachMatrixBlock
- 在矩阵字段中生成所有块类型
对于矩阵,插件将在字段允许的最小和最大块数量内获取一组随机的块类型。
将此设置设置为 true
,我们将按随机顺序生成每种块类型的一个块。这是一种测试页面构建器/内容构建器字段的好方法。
useLocalAssets
- 使用网站中已有的资产来填充资产字段
'useLocalAssets' => [ 'volumeId' => 1, 'path' => 'test/' ]
将上面的数组添加到 config/seeder.php
,以使用卷 1
和文件夹 test/
中的资产进行填充。
fields
- 基本字段配置
'fields' => [ "sessions" => "ignore", "radioField" => [ 'value' => 'value2', ], "category" => [ 'mode' => 'random', 'value' => [152, 153] ] ]
以下是一些基本示例,说明您如何为每个字段定义填充设置。字段处理程序应该是数组中的键,目前可用的选项如下
- "ignore" => 在填充时跳过该字段
["value" => "some string" ]
=> 用于设置纯文本字段、复选框和单选按钮的固定值。["mode" => "random", "value" => [1, 2] ]
=> 与条目和分类字段一起使用,值应该是那些条目的ID。
故障排除
插件最常见的错误是得到以下错误
Unknown command: seeder/generate/entries
如果您已将插件安装在CP中并看到此消息,Craft无法通过命令行连接到您的数据库。您的网站可能工作正常,但CLI命令不会。
如果您正在运行MAMP/XAMP,应使用127.0.0.1
作为主机名,而不是localhost
。
路线图
核心元素
- 条目
- 分类
- 用户
- 条目字段
核心字段
- 标题
- 纯文本
- 电子邮件
- 网址
- 颜色
- 日期
- 条目
- 分类
- 下拉菜单
- 复选框
- 单选按钮
- 多选
- 资产
- 矩阵
- 轻触开关
- 表格
- 标签
- 用户
插件元素
- 商品和变体