Docs For Class Spiral

void finishSession(
)

セッションを破棄します。

[ この関数が使える場所 ]
PHPに対応したページならどこでも使用できます

[ サンプル ]

<?php
$SPIRAL->finishSession();
?>

Tags:

access:

public

[ Top ]

string getAccountId(
)

アカウントIDを取得します。

[ この関数が使える場所 ]
PHPに対応したページならどこでも使用できます

[ サンプル ]

<?php
$account = $SPIRAL->getAccountId();
?>

Tags:

return:	アカウントID
access:	public

[ Top ]

string getArgs(
)

カスタムプログラムの引数を取得します。

[ この関数が使える場所 ]
カスタムプログラムのスクリプトで使用できます

[ サンプル ]

<?php
$args = $SPIRAL->getArgs();
?>

Tags:

return:	引数の配列
access:	public

[ Top ]

SpiralCache getCache(
[int
$_timeout = 900])

キャッシュを取得します。

[ 仕様 ]
このメソッドは、ページ当たり１回のみ実行できます

[ この関数が使える場所 ]
PHPに対応したページならどこでも使用できます

[ サンプル ]

<?php
$cache = $SPIRAL->getCache(30);
?>

Tags:

return:	SpiralCacheクラスのインスタンス
access:	public

Parameters:

int

$_timeout

有効期限(秒)で1〜900を指定可能です。初期値は900となります。

[ Top ]

string getCardId(
)

単票のIDを取得します。

[ この関数が使える場所 ]
単票ページ

[ サンプル ]

<?php
$id = $SPIRAL->getCardId();
?>

Tags:

return:	番号
access:	public

[ Top ]

string getContextByFieldCode(
[string
$_fieldCode = null])

フィールドコードをキーとして、データベースの属性情報を取得します。

[ 取得できないフィールド ]
・パスワード型
・画像型

[ この関数が使える場所 ]
・登録フォーム (登録タイプ・更新タイプのフォームのサンキューページ)
・マイエリア（公開ページを除く）

[ 選択型のフィールドの値について ]
・セレクトフィールド：数値
・マルチセレクト：カンマ区切りの数値
・マルチセレクト128：カンマ区切りの数値

[ サンプル ]

<?php
$attribute = $SPIRAL->getContextByFieldCode("f000000000");
?>

Tags:

return:	フィールドの値
access:	public

Parameters:

string

$_fieldCode

取得したいフィールドのフィールドコード [f000000000]

[ Top ]

string getContextByFieldTitle(
[string
$_fieldTitle = null])

フィールドタイトルをキーとして、データベースの属性情報を取得します。

[ 取得できないフィールド ]
・パスワード型
・画像型

[ この関数が使える場所 ]
・登録フォーム (登録タイプ・更新タイプのフォームのサンキューページ)
・マイエリア（公開ページを除く）

[ 選択型のフィールドの値について ]
・セレクトフィールド：数値
・マルチセレクト：カンマ区切りの数値
・マルチセレクト128：カンマ区切りの数値

[ サンプル ]

<?php
$attribute = $SPIRAL->getContextByFieldTitle("field_title");
?>

Tags:

return:	フィールドの値
access:	public

Parameters:

string

$_fieldTitle

取得したいフィールドのフィールドタイトル [xxxxx]

[ Top ]

void getCookieFilePath(
)

cookie保存先のパスを取得します。 curlでcookieファイルのパスを指定する際にこの関数を指定します。

[ サンプル ]

<?php
$curl = curl_init();
curl_setopt($curl, CURLOPT_COOKIEFILE, $SPIRAL->getCookieFilePath());
curl_setopt($curl, CURLOPT_COOKIEJAR, $SPIRAL->getCookieFilePath());
?>

Tags:

access:

public

[ Top ]

void getDataBase(
[string
$_dbName = null])

データベースを操作するインスタンスを作成します。このメソッドを実行する前に、$SPIRAL->setApiTokenTitle()でAPIのトークンとシークレットを設定しておく必要があります。なお、APIはオプション契約となっております。使用する際は操作画面からお申し込みください。

[ この関数が使える場所 ]
PHPに対応したページならどこでも使用できます

[ サンプル ]

<?php
$SPIRAL->setApiTokenTitle($api_token_title);
$db = $SPIRAL->getDataBase("db_title");
$db->addSelectFields("field_title");
$db->addLikeCondition("field_title", "%value%");
$result_array = $db->doSelect();
print_r($result_array);
?>

Tags:

access:

public

Parameters:

string

$_dbName

スパイラルの操作画面で設定したデータベースのタイトル

[ Top ]

Facebookインスタンス getFacebook(
array
$_option)

facebookSDKのFacebookクラスのインスタンスを作成します。

ご利用にはfacebookのアカウントが必要です。 facebook SDKの使い方は、facebookのサイト http://developers.facebook.com/ をご覧ください。

[ サンプル ]

登録フォームのURLをfacebookへ登録してfacebookアプリケーションを作成できます。

<?php
$args = array(
'appId' => appId,
'secret' => secret,
'cookie' => true,
)
$facebook = $SPIRAL->getFacebook($args);
?>

[ この関数が使える場所 ]
PHPに対応したページならどこでも使用できます

Tags:

access:

public

Parameters:

array

$_option

facebookSDKのFacebookクラスのコンストラクタに渡す配列

[ Top ]

string getJsonParam(
)

カスタムプログラムのJSON形式の引数を取得します。

[ この関数が使える場所 ]
カスタムプログラムのスクリプトで使用できます

[ サンプル ]

<?php
$args = $SPIRAL->getJsonParam();
?>

Tags:

return:	引数の配列
access:	public

[ Top ]

string getParam(
[string
$_name = null])

フォームのパラメータを１つ取得します。

[ この関数が使える場所 ]
PHPに対応したページならどこでも使用できます

[ サンプル ]

<?php
$form_value = $SPIRAL->getParam("form_name");
?>

Tags:

return:	パラメータの値
access:	public

Parameters:

string

$_name

パラメータの名前

[ Top ]

array getParams(
[string
$_name = null])

フォームのパラメータを配列で取得します。同じパラメータ名で複数の値を持つ場合に使用します。

[ この関数が使える場所 ]
PHPに対応したページならどこでも使用できます

[ サンプル ]

<?php
$form_value_array = $SPIRAL->getParams("form_name");
?>

Tags:

return:	値の配列 ["value1", "value2" ... ]
access:	public

Parameters:

string

$_name

パラメータの名前

[ Top ]

SpiralPdfReport getPdfReport(
)

PDF帳票を操作するインスタンスを作成します。このメソッドを実行する前に、$SPIRAL->setApiTokenTitle()でAPIのトークンとシークレットを設定しておく必要があります。なお、APIはオプション契約となっております。使用する際は操作画面からお申し込みください。

[ この関数が使える場所 ]
PHPに対応したページならどこでも使用できます

[ サンプル ]

<?php
$SPIRAL->setApiTokenTitle($api_token_title);
$pdf_report = $SPIRAL->getPdfReport();
$result_array = $pdf_report->doGetFile("file_field", "unique_field_title", "unique_field_value");
print_r($result_array);
?>

Tags:

access:

public

[ Top ]

SpiralSession getSession(
[boolean
$_reGenerate = false], [int
$_timeout = 900])

セッションを取得します。引数でtrueを指定した場合は、session_start()をコール後、セッションIDを再作成します。

[ 仕様 ]
このメソッドは、ページ当たり１回のみ実行できます

[ この関数が使える場所 ]
PHPに対応したページならどこでも使用できます

[ サンプル ]

<?php
$session = $SPIRAL->getSession(true);
?>

Tags:

return:	SpiralSessionクラスのインスタンス
access:	public

Parameters:

boolean	$_reGenerate	セッションID再作成
int	$_timeout	タイムアウト(秒)で60〜3600を指定可能です。初期値は900となります。

[ Top ]

PbSpiralApiCommunicator getSpiralApiCommunicator(
)

スパイラルAPIを利用するインスタンスを作成します。このメソッドを実行する前に、$SPIRAL->setApiTokenTitle()でAPIのトークンとシークレットを設定しておく必要があります。

[ この関数が使える場所 ]
PHPに対応したページならどこでも使用できます

[ サンプル(カスタムプログラムを実行) ]

<?php
// スパイラルAPIサーバと通信するインスタンスを作成します。
$SPIRAL->setApiTokenTitle($api_token_title);
$api_communicator = $SPIRAL->getSpiralApiCommunicator();
// カスタムプログラムを実行する場合のリクエストを作成します。
$request = new SpiralApiRequest();
$request->put("title", "[カスタムプログラムタイトル]");
// スパイラルAPIサーバへリクエストを送信します。
$response = $api_communicator->request("custom_program", "run", $request);
print_r($response);
?>

[ サンプル(Express2配信予約) ]

<?php
// スパイラルAPIサーバと通信するインスタンスを作成します。
$SPIRAL->setApiTokenTitle($api_token_title);
$api_communicator = $SPIRAL->getSpiralApiCommunicator();
// Express2の予約を実行するリクエストを作成します。
$request = new SpiralApiRequest();
$request->put("db_title" , "phptest");
$request->put("reserve_date" , "2012/02/20 10:00");
$request->put("mail_field_title" , "[メールフィールドタイトル]");
$request->put("error_field_title", "[配信エラーフィールドタイトル]");
$request->put("subject" , "メールのサブジェクト");
$request->put("from_name" , "差出人名");
$request->put("from_address" , "example@example.com");
$request->put("body_text" , "メールの本文");
// スパイラルAPIサーバへリクエストを送信します。
$response = $api_communicator->request("deliver_express2", "regist", $request);
print_r($response);
?>

[ サンプル(Thanksメール配信) ]

<?php
// スパイラルAPIサーバと通信するインスタンスを作成します。
$SPIRAL->setApiTokenTitle($api_token_title);
$api_communicator = $SPIRAL->getSpiralApiCommunicator();
// Thanksメールを配信するリクエストを作成します。
$request = new SpiralApiRequest();
$request->put("rule_id", "[配信ルールID]");
$request->put("id" , "IDフィールドの値");
// スパイラルAPIサーバへリクエストを送信します。
$response = $api_communicator->request("deliver_thanks", "send", $request);
print_r($response);
?>

Tags:

return:	PbSpiralApiCommunicatorクラスのインスタンス
access:	public

[ Top ]

SpiralCrypt getSpiralCrypt(
)

暗号化・復号化クラスを取得します。

[ この関数が使える場所 ]
カスタムプログラムのスクリプトで使用できます

[ サンプル ]

<?php
$crypt = $SPIRAL->getSpiralCrypt();
?>

Tags:

return:	SpiralCryptクラスのインスタンス
access:	public

[ Top ]

SpiralCryptOpenSsl getSpiralCryptOpenSsl(
)

暗号化・復号化クラスを取得します。

[ この関数が使える場所 ]
カスタムプログラムのスクリプトで使用できます

[ サンプル ]

<?php
$crypt = $SPIRAL->getSpiralCryptOpenSsl();
?>

Tags:

return:	SpiralCryptOpenSslクラスのインスタンス
access:	public

[ Top ]

UserAgent getUserAgent(
)

ユーザエージェントを判定するインスタンスを作成します。マルチデバイス用フォームでユーザエージェントでの判定を選択した場合に標準で使用します。

[ この関数が使える場所 ]
PHPに対応したページならどこでも使用できます

[ サンプル ]

<?php
// ユーザエージェント判定用インスタンスを作成します。
$UA = $SPIRAL->getUserAgent();
// 判定します
if ($UA->isSmartphone()) {
// スマートフォンの場合の処理
} else if ($UA->isTablet()) {
// タブレットの場合の処理
} else if ($UA->isOther()) {
// 上記以外の場合の処理
}
?>

Tags:

return:	UserAgentクラスのインスタンス
access:	public

[ Top ]

void setApiToken(
[string
$_token = null], [string
$_secret = null])

APIのトークンとシークレットを設定します。データベースを操作するクラス（$SPIRAL->getDataBase()でインスタンスを取得）を使用する場合に設定します。なお、APIはオプション契約となっております。使用する際は操作画面からお申し込みください。

[ この関数が使える場所 ]
PHPに対応したページならどこでも使用できます

[ サンプル ]

<?php
$SPIRAL->setApiToken($api_token, $api_token_secret);
?>

Tags:

access:

public

Parameters:

string	$_token	スパイラルの操作画面で発行したAPIトークン
string	$_secret	スパイラルの操作画面で発行したAPIトークンのシークレット

[ Top ]

void setApiTokenTitle(
[string
$_title = null])

APIのトークンとシークレットを設定します。 setApiToken()と同様の機能で、トークンのタイトルを使用します。

[ この関数が使える場所 ]
PHPに対応したページならどこでも使用できます

[ サンプル ]

<?php
$SPIRAL->setApiTokenTitle($api_token_title);
?>

Tags:

access:

public

Parameters:

string

$_title

スパイラルの操作画面で発行したAPIトークンのタイトル

[ Top ]

string urlEncode(
[string
$_string = null])

RFC3986に従いURLエンコードした文字列を返します。 PHP標準の関数で文字化けする場合は、こちらをお使いください。

[ この関数が使える場所 ]
PHPに対応したページならどこでも使用できます

[ サンプル ]

<?php
$urn_encoded = $SPIRAL->urlEncode($string);
?>

Tags:

return:	URLエンコードした文字列
access:	public

Parameters:

string

$_string

URLエンコードしたい文字列

[ Top ]

Class: Spiral

Class Overview

Methods

Class Details

Class Methods

method finishSession [line 797]

Tags:

method getAccountId [line 1038]

Tags:

method getArgs [line 870]

Tags:

method getCache [line 836]

Tags:

Parameters:

method getCardId [line 923]

Tags:

method getContextByFieldCode [line 247]

Tags:

Parameters:

method getContextByFieldTitle [line 289]

Tags:

Parameters:

method getCookieFilePath [line 1015]

Tags:

method getDataBase [line 410]

Tags:

Parameters:

method getFacebook [line 602]

Tags:

Parameters:

method getJsonParam [line 897]

Tags:

method getParam [line 173]

Tags:

Parameters:

method getParams [line 205]

Tags:

Parameters:

method getPdfReport [line 446]

Tags:

method getSession [line 727]

Tags:

Parameters:

method getSpiralApiCommunicator [line 526]

Tags:

method getSpiralCrypt [line 983]

Tags:

method getSpiralCryptOpenSsl [line 1000]

Tags:

method getUserAgent [line 569]

Tags:

method setApiToken [line 364]

Tags:

Parameters:

method setApiTokenTitle [line 322]

Tags:

Parameters:

method urlEncode [line 689]

Tags:

Parameters: