Element index for package Gliffy
[ a ]
[ b ]
[ c ]
[ d ]
[ e ]
[ f ]
[ g ]
[ h ]
[ i ]
[ k ]
[ l ]
[ m ]
[ n ]
[ o ]
[ p ]
[ r ]
[ s ]
[ t ]
[ u ]
[ v ]
[ w ]
[ _ ]
_
- $_rest
- in file Gliffy.php, variable Gliffy::$_rest
GliffyREST instance
- __construct
- in file OAuth.php, method OAuthServer::__construct()
- __construct
- in file OAuth.php, method SimpleOAuthDataStore::__construct()
- __construct
- in file OAuth.php, method OAuthToken::__construct()
key = the token
- __construct
- in file OAuth.php, method OAuthRequest::__construct()
- __construct
- in file OAuth.php, method OAuthConsumer::__construct()
- __construct
- in file GliffyException.php, method GliffyException::__construct()
Create a GliffyException with the given message
- __destruct
- in file OAuth.php, method SimpleOAuthDataStore::__destruct()
- __destruct
- in file Gliffy.php, method Gliffy::__destruct()
No-op destructor
- __toString
- in file OAuth.php, method OAuthToken::__toString()
- __toString
- in file OAuth.php, method OAuthConsumer::__toString()
- __toString
- in file OAuth.php, method OAuthRequest::__toString()
- $_GLIFFY_accountID
- in file config_example.php, global variable $_GLIFFY_accountID
The id of your account, as provided by Gliffy.
- $_GLIFFY_appDescription
- in file config_example.php, global variable $_GLIFFY_appDescription
This is a String description of the application you are building.
- $_GLIFFY_logLevel
- in file config_example.php, global variable $_GLIFFY_logLevel
The level of logging the Gliffy classes shoudl perform.
- $_GLIFFY_logTo_error_log
- in file config_example.php, global variable $_GLIFFY_logTo_error_log
This is for debugging and testing. If false, logging output will be sent using 'echo' instead of sent to the error_log.
- $_GLIFFY_oauth_consumer_key
- in file config_example.php, global variable $_GLIFFY_oauth_consumer_key
The oauth consumer key assigned to your account by Gliffy.
- $_GLIFFY_oauth_consumer_secret
- in file config_example.php, global variable $_GLIFFY_oauth_consumer_secret
The oauth consumer secret assiged to your account by Gliffy.
- $_GLIFFY_restRoot
- in file config_example.php, global variable $_GLIFFY_restRoot
This is the root of the Gliffy REST API. The value included in this distribution
- $_GLIFFY_restRootPassword
- in file config_example.php, global variable $_GLIFFY_restRootPassword
This is a password to access the REST Root via HTTP Basic Auth. This is
- $_GLIFFY_restRootUsername
- in file config_example.php, global variable $_GLIFFY_restRootUsername
This is a username to access the REST Root via HTTP Basic Auth. This is
- $_GLIFFY_root
- in file config_example.php, global variable $_GLIFFY_root
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.
- $_GLIFFY_strictREST
- in file config_example.php, global variable $_GLIFFY_strictREST
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.
- $_GLIFFY_verifySSLCert
- in file config_example.php, global variable $_GLIFFY_verifySSLCert
If using SSL, this instructs the underlying HTTP code to accept Untrusted SSL certificates.
- __construct
- in file GliffyAccount.php, method GliffyAccount::__construct()
- __construct
- in file GliffyTestAccount.php, method GliffyTestAccount::__construct()
- __toString
- in file GliffyError.php, method GliffyError::__toString()
Formats the http status and message in a suitable way for log messages
top
top
top
top
d
- $data_store
- in file OAuth.php, variable OAuthServer::$data_store
- debug
- in file GliffyLog.php, method GliffyLog::debug()
Print a debug message.
- deleteDiagram
- in file Gliffy.php, method Gliffy::deleteDiagram()
Deletes the diagram.
- deleteFolder
- in file Gliffy.php, method Gliffy::deleteFolder()
Deletes the folder with the given path. All diagrams in this folder will move to the default folder (which, incidentially, cannot be deleted).
- deleteToken
- in file Gliffy.php, method Gliffy::deleteToken()
Delete the OAuth token for this user, effectively logging the user out.
- deleteUser
- in file Gliffy.php, method Gliffy::deleteUser()
Deletes the given user (from this acount), which may not be the user whose session owns this object.
- diagrams_xml_name
- in file GliffyResponseParser.php, class constant GliffyResponseParser::diagrams_xml_name
- diagram_xml_name
- in file GliffyResponseParser.php, class constant GliffyResponseParser::diagram_xml_name
- $default
- in file GliffyFolder.php, variable GliffyFolder::$default
If true, this is the default folder for the account it is in
- $diagrams
- in file GliffyResponse.php, variable GliffyResponse::$diagrams
Array of GliffyDiagram objects
top
e
- error
- in file GliffyLog.php, method GliffyLog::error()
Print an error message.
- error_message
- in file GliffyResponseParser.php, method GliffyResponseParser::error_message()
If response() returns null, this provides a probably explanation as to the problem.
- error_xml_name
- in file GliffyResponseParser.php, class constant GliffyResponseParser::error_xml_name
- EXPIRE_TOLERANCE
- in file Gliffy.php, class constant Gliffy::EXPIRE_TOLERANCE
- $email
- in file GliffyUser.php, variable GliffyUser::$email
The user's email; this can be used to log them into the website outside of the API, but isn't
- $error
- in file GliffyResponse.php, variable GliffyResponse::$error
A GliffyError object
- $expiration_date
- in file GliffyUserToken.php, variable GliffyUserToken::$expiration_date
The unix timestamp when the token expires
- $expiration_date
- in file GliffyTestAccount.php, variable GliffyTestAccount::$expiration_date
Expiration date of the account, as a UNIX timestamp
- $expiration_date
- in file GliffyAccount.php, variable GliffyAccount::$expiration_date
Expiration date of the account, as a UNIX timestamp
top
f
- fetch_access_token
- in file OAuth.php, method OAuthServer::fetch_access_token()
process an access_token request
- fetch_private_cert
- in file OAuth.php, method OAuthSignatureMethod_RSA_SHA1::fetch_private_cert()
- fetch_public_cert
- in file OAuth.php, method OAuthSignatureMethod_RSA_SHA1::fetch_public_cert()
- fetch_request_token
- in file OAuth.php, method OAuthServer::fetch_request_token()
process a request_token request
- folders_xml_name
- in file GliffyResponseParser.php, class constant GliffyResponseParser::folders_xml_name
- folder_xml_name
- in file GliffyResponseParser.php, class constant GliffyResponseParser::folder_xml_name
- from_consumer_and_token
- in file OAuth.php, method OAuthRequest::from_consumer_and_token()
pretty much a helper function to set up the request
- from_request
- in file OAuth.php, method OAuthRequest::from_request()
attempt to build up a request from what was passed to the server
- $folders
- in file GliffyResponse.php, variable GliffyResponse::$folders
Array of GliffyFolder objects
- from_folder_xml
- in file GliffyFolder.php, method GliffyFolder::from_folder_xml()
- from_response_xml
- in file GliffyTestAccount.php, method GliffyTestAccount::from_response_xml()
- from_response_xml
- in file GliffyUser.php, method GliffyUser::from_response_xml()
- from_response_xml
- in file GliffyFolder.php, method GliffyFolder::from_response_xml()
- from_response_xml
- in file GliffyDiagram.php, method GliffyDiagram::from_response_xml()
- from_response_xml
- in file GliffyAccount.php, method GliffyAccount::from_response_xml()
top
g
- get
- in file GliffyREST.php, method GliffyREST::get()
Send a GET request to the given URL
- getAccountInfo
- in file Gliffy.php, method Gliffy::getAccountInfo()
- getAdmins
- in file Gliffy.php, method Gliffy::getAdmins()
Returns the list of "admins" for the account. Admins can mean whatever you want them to mean, however for Gliffy, an admin is simply someone who has access to all Folders of an account.
- getDiagramAsImage
- in file Gliffy.php, method Gliffy::getDiagramAsImage()
Gets the diagram as an image, possibly saving it to a file.
- getDiagramAsURL
- in file Gliffy.php, method Gliffy::getDiagramAsURL()
Returns a URL to the diagram that can be used in an HTML IMG tag.
- getDiagramAsXML
- in file Gliffy.php, method Gliffy::getDiagramAsXML()
- getDiagramMetaData
- in file Gliffy.php, method Gliffy::getDiagramMetaData()
Returns meta-data about a particular diagram.
- getDiagrams
- in file Gliffy.php, method Gliffy::getDiagrams()
Gets a list of diagrams, either for the entire account, or for the given folder.
- getEditDiagramLink
- in file Gliffy.php, method Gliffy::getEditDiagramLink()
Builds a returns a Gliffy editor launch link for the given diagram id
- getFolders
- in file Gliffy.php, method Gliffy::getFolders()
Returns all folders in this account.
- getUserDiagrams
- in file Gliffy.php, method Gliffy::getUserDiagrams()
Gets all diagrams that the user can access
- getUserFolders
- in file Gliffy.php, method Gliffy::getUserFolders()
Returns the folders the given user has access to.
- getUsers
- in file Gliffy.php, method Gliffy::getUsers()
Returns all users in the account, or in the folder specified.
- get_name
- in file OAuth.php, method OAuthSignatureMethod_HMAC_SHA1::get_name()
- get_name
- in file OAuth.php, method OAuthSignatureMethod_RSA_SHA1::get_name()
- get_name
- in file OAuth.php, method OAuthSignatureMethod_PLAINTEXT::get_name()
- get_normalized_http_method
- in file OAuth.php, method OAuthRequest::get_normalized_http_method()
just uppercases the http method
- get_normalized_http_url
- in file OAuth.php, method OAuthRequest::get_normalized_http_url()
parses the url and rebuilds it to be
- get_parameter
- in file OAuth.php, method OAuthRequest::get_parameter()
- get_parameters
- in file OAuth.php, method OAuthRequest::get_parameters()
- get_signable_parameters
- in file OAuth.php, method OAuthRequest::get_signable_parameters()
Returns the normalized parameters of the request
- get_signature_base_string
- in file OAuth.php, method OAuthRequest::get_signature_base_string()
Returns the base string of this request
- get_simple
- in file GliffyREST.php, method GliffyREST::get_simple()
Performs a get request 'text/xml' with no parameters.
- Gliffy
- in file Gliffy.php, method Gliffy::Gliffy()
Create a new connection to Gliffy.
- Gliffy
- in file Gliffy.php, class Gliffy
Primary method of interacting with Gliffy.
- Gliffy.php
- procedural page Gliffy.php
- GliffyException
- in file GliffyException.php, class GliffyException
An exception from Gliffy that you might be able to handle.
- GliffyException.php
- procedural page GliffyException.php
- GliffyLog
- in file GliffyLog.php, class GliffyLog
Class used for logging to the PHP error log console.
- GliffyLog
- in file GliffyLog.php, method GliffyLog::GliffyLog()
Create a GliffyLog
- GliffyLog.php
- procedural page GliffyLog.php
- GliffyResponseParser
- in file GliffyResponseParser.php, class GliffyResponseParser
Parses a Gliffy response.
- GliffyResponseParser
- in file GliffyResponseParser.php, method GliffyResponseParser::GliffyResponseParser()
Create a GliffyResponseParser for some received XML.
- GliffyResponseParser.php
- procedural page GliffyResponseParser.php
- GliffyREST
- in file GliffyREST.php, method GliffyREST::GliffyREST()
Create a GliffyREST object to make REST calls to Gliffy. The recommended usage of this is to ensure proper values for globals (see config_example.php) and to create this as needed using the user's login token.
- GliffyREST
- in file GliffyREST.php, class GliffyREST
Interacts with Gliffy REST protocol.
- GliffyREST.php
- procedural page GliffyREST.php
- GliffyAccount
- in file GliffyAccount.php, class GliffyAccount
Represents information about a Gliffy accont.
- GliffyAccount.php
- procedural page GliffyAccount.php
- GliffyDiagram
- in file GliffyDiagram.php, class GliffyDiagram
Information about a diagram in Gliffy
- GliffyDiagram
- in file GliffyDiagram.php, method GliffyDiagram::GliffyDiagram()
- GliffyDiagram.php
- procedural page GliffyDiagram.php
- GliffyError
- in file GliffyError.php, method GliffyError::GliffyError()
- GliffyError
- in file GliffyError.php, class GliffyError
An error message from Gliffy
- GliffyError.php
- procedural page GliffyError.php
- GliffyFolder
- in file GliffyFolder.php, class GliffyFolder
Represents information about a folder in Gliffy
- GliffyFolder
- in file GliffyFolder.php, method GliffyFolder::GliffyFolder()
- GliffyFolder.php
- procedural page GliffyFolder.php
- GliffyResponse
- in file GliffyResponse.php, class GliffyResponse
A response from Gliffy.
- GliffyResponse.php
- procedural page GliffyResponse.php
- GliffyTestAccount
- in file GliffyTestAccount.php, class GliffyTestAccount
Represents information about a Gliffy accont.
- GliffyTestAccount.php
- procedural page GliffyTestAccount.php
- GliffyUser
- in file GliffyUser.php, class GliffyUser
A user of Gliffy in an account
- GliffyUser
- in file GliffyUser.php, method GliffyUser::GliffyUser()
- GliffyUser.php
- procedural page GliffyUser.php
- GliffyUserToken
- in file GliffyUserToken.php, method GliffyUserToken::GliffyUserToken()
- GliffyUserToken
- in file GliffyUserToken.php, class GliffyUserToken
The token a user gets for using Gliffy
- GliffyUserToken.php
- procedural page GliffyUserToken.php
top
h
- hasToken
- in file Gliffy.php, method Gliffy::hasToken()
Returns true if this object has a token for the user. This makes no call to the server and will not try to update the user's token.
- $http_status
- in file GliffyError.php, variable GliffyError::$http_status
The HTTP status code that would've been used if HTTP was supported by your client.
top
i
- IMAGE_ERROR
- in file Gliffy.php, class constant Gliffy::IMAGE_ERROR
A static image you can use to indicate there is an error when viewing an image of a diagram
- IMAGE_NO_PERMISSION
- in file Gliffy.php, class constant Gliffy::IMAGE_NO_PERMISSION
A static image you can use to indicate there is a permission problem for viewing an image of a diagram
- index.php
- procedural page index.php
- info
- in file GliffyLog.php, method GliffyLog::info()
Print an informational message.
- $id
- in file GliffyTestAccount.php, variable GliffyTestAccount::$id
The id of the account, not guaranteed to be stable
- $id
- in file GliffyUser.php, variable GliffyUser::$id
User's id; not guaranteed to be stable
- $id
- in file GliffyDiagram.php, variable GliffyDiagram::$id
The id of the diagram. This is stable and can be used to reference a diagram
- $id
- in file GliffyAccount.php, variable GliffyAccount::$id
The id of the account, not guaranteed to be stable
- $image_data
- in file GliffyResponse.php, variable GliffyResponse::$image_data
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.
- $is_admin
- in file GliffyUser.php, variable GliffyUser::$is_admin
True if the user is an admin of the account from which this record was retrieved
- $is_private
- in file GliffyDiagram.php, variable GliffyDiagram::$is_private
True if diagram is private; viewable/editable only by its owner
- $is_public
- in file GliffyDiagram.php, variable GliffyDiagram::$is_public
True if diagram is public; viewable to the world
- isGliffyAssignedEmail
- in file GliffyUser.php, method GliffyUser::isGliffyAssignedEmail()
Returns true if the email address looks like one assigned by Gliffy.
top
top
l
- launch_link_xml_name
- in file GliffyResponseParser.php, class constant GliffyResponseParser::launch_link_xml_name
- level
- in file GliffyLog.php, method GliffyLog::level()
Gets this log's level.
- log
- in file GliffyLog.php, method GliffyLog::log()
Generic log function
- LOG_LEVEL_DEBUG
- in file GliffyLog.php, class constant GliffyLog::LOG_LEVEL_DEBUG
Logging level of debug, info, warnings, and errors
- LOG_LEVEL_ERROR
- in file GliffyLog.php, class constant GliffyLog::LOG_LEVEL_ERROR
Logging level of errors only
- LOG_LEVEL_INFO
- in file GliffyLog.php, class constant GliffyLog::LOG_LEVEL_INFO
Logging level of info, warnings, and errors
- LOG_LEVEL_WARN
- in file GliffyLog.php, class constant GliffyLog::LOG_LEVEL_WARN
Logging level of warnings and errors
- lookup_consumer
- in file OAuth.php, method SimpleOAuthDataStore::lookup_consumer()
- lookup_consumer
- in file OAuth.php, method OAuthDataStore::lookup_consumer()
- lookup_nonce
- in file OAuth.php, method SimpleOAuthDataStore::lookup_nonce()
- lookup_nonce
- in file OAuth.php, method OAuthDataStore::lookup_nonce()
- lookup_token
- in file OAuth.php, method SimpleOAuthDataStore::lookup_token()
- lookup_token
- in file OAuth.php, method OAuthDataStore::lookup_token()
- $launch_link
- in file GliffyResponse.php, variable GliffyResponse::$launch_link
A GliffyLaunchLink object
top
top
n
- new_access_token
- in file OAuth.php, method OAuthDataStore::new_access_token()
- new_access_token
- in file OAuth.php, method SimpleOAuthDataStore::new_access_token()
- new_request_token
- in file OAuth.php, method OAuthDataStore::new_request_token()
- new_request_token
- in file OAuth.php, method SimpleOAuthDataStore::new_request_token()
- new_token
- in file OAuth.php, method SimpleOAuthDataStore::new_token()
- $name
- in file GliffyFolder.php, variable GliffyFolder::$name
Name of the folder, used to refer to the folder
- $name
- in file GliffyTestAccount.php, variable GliffyTestAccount::$name
The name of the account
- $name
- in file GliffyAccount.php, variable GliffyAccount::$name
The name of the account
- $name
- in file GliffyDiagram.php, variable GliffyDiagram::$name
The name of this diagram
- $not_modified
- in file GliffyResponse.php, variable GliffyResponse::$not_modified
True if the call was a conditional get and the resource was not modified. This is not set in strict REST mode.
- $num_versions
- in file GliffyDiagram.php, variable GliffyDiagram::$num_versions
The number of versions of this diagram
top
o
- OAuth.php
- procedural page OAuth.php
- OAuthConsumer
- in file OAuth.php, class OAuthConsumer
- OAuthDataStore
- in file OAuth.php, class OAuthDataStore
- OAuthException
- in file OAuth.php, class OAuthException
- OAuthRequest
- in file OAuth.php, class OAuthRequest
- OAuthServer
- in file OAuth.php, class OAuthServer
- OAuthSignatureMethod
- in file OAuth.php, class OAuthSignatureMethod
- OAuthSignatureMethod_HMAC_SHA1
- in file OAuth.php, class OAuthSignatureMethod_HMAC_SHA1
- OAuthSignatureMethod_PLAINTEXT
- in file OAuth.php, class OAuthSignatureMethod_PLAINTEXT
- OAuthSignatureMethod_RSA_SHA1
- in file OAuth.php, class OAuthSignatureMethod_RSA_SHA1
- OAuthToken
- in file OAuth.php, class OAuthToken
- OAuthUtil
- in file OAuth.php, class OAuthUtil
- oauth_token_xml_name
- in file GliffyResponseParser.php, class constant GliffyResponseParser::oauth_token_xml_name
- $oAuthConsumerKey
- in file GliffyTestAccount.php, variable GliffyTestAccount::$oAuthConsumerKey
An OAuthConsumerKey to be used for testing purposes
- $oAuthConsumerSecret
- in file GliffyTestAccount.php, variable GliffyTestAccount::$oAuthConsumerSecret
An OAuthConsumerSecret to be used for testing purposes
- $oauth_token
- in file GliffyResponse.php, variable GliffyResponse::$oauth_token
top
p
- post
- in file GliffyREST.php, method GliffyREST::post()
Send a POST request to the given URL
- $path
- in file GliffyFolder.php, variable GliffyFolder::$path
Path of this folder that can be used in URLs
top
top
top
top
u
- updateDiagramContent
- in file Gliffy.php, method Gliffy::updateDiagramContent()
- updateToken
- in file GliffyREST.php, method GliffyREST::updateToken()
Update the token to use for requests.
- updateToken
- in file Gliffy.php, method Gliffy::updateToken()
Update the user's token, if it needs it. This gets the user token from Gliffy, which can have one of three effects:
- updateUser
- in file Gliffy.php, method Gliffy::updateUser()
Updates the user's information.
- urldecode_rfc3986
- in file OAuth.php, method OAuthUtil::urldecode_rfc3986()
- urlencode_rfc3986
- in file OAuth.php, method OAuthUtil::urlencode_rfc3986()
- users_xml_name
- in file GliffyResponseParser.php, class constant GliffyResponseParser::users_xml_name
- user_token_xml_name
- in file GliffyResponseParser.php, class constant GliffyResponseParser::user_token_xml_name
- user_xml_name
- in file GliffyResponseParser.php, class constant GliffyResponseParser::user_xml_name
- $username
- in file GliffyUser.php, variable GliffyUser::$username
The user's username, used to refer to them
- $users
- in file GliffyTestAccount.php, variable GliffyTestAccount::$users
The list of users in the account as @link GliffyUser objects (this may be null if the request didn't ask for them)
- $users
- in file GliffyResponse.php, variable GliffyResponse::$users
Array of GliffyUser objects in response to a request for users or admins.
- $users
- in file GliffyAccount.php, variable GliffyAccount::$users
The list of users in the account as @link GliffyUser objects (this may be null if the request didn't ask for them)
- $user_token
- in file GliffyResponse.php, variable GliffyResponse::$user_token
A GliffyUserToken object
top
top
top
|
|