Class Error

A common representation of an error on the FamilySearch platform.

Namespace: Gedcomx\Extensions\FamilySearch
Located at Extensions/FamilySearch/Error.php

Methods summary

`public`	# `__construct( mixed $o = null )` Constructs a Error from a (parsed) JSON hash Constructs a Error from a (parsed) JSON hash Parameters `$o` Either an array (JSON) or an XMLReader.
`public integer`	# `getCode( )` The error code. Intepreted per <a href="http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html">RFC 2616, Section 10 (HTTP Status Code Definitions)</a>. The error code. Intepreted per <a href="http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html">RFC 2616, Section 10 (HTTP Status Code Definitions)</a>. Returns integer
`public`	# `setCode( integer $code )` The error code. Intepreted per <a href="http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html">RFC 2616, Section 10 (HTTP Status Code Definitions)</a>. The error code. Intepreted per <a href="http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html">RFC 2616, Section 10 (HTTP Status Code Definitions)</a>. Parameters `$code`
`public string`	# `getLabel( )` A text label associated with the error code. A text label associated with the error code. Returns string
`public`	# `setLabel( string $label )` A text label associated with the error code. A text label associated with the error code. Parameters `$label`
`public string`	# `getMessage( )` A message associated with the error. A message associated with the error. Returns string
`public`	# `setMessage( string $message )` A message associated with the error. A message associated with the error. Parameters `$message`
`public string`	# `getStacktrace( )` The back-end stack trace associated with the error, useful for debugging. The back-end stack trace associated with the error, useful for debugging. Returns string
`public`	# `setStacktrace( string $stacktrace )` The back-end stack trace associated with the error, useful for debugging. The back-end stack trace associated with the error, useful for debugging. Parameters `$stacktrace`
`public array`	# `toArray( )` Returns the associative array for this Error Returns the associative array for this Error Returns array
`public string`	# `toJson( )` Returns the JSON string for this Error Returns the JSON string for this Error Returns string
`public`	# `initFromArray( array $o )` Initializes this Error from an associative array Initializes this Error from an associative array Parameters `$o`
`public`	# `initFromReader( XMLReader $xml )` Initializes this Error from an XML reader. Initializes this Error from an XML reader. Parameters `$xml` The reader to use to initialize this object.
`public`	# `toXml( XMLWriter $writer, boolean $includeNamespaces = true )` Writes this Error to an XML writer. Writes this Error to an XML writer. Parameters `$writer` The XML writer. `$includeNamespaces` Whether to write out the namespaces in the element.
`public`	# `writeXmlContents( XMLWriter $writer )` Writes the contents of this Error to an XML writer. The startElement is expected to be already provided. Writes the contents of this Error to an XML writer. The startElement is expected to be already provided. Parameters `$writer` The XML writer.