Docs For Class atomEntry

Description

Ein einzelner Eintrag bzw. ein Atom-Eintrag-Dokument (Atom Entry Document)

"The "atom:entry" element represents an individual entry, acting as a container for metadata and data associated with the entry." "An Atom Entry Document represents exactly one Atom entry, outside of the context of an Atom feed." quotes of RFC4287

Located in /web/inc/inc.feed.atom.php (line 266)

atomConstructs
   |
   --atomEntry

Direct descendents

Class	Description
atomFeed	Ein kompletter Feed (Atom Feed Document)

Variable Summary

mixed $authors

mixed $errCodes

mixed $id

mixed $title

mixed $updated

Method Summary

atomEntry atomEntry (String $title, String $updated, String $id, [ $authors = null], [ $lang = null], Array $autors)

void addAuthor ( $aPerson)

void addCategory ( $aCategory)

void addContributor ( $aPerson)

void addLink (mixed $aLink)

int isValid ()

boolean setContent (mixed $data)

void setContentIsBase64 ()

boolean setId (String $aIRI)

void setPublished ( $aDate)

void setRights ( $aString)

boolean setSource (object $aFeed)

void setSummary ( $aText)

void setTitle ( $aText)

void setUpdated ( $aDate)

void toArray ()

Variables

mixed $authors (line 271)

mixed $errCodes = array(
"ok" => array("no"=> 0, "text"=>"OK"),"noId"=>array("no"=>1,"text"=>"keine gültige ID"),"noTitle"=>array("no"=>2,"text"=>"kein Titel"),"noDate"=>array("no"=>4,"text"=>"kein Aktualisierungsdatum"),"noAuthor"=>array("no"=>8,"text"=>"kein Author"),"noContent"=>array("no"=>16,"text"=>"kein content und kein alternate-link"),"noSummary"=>array("no"=>32,"text"=>"keine Summary bei Nicht- Text-Content")) (line 272)

mixed $id (line 269)

mixed $title (line 268)

mixed $updated (line 270)

Inherited Variables

Inherited from atomConstructs

atomConstructs::$lang

Methods

Constructor atomEntry (line 291)

Konstruktor

atomEntry atomEntry (String $title, String $updated, String $id, [ $authors = null], [ $lang = null], Array $autors)

String $title: Titel
String $updated: Zeitangabe der letzten Änderung
String $id: eindeutige IRI (URL)
Array $autors: Die Autoren des Eintrages (darf auch nur eine Person sein)
$authors
$lang

addAuthor (line 331)

void addAuthor ( $aPerson)

$aPerson

addCategory (line 472)

void addCategory ( $aCategory)

$aCategory

addContributor (line 494)

void addContributor ( $aPerson)

$aPerson

addLink (line 409)

Fügt einen Verweis hinzu

void addLink (mixed $aLink)

mixed $aLink: URL (IRI) oder Array mit den Schlüsseln href[, rel][, type] [, hreflang] [, title][, length]

isValid (line 533)

prüft ob alle benötigten Elemente mit korrekten Daten gefüllt sind

return: Bitmuster mit Fehlermeldung
see: $this->errCodes

int isValid ()

Redefined in descendants as:

atomFeed::isValid() : gibt eine Fehlernummer zurück In Abständen von childErrorBase() werden die Elemente von rechts nach links aufgelistet.

setContent (line 347)

Setzt die Daten für das content-Tag

return: true, falls Daten die Spezifikation erfüllen

boolean setContent (mixed $data)

mixed $data: Kontent (Text oder Array mit den Schlüsseln text und type)

setContentIsBase64 (line 395)

void setContentIsBase64 ()

setId (line 313)

Setzt die ID

boolean setId (String $aIRI)

String $aIRI: muss ein IRI nach RFC3987 sein

setPublished (line 501)

void setPublished ( $aDate)

$aDate

setRights (line 505)

void setRights ( $aString)

$aString

setSource (line 518)

"If an atom:entry is copied from one feed into another feed, then the

source atom:feed's metadata [...] MAY be preserved within the copied entry by adding an atom:source child element" (RFC4287, 4.2.11 The "atom:source" Element)

boolean setSource (object $aFeed)

object $aFeed: ein atomFeed-Objekt

setSummary (line 399)

void setSummary ( $aText)

$aText

setTitle (line 323)

void setTitle ( $aText)

$aText

setUpdated (line 327)

void setUpdated ( $aDate)

$aDate

toArray (line 608)

void toArray ()

Redefined in descendants as:

atomFeed::toArray()

Inherited Methods

Inherited From atomConstructs

atomConstructs::atomConstructs()
atomConstructs::date()
atomConstructs::isContentMediatype()
atomConstructs::isIRI()
atomConstructs::isLang()
atomConstructs::isMediatype()
atomConstructs::isPerson()
atomConstructs::isTextMediatype()
atomConstructs::isTextType()
atomConstructs::lang()
atomConstructs::person()
atomConstructs::setLang()
atomConstructs::text()