Utility/Serialization/XmlObjectSerializer.phpView Source

Show: PublicProtectedPrivateinherited
Table of Contents
Package
Default  

\XmlObjectSerializer
jump to top

Package: Default
Xml Serialize(r) to serialize and de serialize.
Parent(s)
\IEntitySerializer
Inherited_from
\IEntitySerializer  

Properties

>VPropertypublic\ILogger $IDSLogger
IDS Logger
Details
Type
\ILogger
>VPropertyprivateString $resourceURL = null
Keeps last used object name
Default valuenullDetails
Type
String

Methods

methodpublicDeserialize( $message,  $bLimitToOne = FALSE) : object

DeSerializes the specified action entity type.

Parameters
NameTypeDescription
$message
$bLimitToOne
Returns
TypeDescription
objectReturns the de serialized object.
methodpublicDeserialize( $message,  $limit = FALSE) : string
inherited

DeSerializes the message to Type T.

Inherited from:
Parameters
NameTypeDescription
$message
$limit
Returns
TypeDescription
stringReturns the deserialized message.
methodprivateParseArbitraryResultObjects(string $responseXml, boolean $bLimitToOne) : array
static

Parse an XML string into an array of IPPIntuitEntity objects

Parameters
NameTypeDescription
$responseXmlstring

XML string to parse

$bLimitToOneboolean

Signals to only parse the first element

Returns
TypeDescription
arrayof IPPIntuitEntity objects
methodprivatePhpObjFromXml( $className,  $xmlStr) : \POPOObject
static

Unmarshall XML into a POPO object, presumably the XML came from an IPP v3 API call

Parameters
NameTypeDescription
$className
$xmlStr
Returns
TypeDescription
\POPOObject$phpObj resulting POPO object
methodpublicSerialize( $entity) : string

Serializes the specified entity and updates last used entity name @see resourceURL

Parameters
NameTypeDescription
$entity
Returns
TypeDescription
stringReturns the serialize entity in string format.
methodpublicSerialize( $entity) : object
inherited

Serializes the specified entity.

Inherited from:
Parameters
NameTypeDescription
$entity
Returns
TypeDescription
objectReturns the serialize entity in string format.
methodpublic__construct( $idsLogger = NULL) : void

Initializes a new instance of the XmlObjectSerializer class.

Parameters
NameTypeDescription
$idsLogger
methodpubliccleanPhpClassNameToIntuitEntityName(string $phpClassName) : string
static

Clean a POPO class name (like 'IPPClass') to be an IPP v3 Entity name (like 'Class')

Parameters
NameTypeDescription
$phpClassNamestring

POPO class name

Returns
TypeDescription
stringIntuit Entity name
methodpubliccleanPhpClassNameToIntuitEntityName(string $phpClassName) : string
staticinherited

Clean a POPO class name (like 'IPPClass') to be an IPP v3 Entity name (like 'Class')

Inherited from:
Parameters
NameTypeDescription
$phpClassNamestring

POPO class name

Returns
TypeDescription
stringIntuit Entity name
methodprivatedecorateIntuitEntityToPhpClassName( $intuitEntityName) : \POPO
static

Decorate an IPP v3 Entity name (like 'Class') to be a POPO class name (like 'IPPClass')

Parameters
NameTypeDescription
$intuitEntityName
Returns
TypeDescription
\POPOclass name
methodpublicgetPostXmlFromArbitraryEntity(\IPPIntuitEntity $entity, string $urlResource) : string
static

Marshall a POPO object to be XML

Parameters
NameTypeDescription
$entity\IPPIntuitEntity

The POPO object

$urlResourcestring

the type of the POPO object

Returns
TypeDescription
stringthe XML of the POPO object
methodpublicgetResourceURL() : string

Returns last used resource URL (which entity name)

Returns
TypeDescription
string
methodpublicgetResourceURL() : void
inherited

Returns resource url (basically message type)

Inherited from:
methodprivategetXmlFromObj(\POPOObject $phpObj) : string
static

Marshall a POPO object to XML, presumably for inclusion on an IPP v3 API call

Parameters
NameTypeDescription
$phpObj\POPOObject

inbound POPO object

Returns
TypeDescription
stringXML output derived from POPO object
methodpublicresetResourceURL() : void

Reset value for resourceURL to null

Documentation was generated by phpDocumentor 2.8.5.