スパイラルPHP - パイプドビッツ公式HP フォームパラメータやフィールドの差し替え機能を集めたライブラリです。-SpiralSession セッション機能を集めたライブラリです。セッ

スパイラルPHP

Copyright © 2012 PIPEDBITS Co.,Ltd. All rights Reserved. 2

１．スパイラルＰＨＰ概要

２．ウェブ機能でのＰＨＰ利用

1）PHPが使用できるウェブ機能２）SMP_DYNAMIC_PAGEについて３）スパイラルのPHP実行順序について４）PHP実行エラー時の画面表示５）PHPの実行エラー時の通知メール６）設定例～選択肢をマスタDBから参照～

３．カスタムプログラムでのＰＨＰ利用

１）PHPスクリプトの即時実行２）PHPスクリプトの定期実行

2-1）定期実行ログ２-2）定期実行の通知メール

３）PHPスクリプトのAPI経由での実行４）設定例～配信エラーカウントが3回以上になったデータを毎日消す～

スパイラルＰＨＰライブラリ

注意事項

目次

3

5

11

17

18


1．スパイラルPHP概要

スパイラル®は一覧表や登録フォームなどのWeb機能で、PHPをお使いいただけます。Web機能に設置したPHPプログラムからAPIでスパイラル®にコールし、データベースへのインサートやアップデート、メール機能の操作などができます（APIのご利用には、別途オプション契約が必要です）。もちろん外部アプリケーションにもAPIでコールすることができます。また、PHPをHTMLに埋め込めるだけでなく、PHPプログラムを単体で実行できる環境を用意しています。時間を指定しての定期実行やAPIからもコールできるので、ロジカルなアプリケーションも構築可能です。

外部アプリケーション


▼ウェブ機能でのＰＨＰ利用

スパイラルのウェブ機能でPHPをご利用いただけます。FacebookなどSNSへの書込み、外部データの取込み、演算結果の表示など動的なウェブページを作成できます。

▼カスタムプログラムでのＰＨＰ利用

カスタムプログラムは、PHPスクリプトをPHPサーバで実行させる機能です。管理画面からの直接実行、定期実行、ならびにAPIからの実行が可能です。

PHPを利用できるウェブ機能「フォーム管理」「マイエリア」「一覧表」「掲示板」「集計表」

スパイラルでは、2通りの方法でPHPをご利用いただけます。

PHP単体で設置可能

グループ「開発」


１）PHPが使用できるウェブ機能一覧

※各機能の操作画面プレビューでも動作します

以下のウェブ機能で、HTMLソースを記述する箇所にPHPを記載できます。エラーページはPHP実行エラー時にも表示するため、ループ発生の可能性からPHP使用不可となっています。

機能 PHPを記述できる場所

フォーム管理

入力ページデザイン設定(カスタム)

確認ページデザイン設定(カスタム)

サンキューページデザイン設定(カスタム)

締め切りページデザイン設定(カスタム)

システムエラーページ

使用できません

旧機能＝[ 登録フォーム設定ver.2 ]でも設定が可能です。なお、[ 登録ページ設定（ver.1）]では設定できません。

一覧表一覧表ソース編集画面

単票ソース編集画面

掲示板

トピック

トピック一覧ページ(TOPページ)

トピック作成フォーム各ページ

トピック変更フォーム各ページ

トピック削除フォーム各ページ

コメント

コメント一覧ページ(トピック詳細ページ)

コメント投稿フォーム各ページ

コメント削除フォーム各ページ

集計表ページ編集画面

2．ウェブ機能でのＰＨＰ利用

マイエリア

カスタムマイページ

ソース編集画面

会員情報ページ

「会員情報」ページソース編集画面

「会員情報」変更後ページソース編集画面

パスワード変更ページ

「パスワード変更」ページソース編集画面

「パスワード変更」後ページソース編集画面

パスワード登録・再登録

1:「パスワード登録」完了ページソース

4:「パスワード再登録手続き」完了ページソース

5:「パスワード再登録」ページソース

6:「パスワード再登録」完了ページソース

自動発行キーソース編集画面

エラーページ使用できません

機能 PHPを記述できる場所


２）SMP_DYNAMIC_PAGEについて

PHPを使用するページには、ソース中に専用のタグを記述してください。スパイラルでは、タグの記述されたページに限りPHPを実行いたします。１つのページにつき1回のみの記述で動作します。

（1）使用したいページのソース編集画面で、HTMLソース内に専用タグSMP_DYNAMIC_PAGEとPHPプログラムコードを記述してください。

------------------------------------------------------------------例：



<?php

echo “Hello World

”;

?>

------------------------------------------------------------------

（２）は1ページ当たり1つ記述してください。設定は以下のとおりです。

DISPLAY_ERRORS・・・PHPのエラーメッセージを画面に表示するかどうかを指定します。（設定値 ON : エラーを表示する、OFF : エラーを表示しない。）

NAME・・・・・・・・・動的ページの名前を指定します。エラー通知メール内で動的ページを識別するために使用します。（設定値スペース以外の英数記号）


３）スパイラルのPHP実行順序について

ウェブ機能でＰＨＰを利用した場合の動作順序は以下の通りです。スパイラルの差替えキーワード（%タグ、$タグ）はＰＨＰ実行後に値の差替えが行われます。差替えキーワードを利用して、スパイラルのデータベースの値をＰＨＰのプログラムに組み込むことは出来ませんのでご注意ください。データベースの値を取り出すためのＰＨＰクラスは、後述のスパイラルＰＨＰライブラリにございます。

① URLを入力

③ HTMLを取得

④ 画面を描画する

② ＰＨＰ実行

ブラウザ

<html>

今日は2月28日です</html>

今日は2月28日です

プログラム

<html>

<?php

$now=date(“Y年m月d日”）;echo”今日は$nowです”;

?>

</html>

<html>

今日は2月28日です</html>

スパイラルのキーワード差替え

スパイラル


４）PHP実行エラー時の画面表示

ウェブ機能でPHP実行時にエラーが起こった場合の画面表示は以下のとおりです

▼ PHPエラー表示モード（DISPLAY_ERRORS=ON）で実行エラーが発生した場合

→PHPのエラーを表示し実行が途中で止まります。

▼ PHPエラー表示なしモード（DISPLAY_ERRORS=OFF）で実行エラーが発生した場合

→各ウェブ機能のエラーページを表示します


５）PHPの実行エラー時の通知メール

PHPでエラーが発生した際に、通知メールで管理者にお知らせする機能です。運用開始後のエラー検知メールとしてご利用ください。

「管理グループ」- 「通知メール受信設定」- 「PHPエラー通知メール」で「受け取る」に設定すると、PHPの実行時にエラーが発生したことを通知します。なお、ページを表示した時に通知しますので、アクセス数の多いページは大量に通知メールが届く場合があります。


６）設定例～選択肢をマスタDBから参照～

※スパイラルAPIをご利用になる場合には、オプション契約が必要です

※


１） PHPスクリプトの即時実行

３．カスタムプログラムでのＰＨＰ利用

カスタムプログラムでは、PHPスクリプトを登録して実行できます。PHP実行環境がなくても、スパイラル内でPHPスクリプトの実行が完結します。「基本設定」画面にPHPスクリプトを登録して即時実行が可能です。

PHP単体で設置可能

グループ「開発」


「定期実行」画面から「月」「日 / 曜日」「時」「分」を組み合わせてタイミングを指定して実行させることが可能です。

２）PHPスクリプトの定期実行


２-1）定期実行ログ

実行ログから実行結果の確認が可能です。


２-2）定期実行の通知メール

通知メールから実行結果の確認が可能です。 PHPの定期実行時に通知メールを送信します。

【設定方法】

（１）定期実行の通知にチェックを入れる

（２）「管理グループ」- 「通知メール受信設定」- 「動的ページ通知メール」で「受け取る」に設定※エラーが発生した場合には、こちらの設定のみでエラー通知が配信されます。


３）PHPスクリプトのAPI経由での実行

スパイラルAPI経由で実行することができます。

API

外部からAPIコール

外部アプリケーション


４）設定例～配信エラーカウントが3回以上になったデータを毎日消す～


※

・毎日深夜1時に実行・エラーカウントが「3」以上のものを抽出・削除する


スパイラルPHPライブラリ

スパイラルでは、いくつかのライブラリをご用意しています。サンプルコードも記載していますので、ご覧下さい。

クラス名概要備考

Spiralフォームパラメータやフィールドの差し替え機能を集めたライブラリです。

-

SpiralSessionセッション機能を集めたライブラリです。セッションIDの振り直しを自動的に行います。

-

SpiralDatabaseスパイラルのデータベースを操作するライブラリです。

-

facebookfacebookに関するライブラリです。Facebook SDK を使用できます。

-

TwitterTwitterに関するライブラリです。Twitterに投稿できます。

アクセストークン発行（ https://www.pi-pe.co.jp/lib/php/twitterauth/index.php ）

GoogleAnalyticsGoogle Analyticsで使用するga.phpを設置しています。

スパイラルに設置したga.phpのURL（※登録フォームのサーバでreg@@.smp.ne.jpを使用）

▼主なスパイラルPHPライブラリ


https://www.pi-pe.co.jp/lib/php/twitterauth/index.php


注意事項

（１）プログラムの実行時間が30秒を超えた場合

プログラムを実行できる時間は1リクエスト当たり30秒です。30秒を超えた場合は実行をキャンセルし、エラー画面を示します。

（２）使用できない関数やクラス

ファイルシステムに影響を与える可能性のある関数やクラスは使用できません。下記URLからご確認ください。

▼スパイラルで使用できないPHP関数とクラスの一覧http://www.pi-pe.co.jp/help/manual/php_except.pdf

その他、PHPに組み込まれていない機能は使用できません。

（３）外部サイトと連携した場合のエラー

外部サイトと連携している場合、メンテナンスやサービスダウンにより連携できない場合があります。連携できない場合を考慮したプログラムを作成していただく必要があります。あらかじめご了承ください。※外部サイトとHTTP(S)で通信する場合は、curlライブラリをご利用ください。

http://www.pi-pe.co.jp/help/manual/php_except.pdf


（土日祝祭日、年末年始休業を除く）

ユーザーズデスクについて http://www.smp.ne.jp/usersdesk/

ユーザーズデスク受付時間 10:00～18:00

ご質問がございましたらスパイラルユーザーズデスクよりお気軽にお呼び出しください。

専門スタッフより、すぐに折り返しご連絡差し上げます。

スパイラルにログインし、操作画面最上部の[ ユーザーズデスク ] ボタンをクリックしてください。ポップアップで「ユーザーズデスクご連絡フォーム」が開きます。

Documents

スパイラルPHP - パイプドビッツ公式HP フォームパラメータやフィールドの差し替え機能 を集めたライブラリです。-SpiralSession セッション機能を集めたライブラリです。セッ

スパイラルPHP - パイプドビッツ公式HP フォームパラメータやフィールドの差し替え機能を集めたライブラリです。-SpiralSession セッション機能を集めたライブラリです。セッ