systemkdです。
年単位で放置していたブログ。
久々のプラグイン作成とともに復活させてみます。
(見た目とか気にせず書く)
受注対応状況拡張プラグイン
EC-CUBE オーナーズストアで販売しておりますので、気になりましたら詳細みてください。
[Ver6.0]
EC-CUBE関連を中心に扱っております。
EC-CUBE4のプラグインを色々と作ってます。(EC-CUBE3系のプラグインもあります)
もうAndroidに戻れそうにないのでweb + google関連で進んでいきたいと思っております。
systemkdです。
年単位で放置していたブログ。
久々のプラグイン作成とともに復活させてみます。
(見た目とか気にせず書く)
EC-CUBE オーナーズストアで販売しておりますので、気になりましたら詳細みてください。

namespace Plugin\PlgPatch; // 環境に合わせて変更
use Eccube\Entity\Plugin;
use Eccube\Exception\PluginException;
use Eccube\Plugin\AbstractPluginManager;
use Eccube\Repository\PluginRepository;
use Eccube\Service\PluginService;
use Eccube\Util\CacheUtil;
use Eccube\Util\StringUtil;
use Symfony\Component\DependencyInjection\ContainerInterface;
use Symfony\Component\Filesystem\Filesystem;
use Symfony\Component\Finder\Finder;
class PluginManager extends AbstractPluginManager
{
/** @var PluginRepository */
protected $pluginRepository;
/** @var CacheUtil */
protected $cacheUtil;
/** @var PluginService */
protected $pluginService;
private $upFileName;
private $plgCode;
private const PLG_PATH = __DIR__ . '/Resource/upfile/';
/**
* @param array $meta
* @param ContainerInterface $container
* @throws PluginException
*/
public function enable(array $meta, ContainerInterface $container)
{
log_info('[PlgPatch]パッチ適用開始');
$this->initialize($container);
log_info('[PlgPatch]更新対象プラグインの存在チェック開始');
$Plugin = $this->getPlugin();
log_info('[PlgPatch]更新対象プラグインの存在チェック終了');
// プラグインの手動アップデート
$this->plgManualUpdate($Plugin);
log_info('[PlgPatch]パッチ適用完了');
}
/**
* @param ContainerInterface $container
*/
private function initialize(ContainerInterface $container)
{
$this->pluginRepository = $container->get(PluginRepository::class);
$this->cacheUtil = $container->get(CacheUtil::class);
$this->pluginService = $container->get(PluginService::class);
$finder = Finder::create()
->in(self::PLG_PATH)
->files();
/** @var \SplFileInfo $item */
foreach ($finder as $item) {
$this->upFileName = $item->getFilename();
$fileName = explode(".", $item->getFilename());
$this->plgCode = $fileName[0];
}
}
/**
* @param string $plgCode
* @return Plugin
* @throws PluginException
*/
private function getPlugin($plgCode = "")
{
if (empty($plgCode)) {
$plgCode = $this->plgCode;
}
/** @var Plugin $Plugin */
$Plugin = $this->pluginRepository->findOneBy(['code' => $plgCode]);
if (!$Plugin) {
log_error("[PlgPatch]更新対象プラグインがインストールされていません。");
throw new PluginException("[PlgPatch]更新対象プラグインがインストールされていません。");
}
return $Plugin;
}
/**
* @param Plugin $Plugin
* @param string $upFileName
* @throws PluginException
*/
private function plgManualUpdate(Plugin $Plugin, $upFileName = "")
{
$fs = new Filesystem();
if ($upFileName == "") {
$upFileName = $this->upFileName;
}
$upFilePath = self::PLG_PATH . $upFileName;
/** @var CacheUtil $cacheUtil */
$cacheUtil = $this->cacheUtil;
/** @var PluginService $pluginService */
$pluginService = $this->pluginService;
// ファイル配置
$tmpDir = null;
try {
$cacheUtil->clearCache();
$tmpDir = $pluginService->createTempDir();
$tmpFile = sha1(StringUtil::random(32)) . '.tar.gz';
log_info('[PlgPatch]プラグインファイルコピー開始', [
'origin' => $upFilePath,
'target' => $tmpDir . '/' . $tmpFile,
]);
$fs->copy($upFilePath, $tmpDir . '/' . $tmpFile, true);
log_info('[PlgPatch]プラグインファイルコピー完了');
log_info('[PlgPatch]Update', [$Plugin]);
$pluginService->update($Plugin, $tmpDir . '/' . $tmpFile);
log_info('[PlgPatch]一時ディレクトリから削除', [$tmpDir]);
$fs->remove($tmpDir);
log_info('[PlgPatch]一時ディレクトリから削除完了');
return;
} catch (PluginException $e) {
if (!empty($tmpDir) && file_exists($tmpDir)) {
$fs = new Filesystem();
$fs->remove($tmpDir);
}
$message = $e->getMessage();
log_error('[PlgPatch]' . $message);
throw $e;
} catch (\Exception $er) {
// Catch composer install error | Other error
if (!empty($tmpDir) && file_exists($tmpDir)) {
$fs = new Filesystem();
$fs->remove($tmpDir);
}
log_error('plugin install failed.', ['original-message' => $er->getMessage()]);
throw $er;
}
}
}
SYSTEM_KDです。
EC-CUBE4でのプラグイン開発時メモです。
EC-CUBE4系では、traitを用いてEntityを拡張できるようにEntityの拡張機構が用意されています。
※Entity拡張機構
これによって、プラグインから本体のEntityを拡張することができるのですが、プラグインで追加したEntityを別のプラグインから拡張しようとして、微妙にハマってしまったとメモになります。
/**
* Trait LabTrait
* @Eccube\EntityExtension("Plugin\TargetPlugin\Entity\TargetClass")
*/
trait LabTrait
{
public function getDummy()
{
return "xxx";
}
}
※これを実施しておかないと、proxy生成は成功するけど生成されたファイルを削除しないと、それ以降どうしようもなくなってしまうので注意
if (!class_exists('\Plugin\TargetPlugin\Entity\TargetClass')) {
/**
* TargetClass
*
* [略]
*/
class TargetClass extends \Eccube\Entity\AbstractEntity
{
・・・
}
}
これでOKっと思ったけど、ここがハマりポイントでした。
これだと、bin/console eccube:generate:proxies を実行した際にエラーが発生してしまいました。
プラグインのEntityは拡張できないのかなと思いつつ、EC-CUBEの拡張機構部分のコードを追ってみると、}の後に改行が欲しそうな雰囲気だったので、付け足してみたら解決しました。
(実は環境の問題とかって可能性もあるのかな・・・)
if (!class_exists('\Plugin\TargetPlugin\Entity\TargetClass')) {
/**
* TargetClass
*
* [略]
*/
class TargetClass extends \Eccube\Entity\AbstractEntity
{
・・・
}
}
// ← 最後の空行部分
ということで、Pluginで追加したEntityを別Pluginにて拡張する際のメモでした。
bin/console doctrine:migrations:generate
public function enable(array $meta, ContainerInterface $container)
{
$this->migration($meta['code'], $container);
}
public function uninstall(array $meta, ContainerInterface $container)
{
$this->migration($meta['code'], $container, 0);
}
use ContainerAwareTraitを差し込んであげれば、ContainerInterfaceを使えるようになると見せかけて、ならない。Eccube\Plugin\AbstractPluginManagerのmigration 関数をベースにちょっと書き換えます。class PluginManager extends AbstractPluginManager
{
/**
* @param array $meta
* @param ContainerInterface $container
* @throws MigrationException
*/
public function uninstall(array $meta, ContainerInterface $container)
{
$this->pluginMigration($meta, $container, 0);
}
/**
* * @param array $meta
* @param ContainerInterface $container
* @throws MigrationException
*/
public function enable(array $meta, ContainerInterface $container)
{
$this->pluginMigration($meta, $container);
}
protected function pluginMigration(array $meta, ContainerInterface $container, $version = null)
{
$migrationFilePath = __DIR__ . '/DoctrineMigrations';
$connection = $container->get('database_connection');
$pluginCode = $meta['code'];
$config = new Configuration($connection);
$config->setMigrationsNamespace('\Plugin\\' . $pluginCode . '\DoctrineMigrations');
$config->setMigrationsDirectory($migrationFilePath);
$config->registerMigrationsFromDirectory($migrationFilePath);
$config->setMigrationsTableName(self::MIGRATION_TABLE_PREFIX . $pluginCode);
/** @var Version $objVersion */
foreach ($config->getMigrations() as $objVersion) {
$versionMigration = $objVersion->getMigration();
if ($versionMigration instanceof ContainerAwareInterface) {
$versionMigration->setContainer($container);
}
}
$migration = new Migration($config);
$migration->migrate($version, false);
}
}
/** @var Version $objVersion */
foreach ($config->getMigrations() as $objVersion) {
$versionMigration = $objVersion->getMigration();
if ($versionMigration instanceof ContainerAwareInterface) {
$versionMigration->setContainer($container);
}
}
final class VersionXXX extends AbstractMigration implements ContainerAwareInterface
{
use ContainerAwareTrait;
public function up(Schema $schema): void
{
/** @var EntityManagerInterface $entityManager */
$entityManager = $this->container->get('doctrine.orm.entity_manager');
$ProductRepository = $entityManager->getRepository(Product::class);
}
public function down(Schema $schema): void
{
}
}



