[OriginalPlugin]説明文への提案と質問

[aquazaur]

ここに書けば読んでもらえるのかな...(^^;

OriginalPluginの開発方法がこちらに書かれています。

関連するページとして次の２つがあります。
(1) [connect-cms_option]レポジトリ
(2) [OriginalPluginFiles] ファイルの一覧

以下、提案と質問です。

1. 表題の変更【提案】

「DB定義の作成（DB定義の生成）」→「DB定義の作成（Migrationファイルの作成）」に変更しては？

※この項の続きの項では、見出しとして、「DB 定義の作成（Migrationファイルの修正）」とあります。「Migrationファイル」が唐突に登場しますが、「Migrationファイル」とは何かが理解できませんでした。また、「samplesテーブルへの必要なカラムの追加」も、どこに追加ればいいのか、なかなか理解できませんでした。上記のように、最初の作業に関する表題に「（Migrationファイルの作成）」が書かれていれば、初心者もスムーズに作業ができると思います。

2. 「画面の作成」のファイル【質問】

(a) index_main.blase.php
このファイルは必要なのでしょうか。(1)と(2)には記載がありません。
もし、必要な場合、その中身を教えてください。なお、本ファイル無しで本プラグインは動作しました。

(b)template.ini
このファイルは必要なのでしょうか。(1)と(2)にはありますが、説明文には記載がありません。
もし必要な場合、中身のうち 「template_name = "デフォルト"」は妥当なのでしょうか。「template_name = "サンプル"」なら話が合うように思えるのですが。
なお、同ファイルなしでも本プラグインは動作しました。

3. resources\views\plugins_option\user\samples\card とその中の２つのファイル【質問】

これらは必要でしょうか。(1)と(2)にはありますが、説明文では言及がありませんでした。
なお、これら無しでも本プラグインは動作しました。

4. app/PluginsOption/User/Samples/SamplesPlugin.php の中身【提案1】

(1)のレポジトリに掲載されているコードですと、初めてデータを「新規登録」する時に「403 Forbidden」エラーが発生します。

以下のように editメソッドを修正することで新規登録できました。以下のコードがベストではないかもしれませんが、初めてのデータを新規登録できるように(1)のコードを修正されてはいかがでしょうか。

public function edit($request, $page_id, $frame_id, $post_id = null)
{
	if (is_null($post_id)) {
		// 新規作成の場合は、空のデータを作成
		$post = new SamplePost();
		$post->sample_id = $frame_id; // フレームIDをデフォルトで設定
	} else {
		// 既存投稿を取得
		$post = $this->getPost($post_id);

		// 記事を取得できなかったら403
		if (empty($post->sample_id)) {
			return $this->viewError("403_inframe", null, '詳細取得NG');
		}
	}

	// 編集画面を呼び出す。
	return $this->view('edit', [
		'post' => $post,
	]);
}

5. app/PluginsOption/User/Samples/SamplesPlugin.php の中身【提案2】

エラーとして「403 Forbidden」を出力していますが、「404 (Not Found)」の方が適切ではないでしょうか。

以上です。いろいろあって恐縮ですがよろしくお願いいたします。

[nagasheep]

おはようございます。
永原です。

ご指摘、ありがとうございます。
間違えているところは、修正したいです。
いますぐできるかはわからないですが。。。

動かすことはできたのですよね。
おめでとうございます。
もし、動かないとか、分からないことが残っていれば、オンラインミーティングで永原が説明するので言ってくださいね。

以上

[aquazaur]

コメントありがとうございます。
はい、SamplesPluginはちゃんと動作しております。次のスクリーンショットはデータを登録した様子です。

現時点では各コードの中身と各ファイルとの関係性を理解してないので、マニュアルを読み解くようにいたします。オンラインミーティングは大変ありがたいお申し出です。たぶんお願いすることになると思いますので、そのときはよろしくお願いいたします。

[akagane99]

とりあえず、回答できる所だけ。

1. 表題の変更【提案】
   「DB定義の作成（DB定義の生成）」→「DB定義の作成（Migrationファイルの作成）」に変更しては？

賛成です。

https://github.com/opensource-workshop/connect-cms/wiki/OriginalPlugin

こちらのページの事ですよね。
おそらく変更できると思いますので、変更を試してみてください。

[aquazaur]

わ、ホントですね！変更できました！！

[aquazaur]

自己解決した箇所があるので以下に書いておきます。

2. 「画面の作成」のファイル
(b)template.ini

WikiのTemplateページを読んで理解できました。
複数のテンプレートがある場合、その名称（設定画面での表示名）と、そのドロップダウン項目に表示する順番を指定していることがわかりました。このため、template.ini の中身の「template_name = "デフォルト"」という表記は妥当ですね。

3. resources\views\plugins_option\user\samples\card とその中の２つのファイル

同一のプラグインが複数の見た目（つまり「テンプレート」）を持つことができる（例：メニュープラグイン）ことと関係していることがわかりました。つまり、この cardディレクトリとその中のファイルは、「カード」テンプレートというものを定義していることになりますね。「カード」テンプレートを使うのであれば、これらのディレクトリとファイルが必要と理解しました。

[akagane99]

2. 「画面の作成」のファイル【質問】

(a) index_main.blase.php

https://github.com/opensource-workshop/connect-cms/wiki/OriginalPluginFiles
https://github.com/opensource-workshop/connect-cms_option/tree/master/resources/views/plugins_option/user/samples/default

上記URLを探してみたのですが該当ファイルが見つからなくって、どこかにある感じでしょうか？

4. app/PluginsOption/User/Samples/SamplesPlugin.php の中身【提案1】

https://github.com/opensource-workshop/connect-cms_option/blob/master/app/PluginsOption/User/Samples/SamplesPlugin.php#L140

新規登録時のバグかと思います。
同じような修正になる見込みですが、今後修正を検討してみます。

5. app/PluginsOption/User/Samples/SamplesPlugin.php の中身【提案2】

https://github.com/opensource-workshop/connect-cms_option/blob/master/app/PluginsOption/User/Samples/SamplesPlugin.php

おっしゃる通り、特に権限チェックを行っていなかったので404かと思います。
今後修正を検討してみます。

[akagane99]

今のSamplesPluginでも危ないコードではないので、参考に作っていただいて大丈夫です。^^

[akagane99]

4. app/PluginsOption/User/Samples/SamplesPlugin.php の中身【提案1】

https://github.com/opensource-workshop/connect-cms_option/blob/master/app/PluginsOption/User/Samples/SamplesPlugin.php#L140

新規登録時のバグかと思います。

• [サンプル] 新規登録時に404になる不具合修正 connect-cms_option#19

上記で修正しました。

5. app/PluginsOption/User/Samples/SamplesPlugin.php の中身【提案2】

https://github.com/opensource-workshop/connect-cms_option/blob/master/app/PluginsOption/User/Samples/SamplesPlugin.php

おっしゃる通り、特に権限チェックを行っていなかったので404かと思います。

• [サンプル] エラー表示を「403 Forbidden」から「404 (Not Found)」に修正 connect-cms_option#18

上記で修正しました。

[aquazaur]

今のSamplesPluginでも危ないコードではないので、参考に作っていただいて大丈夫です。^^

ありがとうございます！！！

[akagane99]

修正対応して反映しました。
下記に内容をまとめてあります。
バグも見つかりましたので、参照して頂ければと思います。

• [サンプル] プラグインの処理を最新に対応 connect-cms_option#20

[aquazaur]

ありがとうございました(^^)！！！

[akagane99]

全質問に回答できたと思いますので、一旦クローズさせて頂きます。
また何かありましたら、再オープンや別discussionを立ててもらえばと思います。

[aquazaur]

修正いただいたソースは、ひととおり拝見させてもらいました。
また、実際に動作させてみたところ、バケツの登録／名称変更などメッセージが表示されてわかりやすくなりました。
どうもありがとうございました💕