Annotation of /mambo/branches/4.6/includes/domit/xml_domit_rss.php
Parent Directory
|
Revision Log
Revision 1 -
(view)
(download)
Original Path: mambo/trunk/includes/domit/xml_domit_rss.php
| 1 : | root | 1 | <?php |
| 2 : | /** | ||
| 3 : | * DOMIT! RSS Lite is a DOM based RSS parser | ||
| 4 : | * @package domit-rss | ||
| 5 : | * @subpackage domit-rss-main | ||
| 6 : | * @version 0.3 | ||
| 7 : | * @copyright (C) 2004 John Heinstein. All rights reserved | ||
| 8 : | * @license http://www.gnu.org/copyleft/lesser.html LGPL License | ||
| 9 : | * @author John Heinstein <johnkarl@nbnet.nb.ca> | ||
| 10 : | * @link http://www.engageinteractive.com/domitrss/ DOMIT! RSS Home Page | ||
| 11 : | * DOMIT! RSS is Free Software | ||
| 12 : | **/ | ||
| 13 : | |||
| 14 : | if (!defined('DOMIT_RSS_INCLUDE_PATH')) { | ||
| 15 : | define('DOMIT_RSS_INCLUDE_PATH', (dirname(__FILE__) . "/")); | ||
| 16 : | } | ||
| 17 : | |||
| 18 : | /** current version of DOMIT! RSS */ | ||
| 19 : | define ('DOMIT_RSS_VERSION', '0.3'); | ||
| 20 : | /** language constant */ | ||
| 21 : | define('DOMIT_RSS_ELEMENT_LANGUAGE', 'language'); | ||
| 22 : | /** copyright constant */ | ||
| 23 : | define('DOMIT_RSS_ELEMENT_COPYRIGHT', 'copyright'); | ||
| 24 : | /** managing editor constant */ | ||
| 25 : | define('DOMIT_RSS_ELEMENT_MANAGINGEDITOR', 'managingeditor'); | ||
| 26 : | /** webmaster constant */ | ||
| 27 : | define('DOMIT_RSS_ELEMENT_WEBMASTER', 'webmaster'); | ||
| 28 : | /** pubdate constant */ | ||
| 29 : | define('DOMIT_RSS_ELEMENT_PUBDATE', 'pubdate'); | ||
| 30 : | /** last build date constant */ | ||
| 31 : | define('DOMIT_RSS_ELEMENT_LASTBUILDDATE', 'lastbuilddate'); | ||
| 32 : | /** category constant */ | ||
| 33 : | define('DOMIT_RSS_ELEMENT_CATEGORY', 'category'); | ||
| 34 : | /** generator constant */ | ||
| 35 : | define('DOMIT_RSS_ELEMENT_GENERATOR', 'generator'); | ||
| 36 : | /** docs constant */ | ||
| 37 : | define('DOMIT_RSS_ELEMENT_DOCS', 'docs'); | ||
| 38 : | /** cloud constant */ | ||
| 39 : | define('DOMIT_RSS_ELEMENT_CLOUD', 'cloud'); | ||
| 40 : | /** ttl constant */ | ||
| 41 : | define('DOMIT_RSS_ELEMENT_TTL', 'ttl'); | ||
| 42 : | /** image constant */ | ||
| 43 : | define('DOMIT_RSS_ELEMENT_IMAGE', 'image'); | ||
| 44 : | /** rating constant */ | ||
| 45 : | define('DOMIT_RSS_ELEMENT_RATING', 'rating'); | ||
| 46 : | /** textinput constant */ | ||
| 47 : | define('DOMIT_RSS_ELEMENT_TEXTINPUT', 'textinput'); | ||
| 48 : | /** skiphours constant */ | ||
| 49 : | define('DOMIT_RSS_ELEMENT_SKIPHOURS', 'skiphours'); | ||
| 50 : | /** skipdays constant */ | ||
| 51 : | define('DOMIT_RSS_ELEMENT_SKIPDAYS', 'skipdays'); | ||
| 52 : | /** url constant */ | ||
| 53 : | define('DOMIT_RSS_ELEMENT_URL', 'url'); | ||
| 54 : | /** width constant */ | ||
| 55 : | define('DOMIT_RSS_ELEMENT_WIDTH', 'width'); | ||
| 56 : | /** height constant */ | ||
| 57 : | define('DOMIT_RSS_ELEMENT_HEIGHT', 'height'); | ||
| 58 : | /** guid constant */ | ||
| 59 : | define('DOMIT_RSS_ELEMENT_GUID', 'guid'); | ||
| 60 : | /** enclosure constant */ | ||
| 61 : | define('DOMIT_RSS_ELEMENT_ENCLOSURE', 'enclosure'); | ||
| 62 : | /** comments constant */ | ||
| 63 : | define('DOMIT_RSS_ELEMENT_COMMENTS', 'comments'); | ||
| 64 : | /** source constant */ | ||
| 65 : | define('DOMIT_RSS_ELEMENT_SOURCE', 'source'); | ||
| 66 : | /** name constant */ | ||
| 67 : | define('DOMIT_RSS_ELEMENT_NAME', 'name'); | ||
| 68 : | /** author constant */ | ||
| 69 : | define('DOMIT_RSS_ELEMENT_AUTHOR', 'author'); | ||
| 70 : | |||
| 71 : | /** domain constant */ | ||
| 72 : | define('DOMIT_RSS_ATTR_DOMAIN', 'domain'); | ||
| 73 : | /** port constant */ | ||
| 74 : | define('DOMIT_RSS_ATTR_PORT', 'port'); | ||
| 75 : | /** path constant */ | ||
| 76 : | define('DOMIT_RSS_ATTR_PATH', 'path'); | ||
| 77 : | /** registerProcedure constant */ | ||
| 78 : | define('DOMIT_RSS_ATTR_REGISTERPROCEDURE', 'registerProcedure'); | ||
| 79 : | /** protocol constant */ | ||
| 80 : | define('DOMIT_RSS_ATTR_PROTOCOL', 'protocol'); | ||
| 81 : | /** url constant */ | ||
| 82 : | define('DOMIT_RSS_ATTR_URL', 'url'); | ||
| 83 : | /** length constant */ | ||
| 84 : | define('DOMIT_RSS_ATTR_LENGTH', 'length'); | ||
| 85 : | /** type constant */ | ||
| 86 : | define('DOMIT_RSS_ATTR_TYPE', 'type'); | ||
| 87 : | /** isPermaLink constant */ | ||
| 88 : | define('DOMIT_RSS_ATTR_ISPERMALINK', 'isPermaLink'); | ||
| 89 : | |||
| 90 : | require_once(DOMIT_RSS_INCLUDE_PATH . 'xml_domit_rss_shared.php'); | ||
| 91 : | |||
| 92 : | /** | ||
| 93 : | * The base DOMIT! RSS document class | ||
| 94 : | * | ||
| 95 : | * @package domit-rss | ||
| 96 : | * @subpackage domit-rss-main | ||
| 97 : | * @author John Heinstein <johnkarl@nbnet.nb.ca> | ||
| 98 : | */ | ||
| 99 : | class xml_domit_rss_document extends xml_domit_rss_base_document { | ||
| 100 : | /** | ||
| 101 : | * Constructor | ||
| 102 : | * @param string Path to the rss file | ||
| 103 : | * @param string Directory in which cache files are to be stored | ||
| 104 : | * @param string Expiration time (in seconds) for the cache file | ||
| 105 : | * @return Object A new instance of xml_domit_rss_document | ||
| 106 : | */ | ||
| 107 : | function xml_domit_rss_document($url = '', $cacheDir = './', $cacheTime = '3600') { | ||
| 108 : | $this->parser = 'DOMIT_RSS'; | ||
| 109 : | $this->xml_domit_rss_base_document($url, $cacheDir, $cacheTime); | ||
| 110 : | } //xml_domit_rss_document | ||
| 111 : | |||
| 112 : | /** | ||
| 113 : | * Performs initialization of the RSS document | ||
| 114 : | */ | ||
| 115 : | function _init() { | ||
| 116 : | $total = $this->node->documentElement->childCount; | ||
| 117 : | $itemCounter = 0; | ||
| 118 : | $channelCounter = 0; | ||
| 119 : | $categoryCounter = 0; | ||
| 120 : | |||
| 121 : | for ($i = 0; $i < $total; $i++) { | ||
| 122 : | $currNode =& $this->node->documentElement->childNodes[$i]; | ||
| 123 : | $tagName = strtolower($currNode->nodeName); | ||
| 124 : | |||
| 125 : | switch ($tagName) { | ||
| 126 : | case DOMIT_RSS_ELEMENT_ITEM: | ||
| 127 : | $this->domit_rss_items[$itemCounter] =& new xml_domit_rss_item($currNode); | ||
| 128 : | $itemCounter++; | ||
| 129 : | break; | ||
| 130 : | case DOMIT_RSS_ELEMENT_CHANNEL: | ||
| 131 : | $this->domit_rss_channels[$channelCounter] =& new xml_domit_rss_channel($currNode); | ||
| 132 : | $channelCounter++; | ||
| 133 : | break; | ||
| 134 : | case DOMIT_RSS_ELEMENT_CATEGORY: | ||
| 135 : | $this->domit_rss_categories[$categoryCounter] =& new xml_domit_rss_category($currNode); | ||
| 136 : | $categoryCounter++; | ||
| 137 : | break; | ||
| 138 : | case DOMIT_RSS_ELEMENT_IMAGE: | ||
| 139 : | $this->DOMIT_RSS_indexer[$tagName] =& new xml_domit_rss_image($currNode); | ||
| 140 : | break; | ||
| 141 : | case DOMIT_RSS_ELEMENT_CLOUD: | ||
| 142 : | $this->indexer[$tagName] =& new xml_domit_rss_cloud($currNode); | ||
| 143 : | break; | ||
| 144 : | case DOMIT_RSS_ELEMENT_TEXTINPUT: | ||
| 145 : | $this->indexer[$tagName] =& new xml_domit_rss_textinput($currNode); | ||
| 146 : | break; | ||
| 147 : | case DOMIT_RSS_ELEMENT_TITLE: | ||
| 148 : | case DOMIT_RSS_ELEMENT_LINK: | ||
| 149 : | case DOMIT_RSS_ELEMENT_DESCRIPTION: | ||
| 150 : | case DOMIT_RSS_ELEMENT_LANGUAGE: | ||
| 151 : | case DOMIT_RSS_ELEMENT_COPYRIGHT: | ||
| 152 : | case DOMIT_RSS_ELEMENT_MANAGINGEDITOR: | ||
| 153 : | case DOMIT_RSS_ELEMENT_WEBMASTER: | ||
| 154 : | case DOMIT_RSS_ELEMENT_PUBDATE: | ||
| 155 : | case DOMIT_RSS_ELEMENT_LASTBUILDDATE: | ||
| 156 : | case DOMIT_RSS_ELEMENT_GENERATOR: | ||
| 157 : | case DOMIT_RSS_ELEMENT_DOCS: | ||
| 158 : | case DOMIT_RSS_ELEMENT_TTL: | ||
| 159 : | case DOMIT_RSS_ELEMENT_RATING: | ||
| 160 : | case DOMIT_RSS_ELEMENT_SKIPHOURS: | ||
| 161 : | case DOMIT_RSS_ELEMENT_SKIPDAYS: | ||
| 162 : | $this->DOMIT_RSS_indexer[$tagName] =& new xml_domit_rss_simpleelement($currNode); | ||
| 163 : | break; | ||
| 164 : | default: | ||
| 165 : | $this->addIndexedElement($currNode); | ||
| 166 : | //$this->indexer[$tagName] =& $currNode; | ||
| 167 : | } | ||
| 168 : | } | ||
| 169 : | |||
| 170 : | if ($itemCounter != 0) { | ||
| 171 : | $this->DOMIT_RSS_indexer[DOMIT_RSS_ARRAY_ITEMS] =& $this->domit_rss_items; | ||
| 172 : | } | ||
| 173 : | |||
| 174 : | if ($channelCounter != 0) { | ||
| 175 : | $this->DOMIT_RSS_indexer[DOMIT_RSS_ARRAY_CHANNELS] =& $this->domit_rss_channels; | ||
| 176 : | } | ||
| 177 : | |||
| 178 : | if ($categoryCounter != 0) { | ||
| 179 : | $this->DOMIT_RSS_indexer[DOMIT_RSS_ARRAY_CATEGORIES] =& $this->domit_rss_categories; | ||
| 180 : | } | ||
| 181 : | |||
| 182 : | $this->handleChannelElementsEmbedded(); | ||
| 183 : | } //_init | ||
| 184 : | |||
| 185 : | /** | ||
| 186 : | * Returns the current version of DOMIT! RSS | ||
| 187 : | * @return int The current version of DOMIT! RSS | ||
| 188 : | */ | ||
| 189 : | function getVersion() { | ||
| 190 : | return DOMIT_RSS_VERSION; | ||
| 191 : | } //getVersion | ||
| 192 : | } //xml_domit_rss_document | ||
| 193 : | |||
| 194 : | |||
| 195 : | /** | ||
| 196 : | * Represents an RSS channel | ||
| 197 : | * | ||
| 198 : | * @package domit-rss | ||
| 199 : | * @subpackage domit-rss-main | ||
| 200 : | * @author John Heinstein <johnkarl@nbnet.nb.ca> | ||
| 201 : | */ | ||
| 202 : | class xml_domit_rss_channel extends xml_domit_rss_elementindexer { | ||
| 203 : | /** @var array A list of references to channel items */ | ||
| 204 : | var $domit_rss_items = array(); | ||
| 205 : | /** @var array A list of references to category items */ | ||
| 206 : | var $domit_rss_categories = array(); | ||
| 207 : | |||
| 208 : | /** | ||
| 209 : | * Constructor | ||
| 210 : | * @param Object A DOM node containing channel data | ||
| 211 : | * @param boolean True if channel elements are siblings of the channel rather than children | ||
| 212 : | */ | ||
| 213 : | function xml_domit_rss_channel(&$channel, $externalElements = false) { | ||
| 214 : | $this->node =& $channel; | ||
| 215 : | $this->rssDefinedElements = array('title','link','description','language','copyright', | ||
| 216 : | 'managingEditor','webmaster','pubDate','lastBuildDate', | ||
| 217 : | 'generator','docs','cloud','ttl','image', 'rating', | ||
| 218 : | 'textInput','skipHours','skipDays','domit_rss_channels', | ||
| 219 : | 'domit_rss_items','domit_rss_categories'); | ||
| 220 : | $this->_init(); | ||
| 221 : | } //xml_domit_rss_channel | ||
| 222 : | |||
| 223 : | /** | ||
| 224 : | * Performs initialization of the RSS channel element | ||
| 225 : | */ | ||
| 226 : | function _init() { | ||
| 227 : | $total = $this->node->childCount; | ||
| 228 : | $itemCounter = 0; | ||
| 229 : | $categoryCounter = 0; | ||
| 230 : | |||
| 231 : | for ($i = 0; $i < $total; $i++) { | ||
| 232 : | $currNode =& $this->node->childNodes[$i]; | ||
| 233 : | $tagName = strtolower($currNode->nodeName); | ||
| 234 : | |||
| 235 : | switch($tagName) { | ||
| 236 : | case DOMIT_RSS_ELEMENT_ITEM: | ||
| 237 : | $this->domit_rss_items[$itemCounter] =& new xml_domit_rss_item($currNode); | ||
| 238 : | $itemCounter++; | ||
| 239 : | break; | ||
| 240 : | case DOMIT_RSS_ELEMENT_CATEGORY: | ||
| 241 : | $this->domit_rss_categories[$categoryCounter] =& new xml_domit_rss_category($currNode); | ||
| 242 : | $categoryCounter++; | ||
| 243 : | break; | ||
| 244 : | case DOMIT_RSS_ELEMENT_IMAGE: | ||
| 245 : | $this->DOMIT_RSS_indexer[$tagName] =& new xml_domit_rss_image($currNode); | ||
| 246 : | break; | ||
| 247 : | case DOMIT_RSS_ELEMENT_CLOUD: | ||
| 248 : | $this->DOMIT_RSS_indexer[$tagName] =& new xml_domit_rss_cloud($currNode); | ||
| 249 : | break; | ||
| 250 : | case DOMIT_RSS_ELEMENT_TEXTINPUT: | ||
| 251 : | $this->DOMIT_RSS_indexer[$tagName] =& new xml_domit_rss_textinput($currNode); | ||
| 252 : | break; | ||
| 253 : | case DOMIT_RSS_ELEMENT_TITLE: | ||
| 254 : | case DOMIT_RSS_ELEMENT_LINK: | ||
| 255 : | case DOMIT_RSS_ELEMENT_DESCRIPTION: | ||
| 256 : | case DOMIT_RSS_ELEMENT_LANGUAGE: | ||
| 257 : | case DOMIT_RSS_ELEMENT_COPYRIGHT: | ||
| 258 : | case DOMIT_RSS_ELEMENT_MANAGINGEDITOR: | ||
| 259 : | case DOMIT_RSS_ELEMENT_WEBMASTER: | ||
| 260 : | case DOMIT_RSS_ELEMENT_PUBDATE: | ||
| 261 : | case DOMIT_RSS_ELEMENT_LASTBUILDDATE: | ||
| 262 : | case DOMIT_RSS_ELEMENT_GENERATOR: | ||
| 263 : | case DOMIT_RSS_ELEMENT_DOCS: | ||
| 264 : | case DOMIT_RSS_ELEMENT_TTL: | ||
| 265 : | case DOMIT_RSS_ELEMENT_RATING: | ||
| 266 : | case DOMIT_RSS_ELEMENT_SKIPHOURS: | ||
| 267 : | case DOMIT_RSS_ELEMENT_SKIPDAYS: | ||
| 268 : | $this->DOMIT_RSS_indexer[$tagName] =& new xml_domit_rss_simpleelement($currNode); | ||
| 269 : | break; | ||
| 270 : | default: | ||
| 271 : | $this->addIndexedElement($currNode); | ||
| 272 : | //$this->DOMIT_RSS_indexer[$tagName] =& $currNode; | ||
| 273 : | } | ||
| 274 : | } | ||
| 275 : | |||
| 276 : | if ($itemCounter != 0) { | ||
| 277 : | $this->DOMIT_RSS_indexer[DOMIT_RSS_ARRAY_ITEMS] =& $this->domit_rss_items; | ||
| 278 : | } | ||
| 279 : | |||
| 280 : | if ($categoryCounter != 0) { | ||
| 281 : | $this->DOMIT_RSS_indexer[DOMIT_RSS_ARRAY_CATEGORIES] =& $this->domit_rss_categories; | ||
| 282 : | } | ||
| 283 : | } //_init | ||
| 284 : | |||
| 285 : | /** | ||
| 286 : | * Returns the title of the channel | ||
| 287 : | * @return string The title of the channel, or an empty string | ||
| 288 : | */ | ||
| 289 : | function getTitle() { | ||
| 290 : | return $this->getElementText(DOMIT_RSS_ELEMENT_TITLE); | ||
| 291 : | } //getTitle | ||
| 292 : | |||
| 293 : | /** | ||
| 294 : | * Returns the url of the channel | ||
| 295 : | * @return string The url of the channel, or an empty string | ||
| 296 : | */ | ||
| 297 : | function getLink() { | ||
| 298 : | return $this->getElementText(DOMIT_RSS_ELEMENT_LINK); | ||
| 299 : | } //getLink | ||
| 300 : | |||
| 301 : | /** | ||
| 302 : | * Returns a description of the channel | ||
| 303 : | * @return string A description of the channel, or an empty string | ||
| 304 : | */ | ||
| 305 : | function getDescription() { | ||
| 306 : | return $this->getElementText(DOMIT_RSS_ELEMENT_DESCRIPTION); | ||
| 307 : | } //getDescription | ||
| 308 : | |||
| 309 : | /** | ||
| 310 : | * Returns the number of items in the channel | ||
| 311 : | * @return int The number of items in the channel | ||
| 312 : | */ | ||
| 313 : | function getItemCount() { | ||
| 314 : | return count($this->domit_rss_items); | ||
| 315 : | } //getItemCount | ||
| 316 : | |||
| 317 : | /** | ||
| 318 : | * Returns a reference to the item at the specified index | ||
| 319 : | * @param int The index of the requested item | ||
| 320 : | * @return Object A reference to the item at the specified index | ||
| 321 : | */ | ||
| 322 : | function &getItem($index) { | ||
| 323 : | return $this->domit_rss_items[$index]; | ||
| 324 : | } //getItem | ||
| 325 : | |||
| 326 : | /** | ||
| 327 : | * Returns the number of categories in the channel | ||
| 328 : | * @return int The number of categories in the channel | ||
| 329 : | */ | ||
| 330 : | function getCategoryCount() { | ||
| 331 : | return count($this->domit_rss_categories); | ||
| 332 : | } //getCategoryCount | ||
| 333 : | |||
| 334 : | /** | ||
| 335 : | * Returns a reference to the category at the specified index | ||
| 336 : | * @param int The index of the requested category | ||
| 337 : | * @return Object A reference to the category at the specified index | ||
| 338 : | */ | ||
| 339 : | function &getCategory($index) { | ||
| 340 : | return $this->domit_rss_categories[$index]; | ||
| 341 : | } //getCategory | ||
| 342 : | } //xml_domit_rss_channel | ||
| 343 : | |||
| 344 : | /** | ||
| 345 : | * Represents an RSS item | ||
| 346 : | * | ||
| 347 : | * @package domit-rss | ||
| 348 : | * @subpackage domit-rss-main | ||
| 349 : | * @author John Heinstein <johnkarl@nbnet.nb.ca> | ||
| 350 : | */ | ||
| 351 : | class xml_domit_rss_item extends xml_domit_rss_elementindexer { | ||
| 352 : | /** @var array A list of references to category items */ | ||
| 353 : | var $domit_rss_categories = array(); | ||
| 354 : | |||
| 355 : | /** | ||
| 356 : | * Constructor | ||
| 357 : | * @param Object A DOM node containing item data | ||
| 358 : | */ | ||
| 359 : | function xml_domit_rss_item(&$item) { | ||
| 360 : | $this->node =& $item; | ||
| 361 : | $this->rssDefinedElements = array('title','link','description','author','comments', | ||
| 362 : | 'enclosure','guid','pubDate','source','domit_rss_categories'); | ||
| 363 : | $this->_init(); | ||
| 364 : | } //xml_domit_rss_item | ||
| 365 : | |||
| 366 : | /** | ||
| 367 : | * Performs initialization of the item element | ||
| 368 : | */ | ||
| 369 : | function _init(){ | ||
| 370 : | $total = $this->node->childCount; | ||
| 371 : | $categoryCounter = 0; | ||
| 372 : | |||
| 373 : | for($i = 0; $i < $total; $i++) { | ||
| 374 : | $currNode =& $this->node->childNodes[$i]; | ||
| 375 : | $tagName = strtolower($currNode->nodeName); | ||
| 376 : | |||
| 377 : | switch ($tagName) { | ||
| 378 : | case DOMIT_RSS_ELEMENT_CATEGORY: | ||
| 379 : | $this->categories[$categoryCounter] =& new xml_domit_rss_category($currNode); | ||
| 380 : | $categoryCounter++; | ||
| 381 : | break; | ||
| 382 : | case DOMIT_RSS_ELEMENT_ENCLOSURE: | ||
| 383 : | $this->DOMIT_RSS_indexer[$tagName] =& new xml_domit_rss_enclosure($currNode); | ||
| 384 : | break; | ||
| 385 : | case DOMIT_RSS_ELEMENT_SOURCE: | ||
| 386 : | $this->DOMIT_RSS_indexer[$tagName] =& new xml_domit_rss_source($currNode); | ||
| 387 : | break; | ||
| 388 : | case DOMIT_RSS_ELEMENT_GUID: | ||
| 389 : | $this->DOMIT_RSS_indexer[$tagName] =& new xml_domit_rss_guid($currNode); | ||
| 390 : | break; | ||
| 391 : | case DOMIT_RSS_ELEMENT_TITLE: | ||
| 392 : | case DOMIT_RSS_ELEMENT_LINK: | ||
| 393 : | case DOMIT_RSS_ELEMENT_DESCRIPTION: | ||
| 394 : | case DOMIT_RSS_ELEMENT_AUTHOR: | ||
| 395 : | case DOMIT_RSS_ELEMENT_COMMENTS: | ||
| 396 : | case DOMIT_RSS_ELEMENT_PUBDATE: | ||
| 397 : | $this->DOMIT_RSS_indexer[$tagName] =& new xml_domit_rss_simpleelement($currNode); | ||
| 398 : | break; | ||
| 399 : | default: | ||
| 400 : | $this->addIndexedElement($currNode); | ||
| 401 : | //$this->DOMIT_RSS_indexer[$tagName] =& $currNode; | ||
| 402 : | } | ||
| 403 : | } | ||
| 404 : | |||
| 405 : | if ($categoryCounter != 0) { | ||
| 406 : | $this->DOMIT_RSS_indexer[DOMIT_RSS_ARRAY_CATEGORIES] =& $this->domit_rss_categories; | ||
| 407 : | } | ||
| 408 : | } //init | ||
| 409 : | |||
| 410 : | /** | ||
| 411 : | * Returns the title of the item | ||
| 412 : | * @return string The title of the item, or an empty string | ||
| 413 : | */ | ||
| 414 : | function getTitle() { | ||
| 415 : | return $this->getElementText(DOMIT_RSS_ELEMENT_TITLE); | ||
| 416 : | } //getTitle | ||
| 417 : | |||
| 418 : | /** | ||
| 419 : | * Returns the url of the item | ||
| 420 : | * @return string The url of the item, or an empty string | ||
| 421 : | */ | ||
| 422 : | function getLink() { | ||
| 423 : | return $this->getElementText(DOMIT_RSS_ELEMENT_LINK); | ||
| 424 : | } //getLink | ||
| 425 : | |||
| 426 : | /** | ||
| 427 : | * Returns a description of the item | ||
| 428 : | * @return string A description of the item, or an empty string | ||
| 429 : | */ | ||
| 430 : | function getDescription() { | ||
| 431 : | return $this->getElementText(DOMIT_RSS_ELEMENT_DESCRIPTION); | ||
| 432 : | } //getDescription | ||
| 433 : | |||
| 434 : | /** | ||
| 435 : | * Returns the number of categories in the item | ||
| 436 : | * @return int The number of categories in the item | ||
| 437 : | */ | ||
| 438 : | function getCategoryCount() { | ||
| 439 : | return count($this->domit_rss_categories); | ||
| 440 : | } //getCategoryCount | ||
| 441 : | |||
| 442 : | /** | ||
| 443 : | * Returns a reference to the category at the specified index | ||
| 444 : | * @param int The index of the requested category | ||
| 445 : | * @return Object A reference to the category at the specified index | ||
| 446 : | */ | ||
| 447 : | function &getCategory($index) { | ||
| 448 : | return $this->domit_rss_categories[$index]; | ||
| 449 : | } //getCategory | ||
| 450 : | } //xml_domit_rss_item | ||
| 451 : | |||
| 452 : | |||
| 453 : | /** | ||
| 454 : | * Represents an RSS category | ||
| 455 : | * | ||
| 456 : | * @package domit-rss | ||
| 457 : | * @subpackage domit-rss-main | ||
| 458 : | * @author John Heinstein <johnkarl@nbnet.nb.ca> | ||
| 459 : | */ | ||
| 460 : | class xml_domit_rss_category extends xml_domit_rss_elementindexer { | ||
| 461 : | /** | ||
| 462 : | * Constructor | ||
| 463 : | * @param Object A DOM node containing category data | ||
| 464 : | */ | ||
| 465 : | function xml_domit_rss_category(&$category) { | ||
| 466 : | $this->node =& $category; | ||
| 467 : | $this->_init(); | ||
| 468 : | } //xml_domit_rss_category | ||
| 469 : | |||
| 470 : | /** | ||
| 471 : | * Returns the category | ||
| 472 : | * @return string The category text | ||
| 473 : | */ | ||
| 474 : | function getCategory() { | ||
| 475 : | return $this->node->firstChild->toString(); | ||
| 476 : | } //getCategory | ||
| 477 : | |||
| 478 : | /** | ||
| 479 : | * Returns the category domain | ||
| 480 : | * @return string The category domain | ||
| 481 : | */ | ||
| 482 : | function getDomain() { | ||
| 483 : | return $this->getAttribute(DOMIT_RSS_ATTR_DOMAIN); | ||
| 484 : | } //getDomain | ||
| 485 : | } //xml_domit_rss_category | ||
| 486 : | |||
| 487 : | /** | ||
| 488 : | * Represents an RSS image | ||
| 489 : | * | ||
| 490 : | * @package domit-rss | ||
| 491 : | * @subpackage domit-rss-main | ||
| 492 : | * @author John Heinstein <johnkarl@nbnet.nb.ca> | ||
| 493 : | */ | ||
| 494 : | class xml_domit_rss_image extends xml_domit_rss_elementindexer { | ||
| 495 : | /** | ||
| 496 : | * Constructor | ||
| 497 : | * @param Object A DOM node containing image data | ||
| 498 : | */ | ||
| 499 : | function xml_domit_rss_image(&$image) { | ||
| 500 : | $this->node =& $image; | ||
| 501 : | $this->rssDefinedElements = array('title','link','description','url', | ||
| 502 : | 'width', 'height'); | ||
| 503 : | $this->_init(); | ||
| 504 : | } //xml_domit_rss_image | ||
| 505 : | |||
| 506 : | /** | ||
| 507 : | * Performs initialization of image element | ||
| 508 : | */ | ||
| 509 : | function _init(){ | ||
| 510 : | $total = $this->node->childCount; | ||
| 511 : | |||
| 512 : | for($i = 0; $i < $total; $i++) { | ||
| 513 : | $currNode =& $this->node->childNodes[$i]; | ||
| 514 : | $tagName = strtolower($currNode->nodeName); | ||
| 515 : | |||
| 516 : | switch ($tagName) { | ||
| 517 : | case DOMIT_RSS_ELEMENT_TITLE: | ||
| 518 : | case DOMIT_RSS_ELEMENT_LINK: | ||
| 519 : | case DOMIT_RSS_ELEMENT_DESCRIPTION: | ||
| 520 : | case DOMIT_RSS_ELEMENT_URL: | ||
| 521 : | case DOMIT_RSS_ELEMENT_WIDTH: | ||
| 522 : | case DOMIT_RSS_ELEMENT_HEIGHT: | ||
| 523 : | $this->DOMIT_RSS_indexer[$tagName] =& new xml_domit_rss_simpleelement($currNode); | ||
| 524 : | break; | ||
| 525 : | default: | ||
| 526 : | $this->addIndexedElement($currNode); | ||
| 527 : | //$this->DOMIT_RSS_indexer[$tagName] =& $currNode; | ||
| 528 : | } | ||
| 529 : | } | ||
| 530 : | } //_init | ||
| 531 : | |||
| 532 : | /** | ||
| 533 : | * Returns the image title | ||
| 534 : | * @return string The image title | ||
| 535 : | */ | ||
| 536 : | function getTitle() { | ||
| 537 : | return $this->getElementText(DOMIT_RSS_ELEMENT_TITLE); | ||
| 538 : | } //getTitle | ||
| 539 : | |||
| 540 : | /** | ||
| 541 : | * Returns the image link | ||
| 542 : | * @return string The image link | ||
| 543 : | */ | ||
| 544 : | function getLink() { | ||
| 545 : | return $this->getElementText(DOMIT_RSS_ELEMENT_LINK); | ||
| 546 : | } //getLink | ||
| 547 : | |||
| 548 : | /** | ||
| 549 : | * Returns the image url | ||
| 550 : | * @return string The image url | ||
| 551 : | */ | ||
| 552 : | function getUrl() { | ||
| 553 : | return $this->getElementText(DOMIT_RSS_ELEMENT_URL); | ||
| 554 : | } //getUrl | ||
| 555 : | |||
| 556 : | /** | ||
| 557 : | * Returns the image width in pixels | ||
| 558 : | * @return string The image width (maximum 144, default 88) | ||
| 559 : | */ | ||
| 560 : | function getWidth() { | ||
| 561 : | $myWidth = $this->getElementText(DOMIT_RSS_ELEMENT_WIDTH); | ||
| 562 : | |||
| 563 : | if ($myWidth == '') { | ||
| 564 : | $myWidth = '88'; | ||
| 565 : | } | ||
| 566 : | else if (intval($myWidth) > 144) { | ||
| 567 : | $myWidth = '144'; | ||
| 568 : | } | ||
| 569 : | |||
| 570 : | return $myWidth; | ||
| 571 : | } //getWidth | ||
| 572 : | |||
| 573 : | /** | ||
| 574 : | * Returns the image height in pixels | ||
| 575 : | * @return string The image height (maximum 400, default 31) | ||
| 576 : | */ | ||
| 577 : | function getHeight() { | ||
| 578 : | $myHeight = $this->getElementText(DOMIT_RSS_ELEMENT_HEIGHT); | ||
| 579 : | |||
| 580 : | if ($myHeight == '') { | ||
| 581 : | $myHeight = '31'; | ||
| 582 : | } | ||
| 583 : | else if (intval($myHeight) > 400) { | ||
| 584 : | $myHeight = '400'; | ||
| 585 : | } | ||
| 586 : | |||
| 587 : | return $myHeight; | ||
| 588 : | } //getHeight | ||
| 589 : | |||
| 590 : | /** | ||
| 591 : | * Returns the image description | ||
| 592 : | * @return string The image description | ||
| 593 : | */ | ||
| 594 : | function getDescription() { | ||
| 595 : | return $this->getElementText(DOMIT_RSS_ELEMENT_DESCRIPTION); | ||
| 596 : | } //getDescription | ||
| 597 : | } //xml_domit_rss_image | ||
| 598 : | |||
| 599 : | /** | ||
| 600 : | * Represents an RSS text input form | ||
| 601 : | * | ||
| 602 : | * @package domit-rss | ||
| 603 : | * @subpackage domit-rss-main | ||
| 604 : | * @author John Heinstein <johnkarl@nbnet.nb.ca> | ||
| 605 : | */ | ||
| 606 : | class xml_domit_rss_textinput extends xml_domit_rss_elementindexer { | ||
| 607 : | /** | ||
| 608 : | * Constructor | ||
| 609 : | * @param Object A DOM node containing text input data | ||
| 610 : | */ | ||
| 611 : | function xml_domit_rss_textinput(&$textinput) { | ||
| 612 : | $this->node =& $textinput; | ||
| 613 : | $this->rssDefinedElements = array('title','link','description','name'); | ||
| 614 : | $this->_init(); | ||
| 615 : | } //xml_domit_rss_textinput | ||
| 616 : | |||
| 617 : | /** | ||
| 618 : | * Performs initialization of textInput element | ||
| 619 : | */ | ||
| 620 : | function _init(){ | ||
| 621 : | $total = $this->node->childCount; | ||
| 622 : | |||
| 623 : | for($i = 0; $i < $total; $i++) { | ||
| 624 : | $currNode =& $this->node->childNodes[$i]; | ||
| 625 : | $tagName = strtolower($currNode->nodeName); | ||
| 626 : | |||
| 627 : | switch ($tagName) { | ||
| 628 : | case DOMIT_RSS_ELEMENT_TITLE: | ||
| 629 : | case DOMIT_RSS_ELEMENT_LINK: | ||
| 630 : | case DOMIT_RSS_ELEMENT_DESCRIPTION: | ||
| 631 : | case DOMIT_RSS_ELEMENT_NAME: | ||
| 632 : | $this->DOMIT_RSS_indexer[$tagName] =& new xml_domit_rss_simpleelement($currNode); | ||
| 633 : | break; | ||
| 634 : | default: | ||
| 635 : | $this->addIndexedElement($currNode); | ||
| 636 : | //$this->DOMIT_RSS_indexer[$tagName] =& $currNode; | ||
| 637 : | } | ||
| 638 : | } | ||
| 639 : | } //_init | ||
| 640 : | |||
| 641 : | /** | ||
| 642 : | * Returns the title of the text input | ||
| 643 : | * @return string The title of the text input, or an empty string | ||
| 644 : | */ | ||
| 645 : | function getTitle() { | ||
| 646 : | return $this->getElementText(DOMIT_RSS_ELEMENT_TITLE); | ||
| 647 : | } //getTitle | ||
| 648 : | |||
| 649 : | /** | ||
| 650 : | * Returns a description of the text input | ||
| 651 : | * @return string A description of the text input, or an empty string | ||
| 652 : | */ | ||
| 653 : | function getDescription() { | ||
| 654 : | return $this->getElementText(DOMIT_RSS_ELEMENT_DESCRIPTION); | ||
| 655 : | } //getDescription | ||
| 656 : | |||
| 657 : | /** | ||
| 658 : | * Returns the name of the text input | ||
| 659 : | * @return string The name of the text input, or an empty string | ||
| 660 : | */ | ||
| 661 : | function getName() { | ||
| 662 : | return $this->getElementText(DOMIT_RSS_ELEMENT_NAME); | ||
| 663 : | } //getName | ||
| 664 : | |||
| 665 : | /** | ||
| 666 : | * Returns the url of the text input | ||
| 667 : | * @return string The url of the text input, or an empty string | ||
| 668 : | */ | ||
| 669 : | function getLink() { | ||
| 670 : | return $this->getElementText(DOMIT_RSS_ELEMENT_LINK); | ||
| 671 : | } //getLink | ||
| 672 : | } //xml_domit_rss_textinput | ||
| 673 : | |||
| 674 : | /** | ||
| 675 : | * Represents an RSS cloud | ||
| 676 : | * | ||
| 677 : | * @package domit-rss | ||
| 678 : | * @subpackage domit-rss-main | ||
| 679 : | * @author John Heinstein <johnkarl@nbnet.nb.ca> | ||
| 680 : | */ | ||
| 681 : | class xml_domit_rss_cloud extends xml_domit_rss_elementindexer { | ||
| 682 : | /** | ||
| 683 : | * Constructor | ||
| 684 : | * @param Object A DOM node containing cloud data | ||
| 685 : | */ | ||
| 686 : | function xml_domit_rss_cloud(&$cloud) { | ||
| 687 : | $this->node =& $cloud; | ||
| 688 : | $this->_init(); | ||
| 689 : | } //xml_domit_rss_cloud | ||
| 690 : | |||
| 691 : | /** | ||
| 692 : | * Returns the domain of the cloud | ||
| 693 : | * @return string The domain of the cloud | ||
| 694 : | */ | ||
| 695 : | function getDomain() { | ||
| 696 : | return $this->getAttribute(DOMIT_RSS_ATTR_DOMAIN); | ||
| 697 : | } //getDomain | ||
| 698 : | |||
| 699 : | /** | ||
| 700 : | * Returns the port of the cloud | ||
| 701 : | * @return string The port of the cloud | ||
| 702 : | */ | ||
| 703 : | function getPort() { | ||
| 704 : | return $this->getAttribute(DOMIT_RSS_ATTR_PORT); | ||
| 705 : | } //getPort | ||
| 706 : | |||
| 707 : | /** | ||
| 708 : | * Returns the path of the cloud | ||
| 709 : | * @return string The path of the cloud | ||
| 710 : | */ | ||
| 711 : | function getPath() { | ||
| 712 : | return $this->getAttribute(DOMIT_RSS_ATTR_PATH); | ||
| 713 : | } //getPath | ||
| 714 : | |||
| 715 : | /** | ||
| 716 : | * Returns the register procedure value of the cloud | ||
| 717 : | * @return string The register procedure value of the cloud | ||
| 718 : | */ | ||
| 719 : | function getRegisterProcedure() { | ||
| 720 : | return $this->getAttribute(DOMIT_RSS_ATTR_REGISTERPROCEDURE); | ||
| 721 : | } //getRegisterProcedure | ||
| 722 : | |||
| 723 : | /** | ||
| 724 : | * Returns the protocol used by the cloud | ||
| 725 : | * @return string The protocol used by the cloud | ||
| 726 : | */ | ||
| 727 : | function getProtocol() { | ||
| 728 : | return $this->getAttribute(DOMIT_RSS_ATTR_PROTOCOL); | ||
| 729 : | } //getProtocol | ||
| 730 : | } //xml_domit_rss_cloud | ||
| 731 : | |||
| 732 : | /** | ||
| 733 : | * Represents an RSS enclosure | ||
| 734 : | * | ||
| 735 : | * @package domit-rss | ||
| 736 : | * @subpackage domit-rss-main | ||
| 737 : | * @author John Heinstein <johnkarl@nbnet.nb.ca> | ||
| 738 : | */ | ||
| 739 : | class xml_domit_rss_enclosure extends xml_domit_rss_elementindexer { | ||
| 740 : | /** | ||
| 741 : | * Constructor | ||
| 742 : | * @param Object A DOM node containing enclosure data | ||
| 743 : | */ | ||
| 744 : | function xml_domit_rss_enclosure(&$enclosure) { | ||
| 745 : | $this->node =& $enclosure; | ||
| 746 : | $this->_init(); | ||
| 747 : | } //xml_domit_rss_enclosure | ||
| 748 : | |||
| 749 : | /** | ||
| 750 : | * Returns the url of the enclosure | ||
| 751 : | * @return string The url of the enclosure | ||
| 752 : | */ | ||
| 753 : | function getUrl() { | ||
| 754 : | return $this->getAttribute(DOMIT_RSS_ATTR_URL); | ||
| 755 : | } //getUrl | ||
| 756 : | |||
| 757 : | /** | ||
| 758 : | * Returns the length of the enclosure | ||
| 759 : | * @return string The length of the enclosure | ||
| 760 : | */ | ||
| 761 : | function getLength() { | ||
| 762 : | return $this->getAttribute(DOMIT_RSS_ATTR_LENGTH); | ||
| 763 : | } //getLength | ||
| 764 : | |||
| 765 : | /** | ||
| 766 : | * Returns the type of the enclosure | ||
| 767 : | * @return string The type of the enclosure | ||
| 768 : | */ | ||
| 769 : | function getType() { | ||
| 770 : | return $this->getAttribute(DOMIT_RSS_ATTR_TYPE); | ||
| 771 : | } //getType | ||
| 772 : | } //xml_domit_rss_enclosure | ||
| 773 : | |||
| 774 : | /** | ||
| 775 : | * Represents an RSS guid | ||
| 776 : | * | ||
| 777 : | * @package domit-rss | ||
| 778 : | * @subpackage domit-rss-main | ||
| 779 : | * @author John Heinstein <johnkarl@nbnet.nb.ca> | ||
| 780 : | */ | ||
| 781 : | class xml_domit_rss_guid extends xml_domit_rss_elementindexer { | ||
| 782 : | /** | ||
| 783 : | * Constructor | ||
| 784 : | * @param Object A DOM node containing guid data | ||
| 785 : | */ | ||
| 786 : | function xml_domit_rss_guid(&$guid) { | ||
| 787 : | $this->node =& $guid; | ||
| 788 : | $this->_init(); | ||
| 789 : | } //xml_domit_rss_guid | ||
| 790 : | |||
| 791 : | /** | ||
| 792 : | * Returns the guid text | ||
| 793 : | * @return string The guid text | ||
| 794 : | */ | ||
| 795 : | function getGuid() { | ||
| 796 : | return $this->node->getText(); | ||
| 797 : | } //getGuid | ||
| 798 : | |||
| 799 : | /** | ||
| 800 : | * Determines whether the guid is a permalink | ||
| 801 : | * @return boolean True if the guid is a permalink (default true) | ||
| 802 : | */ | ||
| 803 : | function isPermaLink() { | ||
| 804 : | if (!$this->node->hasAttribute(DOMIT_RSS_ATTR_ISPERMALINK)) { | ||
| 805 : | return true; | ||
| 806 : | } | ||
| 807 : | else { | ||
| 808 : | return (strtolower($this->node->getAttribute(DOMIT_RSS_ATTR_ISPERMALINK)) == "true"); | ||
| 809 : | } | ||
| 810 : | } //isPermaLink | ||
| 811 : | } //xml_domit_rss_guid | ||
| 812 : | |||
| 813 : | /** | ||
| 814 : | * Represents an RSS source | ||
| 815 : | * | ||
| 816 : | * @package domit-rss | ||
| 817 : | * @subpackage domit-rss-main | ||
| 818 : | * @author John Heinstein <johnkarl@nbnet.nb.ca> | ||
| 819 : | */ | ||
| 820 : | class xml_domit_rss_source extends xml_domit_rss_elementindexer { | ||
| 821 : | /** | ||
| 822 : | * Constructor | ||
| 823 : | * @param Object A DOM node containing source data | ||
| 824 : | */ | ||
| 825 : | function xml_domit_rss_source(&$source) { | ||
| 826 : | $this->node =& $source; | ||
| 827 : | $this->_init(); | ||
| 828 : | } //xml_domit_rss_source | ||
| 829 : | |||
| 830 : | /** | ||
| 831 : | * Returns the source text | ||
| 832 : | * @return string The source text | ||
| 833 : | */ | ||
| 834 : | function getSource() { | ||
| 835 : | return $this->node->getText(); | ||
| 836 : | } //getSource | ||
| 837 : | |||
| 838 : | /** | ||
| 839 : | * Returns the url of the source | ||
| 840 : | * @return string The url of the source | ||
| 841 : | */ | ||
| 842 : | function getUrl() { | ||
| 843 : | return $this->getAttribute(DOMIT_RSS_ATTR_URL); | ||
| 844 : | } //getUrl | ||
| 845 : | } //xml_domit_rss_source | ||
| 846 : | |||
| 847 : | ?> |
| ViewVC Help | |
| Powered by ViewVC 1.0.0 |
Web Hosting provided by Network Redux.

