[AtomAPI] element index

$auth

AtomAPI::$auth in class.atomapi.php

$auth

AtomRequest::$auth in class.atomapi.php

$auth

AtomFeed::$auth in class.atomapi.php

$author

AtomEntry::$author in class.atomapi.php

$author

AtomFeed::$author in class.atomapi.php

$authtype

AtomAPI::$authtype in class.atomapi.php

add_entry

AtomFeed::add_entry() in class.atomapi.php

Add an AtomEntry object to the array of entries that make up this AtomFeed

add_link

AtomFeed::add_link() in class.atomapi.php

Adds a link to the links array with the details as per the associative array passed in. Requires href, rel, title and type

add_link

AtomEntry::add_link() in class.atomapi.php

Adds a <link> to the array for this Entry. href, type, title and rel are all required

AtomAPI

AtomAPI in class.atomapi.php

AtomAPI

AtomAPI::AtomAPI() in class.atomapi.php

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

ATOMAPI_AUTHENTICATION_FAILED

ATOMAPI_AUTHENTICATION_FAILED in class.atomapi.php

ATOMAPI_AUTHTYPE_INVALID

ATOMAPI_AUTHTYPE_INVALID in class.atomapi.php

ATOMAPI_CURL_ERROR

ATOMAPI_CURL_ERROR in class.atomapi.php

ATOMAPI_ENDPOINT_INVALID

ATOMAPI_ENDPOINT_INVALID in class.atomapi.php

**************************************************************************\

ATOMAPI_FEED_INIT_FAILED

ATOMAPI_FEED_INIT_FAILED in class.atomapi.php

ATOMAPI_METHOD_INVALID

ATOMAPI_METHOD_INVALID in class.atomapi.php

ATOMAPI_NO_FEEDS

ATOMAPI_NO_FEEDS in class.atomapi.php

ATOMAPI_NO_XML

ATOMAPI_NO_XML in class.atomapi.php

ATOMAPI_PAYLOAD_INVALID

ATOMAPI_PAYLOAD_INVALID in class.atomapi.php

ATOMAPI_REQUEST_INVALID

ATOMAPI_REQUEST_INVALID in class.atomapi.php

AtomEntry

AtomEntry::AtomEntry() in class.atomapi.php

Creates an AtomEntry, with optional initial values.

AtomEntry

AtomEntry in class.atomapi.php

AtomFeed

AtomFeed in class.atomapi.php

AtomFeed

AtomFeed::AtomFeed() in class.atomapi.php

Creates an AtomFeed object, based on the details specified. If $xml is provided, then it is parsed to populate the object, otherwise the endpoint is accessed and it is populated from the response XML. If all values are false or omitted, then an empty AtomFeed is created, and awaits the use of set_*() functions to set it up manually.

AtomRequest

AtomRequest::AtomRequest() in class.atomapi.php

Creates an object with functions for performing standard Atom requests. $method should be [GET|PUT|POST|DELETE], $uri is the endpoint/uri to execute the request against, $auth is an authentication object (BasicAuth or WSSE) and $payload is the XML of the request, if required (POST|PUT)

AtomRequest

AtomRequest in class.atomapi.php

atom_date

AtomEntry::atom_date() in class.atomapi.php

$content

AtomEntry::$content in class.atomapi.php

$created

AtomEntry::$created in class.atomapi.php

class.atomapi.php

class.atomapi.php in class.atomapi.php

$endpoint

AtomAPI::$endpoint in class.atomapi.php

$endpoint

AtomFeed::$endpoint in class.atomapi.php

$entries

AtomFeed::$entries in class.atomapi.php

$err_no

AtomEntry::$err_no in class.atomapi.php

$err_no

AtomRequest::$err_no in class.atomapi.php

$err_no

AtomAPI::$err_no in class.atomapi.php

$err_no

AtomFeed::$err_no in class.atomapi.php

error

AtomEntry::error() in class.atomapi.php

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

error

AtomAPI::error() in class.atomapi.php

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

error

AtomFeed::error() in class.atomapi.php

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

error

AtomRequest::error() in class.atomapi.php

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

exec

AtomRequest::exec() in class.atomapi.php

Executes the AtomRequest on the URI specified in the object. Returns the HTTP response code, or FALSE on a serious error

extract_attribs

AtomFeed::extract_attribs() in class.atomapi.php

Parses an XML/HTML string and returns an associative array containing key/value pairs

extract_attribs

AtomEntry::extract_attribs() in class.atomapi.php

Parses an XML/HTML string and returns an associative array containing key/value pairs

$feeds

AtomAPI::$feeds in class.atomapi.php

$feed_objs

AtomAPI::$feed_objs in class.atomapi.php

from_xml

AtomFeed::from_xml() in class.atomapi.php

Populates the variables of the AtomFeed, based on a complete XML representation of it.

from_xml

AtomEntry::from_xml() in class.atomapi.php

Builds out the details of the object by parsing an XML <entry>

$generator

AtomEntry::$generator in class.atomapi.php

$generator

AtomFeed::$generator in class.atomapi.php

get_auth

AtomAPI::get_auth() in class.atomapi.php

Returns an authentication object (either WSSE or Basic)

get_auth

AtomFeed::get_auth() in class.atomapi.php

Returns the currently set authentication object for this AtomFeed, or FALSE if not set

get_author

AtomEntry::get_author() in class.atomapi.php

Returns author details - either item requested, or all.

get_authtype

AtomAPI::get_authtype() in class.atomapi.php

Returns the current authentication model (Basic or WSSE)

get_content

AtomEntry::get_content() in class.atomapi.php

Returns the contents of this entry - including attributes of the content element

get_created

AtomEntry::get_created() in class.atomapi.php

Returns the <created> date for the entry

get_endpoint

AtomAPI::get_endpoint() in class.atomapi.php

Return the endpoint set for this AtomAPI or FALSE if unset

get_endpoint

AtomFeed::get_endpoint() in class.atomapi.php

Returns the endpoint for this AtomFeed if specified, or FALSE if not

get_entries

AtomAPI::get_entries() in class.atomapi.php

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

get_entries

AtomFeed::get_entries() in class.atomapi.php

Returns an array containing AtomEntries for each entry in this AtomFeed, or FALSE if none are set

get_feed

AtomAPI::get_feed() in class.atomapi.php

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

get_feeds

AtomAPI::get_feeds() in class.atomapi.php

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

get_generator

AtomFeed::get_generator() in class.atomapi.php

Returns either a specific element of the generator, or the entire array of data if none is specified.

get_httpcode

AtomRequest::get_httpcode() in class.atomapi.php

Returns the last stored http status code for this AtomRequest

get_id

AtomEntry::get_id() in class.atomapi.php

Returns the unique <id> for this Entry

get_id

AtomFeed::get_id() in class.atomapi.php

Returns the contents of the <id> element for this AtomFeed

get_info

AtomFeed::get_info() in class.atomapi.php

Returns either the requested individual attribute of the info element, the entire array, or FALSE if it's not set.

get_issued

AtomEntry::get_issued() in class.atomapi.php

Returns the <issued> date for the entry

get_links

AtomFeed::get_links() in class.atomapi.php

Filters the <link>s of this AtomFeed for ones where the $key matches the $val and returns an array of them, otherwise returns all links

get_links

AtomEntry::get_links() in class.atomapi.php

Returns the links where $key matches $val if specified, or all links if both ommitted

get_method

AtomRequest::get_method() in class.atomapi.php

Returns the current $method set for this AtomRequest. Should be [GET|PUT|POST|DELETE]. Returns FALSE if it is unset.

get_modified

AtomFeed::get_modified() in class.atomapi.php

Get the modified date for this feed, or FALSE if it's not set

get_modified

AtomEntry::get_modified() in class.atomapi.php

Returns the <modified> date for the entry

get_payload

AtomRequest::get_payload() in class.atomapi.php

Returns the current stored payload, which should be an XML package, or FALSE if it is not set yet.

get_response

AtomRequest::get_response() in class.atomapi.php

Returns the response content from the exec()'d AtomRequest, or FALSE if not set yet

get_tagline

AtomFeed::get_tagline() in class.atomapi.php

Returns either a specific element of the tagline, or the entire array of data if none is specified.

get_title

AtomEntry::get_title() in class.atomapi.php

Returns either the requested value, or all details of the $title

get_title

AtomFeed::get_title() in class.atomapi.php

Returns either a specific element of the title, or the entire array of data if none is specified.

get_uri

AtomRequest::get_uri() in class.atomapi.php

Returns the URI stored for this AtomRequest to operate against, or FALSE if not set yet

get_version

AtomFeed::get_version() in class.atomapi.php

Returns the version number specified for this AtomFeed in the <feed> element

$httpcode

AtomRequest::$httpcode in class.atomapi.php

$id

AtomEntry::$id in class.atomapi.php

$id

AtomFeed::$id in class.atomapi.php

$info

AtomFeed::$info in class.atomapi.php

$issued

AtomEntry::$issued in class.atomapi.php

init

AtomFeed::init() in class.atomapi.php

Initiates the AtomFeed object from a URI by loading the data, then parsing it as XML. Returns an HTTP response code on error, or TRUE if successful.

$links

AtomFeed::$links in class.atomapi.php

$links

AtomEntry::$links in class.atomapi.php

$method

AtomRequest::$method in class.atomapi.php

$modified

AtomFeed::$modified in class.atomapi.php

$modified

AtomEntry::$modified in class.atomapi.php

$payload

AtomRequest::$payload in class.atomapi.php

$response

AtomRequest::$response in class.atomapi.php

sanitize_date

AtomEntry::sanitize_date() in class.atomapi.php

set_auth

AtomRequest::set_auth() in class.atomapi.php

Set the authentication object to use for this AtomRequest

set_auth

AtomFeed::set_auth() in class.atomapi.php

Sets the authentication object to use for this AtomFeed

set_author

AtomEntry::set_author() in class.atomapi.php

Set all details relating to the author (name, email, url)

set_authtype

AtomAPI::set_authtype() in class.atomapi.php

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

set_content

AtomEntry::set_content() in class.atomapi.php

Sets the content details for the Entry, including some defaults if ommitted. FORMAT: array('content'=>$content); Also removes default <DIV> from Blogger entries to avoid PUT problems

set_created

AtomEntry::set_created() in class.atomapi.php

Set the <created> date, after sanitization

set_endpoint

AtomFeed::set_endpoint() in class.atomapi.php

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

set_endpoint

AtomAPI::set_endpoint() in class.atomapi.php

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

set_generator

AtomFeed::set_generator() in class.atomapi.php

Sets the details of the generator for this AtomFeed.

set_httpcode

AtomRequest::set_httpcode() in class.atomapi.php

Internal function, used to update the http status code returned when the AtomRequest is exec()'d

set_id

AtomFeed::set_id() in class.atomapi.php

Sets the <id> element contents for the AtomFeed.

set_id

AtomEntry::set_id() in class.atomapi.php

Set the unique <id> for the Entry

set_info

AtomFeed::set_info() in class.atomapi.php

Set the info element details. If a string is passed in, then defaults to the info contents

set_issued

AtomEntry::set_issued() in class.atomapi.php

Set the <issued> date, after sanitization

set_method

AtomRequest::set_method() in class.atomapi.php

Sets the method of this AtomRequest. Allowed values are [GET|PUT|POST|DELETE]

set_modified

AtomFeed::set_modified() in class.atomapi.php

Set the modified date for this feed

set_modified

AtomEntry::set_modified() in class.atomapi.php

Set the <modified> date, after sanitization

set_payload

AtomRequest::set_payload() in class.atomapi.php

Set the payload (body) of the AtomRequest. Should be an XML string, and is only required for POST and PUT operations

set_tagline

AtomFeed::set_tagline() in class.atomapi.php

Sets the details of the tagline for this AtomFeed

set_title

AtomEntry::set_title() in class.atomapi.php

Sets the title details for the Entry, including some defaults if ommitted. FORMAT: array('title'=>$title);

set_title

AtomFeed::set_title() in class.atomapi.php

Sets the title for this AtomFeed.

set_uri

AtomRequest::set_uri() in class.atomapi.php

Set the URI to execute this AtomRequest against. Should be a fully-qualified URL and start with 'http'

set_version

AtomFeed::set_version() in class.atomapi.php

Set the version number for this AtomFeed (goes in the <feed> element)

$tagline

AtomFeed::$tagline in class.atomapi.php

$title

AtomFeed::$title in class.atomapi.php

$title

AtomEntry::$title in class.atomapi.php

to_xml

AtomFeed::to_xml() in class.atomapi.php

Returns an XML/String representation of the entire AtomFeed, including header values and all AtomEntries found in $this->entries.

to_xml

AtomEntry::to_xml() in class.atomapi.php

Creates an XML representation of this Entry. $purpose is [PUT|POST|FEED] and defines what you're going to do with this XML. $purpose modifies the elements included according to the Atom spec.

$uri

AtomRequest::$uri in class.atomapi.php

$version

AtomFeed::$version in class.atomapi.php

verify_auth

AtomAPI::verify_auth() in class.atomapi.php

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