Docs For Class AtomAPI

Description

Located in /class.atomapi.php (line 53)

Variable Summary

mixed $auth

mixed $authtype

mixed $endpoint

mixed $err_no

mixed $feeds

mixed $feed_objs

Method Summary

AtomAPI/FALSE AtomAPI (String $endpoint, String $username, String $password, String $authtype)

Int/FALSE error ()

AuthenticationObject get_auth ()

String get_authtype ()

String/FALSE get_endpoint ()

Array/String get_entries (Int $id)

AtomFeed get_feed (Int $id)

Array/String get_feeds ([mixed $xml = false])

void set_authtype (String $type, String $user, String $pass)

void set_endpoint (String $uri)

Boolean verify_auth ()

Variables

mixed $auth (line 56)

mixed $authtype (line 55)

mixed $endpoint (line 54)

mixed $err_no (line 59)

mixed $feeds (line 57)

mixed $feed_objs (line 58)

Methods

Constructor AtomAPI (line 69)

Creates an AtomAPI Object, verifying authentication details by attempting to load a list of feeds. $authtype should be 'Basic' or 'WSSE'

AtomAPI/FALSE AtomAPI (String $endpoint, String $username, String $password, String $authtype)

String $endpoint
String $username
String $password
String $authtype

error (line 295)

Returns the last error registered in this class, or FALSE if none

Int/FALSE error ()

get_auth (line 173)

Returns an authentication object (either WSSE or Basic)

AuthenticationObject get_auth ()

get_authtype (line 144)

Returns the current authentication model (Basic or WSSE)

String get_authtype ()

get_endpoint (line 108)

Return the endpoint set for this AtomAPI or FALSE if unset

String/FALSE get_endpoint ()

get_entries (line 274)

Creates an AtomFeed object for the details specified in $id, and gets the entries available. Stores the object internally for later

Array/String get_entries (Int $id)

Int $id

get_feed (line 248)

Creates (if required) and returns an AtomFeed object, based on an $id for the feeds array (pulled from endpoint)

AtomFeed get_feed (Int $id)

Int $id

get_feeds (line 181)

Returns an array containing the details of the feeds listed at the endpoint. On failure, returns the HTTPCode as a string instead

Array/String get_feeds ([mixed $xml = false])

set_authtype (line 124)

Creates the authentication object for this Atom API, based on the type specified. Currently supports WSSE and Basic as $type

void set_authtype (String $type, String $user, String $pass)

String $type
String $user
String $pass

set_endpoint (line 95)

Set the endpoint for accessing this AtomAPI. Must be a fully-qualified URI starting with 'http'

void set_endpoint (String $uri)

String $uri

verify_auth (line 152)

Verifies authentication details by attempting to access the endpoint. If successful, initiates the list of available feeds and returns true, otherwise returns false.

Boolean verify_auth ()