5. クラス・メソッド
5.2. 実装クラス
5.2.1. SCORM クラス
5.2.1.1. SCORMRoot クラス
説明
アクティビティコンテンツのツリー構造の"葉"に対応づけるSCORMアクティビティクラス
継承クラス ActivityBase |
--ActivityRoot |
--SimpleRoot |
--SCORMRoot
プロパティ
プロパティ名 属性 説明
$seqParam private SimpleSequencing(シーケンシング処理)オブジェクト
$isRollUp private ロールアップ対象フラグ
メソッド一覧
メソッド名 属性 説明
Constructor__construct コンストラクタ
addTable 子から伝搬されるコマンドテーブルを定義する
setData (このクラスでは使用していない)
getStatus public ステータスを返す
save アクティビティの状態をiniファイルに保存する
startAttempt protected アクティビティの開始処理を行う
getCommandList public クラスで実行可能なコマンドテーブルを取得する
exeInitAll public
exeIndex INDEXコマンドを実行する
exeMeasure_Rollup_Process exeRollup_Using_Rules
exeRollUp ROLLUPコマンドを実行する
exeRollUpFromObj exeExitCondition
checkPreCondition コマンド実行前に条件をチェックする
exeRollUpStart ROLLUPコマンドの開始処理を行う
preRollUpFromObj (objectivesから呼び出される)ROLLUPの前処理を行う
preRollUp ROLLUPの前処理を行う
endAttempt アクティビティの終了処理を行う
exeRetryAll RETRYALLコマンドを実行する
getDeliveryControlsTracked $deliveryControls プロパティ(Delivery Controls 情報)の tracked属性の値を返す
■ コマンドハンドラ一覧
子アクティビティからのコマンドのハンドラメソッド
127
コマンド名 ハンドラメソッド
SimpleRoot から継承する一覧
INIT exeInit
INDEX exeIndex (SCORMRoot でオーバーライド)
ROLLUP exeRollUp (SCORMRoot でオーバーライド)
CONTINUE exeContinue
PREVIOUS exePrevious
CHOICE exeChoice
SUSPEND exeSuspend
EXITALL exeExitAll
RETRY exeRetry
RETRYALL exeRetryAll
EXITRETRY exeExitRetry
SCORMRoot で定義される一覧
EXITCOND exeExitCondition
PREROLLUP preRollUp
INITS exeInitAll
INITAB exeInitAll
INITPB exeInitAll
5.2.1.1.1 Constructor__construct
機能説明
継承クラス(SimpleRoot)のコンストラクタを呼び出す クラスのプロパティを設定する
SimpleSequencing(シーケンシング処理)オブジェクトを生成する
パラメータ num
ノードのナンバー(ROOTノードは0) node
ノード path
アクティビティフォルダへのパス res
再開フラグ(再開ならtrue) objectives
objectivesオブジェクト配列
5.2.1.1.2 addTable メソッド
機能説明
子から伝搬されるコマンドテーブルを定義する
パラメータ なし
返り値 なし
5.2.1.1.3 setData メソッド
機能説明
(このクラスでは使用していない)
パラメータ node
ノード
返り値 なし
5.2.1.1.4 getStatus メソッド
機能説明
ステータスを返す
パラメータ str
ステータス名 objArray
objectivesオブジェクト配列
返り値 ステータス
5.2.1.1.5 save メソッド
機能説明
アクティビティの状態をiniファイルに保存する
パラメータ path
保存先フォルダ
返り値
成功フラグ(TRUE / FALSE)
5.2.1.1.6 startAttempt メソッド
機能説明
アクティビティの開始処理を行う
パラメータ なし
返り値 なし
129 5.2.1.1.7 getCommandList メソッド
機能説明
クラスで実行可能なコマンドテーブルを取得する
パラメータ val
コマンド引数
返り値
クラスで実行可能なコマンドテーブル
5.2.1.1.8 exeInitAll メソッド
機能説明
EXEINITALLコマンドを実行する
パラメータ id
アクティビティID val
コマンド引数 actArray
activitiesオブジェクト配列 objArray
objectivesオブジェクト配列
返り値 Array (
[Result] => 正常フラグ [Continue] => 続行フラグ
[NextID] => 次候補アクティビティID [Value] => 結果値
[Command] => 実行したコマンド )
5.2.1.1.9 exeIndex メソッド
機能説明
INDEXコマンドを実行する
パラメータ id
アクティビティID val
コマンド引数 actArray
activitiesオブジェクト配列 objArray
objectivesオブジェクト配列
返り値 Array (
[Result] => 正常フラグ [Continue] => 続行フラグ
[NextID] => 次候補アクティビティID [Value] => 結果値
[Command] => 実行したコマンド )
5.2.1.1.10 exeMeasure_Rollup_Process メソッド
機能説明
パラメータ actArray
activitiesオブジェクト配列 objArray
objectivesオブジェクト配列 idCurrenetO
カレントフラグ
返り値 なし
5.2.1.1.11 exeRollup_Using_Rules メソッド
機能説明
パラメータ str
属性 actArray
activitiesオブジェクト配列 objArray
objectivesオブジェクト配列 isCurrentO
useCurrentAttemptObjectiveInfoフラグ isCurrentA
useCurrentAttemptProgressInfoフラグ
返り値
Using_Rulesフラグ
5.2.1.1.12 exeRollUp メソッド
機能説明
ROLLUPコマンドを実行する
パラメータ id
アクティビティID val
131 コマンド引数
actArray
activitiesオブジェクト配列 objArray
objectivesオブジェクト配列
返り値 なし
5.2.1.1.13 exeRollUpFromObj メソッド
機能説明
パラメータ actArray
activitiesオブジェクト配列 objArray
objectivesオブジェクト配列
返り値 なし
5.2.1.1.14 exeExitCondition メソッド
機能説明
パラメータ id
アクティビティID val
コマンド引数 actArray
activitiesオブジェクト配列 objArray
objectivesオブジェクト配列
返り値 Array (
[Result] => 正常フラグ [Continue] => 続行フラグ
[NextID] => 次候補アクティビティID [Value] => 結果値
[Command] => 実行したコマンド )
5.2.1.1.15 checkPreCondition メソッド
機能説明
コマンド実行前に条件をチェックする
パラメータ cmd
コマンド objArray
objectivesオブジェクト配列 isDescending
返り値
前提条件文字列
5.2.1.1.16 exeRollUpStart メソッド
機能説明
ROLLUPコマンドの開始処理を行う
パラメータ
activitiesオブジェクト配列 objArray
objectivesオブジェクト配列
返り値 Array (
[Result] => 正常フラグ [Continue] => 続行フラグ
[NextID] => 次候補アクティビティID [Value] => 結果値
[Command] => 実行したコマンド )
5.2.1.1.17 preRollUpFromObj メソッド
機能説明
(objectivesから呼び出される)ROLLUPの前処理を行う
パラメータ actArray
activitiesオブジェクト配列 objArray
objectivesオブジェクト配列
返り値 なし
5.2.1.1.18 preRollUp メソッド
機能説明
ROLLUPの前処理を行う
パラメータ
133 id
アクティビティID val
コマンド引数 actArray
activitiesオブジェクト配列 objArray
objectivesオブジェクト配列
返り値 Array (
[Result] => 正常フラグ [Continue] => 続行フラグ
[NextID] => 次候補アクティビティID [Value] => 結果値
[Command] => 実行したコマンド )
5.2.1.1.19 endAttempt メソッド
機能説明
アクティビティの終了処理を行う
パラメータ cmd
コマンド actArray
activitiesオブジェクト配列 objArray
objectivesオブジェクト配列
返り値 Array (
[Result] => 正常フラグ [Continue] => 続行フラグ
[NextID] => 次候補アクティビティID [Value] => 結果値
[Command] => 実行したコマンド )
5.2.1.1.20 exeRetryAll メソッド
機能説明
RETRYALLコマンドを実行する
パラメータ id
アクティビティID val
コマンド引数 actArray
activitiesオブジェクト配列
objArray
objectivesオブジェクト配列
返り値 Array (
[Result] => 正常フラグ [Continue] => 続行フラグ
[NextID] => 次候補アクティビティID [Value] => 結果値
[Command] => 実行したコマンド )
5.2.1.1.21 getDeliveryControlsTracked メソッド
機能説明
$deliveryControlsプロパティ(Delivery Controls情報)のtracked属性の値を返す
パラメータ なし
返り値
$deliveryControlsプロパティ(Delivery Controls情報)のtracked属性の値
135