akeneo-labs/extension-starter

Akeneo PIM 扩展入门

维护者

详细信息

github.com/akeneo-labs/ExtensionStarter

源代码

问题

安装: 48

依赖项: 0

建议者: 0

安全: 0

星标: 6

关注者: 6

分支: 6

开放问题: 1

类型:symfony-bundle

v0.2.0 2016-12-12 08:42 UTC

Requires

Requires (Dev)

OSL-3.0 0d09d9ca42876f100a1a2a2dedec9baf555f3482

  • JM Leroux <jean-marie.leroux@akeneo.com>

extensionPIMakeneo

This package is auto-updated.

Last update: 2024-09-20 22:31:17 UTC

README

[实验性] 快速设置您自己的 Akeneo PIM 扩展的入门套件

Build Status

要求

使用此入门套件

上下文

我们的扩展旨在作为现有 PIM 安装的组成部分运行，因此我们将使用 PIM 社区标准版来托管连接器。此示例宿主容器将位于我们的文件系统中的 /tmp/pim-standard-edition。

假设你在 WorldCompany 工作，并且连接器名称是 WorldExtension。一个广泛使用的做法是将公司名称用作根命名空间。

COMPANY_NAME=WorldCompany
PIM_PATH=/tmp/pim-standard-edition
EXTENSION_NAME=WorldExtension

标准版的初始化

使用标准版创建一个新的宿主项目

composer create-project --prefer-dist akeneo/pim-community-standard ${PIM_PATH} "1.5.*@stable"

这将下载标准版，但不包含 git 信息。

在这个阶段，你有三种方法来开发你的扩展

  • 直接在标准版 src 目录中工作
  • 通过符号链接在标准版 src 目录中工作
  • 在 vendors 目录中工作

在 src 目录中工作

在这种组织结构中，我们将在宿主项目中工作。当你真正从零开始你的项目时，你可以以这种方式工作。当你已经提交了一些更改时，你可能会切换到使用符号链接或 vendors 目录的工作方式。

pim-standard-edition
└── src
    └── WorldCompany
        ├── WorldConnectorExtension.php
        ├── composer.json
        └── ...

完整的过程在install-standalone.md 文档中有详细说明。

使用符号链接工作

待办事项

在 vendor 目录中工作

如果我们的扩展需要一些 composer 依赖项，我们将别无选择，只能在 vendor 中工作，以便使其与我们的标准版安装一起工作。

最佳实践

我们维护了一份关于[扩展开发最佳实践]的在线文档（http://docs.akeneo.com/latest/reference/best_practices/reusable_bundle.html）。

## 功能清单我们还维护了一个功能清单，你应检查连接器或扩展的功能：doc/checklist.md

其他文档