Web Collaboration by PukiWiki-付録3 自作プラグイン一覧-pkwkmail.inc.php の編集

* 確認画面のあるメールフォームを生成するプラグインです。 [#uaa9a4d8]
-ページ:     [[カスタマイズ]]
-投稿者:     [[Web collaboration by Pukiwiki]]
-優先順位:   普通
-状態:       完了
-カテゴリー: 本体バグ
-投稿日:     2016-08-15 (月) 07:16:30
-バージョン: 1.5.1

** メッセージ [#lc48b4b0]
*最初に [#b58635bb]
このプラグインには後継プラグイン「[[pkwkmail2.inc.php>自作プラグイン/pkwkmail2.inc.php]]」があります。

*このプラグインは？ [#hd2bb71b]
確認画面のあるメールフォームを生成するプラグインです。'' pukiwiki.ini.php の PKWKEXP_DISABLE_MULTILINE_PLUGIN_HACK を 0（有効）にしてお使いください。''プラグイン呼び出しの書式は下記の通りです。

#pkwkmail{{
 ここにフォームの部品やメッセージを書く
 }}

このプラグインは、誰でも編集できてしまうとスパムメールの発射台になってしまうので、ページが凍結状態でないと動かないようになっています。しかし、凍結状態のままだと、編集の結果を見るのが煩わしくなってしまうので、編集時には、プラグインのソースコード冒頭の PKWKMAIL_FREEZE_CHECK の値を 0 にすると、注意喚起をしつつ、編集結果を確認していじれるようになっています。実際の運用時には、凍結状態で使うようにしてください。

*フォーム部品の作り方 [#ya6ef222]

フォームの部品は attr という文字列から始めます。
たとえば氏名の入力欄を作る場合、下記のような書式になります。
 attr = 'ご氏名','text','1','','お名前','(15)'
この書式の意味は、「th がご氏名となっている、input 入力欄をつくる。そのフィールドの初期値は、お名前。この項目は入力必須項目で、size は 15。」という意味です。

attr = '趣味','checkbox','1','(野球,テニス,サッカー)','(テニス,サッカー)'
この場合は、チェックボックスを生成します。th が チェックボックスで、その候補が、４つめのシングルクォーテーション内に括弧書き、コンマ区切りで並んでいます。５つめのシングルクォーテーション内には、初期選択値が入っています。

項目の種類には、text, password, option, radio, checkbox, textarea に加えて、email というものがあります。email だけは特別扱いで、自動返信の機能を使う場合は、自動返信先になる予定のフィールドを email としてください。
また checkbox-br と radio-br という項目にすると、強制改行がはいります。
あと、Katsumi Saito さんの改造で、初期値に「%DATE%」を入れると、当日の日付が表示されるようになりました。

これらの設定値は、admin_adrs という値で設定したメールアドレスに送信されます（admin_adrs を設定しない場合は、pukiwiki.ini.phpの$notify_toで設定したメールアドレスに送信）。

**フォーム部品についてもうちょっと詳しく [#q07e6ce8]

|~変数名|~th|~種類|~必須|~選択肢|~初期値|~サイズ|h
|attr|ご氏名|text|1||お名前|(15)|
|attr|趣味|checkbox|1|(野球,テニス,サッカー)|(テニス,サッカー)||

最初に「attr=」を書いて、続けて属性を設定します。シングルクォーテーションの順序でフォーム部品を作るので、たとえば「選択肢」が存在しないようなフォーム部品の場合、空のシングルクォーテーションを用意します。~
checkbox, radio, option の選択肢は配列であることを明示するので、半角括弧でくくります。初期値（初期選択値）も同様に半角括弧でくくります。~
text と password と emailと textarea は、ボックスのサイズを指定できますが、これも半角括弧でくくります。

**以下に文例を記載しておきます。 [#yb206a47]

attr = 'ご氏名','text','1','','お名前','(15)'
 attr = 'ふりがな','text','0','','おなまえ','(15)'
 attr = 'メールアドレス','email','1','',''
 attr = '性別','option','1','(,女,男)'
 attr = 'メニュー','radio','1','(うどん,そば,ラーメン)',''
 attr = '趣味','checkbox-br','1','(野球,テニス,サッカー)','(テニス,サッカー)'
 attr = '内容','textarea','0','','なにか文章を書いてください','(15,20)'
 admin_adrs ='example@example.com'

これはおまけです。当方京都在住なので、京都が初期値です :)((読みにくかったので勝手に改行しちゃいました))((やー、やっぱり改行した方がよかったですかね。ありがとうございます。))
 attr = '都道府県','option','1','(北海道,青森県,岩手県,宮城県,秋田県,山形県,福島県,
 東京都,茨城県,栃木県,群馬県,埼玉県,千葉県,神奈川県,新潟県,富山県,石川県,福井県,
 山梨県,長野県,岐阜県,静岡県,愛知県,三重県,京都府,滋賀県,大阪府,兵庫県,奈良県,
 和歌山県,鳥取県,島根県,岡山県,広島県,山口県,徳島県,香川県,愛媛県,高知県,福岡県,
 佐賀県,長崎県,熊本県,大分県,宮崎県,鹿児島県,沖縄県)','京都府'

**余談 [#s4358bb9]
[[WCAG の 10.4>http://www.w3.org/TR/WAI-WEBCONTENT-TECHS/#tech-place-holders]] では、フォームの入力例にあたる初期値を入れておくことを推奨していますが、フィールドにキャレットが移動したときに、初期値が選択された状態を解除してしまうことがあり、音声利用環境では、これに気づかずまちがった値を送信してしまうことがあります。下記の default_explanation などで、入力欄に移動したときに、初期値を消すように注意を喚起するのも手かと思います。

*ダウンロード [#h1cb62df]
すべて UTF-8 です。EUC の場合は、文字コードを変更してお使いください((thx aino310))。
基本的に最新版の方がよいはずですが、検証用に過去バージョンを残しています。

-%%pkwkmail 0.90(http&#x3a;//www.jidaikobo.com/pukiwiki/pkwkmail09.zip )%%
-%%pkwkmail 0.91(http&#x3a;//www.jidaikobo.com/pukiwiki/pkwkmail091.zip )%%
-%%pkwkmail 0.92(http&#x3a;//www.jidaikobo.com/pukiwiki/pkwkmail092.zip )%%
-%%pkwkmail 0.94(http&#x3a;//www.jidaikobo.com/pukiwiki/pkwkmail094.zip )%%
-%%pkwkmail 0.95(http&#x3a;//www.jidaikobo.com/pukiwiki/pkwkmail095.zip )%%
-%%pkwkmail 0.96(http&#x3a;//www.jidaikobo.com/pukiwiki/pkwkmail096.zip )%%
-%%pkwkmail 0.98(http&#x3a;//www.jidaikobo.com/pukiwiki/pkwkmail098.zip )%%
-pkwkmail 0.99(http://www.jidaikobo.com/pukiwiki/pkwkmail099.zip )
-pkwkmail 1.00b(http://www.jidaikobo.com/pukiwiki/pkwkmail100b.zip )

*メッセージ類のカスタマイズ [#eeb58e7b]

**default_message [#l820ce7d]
 default_message = 'default_messageを設定してください。'
当該ページの本文にあたります。確認段階に進むと表示されなくなります。wiki書式扱いになります。

**default_explanation [#l62c9d75]
 default_explanation='
 *フォーム
 以下フォームに必要事項をご記入願います。''入力必須項目''について、
 ご記入漏れのないようにお願いいたします。'
入力用フォームに付帯する説明文です。wiki書式扱いになります。

**reply_message_require [#ueb12f2b]
 reply_message_require='1'
０か１を指定します。初期値は１（自動返信メールを送る）になっています。
自動返信メールを送る、にしていても問い合わせをした人が、自動返信不要とすることができます。
自動返信を不要にされた場合と、この値をゼロにしている場合は、管理者には、「Copy has not been sent.」の情報が送信されます。

**admin_return_allowed [#tbbba1d4]
 admin_return_allowed='1'
０か１を指定します。初期値は１（自動返信メールの From を追加する）になっています。

**reply_message [#s81197b0]
 reply_message='このメールはシステムによる自動返信です。
 以下、お問い合わせいただいた内容です。'
自動返信メールの本文です。この文章に続いて送信した値がメールされます。

**reply_message_foot [#w5d1ea70]
 reply_message_foot='ありがとうございました。'
自動返信メールの本文です。送信した値の下に表示されます。

**confirm_message [#gbb43127]
 confirm_message = ''''必要項目はすべて入力されています。
 '''もう一度、内容を修正したい場合は、以下に続くフォームを編集してください。'
必要項目がすべて入力されている場合に出力される、最後の確認メッセージです。wiki書式扱いになります。

**confirm_message_title [#k4dee178]
 confirm_message_title='送信確認'
必要項目がすべて入力されている場合に出力される、最後の画面の大見出しです。

**confirm_message_reply [#f64d6a54]
 confirm_message_reply = '送信内容のご確認用メールが不要の場合は、
 下記チェックを外して「送信する」を押してください。'
reply_message_requireが１になっているとき、お問い合わせをする人は自動返信の受け取りを自分で選ぶことになります。このときの説明文です。wiki書式扱いになります。

**confirm_message_yet [#k8a7e6c3]
 confirm_message_yet = '下記項目をすべて入力の上、
 送信しなおしてください。'
入力必須項目の確認です。wiki書式扱いになります。

**confirm_message_fromtitle [#r83f8e30]
 confirm_message_fromtitle='*編集・内容確認用フォーム'
送信内容確認用フォームの前掲文です。wiki書式扱いになります。

**confirm_message_yet [#h1dd4751]
 confirm_message_yet='入力必須項目をご確認ください'
確認用フォームの前掲文です。wiki書式扱いになります。

**finish_message [#qfbaf853]
 finish_message = '下記の通り、メールを送信しました。~
 しかるべき反応がない場合は、システム不具合など理由でメールが
 届いていない可能性があります。お手数ですが、別の手段でお問い合わせください。'
メール送信後のメッセージです。wiki書式扱いになります。

**finish_message_return [#xcedaa41]
 finish_message_return = '[[トップページへもどる>FrontPage]]'
メール送信後の送信済みデータの下に出る文章です。wiki書式扱いになります。

**finish_message_title [#mf0f850c]
 finish_message_title='メールを送信しました'
メール送信後の見出しです。

**contact_title_to_admin [#aae5e56a]
 contact_title_to_admin='お問合せがありました'
管理者に向かって送信されるメールの件名です。

**contact_title_to_client [#hf1843d9]
 contact_title_to_client='自動返信：お問合せをいただきました'
自動返信で送信されるメールの件名です。

**domain_check [#o2e4da44]
 domain_check='1'
０か１を指定します。初期値は１（メールのドメインの存在チェックをする）になっています。このチェックを緩めたいときに設定してください。

*ライセンス [#xead3ffa]
-PukiWiki と同じライセンスで。

*footnote [#fa5505bf]
-このプラグインは XOOPS のお問い合わせモジュール「InquirySP」に影響を受けて作りました。ので InquirySP の作者の Marijuana さんへの謝辞がソース上にありますが、 Marijuana さんが作った訳ではないので、仕様や動作について、くれぐれも Marijuana さんに問い合わせなどしないようにしてください。
-仕事でプログラミングが必要なときは、外注しているので、僕自身はウェブ屋ですが PHPについては初心者です。アドバイスなどいただけると幸いです。

タイムスタンプを変更しない