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

Class: Services_UseKetchup_Notes

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

Class Overview

Services_UseKetchup_Common
   |
   --Services_UseKetchup_Notes

Services_UseKetchup_Notes


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 56]
Services_UseKetchup_Notes


[ Top ]


Class Variables

$lastCreated =

[line 63]

  • See: self::add()
  • See: self::getLastCreated()
  • Access: protected

Type:   stdClass


[ Top ]



Method Detail

add   [line 75]

boolean add( mixed $item, $note)

Add a note to an item.
  • See: self::getLastCreated();
  • Access: public

Parameters:

mixed   $item     Either a string (an ID/shortcode_url), or a stdClass with an attribute shortcode_url.
stdClass   $note     The note object.

[ Top ]

delete   [line 101]

boolean delete( mixed $note)

Delete a note.
  • Access: public

Parameters:

mixed   $note     Either stdClass (with shortcode_url), or the shortcode_url of the node.

[ Top ]

getLastCreated   [line 190]

stdClass getLastCreated( )

Get last created meeting.
  • See: self::add()
  • Throws: RuntimeException When called prior to add().
  • Access: public
  • Uses: self::$lastCreated

[ Top ]

show   [line 124]

array show( mixed $item)

Show all notes of a given item.
  • Return: An array stacked with stdClass.
  • Access: public

Parameters:

mixed   $item     Either stdClass (with shortcode_url), or the shortcode_url of the item.

[ Top ]

sort   [line 140]

void sort( mixed $item, $sort)

Change sort order of the given nodes on an item.
  • Access: public

Parameters:

mixed   $item     Either stdClass (with shortcode_url), or the shortcode_url of the item.
stdClass   $sort     {'notes':['SHORTCODE_URL', 'SHORTCODE_URL']}

[ Top ]

update   [line 165]

boolean update( $note)

Update a note.
  • Access: public

Parameters:

stdClass   $note     The note object (must contain a shortcode_url attribute).

[ Top ]


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