Class atomConstructs

Description

Basiselemente

"Many of Atom's elements share a few common structures. This section defines those structures and their requirements for convenient reference by the appropriate element definitions." quote of RFC4287

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


	
			
Direct descendents
Class Description
atomEntry Ein einzelner Eintrag bzw. ein Atom-Eintrag-Dokument (Atom Entry Document)
Variable Summary
mixed $lang
Method Summary
atomConstructs atomConstructs ([ $lang = null])
String date (String $string)
void isContentMediatype ( $aText)
void isIRI ( $text)
void isLang ( $aLanguageTag)
boolean isMediatype (String $aText)
void isPerson ( $aPerson)
boolean isTextMediatype (String $aText)
void isTextType ( $aType)
Array lang (Array $array)
Array person (mixed $data)
void setLang ( $aLanguageTag)
Array text (StringOrArray $text)
Variables
mixed $lang (line 36)

xml:lang specified in XML 1.0 [W3C.REC-xml-20040204], Section 2.12

Methods
Constructor atomConstructs (line 41)

Konstruktor

atomConstructs atomConstructs ([ $lang = null])
  • $lang
date (line 229)

"A Date construct is an element whose content MUST conform to the "date-

time" production in [RFC3339]. In addition, an uppercase "T" character MUST be used to separate date and time, and an uppercase "Z" character MUST be present in the absence of a numeric time zone offset." quote of RFC4287

String date (String $string)
  • String $string: Zeitangabe
isContentMediatype (line 73)
void isContentMediatype ( $aText)
  • $aText
isIRI (line 57)

TODO: "MUST be an IRI reference [RFC3987]"

void isIRI ( $text)
  • $text
isLang (line 115)

Gibt an ob es sich nach RFC3066 um ein'language tag' handelt

"value MUST be a language tag [RFC3066]"

void isLang ( $aLanguageTag)
  • $aLanguageTag
isMediatype (line 68)

Gibt an ob es sich um einen Mediatypen nach RFC4288 handelt

  • see: Section 4.2. Naming Requirements in RFC4288 (Media Type Specifications and Registration Procedures)
boolean isMediatype (String $aText)
  • String $aText: mediatype
isPerson (line 210)
void isPerson ( $aPerson)
  • $aPerson
isTextMediatype (line 87)

Der Medientyp gibt an, dass es sich um Text handelt

boolean isTextMediatype (String $aText)
  • String $aText: Medientyp (MIME-type)
isTextType (line 100)

the value MUST be one of "text", "html", or "xhtml"

(RFC4287, 3.1.1 The "type" Attribute)

void isTextType ( $aType)
  • $aType
lang (line 126)

Language-Sensitive

  • return: Array ggf. mit Schlüssel 'lang'
Array lang (Array $array)
  • Array $array
person (line 184)

"A Person construct is an element that describes a person, corporation, or similar entity" quote of RFC4287

Childs: name, uri (optional), email (optional)

  • return: Personendaten (Name [, URL][, E-Mail])
Array person (mixed $data)
  • mixed $data: Personendaten (Array oder String)
setLang (line 48)
void setLang ( $aLanguageTag)
  • $aLanguageTag
text (line 142)

"A Text construct contains human-readable text, usually in small quantities. The content of Text constructs is Language- Sensitive." quote of RFC4287

  • return: atom-data
Array text (StringOrArray $text)
  • StringOrArray $text: Entweder String oder ein Array mit den Schlüsseln 'type' und 'text'

Documentation generated on Mon, 22 Oct 2007 17:17:20 +0200 by phpDocumentor 1.3.1