[Craft CMS 3]Super Tableプラグインを1.0.8から2.2.1にアップデートするとmigrationに失敗する件

Craft CMS 2.6からCraft CMS 3.2に一気にアップデートを行っても、基本的に問題ないのですが、Super Tableプラグインだけ、アップデートに失敗します。
$ ./craft update all
で、アップデートしたあと

$ ./craft migrate --type=app
本体のDBマイグレーションは成功しますが

$ ./craft migrate --plugin=super-table
Super Tableプラグインは外部キーの問題でALTER TABLEに失敗します。

エラーが出た場合の対処方法


1)バージョンアップ前に取ったバックアップでDBを復元する
2)一旦、Super Tableプラグインを削除する
$ composer remove verbb/super-table
3)Super Table 2.0.14をインストールする
$ composer require verbb/super-table:2.0.14
4)マイグレーションを実行
$ ./craft migrate --type=app
$ ./craft migrate --plugin=super-table
5)Super Tableプラグインを2.2.1にアップデートする
$ composer update all
6)再度、マイグレーションを実行
$ ./craft migrate --plugin=super-table



Craft CMS 3のプラグイン開発

とっかかりの部分だけをメモ。

プラグインの雛形を pluginfactory.io で作成する


https://pluginfactory.io/
ベンダー名 : package
プラグイン名 : name

Craft CMSのインストールディレクトリにdevフォルダを作成する


/craft3         /* Craft CMSのインストールディレクトリ */
/craft3/dev /* プラグイン用 */

※公式のサンプルだとCraft本体の外にプラグインディレクトリを作成していますが、IDEの都合上、同一ディレクトリのほうが都合がいい。

テンプレートを配置


ダウンロードしたzipを、/craft3/devに展開

composer.jsonに以下を追加


編集するのは/craft3/composer.json。urlに指定するのはプラグインのsrcディレクトリがある場所
  ,
"minimum-stability": "dev",
"prefer-stable": true,
"repositories": [
{
"type": "path",
"url": "../craft3/dev"
}
]


composerで反映する


$ cd /craft3
$ composer require package/name


これで、/craft3/vendor/package/nameディレクトリがシンボリックリンクとして作成されていれば成功。
/craft3/dev/src配下のファイルを編集すれば、動作確認しながら開発できます。

Craft 2の時のプラグインと構造が大分違うので、雛形を作ってからメソッド単位で移植するほうが早そう。

UTF-8なテキストファイルを指定行数ずつに分割する(PowerShell)

どこか忘れちゃったのですが、catでテキスト分割をする方法を書いているブログがあったのですが、それだとUTF-8なテキストファイルだと文字化けするので、UTF-8でも大丈夫な1000行ずつに分割する1行コマンドを書いたのでメモ。

PS > $i=0; Get-Content -ReadCount 1000 .¥sample.csv -Encoding UTF8 | % { $_ > dest$i.csv;$i++}


※でも、BOM付きになってしまうので、結局Git bashのsplitを使うことにしました…。

Craft CMSのcraft.entries.searchは安易に使ってはいけない話

以前のエントリーで、タグ検索は
$criteria          = craft()->elements->getCriteria(ElementType::Entry);
$criteria->section = "sampleSection";
$criteria->search = "sampleTags:test";
$entries = $criteria->find();

こう書くよ、と記載したのですが、エントリー数が数万〜数十万になると、とっても遅いのでした。

searchを使った場合、craft_searchindexテーブルが参照されるのですが、検索対象のIDが列挙されるので
SELECT * FROM craft_searchindex WHERE elementId IN (1,2,3,4,5,6,7,8 ...)

のように、WHERE IN句に、数万のIDが列挙されたりします。結果、生成されたSQLをMySQL Workbenchに貼り付けると、アプリが落ちるほど巨大なクエリーになります。

なので、正しいクエリー方法は以下のようになります。
$criteria = craft()->elements->getCriteria(ElementType::Tag);
$criteria->groupId = craft()->tags->getTagGroupByHandle('sampleGroup')->id;
$criteria->title = 'test';
$tags = $criteria->find();

$criteria = craft()->elements->getCriteria(ElementType::Entry);
$criteria->section = "sampleSection";
$criteria->relatedTo = ['targetElement' => $tags, 'field' => 'sampleTags'],
$entries = $criteria->find();

relatedToを使用した場合、craft_relationsテーブルを参照した割と普通なクエリーになります。

エントリー数が20万ほどある状況だと、searchを使ったタグ検索は4秒、relatedToを使ったタグ検索は0.1秒以下でした。なので、searchはエントリー総数が少ないセクションに限定して使わないとダメそうです。

【追記】
Twigで記述する場合に
{% set entries = craft.entries.section('sampleSection').relatedTo(tags) %}

のような書き方が普通みたいな感じになっていますが、エントリー数が多い場合は、これも遅いです。
fieldを指定したほうが、場合によっては数百倍速いので、ちゃんと指定しましょう。
{% set entries = craft.entries.section('sampleSection').relatedTo({'targetElement':tags, 'field':'sampleTags'}) %}

Craft CMS プラグインの作法(Matrixフィールド内にSuperTableフィールドがある場合の新規ブロック追加)

番外編。

Matrixフィールド内にSuperTableフィールドをレイアウトしている場合、プラグインから新規ブロックを追加するのが、結構わかりにくいです。

'sampleMatrix'フィールドに、'sampleBlock'というブロックがあり、そのブロックに'superTableField'というSuperTableフィールドがあるとします。
$matrix["new1"] = [
'type' => 'sampleBlock',
'enabled' => true,
'fields' => [
'textField' => 'abcdefg',
'numField' => 123456,
'superTableField' => [
'new1' => [
'type' => 0,
'enabled' => true,
'fields' => [
'columnOne' => 'sample one',
'columnTwo' => 'sample two',
],
],
],
],
];
$entry->setContentFromPost(array('sampleMatrix' => $matrix));
$success = craft()->entries->saveEntry($entry);
本当は、こう書きたいところですが、これではエラーになります…。
問題は、ブロック内のsuperTableFieldのtypeに設定するブロックタイプIDが決定していない点にあります。

ということで、ブロックタイプIDを取得するメソッドを作ってみます。
public function getSuperTableFieldId($ownerId, $matrixFieldHandle, $blockHandle, $tableFieldName) {
$criteria = craft()->elements->getCriteria(ElementType::MatrixBlock);
$criteria->ownerId = (int)$ownerId;
$criteria->type = $blockHandle;
$criteria->fieldId = (int)craft()->fields->getFieldByHandle($matrixFieldHandle)->id;
$blocks = $criteria->find();
if (!empty($blocks)) {
$blockTypes = craft()->superTable->getBlockTypesByFieldId($blocks[0]->$tableFieldName->fieldId);
if (!empty($blockTypes)) {
return $blockTypes[0]->id;
}
}
return false;
}
ただし、このメソッドはentryにmatrixブロックが1つ以上、存在する状態でないと機能しません。

以上を踏まえて、作成したメソッドを利用して新規ブロック追加をしてみます。
// 一旦superTableFieldは空にしておく
$matrix["new1"] = [
'type' => 'sampleBlock',
'enabled' => true,
'fields' => [
'textField' => 'abcdefg',
'numField' => 123456,
'superTableField' => [],
],
],
];

$entry->setContentFromPost(array('sampleMatrix' => $matrix));
// ブロックを追加するために、一旦保存
$success = craft()->entries->saveEntry($entry);

// superTableFieldを追加
$table["new1"] = [
'type' => $this->getSuperTableFieldId($entry->id, 'sampleMatrix', 'sampleBlock', 'superTableField'),
'enabled' => true,
'fields' => [
'columnOne' => 'sample one',
'columnTwo' => 'sample two',
],
];
$matrix['new1']['fields'][] = $table;

$entry->setContentFromPost(array('sampleMatrix' => $matrix));
$success = craft()->entries->saveEntry($entry);

一旦saveEntry()を実行してブロックを保存していますが、ブロックだけ更新するような場合は、MatrixServiceのsaveBlock()でも良いと思います。ただ、エントリーの他のフィールドも一緒に更新する場合は、saveEntry()でまとめて保存してしまったほうが良い気もするので、お好みで。

Craft CMS プラグインの作法(メール関連)

Craft CMSの設定ページでメールテンプレートを編集できますが、そのテンプレートを追加したい場合の方法。

1)プラグイン本体に、registerEmailMessages()を書く。配列に記述するのはテンプレートのキー名。
public function registerEmailMessages() {
return array(
'template_one',
'template_two',
);
}


2)プラグインのtranslationsフォルダにja.phpやen.phpを作成して、各言語毎のデフォルトテンプレートを定義する。
return array(
'template_one_heading' => 'hogehogeされた時',
'template_one_subject' => 'メール件名',
'template_one_body' => "Dear {{ user.username }}¥n¥n" . "本文.¥n¥n",
'template_two_heading' => 'hogehogeされた時',
'template_two_subject' => 'メール件名',
'template_two_body' => "Hello, {{ user.username }}¥n¥n" . "本文.¥n¥n",
);
※Craft CMSの設定ページでテンプレートを編集すると、データベースに保存されます。

3)サービス等から、テンプレート名をキーにして、送信する。配列で渡すのはテンプレートで使用するデータ。
craft()->email->sendEmailByKey($user, 'template_one', array(
'user' => $user,
'entry' => $entry,
));

Craft CMS プラグインの作法(セクション関連)

Craft CMSのプラグインを書くときの作法

スラッグでセクションを取得する


URLのslugでセクションからエントリーを1件取得する方法。
$criteria = craft()->elements->getCriteria(ElementType::Entry);
$criteria->section = 'sampleSection';
$criteria->slug = 'test-slug';
$entry = $criteria->first();

sampleSectionのsampleTagsフィールドでタグ検索した結果を取得する


$criteria->searchを使います。twigで記述した場合
{% set entries = craft.entries.section('sampleSection').search('sampleTags:test') %}
と等価です。
$criteria          = craft()->elements->getCriteria(ElementType::Entry);
$criteria->section = "sampleSection";
$criteria->search = "sampleTags:test";
$entries = $criteria->find();

新規にセクションを作成する


プラグインでセクションの新規エントリーを保存する方法。
$currentUser = craft()->userSession->getUser();
$section = craft()->sections->getSectionByHandle('sampleSection');
$section->getEntryTypes();
$entry = new EntryModel();
$entry->sectionId = $section->id;
$entry->enabled = true;
$entry->authorId = $currentUser->id;
// ToDo : セクションのフィールドを埋める
$success = craft()->entries->saveEntry($entry);

セクションのSuper Tableフィールドを更新する


new1,new2,new3…のインデックスを持った配列を設定します。新規作成時、更新時どちらも同じ方法です。
$field = craft()->fields->getFieldByHandle("sampleSuperTableField");
$blockTypes = craft()->superTable->getBlockTypesByFieldId($field->id);
$blockType = $blockTypes[0];
$superTableData = array();

$tableValues = array(
'new1' => array(
'sampleTextField' => 'foobar',
'sampleAssetFileField' => $assets,
),
'new2' => array(
'sampleTextField' => 'foobar',
'sampleAssetFileField' => $assets,
),
);

foreach($tableValues as $key => $value) {
$superTableData[$key] = array(
'type' => $blockType->id,
'enabled' => true,
'fields' => $value,
);
}
$entry->setContentFromPost(array("sampleSuperTableField" => $superTableData));

$success = craft()->entries->saveEntry($entry);

アセットフィールドの更新


アセットフィールドはIDの配列なので、そのように設定します。タグフィールドやカテゴリフィールドも基本的に同じです。
$entry->getContent()->setAttributes(array(
"sampleAssetField" => array($assetModel->id),
));
$success = craft()->entries->saveEntry($entry);


Craft CMSのTasks

Craft CMSのTasksを利用して、旧サイトから大量のデータを変換してインポートする処理を実装しようとしていたりします。

TasksはWordPressでいうと"wp_cron"と同じようなもので、サイトへのアクセスをトリガーに処理の実行を開始します。

Craft CMSでは、以下のようなURLでタスクのスケジュールを開始します。
http://craft.domain/actions/pluginName/actionName
(タスクのスケジュール登録方法はコントローラー以外でも可)

簡単な実装であればTaskとControllerとServiceの実装だけで済みます。

実行中は、定義したステップ数を最大値とした円形のプログレス表示がダッシュボードに表示されて、非同期でステップを順次処理していくのですが、プログレス表示は一度エラーにならないと表示されません…。"desc"の部分はTaskクラスで定義したdescriptionが表示されます。


エラーになると、エラーメッセージが表示され、再スケジュールかキャンセルを選択できます(ただし、詳細なエラーメッセージは定義できない)。再スケジュールをすると、ダッシュボードをリロードしたタイミングでプログレス表示がメニューに追加されます。


通常だとタイムアウトになってしまうような処理を分割して処理したい時には便利だと思います。正常終了したときは、一切結果が表示されないので、正常処理時も結果を確認したいような処理はプラグインのコントロールパネル等で実装したほうがよさそうです。

カスタムタクソノミーのメタボックスだけを非表示にする

CPT UIにはmeta_box_cbのオプションが無いので、投稿画面の右側に表示されるメタボックスだけを非表示にするには、こんなフィルタを書く。

function _disable_custom_taxonomy_metabox($args, $taxonomy, $object_type) {
if ($taxonomy == 'foo' || $taxonomy == 'bar') {
$args['meta_box_cb'] = false;
}
return $args;
}
add_filter('register_taxonomy_args', '_disable_custom_taxonomy_metabox', 10, 3);

これでカスタムタクソノミー"foo"と"bar"のメタボックスが消える(左側のメニューには表示される)。

PhpStormでGruntを使う

最近はフロントエンド部分の開発を行っていなかったので、JavaScriptやCSSの結合や圧縮をすることがなかったのですが、サイトの運用開始後にちょっとだけ修正するといったことも増えてきたので、この作業を自動化してみることにしました。

今回使ったのはGruntとというJavaScriptで記述するタスクランナーです。

https://www.jetbrains.com/help/phpstorm/grunt.html

基本的な手順は、PhpStorm 2017.2 Helpに書かれています。

今回はGit Bashを使って設定したので、GitとNode.js(windows版)を予めインストールしておきます。

管理者権限で起動したGit Bachでgrunt-cliをインストール
$ npm install -g grunt-cli

この時に表示されるインストールパスをメモ。

[Run] - [Edit Configurations...]でインタプリターの設定と、grant-cliのパスを指定。


package.jsonの初期化とgruntのインストール。必ず、プロジェクトディレクトリのルートに移動してからコマンドを実行します。
$ cd /d/workspace/hoge
$ npm init
$ npm install grunt --save-dev


[File] - [Settings...] - [Language & Frameworks] - [Node.js and NPM]

ここで、npm installが出来るっぽいんですが、上手くいかなかったので(インストールしたはずのパッケージがNot Foundになる)、引き続きGit Bashでインストール。
$ npm install grunt-contrib-concat --save-dev
$ npm install grunt-contrib-ugify --save-dev

d:¥workspace¥hoge¥gruntfile.js
module.exports = function (grunt) {
grunt.initConfig({
concat: {
files: {
src : ['assets/js/plugin.js','assets/js/script.js'],
dest: 'assets/js/concat.js'
}
},

uglify: {
dist: {
files: {
'assets/js/all.js': 'assets/js/concat.js'
}
}
}
});

grunt.loadNpmTasks('grunt-contrib-uglify');
grunt.loadNpmTasks('grunt-contrib-concat');
grunt.registerTask('default', ['concat', 'uglify']);
};
plugin.jsとscript.jsを結合して、concat.jsとして保存して、それをminifyしてall.jsとして出力する例。

[View] - [Tool Window] - [Grunt]でGruntのツールウィンドウが開くので、そこから実行。