MbsMessage クラスは、メッセージ・アセンブリーを構成する論理ツリーの 1 つを表します。
MbsMessage クラスは、以下の表で示されている API メソッドを提供します。 大括弧内のパラメーターはオプションです。
メソッド | 説明 |
---|---|
Constructor([MbsMessage $msg]) | msg パラメーターのコピーである新規メッセージ・オブジェクトをインスタンス化します (オプション)。 パラメーターが提供されない場合、新しい空のメッセージが作成されます。 |
int getType() | ルート・エレメントの固有のタイプを戻します。 |
array xpath(string $expression [, array $namespace]) | ルートの最後の子 (BODY 要素) をコンテキスト・ノードとして使用して XPath 式を評価します。 結果をストリング、倍精度、ブール、または MbsElement オブジェクトの配列でのノードセットのいずれかで戻します。 オプションの namespace パラメーターは、キーとしてネーム・スペース接頭部があり、値としてネーム・スペース URI がある結合配列です。 |
MbsElement getChild(string $name [, int $occurrence]) | 名前が最初のパラメーターにより付与される、ルート・エレメントの最初の子を戻します。 2 番目のオプション・パラメーターを指定することによって、子の n 番目のオカレンスを返すことができます。 |
array getChildren([string $namespace]) | ルート・エレメントのすべての子エレメントを MbsElements の配列として戻します。 namespace パラメーターが指定された場合、配列にはそのネーム・スペース URI を持つ子エレメントのみが入ります。 |
MbsElement getFirstChild() | ルート・エレメントの最初の子を戻します。 |
MbsElement getLastChild() | ルート・エレメントの最後の子を戻します。 |
MbsElement addElement(string $name, object $value [, string $namespace [, int $type [, int $position]]]) | エレメントをルート・エレメントの最後の子 (デフォルト) として作成します。 オプションの type パラメーターは、パーサー固有タイプの新規ノードであり、これは XML パーサーの場合は XML エレメント・タイプがデフォルトになります。 オプションの position パラメーターは、以下のいずれかの値にすることができます。
|
MbsElement addDomainElement(string $domainName) | ドメイン・エレメントを作成します。 |
void detachAllChildren() | ルート・エレメントのすべての子エレメントを切り離します。 |
string asBitstream([array $options]) | エレメント・ツリーを直列化して、ビット・ストリームを生成します。 MRM パーサー (および他のパーサー) を使用する場合、options 配列には以下のキー/値のペアを取り込む必要があります。
|
void addElementFromBitstream(string $bitstream [, array $options]) | エレメント・ツリーを提供されたビット・ストリームから作成します。 options の提供がない場合、ビット・ストリームはルート・エレメントのパーサーで構文解析され、その最後の子として付加されます (この場合、ドメイン・エレメントは作成されません)。 options が提供される場合、それにはキー/値のペア 'domain' => '<parserDomain>' と、MRM パーサーの任意の追加オプションが含まれなければなりません (asBitstream() を参照)。 この場合、パーサー・エレメントは新規サブツリーのヘッドで作成され、ルート・エレメントの最後の子として付加されます。 |