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

Class: Services_UseKetchup

Source Location: /Services_UseKetchup-0.1.0/Services/UseKetchup.php

Class Overview

Services_UseKetchup_Common
   |
   --Services_UseKetchup

Services_UseKetchup


Author(s):

Version:

  • Release: 0.1.0

Variables

Methods


Inherited Variables

Inherited Methods

Class: Services_UseKetchup_Common

Services_UseKetchup_Common::accept()
Acceptor pattern.
Services_UseKetchup_Common::debugCall()
Collect debug information on the last call.
Services_UseKetchup_Common::getClient()
Return the instance of HTTP_Request2 or null.
Services_UseKetchup_Common::guessId()
Try to guess the ID (aka shortcode_url) from the variable.
Services_UseKetchup_Common::makeRequest()
Make an API request. Override the instance of HTTP_Request2 with self::accept() if you need to configure the object with a proxy or something similar.
Services_UseKetchup_Common::parseResponse()
Parse the response (from self::makeRequest().
Services_UseKetchup_Common::setApiToken()
Set an API Token.
Services_UseKetchup_Common::setPassword()
Set password.
Services_UseKetchup_Common::setUsername()
Set username.

Class Details

[line 66]
Services_UseKetchup


[ Top ]


Class Variables

$subs = array()

[line 71]

  • Var: See self::__get()
  • Access: protected

Type:   array


[ Top ]



Method Detail

__construct (Constructor)   [line 83]

$this __construct( string $username, string $password)

__construct

Initialize the class, and get an API token.

  • Access: public

Parameters:

string   $username     The useketchup.com username/email.
string   $password     The useketchup.com password.

[ Top ]

getApiToken   [line 151]

string getApiToken( )

Return/request an API token from useketchup. If one is already set, we return it instead of requesting one again.
  • Access: public
  • Uses: self::$apiToken

[ Top ]

setApiToken   [line 171]

void setApiToken( string $token)

To be able to mock requests, etc. later/
  • Access: public

Overrides Services_UseKetchup_Common::setApiToken() (Set an API Token.)

Parameters:

string   $token     Required for each call.

[ Top ]

__get   [line 98]

mixed __get( string $sub)

Magic getter.
  • Return: Services_UseKetchup_*
  • Throws: LogicException In case something unsupported is requested.
  • Access: public
  • Uses: self::getApiToken()

Parameters:

string   $sub     Items, Meetings, Notes, Projects or User.

[ Top ]


Documentation generated on Fri, 17 Sep 2010 13:30:03 +0000 by phpDocumentor 1.4.3. PEAR Logo Copyright © PHP Group 2004.