spiral
[ class tree: spiral ] [ index: spiral ] [ all elements ]

Class: Spiral

Source Location: /base/Spiral.php

Class Overview


スパイラルの基本クラス


Methods



Class Details

[line 30]
スパイラルの基本クラス

このクラスは、スパイラルが自動的にインスタンスを作成して、グローバル変数 $SPIRAL へ代入します。 ご自分でインスタンスを作成する必要はありません。

[サンプル]

  1.  <!-- SMP_DYNAMIC_PAGE DISPLAY_ERRORS=ON NAME=SAMPLE_PAGE -->
  2.  <?php
  3.      echo "Hellow World!<br>\n";
  4.      echo $SPIRAL->getParam("form_parameter""<br>\n";
  5.  ?>

※ スパイラルでPHPを使用するには、SMP_DYNAMIC_PAGE をページに1つ記述して頂く必要があります。




[ Top ]


Class Methods


method finishSession [line 843]

void finishSession( )

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

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

[ サンプル ]

  1.  <?php
  2.      $SPIRAL->finishSession();
  3.  ?>




Tags:

access:  public


[ Top ]

method getArgs [line 916]

string getArgs( )

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

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

[ サンプル ]

  1.  <?php
  2.      $args $SPIRAL->getArgs();
  3.  ?>




Tags:

return:  引数の配列
access:  public


[ Top ]

method getCache [line 882]

SpiralCache getCache( [int $_timeout = 900])

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

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

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

[ サンプル ]

  1.  <?php
  2.      $cache $SPIRAL->getCache(30);
  3.  ?>




Tags:

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


Parameters:

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

[ Top ]

method getCardId [line 969]

string getCardId( )

単票のIDを取得します。

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

[ サンプル ]

  1.  <?php
  2.      $id $SPIRAL->getCardId();
  3.  ?>




Tags:

return:  番号
access:  public


[ Top ]

method getContextByFieldCode [line 248]

string getContextByFieldCode( [string $_fieldCode = null])

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

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

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

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

[ サンプル ]

  1.  <?php
  2.      $attribute $SPIRAL->getContextByFieldCode("f000000000");
  3.  ?>




Tags:

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


Parameters:

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

[ Top ]

method getContextByFieldTitle [line 290]

string getContextByFieldTitle( [string $_fieldTitle = null])

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

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

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

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

[ サンプル ]

  1.  <?php
  2.      $attribute $SPIRAL->getContextByFieldTitle("field_title");
  3.  ?>




Tags:

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


Parameters:

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

[ Top ]

method getCookieFilePath [line 1061]

void getCookieFilePath( )

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

[ サンプル ]

  1.  <?php
  2.      $curl curl_init();
  3.      curl_setopt($curlCURLOPT_COOKIEFILE$SPIRAL->getCookieFilePath());
  4.      curl_setopt($curlCURLOPT_COOKIEJAR$SPIRAL->getCookieFilePath());
  5.  ?>




Tags:

access:  public


[ Top ]

method getDataBase [line 411]

void getDataBase( [string $_dbName = null])

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

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

[ サンプル ]

  1.  <?php
  2.      $SPIRAL->setApiTokenTitle($api_token_title);
  3.      $db $SPIRAL->getDataBase("db_title");
  4.      $db->addSelectFields("field_title");
  5.      $db->addLikeCondition("field_title""%value%");
  6.      $result_array $db->doSelect();
  7.      print_r($result_array);
  8.  ?>




Tags:

access:  public


Parameters:

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

[ Top ]

method getFacebook [line 648]

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

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

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

[ サンプル ]

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

  1.  <?php
  2.   $args array(
  3.                 'appId'  => appId,
  4.                 'secret' => secret,
  5.                 'cookie' => true,
  6.                 )
  7.      $facebook $SPIRAL->getFacebook($args);
  8.  ?>

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




Tags:

access:  public


Parameters:

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

[ Top ]

method getJsonParam [line 943]

string getJsonParam( )

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

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

[ サンプル ]

  1.  <?php
  2.      $args $SPIRAL->getJsonParam();
  3.  ?>




Tags:

return:  引数の配列
access:  public


[ Top ]

method getParam [line 174]

string getParam( [string $_name = null])

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

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

[ サンプル ]

  1.  <?php
  2.      $form_value $SPIRAL->getParam("form_name");
  3.  ?>




Tags:

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


Parameters:

string   $_name   パラメータの名前

[ Top ]

method getParams [line 206]

array getParams( [string $_name = null])

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

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

[ サンプル ]

  1.  <?php
  2.      $form_value_array $SPIRAL->getParams("form_name");
  3.  ?>




Tags:

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


Parameters:

string   $_name   パラメータの名前

[ Top ]

method getPdfReport [line 447]

SpiralPdfReport getPdfReport( )

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

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

[ サンプル ]

  1.  <?php
  2.      $SPIRAL->setApiTokenTitle($api_token_title);
  3.      $pdf_report $SPIRAL->getPdfReport();
  4.      $result_array $pdf_report->doGetFile("file_field""unique_field_title""unique_field_value");
  5.      print_r($result_array);
  6.  ?>




Tags:

access:  public


[ Top ]

method getSession [line 773]

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

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

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

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

[ サンプル ]

  1.  <?php
  2.      $session $SPIRAL->getSession(true);
  3.  ?>




Tags:

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


Parameters:

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

[ Top ]

method getSpiralApiCommunicator [line 527]

PbSpiralApiCommunicator getSpiralApiCommunicator( )

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

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

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

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

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

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

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

  1.  <?php
  2.      // スパイラルAPIサーバと通信するインスタンスを作成します。
  3.      $SPIRAL->setApiTokenTitle($api_token_title);
  4.      $api_communicator $SPIRAL->getSpiralApiCommunicator();
  5.  
  6.      // Thanksメールを配信するリクエストを作成します。
  7.      $request new SpiralApiRequest();
  8.      $request->put("rule_id""[配信ルールID]");
  9.      $request->put("id"     "IDフィールドの値");
  10.  
  11.      // スパイラルAPIサーバへリクエストを送信します。
  12.      $response $api_communicator->request("deliver_thanks""send"$request);
  13.      print_r($response);
  14.  ?>




Tags:

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


[ Top ]

method getSpiralCrypt [line 1029]

SpiralCrypt getSpiralCrypt( )

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

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

[ サンプル ]

  1.  <?php
  2.      $crypt $SPIRAL->getSpiralCrypt();
  3.  ?>




Tags:

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


[ Top ]

method getSpiralCryptOpenSsl [line 1046]

SpiralCryptOpenSsl getSpiralCryptOpenSsl( )

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

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

[ サンプル ]

  1.  <?php
  2.      $crypt $SPIRAL->getSpiralCryptOpenSsl();
  3.  ?>




Tags:

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


[ Top ]

method getTwitter [line 606]

Twitter getTwitter( [string $_accessToken = null], [string $_accessTokenSecret = null])

Twitterへアクセスするインスタンスを作成します。

ご利用にはTwitterのアカウントが必要です。スパイラルはTwitterアカウントの所有者様から アクセストークンを指定して頂くことでTwitterへアクセスします。 アクセストークンは、以下の「アクセストークンの作成方法」をご覧下さい。

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

[ アクセストークンの作成方法 ]
https://www.pi-pe.co.jp/lib/php/twitterauth/index.php のページで発行します。

[ サンプル ]

  1.  <?php
  2.      $twitter $SPIRAL->getTwitter($twitter_access_token$twitter_access_token_secret);
  3.      $success $twitter->updateStatus("ツイートしたい文面");
  4.  
  5.      if ($success{
  6.          echo "ツイートに成功しました。<br>\n";
  7.      else {
  8.          echo "ツイートに失敗しました。<br>\n";
  9.      }
  10.  ?>




Tags:

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


Parameters:

string   $_accessToken   アクセストークン
string   $_accessTokenSecret   アクセストークンシークレット

[ Top ]

method getUserAgent [line 570]

UserAgent getUserAgent( )

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

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

[ サンプル ]

  1.  <?php
  2.      // ユーザエージェント判定用インスタンスを作成します。
  3.      $UA $SPIRAL->getUserAgent();
  4.  
  5.      // 判定します
  6.      if ($UA->isSmartphone()) {
  7.        // スマートフォンの場合の処理
  8.      else if ($UA->isTablet()) {
  9.        // タブレットの場合の処理
  10.      else if ($UA->isOther()) {
  11.        // 上記以外の場合の処理
  12.      }
  13.  ?>




Tags:

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


[ Top ]

method setApiToken [line 365]

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

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

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

[ サンプル ]

  1.  <?php
  2.      $SPIRAL->setApiToken($api_token$api_token_secret);
  3.  ?>




Tags:

access:  public


Parameters:

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

[ Top ]

method setApiTokenTitle [line 323]

void setApiTokenTitle( [string $_title = null])

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

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

[ サンプル ]

  1.  <?php
  2.      $SPIRAL->setApiTokenTitle($api_token_title);
  3.  ?>




Tags:

access:  public


Parameters:

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

[ Top ]

method urlEncode [line 735]

string urlEncode( [string $_string = null])

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

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

[ サンプル ]

  1.  <?php
  2.      $urn_encoded $SPIRAL->urlEncode($string);
  3.  ?>




Tags:

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


Parameters:

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

[ Top ]


Documentation generated on Mon, 23 Aug 2021 14:35:38 +0900 by phpDocumentor 1.4.4