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

Procedural File: config_example.php

Source Location: /config_example.php



Page Details:

Example Configuration file for Gliffy PHP Client. Copy this to "config.php" and edit this based on your account's information.

At a minimum, you'll need to update the values for the following:

  • $_GLIFFY_appDescription
  • $_GLIFFY_accountID
  • $_GLIFFY_oauth_consumer_key
  • $_GLIFFY_oauth_consumer_secret







string $_GLIFFY_accountID [line 45]

The id of your account, as provided by Gliffy.

If you don't have your API credentials, visit http://www.gliffy.com/developer/ to look them up


Default value:   "Your Account ID"


[ Top ]



string $_GLIFFY_appDescription [line 37]

This is a String description of the application you are building.

Helps Gliffy track which integrations are popular. This is required.


Default value:   "Your Application Description"


[ Top ]



string $_GLIFFY_logLevel [line 86]

The level of logging the Gliffy classes shoudl perform.

Setting this to LOG_LEVEL_DEBUG can help diagnose issues on the client side.


Default value:   GliffyLog::LOG_LEVEL_INFO


[ Top ]



boolean $_GLIFFY_logTo_error_log [line 119]

This is for debugging and testing. If false, logging output will be sent using 'echo' instead of sent to the error_log.

You probably want this to be true so that logging goes to the php error_log.


Default value:   true


[ Top ]



string $_GLIFFY_oauth_consumer_key [line 53]

The oauth consumer key assigned to your account by Gliffy.

If you don't have your API credentials, visit http://www.gliffy.com/developer/ to look them up


Default value:   "Your OAuth Consumer Key"


[ Top ]



string $_GLIFFY_oauth_consumer_secret [line 61]

The oauth consumer secret assiged to your account by Gliffy.

WARNING: You should never share your oauth consumer secret as this will allow others to access documents in your account


Default value:   "Your OAuth Consumer Secret"


[ Top ]



string $_GLIFFY_restRoot [line 29]

This is the root of the Gliffy REST API. The value included in this distribution

is probably correct, however check the Gliffy Developer Site for more details. This should not include a trailing slash


Default value:   $_GLIFFY_root . "/api/1.0"


[ Top ]



string $_GLIFFY_restRootPassword [line 102]

This is a password to access the REST Root via HTTP Basic Auth. This is

not needed for normal usages of Gliffy, and is here for testing purposes


Default value:   null


[ Top ]



string $_GLIFFY_restRootUsername [line 94]

This is a username to access the REST Root via HTTP Basic Auth. This is

not needed for normal usages of Gliffy, and is here for testing purposes


Default value:   null


[ Top ]



string $_GLIFFY_root [line 20]

This is the root of the Gliffy web app. The value included in this distribution is probably correct, however check the Gliffy Developer Site for more details.

This should start with either "http://" or "https://" and should not include a trailing slash. Note that https may not be supported for your account type.


Default value:   "http://www.gliffy.com"


[ Top ]



boolean $_GLIFFY_strictREST [line 70]

Setting this to true instructs Gliffy to operate in a strict HTTP/REST mode, where errors that occur result in HTTP status codes and not <go-error> XML responses. You probably want to keep this false.

Default value:   false


[ Top ]



boolean $_GLIFFY_verifySSLCert [line 78]

If using SSL, this instructs the underlying HTTP code to accept Untrusted SSL certificates.

You should probably never need to set this to true


Default value:   false


[ Top ]






Documentation generated on Wed, 01 Apr 2009 18:11:07 -0700 by phpDocumentor 1.4.1