CkAtom PHP Extension Reference Documentation

CkAtom

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

Object Creation

$obj = new CkAtom();

Properties

(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.)

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

If set to a file path, causes each Chilkat method or property call to automatically append it's LastErrorText to the specified log file. The information is appended such that if a hang or crash occurs, it is possible to see the context in which the problem occurred, as well as a history of all Chilkat calls up to the point of the problem. The VerboseLogging property can be set to provide more detailed information.

This property is typically used for debugging the rare cases where a Chilkat method call hangs or generates an exception that halts program execution (i.e. crashes). A hang or crash should generally never happen. The typical causes of a hang are:

  1. a timeout related property was set to 0 to explicitly indicate that an infinite timeout is desired,
  2. the hang is actually a hang within an event callback (i.e. it is a hang within the application code), or
  3. there is an internal problem (bug) in the Chilkat code that causes the hang.

(read-only)
string lastErrorHtml();

Provides information in HTML format about the last method/property called. If a method call returns a value indicating failure, or behaves unexpectedly, examine this property to get more information.

(read-only)
string lastErrorText();

Provides information in plain-text format about the last method/property called. If a method call returns a value indicating failure, or behaves unexpectedly, examine this property to get more information.

Concept of LastErrorText

LastErrorText Standard Information

(read-only)
string lastErrorXml();

Provides information in XML format about the last method/property called. If a method call returns a value indicating failure, or behaves unexpectedly, examine this property to get more information.

bool get_LastMethodSuccess()
void put_LastMethodSuccess(bool boolVal);

Introduced in version 9.5.0.52

Indicate whether the last method call succeeded or failed. A value of true indicates success, a value of false indicates failure. This property is automatically set for method calls. It is not modified by property accesses. The property is automatically set to indicate success for the following types of method calls:

  • Any method that returns a string.
  • Any method returning a Chilkat object, binary bytes, or a date/time.
  • Any method returning a standard boolean status value where success = true and failure = false.
  • Any method returning an integer where failure is defined by a return value less than zero.

Note: Methods that do not fit the above requirements will always set this property equal to true. For example, a method that returns no value (such as a "void" in C++) will technically always succeed.

(read-only)
int get_NumEntries()

Number of entries in the Atom document.

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.

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.

(read-only)
string version();

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

Methods

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.

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.

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.

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.

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.

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.

void AddEntry(string xmlStr);

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

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

Adds a link to the Atom document.

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.

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.

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 ).

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.

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.

CkTask DownloadAtomAsync(string url);

Creates an asynchronous task to call the DownloadAtom method with the arguments provided. (Async methods are available starting in Chilkat v9.5.0.52.)

Returns null on failure

How to Run an Asynchronous Task

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.

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.

int GetElementCount(string tag);

The number of elements having a specific tag.

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.

CkDateTime GetElementDt(string tag, int index);

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

Returns null on failure

CkAtom GetEntry(int index);

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

Returns null on failure

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.

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.

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.

bool HasElement(string tag);

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

bool LoadXml(string xmlStr);

Loads the Atom document from an XML string.

Returns true for success, false for failure.

void NewEntry();

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

void NewFeed();

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

bool SaveLastError(string path);

Saves the last-error information (the contents of LastErrorXml) to an XML formatted file.

Returns true for success, false for failure.

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

Adds or replaces an attribute on an element.

void SetTopAttr(string attrName, string value);

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

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

Serializes the Atom document to an XML string.

Returns true for success, false for failure.

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

Replaces the content of an element.

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.

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

Replaces the content of a date-formatted element.

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

Replaces the content of an HTML element.

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

Replaces the content of an XHTML element.

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

Replaces the content of an XML element.

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.