API Documentation for Piece Framework

PHP Piece

phpDocumentor で Piece の API ドキュメントを生成してみました。
http://www.opendogs.org/doc/piece/
以下のパッケージ/バージョンを文書化しています。

  • Piece_Flow 1.8.0 (stable)
  • Piece_Right 1.4.0 (stable)
  • Piece_Unity 0.10.0 (beta)
  • Stagehand_FSM 1.8.0 (stable)
  • Stagehand_TestRunner 0.4.0 (beta)


phpdoc には private なプロパティ/メソッドが載っていないので、Piece を使った開発でよく使うであろうものを挙げておきます。

Piece_Flow_Action の private なプロパティ
プロパティ 値
$_flow Piece_Flow のインスタンス
$_payload Piece_Unity_Context のインスタンス (Piece_Unity を使う場合)
$_event 現在のイベント名
Piece_Right_Validator_Common の private なメソッド
メソッド 説明 引数 返り値
_initialize() バリデータを初期化するメソッド
この中で _addRule() を呼び出す
  • void
 void
_addRule() バリデーションルールを追加する
  • string $rule
    (ルール名)
  • mixed $default
    (デフォルト値, optional)
  • string $message
    (エラーメッセージ, optional)
 void
Piece_Unity_Plugin_Common の private なプロパティ
プロパティ 値
$_context Piece_Unity_Context のインスタンス
Piece_Unity_Plugin_Common の private なメソッド
メソッド 説明 引数 返り値
_initialize() プラグインを初期化するメソッド
この中で _addExtensionPoint() および
_addConfigurationPoint() を呼び出す
  • void
 void
_addExtensionPoint() 拡張ポイントを追加する
  • string $extensionPoint
    (拡張ポイント名)
  • mixed $default
    (デフォルト値, optional)
 void
_addConfigurationPoint() 設定ポイントを追加する
  • string $configurationPoint
    (設定ポイント名)
  • mixed $default
    (デフォルト値, optional)
 void