Atom PHP Extension Reference Documentation

CkAtom

Deprecated To be removed in a future version, and should no longer be used.

Current Version: 10.1.2

Represents an Atom document. The Atom API allows one to download, create and modify Atom documents.

Object Creation

$obj = new CkAtom();

Properties

AbortCurrent

(read-only)
bool get_AbortCurrent()

Introduced in version 9.5.0.58

When set to true, causes the currently running method to abort. Methods that always finish quickly (i.e.have no length file operations or network communications) are not affected. If no method is running, then this property is automatically reset to false when the next method is called. When the abort occurs, this property is reset to false. Both synchronous and asynchronous method calls can be aborted. (A synchronous method call could be aborted by setting this property from a separate thread.)

DebugLogFilePath

string debugLogFilePath();
void put_DebugLogFilePath(string strVal);

If set to a file path, this property logs the LastErrorText of each Chilkat method or property call to the specified file. This logging helps identify the context and history of Chilkat calls leading up to any crash or hang, aiding in debugging.

Enabling the VerboseLogging property provides more detailed information. This property is mainly used for debugging rare instances where a Chilkat method call causes a hang or crash, which should generally not happen.

Possible causes of hangs include:

A timeout property set to 0, indicating an infinite timeout.
A hang occurring within an event callback in the application code.
An internal bug in the Chilkat code causing the hang.

More Information and Examples

Example showing how to use DebugLogFilePath.

LastErrorHtml

(read-only)
string lastErrorHtml();

Provides HTML-formatted information about the last called method or property. If a method call fails or behaves unexpectedly, check this property for details. Note that information is available regardless of the method call's success.

LastErrorText

(read-only)
string lastErrorText();

Provides plain text information about the last called method or property. If a method call fails or behaves unexpectedly, check this property for details. Note that information is available regardless of the method call's success.

More Information and Examples

Concept of LastErrorText LastErrorText Standard Information

LastErrorXml

(read-only)
string lastErrorXml();

Provides XML-formatted information about the last called method or property. If a method call fails or behaves unexpectedly, check this property for details. Note that information is available regardless of the method call's success.

LastMethodSuccess

bool get_LastMethodSuccess()
void put_LastMethodSuccess(bool boolVal);

Indicates the success or failure of the most recent method call: true means success, false means failure. This property remains unchanged by property setters or getters. This method is present to address challenges in checking for null or Nothing returns in certain programming languages.

NumEntries

(read-only)
int get_NumEntries()

Number of entries in the Atom document.

Utf8

bool get_Utf8()
void put_Utf8(bool boolVal);

When set to true, all "const char *" arguments are interpreted as utf-8 strings. If set to false (the default), then "const char *" arguments are interpreted as ANSI strings. Also, when set to true, and Chilkat method returning a "const char *" is returning the utf-8 representation. If set to false, all "const char *" return values are ANSI strings.

VerboseLogging

bool get_VerboseLogging()
void put_VerboseLogging(bool boolVal);

If set to true, then the contents of LastErrorText (or LastErrorXml, or LastErrorHtml) may contain more verbose information. The default value is false. Verbose logging should only be used for debugging. The potentially large quantity of logged information may adversely affect peformance.

Version

(read-only)
string version();

Version of the component/library, such as "10.1.0"

More Information and Examples

How to get the Chilkat version at runtime.

Methods

AddElement

int AddElement(string tag, string value);

Adds a new element to the Atom document. The tag is a string such as "title", "subtitle", "summary", etc. Returns the index of the element added, or -1 for failure.

AddElementDateStr

int AddElementDateStr(string tag, string dateTimeStr);

Adds a new date-formatted element to the Atom document. The tag is a string such as "created", "modified", "issued", etc. The dateTimeStr should be an RFC822 formatted date/time string such as "Tue, 25 Sep 2012 12:25:32 -0500". Returns the index of the element added, or -1 for failure.

AddElementDt

int AddElementDt(string tag, CkDateTime dateTime);

Adds a new date-formatted element to the Atom document. The tag is a string such as "created", "modified", "issued", etc. Returns the index of the element added, or -1 for failure.

AddElementHtml

int AddElementHtml(string tag, string htmlStr);

Adds a new HTML formatted element to the Atom document. Returns the index of the element added, or -1 for failure.

AddElementXHtml

int AddElementXHtml(string tag, string xmlStr);

Adds a new XHTML formatted element to the Atom document. Returns the index of the element added, or -1 for failure.

AddElementXml

int AddElementXml(string tag, string xmlStr);

Adds a new XML formatted element to the Atom document. Returns the index of the element added, or -1 for failure.

AddEntry

void AddEntry(string xmlStr);

Adds an "entry" Atom XML document to the caller's Atom document.

AddLink

void AddLink(string rel, string href, string title, string typ);

Adds a link to the Atom document.

AddPerson

void AddPerson(string tag, string name, string uri, string email);

Adds a person to the Atom document. The tag should be a string such as "author", "contributor", etc. If a piece of information is not known, an empty string or NULL value may be passed.

DeleteElement

void DeleteElement(string tag, int index);

Removes the Nth occurrence of a given element from the Atom document. Indexing begins at 0. For example, to remove the 2nd category, set tag = "category" and index = 1.

DeleteElementAttr

void DeleteElementAttr(string tag, int index, string attrName);

Remove an attribute from an element.The index should be 0 unless there are multiple elements having the same tag, in which case it selects the Nth occurrence based on the index ( 0 = first occurrence ).

DeletePerson

void DeletePerson(string tag, int index);

Deletes a person from the Atom document. The tag is a string such as "author". The index should be 0 unless there are multiple elements having the same tag, in which case it selects the Nth occurrence based on the index. For example, DeletePerson("author",2) deletes the 3rd author.

DownloadAtom

bool DownloadAtom(string url);

Download an Atom feed from the Internet and load it into the Atom object.

Returns true for success, false for failure.

DownloadAtomAsync ⁽¹⁾

CkTask DownloadAtomAsync(string url);

Creates an asynchronous task to call the DownloadAtom method with the arguments provided.

Returns null on failure

GetElement

bool GetElement(string tag, int index, CkString outStr);
string getElement(string tag, int index);

Returns the content of the Nth element having a specified tag.

Returns true for success, false for failure.

GetElementAttr

bool GetElementAttr(string tag, int index, string attrName, CkString outStr);
string getElementAttr(string tag, int index, string attrName);

Returns the value of an element's attribute. The element is selected by the tag name and the index (the Nth element having a specific tag) and the attribute is selected by name.

Returns true for success, false for failure.

GetElementCount

int GetElementCount(string tag);

The number of elements having a specific tag.

GetElementDateStr

bool GetElementDateStr(string tag, int index, CkString outStr);
string getElementDateStr(string tag, int index);

Returns an element's value as a date/time in an RFC822 formatted string, such as such as "Tue, 25 Sep 2012 12:25:32 -0500".

Returns true for success, false for failure.

GetElementDt

CkDateTime GetElementDt(string tag, int index);

Returns an element's value as a date/time object.

Returns null on failure

GetEntry

CkAtom GetEntry(int index);

Returns the Nth entry as an Atom object. (Indexing begins at 0)

Returns null on failure

GetLinkHref

bool GetLinkHref(string relName, CkString outStr);
string getLinkHref(string relName);

Returns the href attribute of the link having a specified "rel" attribute (such as "service.feed", "alternate", etc.).

Returns true for success, false for failure.

GetPersonInfo

bool GetPersonInfo(string tag, int index, string tag2, CkString outStr);
string getPersonInfo(string tag, int index, string tag2);

Returns a piece of information about a person. To get the 2nd author's name, call GetPersonInfo("author",1,"name").

Returns true for success, false for failure.

GetTopAttr

bool GetTopAttr(string attrName, CkString outStr);
string getTopAttr(string attrName);

Returns the value of an attribute on the top-level XML node. The tag of a top-level Atom XML node is typically "feed" or "entry", and it might have attributes such as "xmlns" and "xml:lang".

Returns true for success, false for failure.

HasElement

bool HasElement(string tag);

True (1) if the element exists in the Atom document. Otherwise 0.

LoadTaskCaller

bool LoadTaskCaller(CkTask task);

Introduced in version 9.5.0.80

Loads the caller of the task's async method.

Returns true for success, false for failure.

LoadXml

bool LoadXml(string xmlStr);

Loads the Atom document from an XML string.

Returns true for success, false for failure.

NewEntry

void NewEntry();

Initializes the Atom document to be a new "entry".

NewFeed

void NewFeed();

Initializes the Atom document to be a new "feed".

SetElementAttr

void SetElementAttr(string tag, int index, string attrName, string attrValue);

Adds or replaces an attribute on an element.

SetTopAttr

void SetTopAttr(string attrName, string value);

Adds or replaces an attribute on the top-level XML node of the Atom document.

ToXmlString

bool ToXmlString(CkString outStr);
string toXmlString();

Serializes the Atom document to an XML string.

Returns true for success, false for failure.

UpdateElement

void UpdateElement(string tag, int index, string value);

Replaces the content of an element.

UpdateElementDateStr

void UpdateElementDateStr(string tag, int index, string dateTimeStr);

Replaces the content of a date-formatted element. The index should be an RFC822 formatted date/time string.

UpdateElementDt

void UpdateElementDt(string tag, int index, CkDateTime dateTime);

Replaces the content of a date-formatted element.

UpdateElementHtml

void UpdateElementHtml(string tag, int index, string htmlStr);

Replaces the content of an HTML element.

UpdateElementXHtml

void UpdateElementXHtml(string tag, int index, string xmlStr);

Replaces the content of an XHTML element.

UpdateElementXml

void UpdateElementXml(string tag, int index, string xmlStr);

Replaces the content of an XML element.

UpdatePerson

void UpdatePerson(string tag, int index, string name, string uri, string email);

Replaces the content of a person. To update the 3rd author, call UpdatePerson("author",2,"new name","new URL","new email"). If a piece of information is not known, pass an empty string or a NULL.