Atom Class

Properties   Methods   Events   Configuration Settings   Errors  

The Atom Component is used to retrieve, parse, and update Atom content.

Class Name

IPWorks_Atom

Procedural Interface

 ipworks_atom_open();
 ipworks_atom_close($res);
 ipworks_atom_register_callback($res, $id, $function);
 ipworks_atom_get_last_error($res);
 ipworks_atom_get_last_error_code($res);
 ipworks_atom_set($res, $id, $index, $value);
 ipworks_atom_get($res, $id, $index);
 ipworks_atom_do_addcookie($res, $cookiename, $cookievalue);
 ipworks_atom_do_addnamespace($res, $prefix, $namespaceuri);
 ipworks_atom_do_config($res, $configurationstring);
 ipworks_atom_do_deleteresource($res, $url);
 ipworks_atom_do_doevents($res);
 ipworks_atom_do_getfeed($res, $url);
 ipworks_atom_do_getproperty($res, $propertyname);
 ipworks_atom_do_getresource($res, $url);
 ipworks_atom_do_interrupt($res);
 ipworks_atom_do_postresource($res, $url);
 ipworks_atom_do_put($res, $url);
 ipworks_atom_do_putresource($res, $url);
 ipworks_atom_do_readfile($res, $filename);
 ipworks_atom_do_reset($res);
 ipworks_atom_do_setproperty($res, $propertyname, $propertyvalue);
 ipworks_atom_do_writefile($res, $filename);

Remarks

The Atom Class implements a standard Atom client as defined by RFC 4287 (http://www.ietf.org/rfc/rfc4287) and includes the Atom publishing capabilities as defined by the "The Atom Publishing Protocol" (http://www.ietf.org/rfc/rfc5023).

The class contains a number of properties that map directly to Atom fields. To receive a feed, call the GetFeed method with the URL or file to retrieve specified in the URL parameter. You may also update the Entries properties using the Put method.

The Atom Class supports all standard Atom properties and allows you to add your own through AddNamespace and the GetProperty and SetProperty methods.