スパイラル PHP
目次 1. スパイラル PHP 概要 2. ウェブ機能での PHP 利用 3 5 1)PHP が使用できるウェブ機能 2)SMP_DYNAMIC_PAGE について 3) スパイラルの PHP 実行順序について 4)PHP 実行エラー時の画面表示 5)PHP の実行エラー時の通知メール 6) 設定例 ~ 選択肢をマスタ DB から参照 ~ 3. カスタムプログラムでの PHP 利用 1)PHP スクリプトの即時実行 2)PHP スクリプトの定期実行 2-1) 定期実行ログ 2-2) 定期実行の通知メール 3)PHP スクリプトの API 経由での実行 4) 設定例 ~ 配信エラーカウントが 3 回以上になったデータを毎日消す ~ スパイラル PHP ライブラリ 注意事項 11 17 18 Copyright 2012 PIPEDBITS Co.,Ltd. All rights Reserved. 2
1. スパイラル PHP 概要 スパイラル は一覧表や登録フォームなどの Web 機能で PHP をお使いいただけます Web 機能に設置した PHP プログラムから API でスパイラル にコールし データベースへのインサートやアップデート メール機能の操作などができます (API のご利用には 別途オプション契約が必要です ) もちろん外部アプリケーションにも API でコールすることができます また PHP を HTML に埋め込めるだけでなく PHP プログラムを単体で実行できる環境を用意しています 時間を指定しての定期実行や API からもコールできるので ロジカルなアプリケーションも構築可能です 外部アプリケーション Copyright 2012 PIPEDBITS Co.,Ltd. All rights Reserved. 3
スパイラルでは 2 通りの方法で PHP をご利用いただけます ウェブ機能での PHP 利用 スパイラルのウェブ機能で PHP をご利用いただけます Facebook など SNS への書込み 外部データの取込み 演算結果の表示など動的なウェブページを作成できます PHP を利用できるウェブ機能 フォーム管理 マイエリア 一覧表 掲示板 集計表 カスタムプログラムでの PHP 利用 カスタムプログラムは PHP スクリプトを PHP サーバで実行させる機能です 管理画面からの直接実行 定期実行 ならびに API からの実行が可能です グループ 開発 PHP 単体で設置可能 Copyright 2012 PIPEDBITS Co.,Ltd. All rights Reserved. 4
2. ウェブ機能での PHP 利用 1)PHP が使用できるウェブ機能一覧 以下のウェブ機能で HTML ソースを記述する箇所に PHP を記載できます エラーページは PHP 実行エラー時にも表示するため ループ発生の可能性から PHP 使用不可となっています 機能 PHP を記述できる場所 機能 PHP を記述できる場所 フォーム管理 一覧表 入力ページデザイン設定 ( カスタム ) 確認ページデザイン設定 ( カスタム ) サンキューページデザイン設定 ( カスタム ) 締め切りページデザイン設定 ( カスタム ) システムエラーページ 使用できません 旧機能 =[ 登録フォーム設定 ver.2 ] でも設定が可能です なお [ 登録ページ設定 (ver.1)] では設定できません 一覧表 単票 ソース編集画面 ソース編集画面 トピック一覧ページ (TOP ページ ) マイエリア カスタムマイページ 会員情報ページ パスワード変更ページ ソース編集画面 会員情報 ページ面 会員情報 変更後ページ編集画面 パスワード変更 ページ編集画面 ソース編集画 ソース ソース パスワード変更 後ページソース編集画面 1: パスワード登録 完了ページソース 掲示板 集計表 トピック コメント トピック作成フォーム トピック変更フォーム トピック削除フォーム 各ページ 各ページ 各ページ コメント一覧ページ ( トピック詳細ページ ) コメント投稿フォーム コメント削除フォーム ページ編集画面 各ページ 各ページ パスワード登録 再登録 自動発行キー エラーページ 4: パスワード再登録手続き 完了ページソース 5: パスワード再登録 ページソース 6: パスワード再登録 完了ページソース ソース編集画面 使用できません 各機能の操作画面プレビューでも動作します Copyright 2012 PIPEDBITS Co.,Ltd. All rights Reserved. 5
2)SMP_DYNAMIC_PAGE について PHP を使用するページには ソース中に専用のタグを記述してください スパイラルでは タグの記述されたページに限り PHP を実行いたします 1 つのページにつき 1 回のみの記述で動作します (1) 使用したいページのソース編集画面で HTML ソース内に専用タグ SMP_DYNAMIC_PAGE と PHP プログラムコードを記述してください ------------------------------------------------------------------ 例 : <!--SMP_DYNAMIC_PAGE DISPLAY_ERRORS=ON NAME=SAMPLE --> <?php echo Hello World ;?> ------------------------------------------------------------------ (2)<!--SMP_DYNAMIC_PAGE ----> は 1 ページ当たり 1 つ記述してください 設定は以下のとおりです DISPLAY_ERRORS PHP のエラーメッセージを画面に表示するかどうかを指定します ( 設定値 ON : エラーを表示する OFF : エラーを表示しない ) NAME 動的ページの名前を指定します エラー通知メール内で動的ページを識別するために使用します ( 設定値スペース以外の英数記号 ) Copyright 2012 PIPEDBITS Co.,Ltd. All rights Reserved. 6
3) スパイラルの PHP 実行順序について ウェブ機能で PHP を利用した場合の動作順序は以下の通りです スパイラルの差替えキーワード (% タグ $ タグ ) は PHP 実行後に値の差替えが行われます 差替えキーワードを利用して スパイラルのデータベースの値を PHP のプログラムに組み込むことは出来ませんのでご注意ください データベースの値を取り出すための PHP クラスは 後述のスパイラル PHP ライブラリにございます 1 URL を入力 3 HTML を取得 <html> 今日は 2 月 28 日です </html> ブラウザ 4 画面を描画する 今日は 2 月 28 日です スパイラル プログラム <html> <?php $now=date( Y 年 m 月 d 日 ); echo 今日は $now です ;?> </html> <html> 今日は 2 月 28 日です </html> 2 PHP 実行 スパイラルのキーワード差替え Copyright 2012 PIPEDBITS Co.,Ltd. All rights Reserved. 7
4)PHP 実行エラー時の画面表示 ウェブ機能で PHP 実行時にエラーが起こった場合の画面表示は以下のとおりです PHP エラー表示モード (DISPLAY_ERRORS=ON) で実行エラーが発生した場合 PHP のエラーを表示し実行が途中で止まります PHP エラー表示なしモード (DISPLAY_ERRORS=OFF) で実行エラーが発生した場合 各ウェブ機能のエラーページを表示します Copyright 2012 PIPEDBITS Co.,Ltd. All rights Reserved. 8
5)PHP の実行エラー時の通知メール PHP でエラーが発生した際に 通知メールで管理者にお知らせする機能です 運用開始後のエラー検知メールとしてご利用ください 管理グループ - 通知メール受信設定 - PHP エラー通知メール で 受け取る に設定すると PHP の実行時にエラーが発生したことを通知します なお ページを表示した時に通知しますので アクセス数の多いページは大量に通知メールが届く場合があります Copyright 2012 PIPEDBITS Co.,Ltd. All rights Reserved. 9
6) 設定例 ~ 選択肢をマスタ DB から参照 ~ スパイラル API をご利用になる場合には オプション契約が必要です Copyright 2012 PIPEDBITS Co.,Ltd. All rights Reserved. 10
3. カスタムプログラムでの PHP 利用 1) PHP スクリプトの即時実行 カスタムプログラムでは PHP スクリプトを登録して実行できます PHP 実行環境がなくても スパイラル内で PHP スクリプトの実行が完結します 基本設定 画面に PHP スクリプトを登録して即時実行が可能です グループ 開発 PHP 単体で設置可能 Copyright 2012 PIPEDBITS Co.,Ltd. All rights Reserved. 11
2)PHP スクリプトの定期実行 定期実行 画面から 月 日 / 曜日 時 分 を組み合わせてタイミングを指定して実行させることが可能です Copyright 2012 PIPEDBITS Co.,Ltd. All rights Reserved. 12
2-1) 定期実行ログ 実行ログから実行結果の確認が可能です Copyright 2012 PIPEDBITS Co.,Ltd. All rights Reserved. 13
2-2) 定期実行の通知メール 通知メールから実行結果の確認が可能です PHP の定期実行時に通知メールを送信します 設定方法 (1) 定期実行の通知にチェックを入れる (2) 管理グループ - 通知メール受信設定 - 動的ページ通知メール で 受け取る に設定 エラーが発生した場合には こちらの設定のみでエラー通知が配信されます Copyright 2012 PIPEDBITS Co.,Ltd. All rights Reserved. 14
3)PHP スクリプトの API 経由での実行 スパイラル API 経由で実行することができます 外部から API コール API 外部アプリケーション Copyright 2012 PIPEDBITS Co.,Ltd. All rights Reserved. 15
4) 設定例 ~ 配信エラーカウントが 3 回以上になったデータを毎日消す ~ 毎日深夜 1 時に実行 エラーカウントが 3 以上のものを抽出 削除する スパイラル API をご利用になる場合には オプション契約が必要です Copyright 2012 PIPEDBITS Co.,Ltd. All rights Reserved. 16
スパイラル PHP ライブラリ スパイラルでは いくつかのライブラリをご用意しています サンプルコードも記載していますので ご覧下さい Spiral クラス名概要備考 SpiralSession SpiralDatabase facebook Twitter 主なスパイラル PHP ライブラリ GoogleAnalytics フォームパラメータやフィールドの差し替え機能を集めたライブラリです セッション機能を集めたライブラリです セッション ID の振り直しを自動的に行います スパイラルのデータベースを操作するライブラリです facebook に関するライブラリです Facebook SDK を使用できます Twitter に関するライブラリです Twitter に投稿できます Google Analytics で使用する ga.php を設置しています - - - - アクセストークン発行 ( https://www.pi-pe.co.jp/lib/php/twitterauth/index.php ) スパイラルに設置した ga.php の URL ( 登録フォームのサーバで reg@@.smp.ne.jp を使用 ) スパイラル API をご利用になる場合には オプション契約が必要です Copyright 2012 PIPEDBITS Co.,Ltd. All rights Reserved. 17
注意事項 (1) プログラムの実行時間が 30 秒を超えた場合 プログラムを実行できる時間は 1 リクエスト当たり 30 秒です 30 秒を超えた場合は実行をキャンセルし エラー画面を示します (2) 使用できない関数やクラス ファイルシステムに影響を与える可能性のある関数やクラスは使用できません 下記 URL からご確認ください スパイラルで使用できない PHP 関数とクラスの一覧 http://www.pi-pe.co.jp/help/manual/php_except.pdf その他 PHP に組み込まれていない機能は使用できません (3) 外部サイトと連携した場合のエラー 外部サイトと連携している場合 メンテナンスやサービスダウンにより連携できない場合があります 連携できない場合を考慮したプログラムを作成していただく必要があります あらかじめご了承ください 外部サイトと HTTP(S) で通信する場合は curl ライブラリをご利用ください Copyright 2012 PIPEDBITS Co.,Ltd. All rights Reserved. 18
ご質問がございましたら スパイラルユーザーズデスクよりお気軽にお呼び出しください 専門スタッフより すぐに折り返しご連絡差し上げます スパイラルにログインし 操作画面最上部の [ ユーザーズデスク ] ボタンをクリックしてください ポップアップで ユーザーズデスクご連絡フォーム が開きます ユーザーズデスク受付時間 ユーザーズデスクについて 10:00~18:00 ( 土日祝祭日 年末年始休業を除く ) http://www.smp.ne.jp/usersdesk/ Copyright 2012 PIPEDBITS Co.,Ltd. All rights Reserved. 19