A classe MbsMessage representa uma das árvores lógicas que compõem a montagem da mensagem.
A classe MbsMessage fornece os métodos API mostrados na tabela a seguir. Os parâmetros entre colchetes são opcionais:
Método | Descrição |
---|---|
Constructor([MbsMessage $msg]) | Instancia um novo objeto de mensagem, que é uma cópia do parâmetro msg (opcional). Se nenhum parâmetro for fornecido, uma nova mensagem vazia é criada. |
int getType() | Retorna o tipo específico do elemento raiz. |
array xpath(string $expression [, array $namespace]) | Avalia a expressão XPath usando o último filho da raiz (elemento de corpo) como o nó de contexto. Retorna o resultado como uma cadeia, double, booleano ou um nodeset como uma matriz de objetos MbsElement. O parâmetro opcional namespace é uma matriz associativa com prefixo de namespace como as URIs de teclas e namespace e como os valores. |
MbsElement getChild(string $name [, int $occurrence]) | Retorna o primeiro filho do elemento raiz cujo nome é dado pelo primeiro parâmetro. A na ocorrência desse filho pode ser retornada especificando o segundo parâmetro opcional. |
array getChildren([string $namespace]) | Retorna todos os elementos filhos do elemento raiz como uma matriz de MbsElements. Se o parâmetro namespace for especificado, a matriz conterá somente os elementos filhos com esse URI de namespace. |
MbsElement getFirstChild() | Retorna o primeiro filho do elemento raiz. |
MbsElement getLastChild() | Retorna o último filho do elemento raiz. |
MbsElement addElement(string $name, object $value [, string $namespace [, int $type [, int $position]]]) | Cria um elemento como último filho (por padrão) do elemento raiz. O parâmetro type opcional
é o tipo específico de analisador do novo nó, que é padrão para o
tipo de elemento XML para analisadores XML. O parâmetro position opcional
pode ser um dos seguintes valores:
|
MbsElement addDomainElement(string $domainName) | Cria um elemento de domínio. |
void detachAllChildren() | Separa todos os elementos filhos do elemento-raiz. |
string asBitstream([array $options]) | Serializa a árvore de elementos para produzir um fluxo
de bits. Ao utilizar o analisador MRM (e outros analisadores), a matriz options
deve estar preenchida com os seguintes pares chave/de valor:
|
void addElementFromBitstream(string $bitstream [, array $options]) | Cria uma árvore de elementos a partir do fluxo de bits fornecido. Sem options fornecido, o fluxo de bits é analisado pelo analisador do elemento-raiz e conectado como seu último filho (nenhum elemento de domínio é criado neste caso). Caso seja fornecido options, deve conter o par valor/tecla 'domain' => '<parserDomain>' além de qualquer opção adicional para o analisador MRM (consulte asBitstream()). Nesse caso, um elemento analisador é criado no cabeçalho na nova subárvore e conectado como último filho do elemento raiz. |