ParseSamlSpMetadata
in package
implements
JsonSerializable
`POST …/saml/parse-sp-metadata` body: **exactly one** of the two members.
Every property is optional: one you leave unset is omitted from the wire request entirely rather than sent as null (§27.4 rule 5).
Table of Contents
Interfaces
- JsonSerializable
Properties
- $metadataUrl : string|null
- $metadataXml : string|null
Methods
- __construct() : mixed
- Constructs a ParseSamlSpMetadata.
- fromArray() : self
- Rebuilds a ParseSamlSpMetadata from one decoded JSON object.
- fromUrl() : self
- A request for the server to fetch the SP's metadata from `$value` (`https` only, through its SSRF guard). Leaves `metadata_xml` absent.
- fromXml() : self
- A request carrying the SP's metadata document itself (at most 512 KiB). Leaves `metadata_url` absent.
- jsonSerialize() : array<string, mixed>
- Renders this object for `json_encode()`.
- toArray() : array<string, mixed>
- Renders this object back to its wire form.
Properties
$metadataUrl read-only
public
string|null
$metadataUrl
= null
$metadataXml read-only
public
string|null
$metadataXml
= null
Methods
__construct()
Constructs a ParseSamlSpMetadata.
public
__construct([string|null $metadataUrl = null ][, string|null $metadataXml = null ]) : mixed
Parameters
- $metadataUrl : string|null = null
-
An
httpsURL the server fetches the document from, once, through its SSRF guard. (optional) - $metadataXml : string|null = null
-
A metadata document, at most 512 KiB. (optional)
fromArray()
Rebuilds a ParseSamlSpMetadata from one decoded JSON object.
public
static fromArray(array<string, mixed> $data) : self
Parameters
- $data : array<string, mixed>
-
The raw wire object.
Return values
selffromUrl()
A request for the server to fetch the SP's metadata from `$value` (`https` only, through its SSRF guard). Leaves `metadata_xml` absent.
public
static fromUrl(string $value) : self
Parameters
- $value : string
-
the
metadata_urlmember
Return values
selffromXml()
A request carrying the SP's metadata document itself (at most 512 KiB). Leaves `metadata_url` absent.
public
static fromXml(string $value) : self
Parameters
- $value : string
-
the
metadata_xmlmember
Return values
selfjsonSerialize()
Renders this object for `json_encode()`.
public
jsonSerialize() : array<string, mixed>
Any Sensitive it carries stays WRAPPED here, so a log line or a
json_encode($model) in application code prints [SENSITIVE]. The one place a secret
is revealed is ManagementTransport, on the way to the wire
and nowhere else (§27.5).
Return values
array<string, mixed>toArray()
Renders this object back to its wire form.
public
toArray() : array<string, mixed>
§27.4 rule 5: a null property is OMITTED, not emitted as null. On a sparse update those two say opposite things — "leave this alone" versus "set this to nothing" — and only omission means the first.