Class Golem_Api_Special_List

Description

Class for accessing the list of special categories via web interface.

Located in /Api/Special/List.php (line 52)


	
			
Class Constant Summary
 URL = 'http://api.golem.de/api/special/list/'
Variable Summary
String $key
Array $specials
Method Summary
Golem_Api_Special_List __construct (String $key)
Boolean fetch ([Array $curlOptions = array()])
Array getSpecials ()
Variables
String $key = null (line 70)

Developer access key

  • access: protected
Array $specials = array() (line 64)

special category data

  • access: protected
Methods
Constructor __construct (line 77)

Creates the Special_List object

  • access: public
Golem_Api_Special_List __construct (String $key)
  • String $key: your developer key
fetch (line 100)

Does the request to get the list of special categories.

If the request was succesful, true will be returned, else an exception will be thrown.

The possible Exception code is Golem_Request::DATABASE.

After a successful request the special category list is available from getSpecials().

  • return: true, if request was successful
  • access: public
Boolean fetch ([Array $curlOptions = array()])
  • Array $curlOptions: optional options for cUrl
getSpecials (line 130)

Returns the list of special categories.

In the array, each entry represents a special category record. The keys of record array are:

  • name - String - special category name
  • shortname - String - short special category name, used as identifier
  • url - String - URL to the special category name

  • access: public
Array getSpecials ()
Class Constants
URL = 'http://api.golem.de/api/special/list/' (line 58)

Base url of the webservice

Documentation generated on Tue, 20 Apr 2010 14:21:07 +0200 by phpDocumentor 1.4.3