[ class tree: Gliffy ] [ index: Gliffy ] [ all elements ]

Class: GliffyResponse

Source Location: /GliffyResponse.php

Class Overview


A response from Gliffy.


Variables



Class Details

[line 17]
A response from Gliffy.

This is a union of all possible responses, including those formatted to the Gliffy Response XSD, as well as binary/image responses.

Exactly one of the public fields will have a value. Since you will know which one to expect based upon your request, you can simply access it. If it is null, $error should have a value explaining why your expected field was null. Note that errors from Gliffy are either because you've made a bad request, or something bad happened on the Gliffy side. In both cases, you will want to provide the user with a better error message than the one you get from $error. That is useful for your own debugging or reporting problems to Gliffy




[ Top ]


Class Variables

$accounts =

[line 21]

Array of GliffyAccount objects.



Tags:

access:  public

Type:   array


[ Top ]

$content =

[line 65]

The unparsed response (this is only filled in if you specifically requested that GliffyResponseParser save it).



Tags:

access:  public

Type:   mixed


[ Top ]

$diagrams =

[line 27]

Array of GliffyDiagram objects



Tags:

access:  public

Type:   array


[ Top ]

$error =

[line 44]

A GliffyError object



Tags:

access:  public

Type:   GliffyError


[ Top ]

$folders =

[line 30]

Array of GliffyFolder objects



Tags:

access:  public

Type:   array


[ Top ]

$image_data =

[line 59]

If the request was for an image, this contains the image's bytes. Note that the format of this depends on the requested mime type. Gliffy should not send you back a mime type different than what you requested, so you can reliably assume that if this is set, it will be the type requested.



Tags:

access:  public

Type:   mixed


[ Top ]

$launch_link =

[line 41]

A GliffyLaunchLink object



Tags:

access:  public

Type:   GliffyLaunchLink


[ Top ]

$not_modified =

[line 52]

True if the call was a conditional get and the resource was not modified. This is not set in strict REST mode.



Tags:

access:  public

Type:   boolean


[ Top ]

$oauth_token =

[line 33]



Tags:

access:  public

Type:   mixed


[ Top ]

$success =

[line 48]

True if the call was successful, though you can just interrogate the item you expect.



Tags:

access:  public

Type:   boolean


[ Top ]

$users =

[line 24]

Array of GliffyUser objects in response to a request for users or admins.



Tags:

access:  public

Type:   array


[ Top ]

$user_token =

[line 37]

A GliffyUserToken object



Tags:

access:  public

Type:   GliffyUserToken


[ Top ]



Documentation generated on Mon, 13 Jul 2009 19:54:34 -0500 by phpDocumentor 1.4.1