lib/pkp/classes/rt/RTXMLParser.inc.php

   1 <?php
   2
   3 /**
   4  * @file classes/rt/RTXMLParser.inc.php
   5  *
   6  * Copyright (c) 2000-2009 John Willinsky
   7  * Distributed under the GNU GPL v2. For full terms see the file docs/COPYING.
   8  *
   9  * @class RTXMLParser
  10  * @ingroup rt
  11  * @see RT
  12  *
  13  * @brief Class to parse Reading Tools data from an XML format.
  14  */
  15
  16 // $Id: RTXMLParser.inc.php,v 1.6 2009/04/08 21:34:54 asmecher Exp $
  17
  18
  19 import('xml.XMLParser');
  20 import('rt.RTStruct');
  21
  22 class RTXMLParser {
  23
  24         /** @var XMLParser the parser to use */
  25         var $parser;
  26
  27
  28         /**
  29          * Parse an RT version XML file.
  30          * @param $file string path to the XML file
  31          * @return RTVersion
  32          */
  33         function &parse($file) {
  34                 $parser = new XMLParser();
  35                 $tree = $parser->parse($file);
  36                 $parser->destroy();
  37                 $version = false;
  38
  39                 if ($tree !== false) {
  40                         $version =& $this->parseVersion($tree);
  41                 }
  42                 $tree->destroy();
  43
  44                 return $version;
  45         }
  46
  47
  48         /**
  49          * Parse all RT version XML files in a directory.
  50          * @param $dir string path to the directory
  51          * @return array RTVersion
  52          */
  53         function &parseAll($dir) {
  54                 $versions = array();
  55
  56                 if(($fd = opendir($dir)) !== false) {
  57                         while (($file = readdir($fd)) !== false) {
  58                                 if (preg_match('/\.xml$/', $file)) {
  59                                         if (($version = $this->parse($dir . '/' . $file))) {
  60                                                 array_push($versions, $version);
  61                                         }
  62                                 }
  63                         }
  64                         closedir($fd);
  65                 }
  66
  67                 return $versions;
  68         }
  69
  70
  71         //
  72         // PRIVATE
  73         //
  74
  75
  76         /**
  77          * Parse version entity.
  78          * @param $version XMLNode
  79          * @return RTVersion
  80          */
  81         function &parseVersion(&$version) {
  82                 $newVersion = new RTVersion();
  83                 $numContexts = 0;
  84
  85                 $newVersion->key = $version->getAttribute('id');
  86                 $newVersion->locale = $version->getAttribute('locale');
  87
  88                 foreach ($version->getChildren() as $attrib) {
  89                         switch ($attrib->getName()) {
  90                                 case 'version_title':
  91                                         $newVersion->title = $attrib->getValue();
  92                                         break;
  93                                 case 'version_description':
  94                                         $newVersion->description = $attrib->getValue();
  95                                         break;
  96                                 case 'context':
  97                                         $newContext =& $this->parseContext($attrib);
  98                                         $newContext->order = $numContexts++;
  99                                         $newVersion->addContext($newContext);
 100                                         break;
 101                         }
 102                 }
 103
 104                 return $newVersion;
 105         }
 106
 107         /**
 108          * Parse context entity.
 109          * @param $context XMLNode
 110          * @return RTContext
 111          */
 112         function &parseContext(&$context) {
 113                 $newContext = new RTContext();
 114                 $numSearches = 0;
 115
 116                 foreach ($context->getChildren() as $attrib) {
 117                         switch ($attrib->getName()) {
 118                                 case 'context_title':
 119                                         $newContext->title = $attrib->getValue();
 120                                         break;
 121                                 case 'context_abbrev':
 122                                         $newContext->abbrev = $attrib->getValue();
 123                                         break;
 124                                 case 'context_description':
 125                                         $newContext->description = $attrib->getValue();
 126                                         break;
 127                                 case 'cites_context':
 128                                         $newContext->citedBy = true;
 129                                         break;
 130                                 case 'author_terms':
 131                                         $newContext->authorTerms = true;
 132                                         break;
 133                                 case 'geo_terms':
 134                                         $newContext->geoTerms = true;
 135                                         break;
 136                                 case 'define_terms':
 137                                         $newContext->defineTerms = true;
 138                                         break;
 139                                 case 'search':
 140                                         $newSearch =& $this->parseSearch($attrib);
 141                                         $newSearch->order = $numSearches++;
 142                                         $newContext->addSearch($newSearch);
 143                                         break;
 144                         }
 145                 }
 146
 147                 return $newContext;
 148         }
 149
 150         /**
 151          * Parse search entity.
 152          * @param $context XMLNode
 153          * @return RTSearch
 154          */
 155         function &parseSearch(&$search) {
 156                 $newSearch = new RTSearch();
 157
 158                 foreach ($search->getChildren() as $attrib) {
 159                         switch ($attrib->getName()) {
 160                                 case 'search_title':
 161                                         $newSearch->title = $attrib->getValue();
 162                                         break;
 163                                 case 'search_description':
 164                                         $newSearch->description = $attrib->getValue();
 165                                         break;
 166                                 case 'url':
 167                                         $newSearch->url = $attrib->getValue();
 168                                         break;
 169                                 case 'search_url':
 170                                         $newSearch->searchUrl = $attrib->getValue();
 171                                         break;
 172                                 case 'search_post':
 173                                         $newSearch->searchPost = $attrib->getValue();
 174                                         break;
 175                         }
 176                 }
 177
 178                 return $newSearch;
 179         }
 180 }
 181
 182 ?>