Atom Klassenreferenz

Klassendiagramm für Atom:

Aufstellung aller Elemente

Öffentliche Methoden
	execute ()
	atomFeed ($input, $stylesheet='')
Öffentliche Attribute
	$parameters
	$folderid = 0
	$description = 'Creates an Atom-Feed of pages in a folder'
	$api
	$feed_url = ''
	$feed_title = ''
	$feed_description = ''

---

Ausführliche Beschreibung

Erstellen eines ATOM-Feeds

Autor:

Jan Dankert

Definiert in Zeile 29 der Datei Atom.class.php.

---

Dokumentation der Elementfunktionen

Atom::atomFeed	(	$	input,
		$	stylesheet = ''
	)

Definiert in Zeile 110 der Datei Atom.class.php.

Wird benutzt von execute().

     {
          $input["encoding"]  = (empty($input["encoding"] ))?"UTF-8":$input["encoding"];
          $input["language"]  = (empty($input["language"] ))?"en-us":$input["language"];
          
          if   ( empty($input['title'      ])) $input['title'      ] = ''; 
          if   ( empty($input['description'])) $input['description'] = ''; 
          if   ( empty($input['link'       ])) $input['link'       ] = ''; 
          $feed = '<?xml version="1.0" encoding="'.$input["encoding"].'"?>';
          $feed .= (!empty($stylesheet))?"\n".'<?xml-stylesheet type="text/xsl" href="'.$stylesheet.'"?>':"";
          $feed .= <<<__RSS__
          
          <feed xmlns="http://www.w3.org/2005/Atom">
          <title>{$input["title"]}</title>
          
__RSS__;
              foreach($input["items"] as $item)
              {
                    if   ( empty($item['title'      ])) $item['title'      ] = ''; 
                    if   ( empty($item['description'])) $item['description'] = ''; 
                  $feed .= "\n<entry>\n<title>".$item["title"]."</title>";
                  $feed .= "\n<summary><![CDATA[".$item["description"]."]]></summary>";
                 $feed .= "\n<updated>".date('Y-m-d\TH:i:s\Z', $item["date"])."</updated>";
                 $feed .= "\n<link href=\"".$item["link"]."\" />";
                  $feed .= "\n</entry>\n";
              }
               $feed .= "\n</feed>";
          return $feed;
     }

Atom::execute

(

)

Erneute Implementation von Dynamic.

Definiert in Zeile 56 der Datei Atom.class.php.

Benutzt atomFeed(), Dynamic::folderid(), Dynamic::getObjectId(), Dynamic::getRootObjectId(), Dynamic::output() und Dynamic::pathToObject().

     {
          $feed = array();

          // Lesen des Root-Ordners
          if   ( intval($this->folderid) == 0 )
               $folder = new Folder( $this->getRootObjectId() );
          else
               $folder = new Folder( intval($this->folderid) );

          $folder->load();

          if   ( $this->feed_title == '' )
               $this->feed_title = $folder->name;

          if   ( $this->feed_description == '' )
               $this->feed_description = $folder->desc;

          $feed['title'      ] = $this->feed_title;              
          $feed['description'] = $this->feed_description;             
          $feed['url'        ] = $this->feed_url;           
          $feed['items'      ] = array();              
          // Schleife ueber alle Inhalte des Root-Ordners
          foreach( $folder->getObjectIds() as $id )
          {
               if   ( $id == $this->getObjectId() )
                    continue;
               $o = new Object( $id );
               $o->languageid = $this->page->languageid;
               $o->load();
               if ( $o->isPage ) // Nur wenn Seite
               {
                    $p = new Page( $id );
                    $p->load();

                    $item = array();
                    $item['title'      ] = $p->name;
                    $item['description'] = $p->desc;
                    $item['date'       ] = $p->lastchangeDate;
                    if   ( empty($this->feed_url) )
                         $item['link'       ] = $this->pathToObject($id);
                    else
                         $item['link'       ] = $this->feed_url;
                    
                    $feed['items'][] = $item;
               }
          }
          
          $feed = $this->atomFeed($feed);

          $this->output( $feed );
     }

---

Dokumentation der Datenelemente

Atom::$api

Definiert in Zeile 49 der Datei Atom.class.php.

Atom::$description = 'Creates an Atom-Feed of pages in a folder'

Bitte immer eine Beschreibung benutzen, dies ist fuer den Web-Developer hilfreich. String

Erneute Implementation von Dynamic.

Definiert in Zeile 48 der Datei Atom.class.php.

Atom::$feed_description = ''

Definiert in Zeile 53 der Datei Atom.class.php.

Atom::$feed_title = ''

Definiert in Zeile 52 der Datei Atom.class.php.

Atom::$feed_url = ''

Definiert in Zeile 51 der Datei Atom.class.php.

Atom::$folderid = 0

Definiert in Zeile 42 der Datei Atom.class.php.

Atom::$parameters

Initialisierung:

 Array(
          'folderid'        =>'Id of the folder whose pages should go into the Atom-Feed, default: the root folder',
          'feed_url'        =>'Url of the feed, default: blank',
          'feed_title'      =>'Title of the feed, default: Name of folder',
          'feed_description'=>'Description of the feed, default: Description of folder'
          )

Bitte immer alle Parameter in dieses Array schreiben, dies ist fuer den Web-Developer hilfreich. String

Erneute Implementation von Dynamic.

Definiert in Zeile 35 der Datei Atom.class.php.

---

Die Dokumentation für diese Klasse wurde erzeugt aufgrund der Datei:

• dynamicClasses/Atom.class.php