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

Class: Services_UseKetchup_Meetings

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

Class Overview

Services_UseKetchup_Common
   |
   --Services_UseKetchup_Meetings

Services_UseKetchup_Meetings


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_Meetings


[ Top ]


Class Variables

$lastCreated =

[line 63]

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

Type:   stdClass


[ Top ]



Method Detail

add   [line 72]

true add( stdClass $meeting)

Add a new meeting.
  • Access: public

Parameters:

stdClass   $meeting   —  The meeting object.

[ Top ]

delete   [line 96]

boolean delete( mixed $meeting)

Delete a meeting.
  • Access: public

Parameters:

mixed   $meeting   —  Either a string, or stdClass. If stdClass, it must contain a shortcode_url attribute.

[ Top ]

getLastCreated   [line 222]

stdClass getLastCreated( )

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

[ Top ]

ics   [line 118]

string ics( [boolean $lean = false])

Get an ICS calendar of your meetings.
  • Access: public

Parameters:

boolean   $lean   —  Lean = true, is faster, but less verbose.

[ Top ]

previous   [line 130]

array previous( [boolean $lean = false])

Get all previous meetings.
  • Return: An array stacked with stdClass.
  • Access: public

Parameters:

boolean   $lean   —  Lean = true, is faster, but less verbose.

[ Top ]

show   [line 145]

string|array show( [boolean $lean = false], [boolean $ics = false], [string $url = '/meetings.'])

Get meetings.
  • Return: String, if $ics = true, otherwise an array stacked with stdClass.
  • Access: public

Parameters:

boolean   $lean   —  Lean = true, is faster, but less verbose.
boolean   $ics   —  If you'd like an ICS instead (see self::ics().
string   $url   —  Optional, for previous, upcoming, todays, etc..

[ Top ]

todays   [line 168]

array todays( [boolean $lean = false])

Get todays meetings.
  • Return: An array stacked with stdClass.
  • Access: public

Parameters:

boolean   $lean   —  Lean = true, is faster, but less verbose.

[ Top ]

upcoming   [line 180]

array upcoming( [boolean $lean = false])

Get all upcoming meetings.
  • Return: An array stacked with stdClass.
  • Access: public

Parameters:

boolean   $lean   —  Lean = true, is faster, but less verbose.

[ Top ]

update   [line 192]

boolean update( stdClass $meeting)

Update a meeting.
  • Access: public

Parameters:

stdClass   $meeting   —  The meeting object.

[ Top ]


Documentation generated on Mon, 11 Mar 2019 15:39:04 -0400 by phpDocumentor 1.4.4. PEAR Logo Copyright © PHP Group 2004.