\BaseController_Neapi

ネクストエンジンAPIを使用するコントローラの基底となるクラス

ネクストエンジンAPIを利用する際に継承する抽象クラス APIを使用する画面で共通処理として必要なセッション処理、クライアントの初期化を行う。

NOTE: 継承クラスで別途_initの処理を書きたくなった際には、「必ず」parent::_initをコールして下さい。 parent::_initをコールしないと言語ファイルのロードなど必要な初期化処理が行われません

Summary

Methods
Properties
Constants
_init()
before()
No public properties found
No constants found
No protected methods found
$company
$user
$client
N/A
getLocale()
No private properties found
N/A

Properties

$company

$company : \Model_Company

現在ログインしている企業情報を保持する

ログインしていない場合はnullが格納されている

Type

\Model_Company

$user

$user : \Model_User

現在ログインしているユーザ情報を保持する

ログインしていない場合はnullが格納されている

Type

\Model_User

$client

$client : \Nextengine\Api\Client

ネクストエンジンAPIクライアントのインスタンスを格納する

Type

\Nextengine\Api\Client

Methods

_init()

_init() : void

言語の設定、言語ファイルの読み込みを行う

ここに書いておくことで継承クラスは言語ファイルのロードを考慮せずコーディングできる このクラスを継承したクラスで_initを定義したい場合には、"必ず"parent::_init()をコールして下さい

before()

before() : void

APIを使用する画面で共通処理として必要な処理、クライアントの初期化を行う。

ただしログイン済みの場合のみ。未ログインの場合はプロパティはnullのままです。 この仕様を利用してログイン判定をすることができます。 が、Controller_Neapiクラスを継承しているならその処理を記述済みなのであえて書く必要はありません。

Fuelのドキュメントにもありますが、互換性を維持するため継承したクラスでbeforeメソッドを使用する場合には必ずparent::before()をコールして下さい。

getLocale()

getLocale(string  $raw_locale) : string

アクセスされたユーザの言語ロケールを取得する

複数指定されている場合は、もっとも先頭に指定されている言語を返却します。 先頭の2文字だけを見るので、3文字以上の言語略称が現れた場合にはバグります。直して下さい。

example

  • 'en' => 'en'
  • 'ja;q=0.6' => 'ja'
  • 'xxx' => 'xx'

Parameters

string $raw_locale

ブラウザから送信された言語情報を表す文字列

Returns

string