Detailed Description
What reading a 51Did produced, and why.
The same three facts are always reported, exactly as the OWID library reports them for an envelope. Whether it worked, which ordinary caller logic tests with if ($result->ok). The 51Did, which is present only on success and is never a half read one. A named reason, which is {
- See also
- ParseStatus::Parsed} on success and the specific problem otherwise.
The reason is one of two kinds and a caller can tell them apart by type. A {
- See also
- ParseStatus} came from the OWID library and means the envelope itself could not be read, and it is the library's own value with nothing mapped or renamed. A {
-
FodIdParseStatus} means the envelope was sound and the payload inside it does not fit a 51Did. Both are string backed with the cross language name of the status, so
$result->status->valueis safe to log whichever kind it is.
A successful result says nothing about the signature. A parsed 51Did is not necessarily genuine, and {
- See also
- FodId::verify()}, {
- FodId::signatureStatus()} or {
- DidClient::verifySignature()} answer that separately.
The fields are read only, so a result cannot be changed into saying something the read did not find.
Static Public Member Functions | |
| static | parsed (FodId $fodId) |
| A successful read of the 51Did given. | |
| static | failed (ParseStatus|FodIdParseStatus $status) |
| A read that did not produce a 51Did, for the reason given. | |