NotificationInterface
extends
XmlSerializable
in
This interface reflects a single notification type.
Tags
Table of Contents
- getETag() : string
- Returns the ETag for this notification.
- getId() : string
- Returns a unique id for this notification.
- xmlSerialize() : mixed
- The xmlSerialize method is called during xml writing.
- xmlSerializeFull() : mixed
- This method serializes the entire notification, as it is used in the response body.
Methods
getETag()
Returns the ETag for this notification.
public
getETag() : string
The ETag must be surrounded by literal double-quotes.
Return values
string —getId()
Returns a unique id for this notification.
public
getId() : string
This is just the base url. This should generally be some kind of unique id.
Return values
string —xmlSerialize()
The xmlSerialize method is called during xml writing.
public
xmlSerialize(Writer $writer) : mixed
Use the $writer argument to write its own xml serialization.
An important note: do not create a parent element. Any element implementing XmlSerializble should only ever write what's considered its 'inner xml'.
The parent of the current element is responsible for writing a containing element.
This allows serializers to be re-used for different element names.
If you are opening new elements, you must also close them again.
Parameters
- $writer : Writer
Return values
mixed —xmlSerializeFull()
This method serializes the entire notification, as it is used in the response body.
public
xmlSerializeFull(Writer $writer) : mixed
Parameters
- $writer : Writer