Class AtomEntry

Description

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


	
			
Variable Summary
mixed $author
mixed $content
mixed $created
mixed $err_no
mixed $generator
mixed $id
mixed $issued
mixed $links
mixed $modified
mixed $title
Method Summary
AtomEntry AtomEntry ([Array $title = array()], [Array $content = array()], Array $author, String $issued, String $modified, String $created)
void add_link (String $href, String $rel, String $title, String $type)
void atom_date (mixed $date, mixed $tz)
Int/FALSE error ()
Array extract_attribs (String $str)
void from_xml (String $xml)
Array/String/FALSE get_author ([String $elem = false])
Array/String/FALSE get_content ([String $elem = false])
String/FALSE get_created ()
String/FALSE get_id ()
String get_issued ()
Array get_links ([String $key = false], [String $val = false])
String/FALSE get_modified ()
String/Array/FALSE get_title ([String $elem = false])
void sanitize_date (mixed $date)
void set_author (Array $author)
void set_content (Array $content)
void set_created (String $date)
void set_id (String $id)
void set_issued (String $date)
void set_modified (String $date)
void set_title (Array $title)
String to_xml ([String $purpose = 'POST'])
Variables
mixed $author = array() (line 910)
mixed $content = array() (line 909)
mixed $created (line 914)
mixed $err_no (line 916)
mixed $generator = array() (line 911)
mixed $id (line 915)
mixed $issued (line 912)
mixed $links = array() (line 907)
mixed $modified (line 913)
mixed $title = array() (line 908)
Methods
Constructor AtomEntry (line 928)

Creates an AtomEntry, with optional initial values.

AtomEntry AtomEntry ([Array $title = array()], [Array $content = array()], Array $author, String $issued, String $modified, String $created)
  • Array $title
  • Array $content
  • Array $author
  • String $issued
  • String $modified
  • String $created
add_link (line 1141)

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

void add_link (String $href, String $rel, String $title, String $type)
  • String $href
  • String $rel
  • String $title
  • String $type
atom_date (line 1188)
void atom_date (mixed $date, mixed $tz)
error (line 1368)

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

Int/FALSE error ()
extract_attribs (line 1203)

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

Array extract_attribs (String $str)
  • String $str
from_xml (line 1219)

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

void from_xml (String $xml)
  • String $xml
get_author (line 1031)

Returns author details - either item requested, or all.

Array/String/FALSE get_author ([String $elem = false])
  • String $elem
get_content (line 996)

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

Array/String/FALSE get_content ([String $elem = false])
  • String $elem
get_created (line 1102)

Returns the <created> date for the entry

String/FALSE get_created ()
get_id (line 1124)

Returns the unique <id> for this Entry

String/FALSE get_id ()
get_issued (line 1058)

Returns the <issued> date for the entry

String get_issued ()
get_links (line 1153)

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

Array get_links ([String $key = false], [String $val = false])
  • String $key
  • String $val
get_modified (line 1080)

Returns the <modified> date for the entry

String/FALSE get_modified ()
get_title (line 960)

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

String/Array/FALSE get_title ([String $elem = false])
  • String $elem
sanitize_date (line 1170)
void sanitize_date (mixed $date)
set_author (line 1015)

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

void set_author (Array $author)
  • Array $author
set_content (line 979)

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

void set_content (Array $content)
  • Array $content
set_created (line 1094)

Set the <created> date, after sanitization

void set_created (String $date)
  • String $date
set_id (line 1116)

Set the unique <id> for the Entry

void set_id (String $id)
  • String $id
set_issued (line 1050)

Set the <issued> date, after sanitization

void set_issued (String $date)
  • String $date
set_modified (line 1072)

Set the <modified> date, after sanitization

void set_modified (String $date)
  • String $date
set_title (line 941)

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

void set_title (Array $title)
  • Array $title
to_xml (line 1275)

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.

String to_xml ([String $purpose = 'POST'])
  • String $purpose

Documentation generated on Sun, 16 Oct 2005 14:55:02 -0700 by phpDocumentor 1.3.0RC3