yaffs.net Git - yaffs-website/blob - vendor/easyrdf/easyrdf/lib/EasyRdf/Parser.php

   1 <?php
   2
   3 /**
   4  * EasyRdf
   5  *
   6  * LICENSE
   7  *
   8  * Copyright (c) 2009-2013 Nicholas J Humfrey.  All rights reserved.
   9  *
  10  * Redistribution and use in source and binary forms, with or without
  11  * modification, are permitted provided that the following conditions are met:
  12  * 1. Redistributions of source code must retain the above copyright
  13  *    notice, this list of conditions and the following disclaimer.
  14  * 2. Redistributions in binary form must reproduce the above copyright notice,
  15  *    this list of conditions and the following disclaimer in the documentation
  16  *    and/or other materials provided with the distribution.
  17  * 3. The name of the author 'Nicholas J Humfrey" may be used to endorse or
  18  *    promote products derived from this software without specific prior
  19  *    written permission.
  20  *
  21  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
  22  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  23  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  24  * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
  25  * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
  26  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
  27  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
  28  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
  29  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
  30  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
  31  * POSSIBILITY OF SUCH DAMAGE.
  32  *
  33  * @package    EasyRdf
  34  * @copyright  Copyright (c) 2009-2013 Nicholas J Humfrey
  35  * @license    http://www.opensource.org/licenses/bsd-license.php
  36  */
  37
  38 /**
  39  * Parent class for the EasyRdf parsers
  40  *
  41  * @package    EasyRdf
  42  * @copyright  Copyright (c) 2009-2013 Nicholas J Humfrey
  43  * @license    http://www.opensource.org/licenses/bsd-license.php
  44  */
  45 class EasyRdf_Parser
  46 {
  47     /** Mapping from source to graph bnode identifiers */
  48     private $bnodeMap = array();
  49
  50     /** The current graph to insert triples into */
  51     protected $graph = null;
  52
  53     /** The format of the document currently being parsed */
  54     protected $format = null;
  55
  56     /** The base URI for the document currently being parsed */
  57     protected $baseUri = null;
  58
  59
  60     protected $tripleCount = 0;
  61
  62     /**
  63      * Create a new, unique bnode identifier from a source identifier.
  64      * If the source identifier has previously been seen, the
  65      * same new bnode identifier is returned.
  66      * @ignore
  67      */
  68     protected function remapBnode($name)
  69     {
  70         if (!isset($this->bnodeMap[$name])) {
  71             $this->bnodeMap[$name] = $this->graph->newBNodeId();
  72         }
  73         return $this->bnodeMap[$name];
  74     }
  75
  76     /**
  77      * Delete the bnode mapping - to be called at the start of a new parse
  78      * @ignore
  79      */
  80     protected function resetBnodeMap()
  81     {
  82         $this->bnodeMap = array();
  83     }
  84
  85     /**
  86      * Check, cleanup parameters and prepare for parsing
  87      * @ignore
  88      */
  89     protected function checkParseParams($graph, $data, $format, $baseUri)
  90     {
  91         if ($graph == null or !is_object($graph) or
  92             !($graph instanceof EasyRdf_Graph)) {
  93             throw new InvalidArgumentException(
  94                 "\$graph should be an EasyRdf_Graph object and cannot be null"
  95             );
  96         } else {
  97             $this->graph = $graph;
  98         }
  99
 100         if ($format == null or $format == '') {
 101             throw new InvalidArgumentException(
 102                 "\$format cannot be null or empty"
 103             );
 104         } elseif (is_object($format) and $format instanceof EasyRdf_Format) {
 105             $this->format = $format = $format->getName();
 106         } elseif (!is_string($format)) {
 107             throw new InvalidArgumentException(
 108                 "\$format should be a string or an EasyRdf_Format object"
 109             );
 110         } else {
 111             $this->format = $format;
 112         }
 113
 114         if ($baseUri) {
 115             if (!is_string($baseUri)) {
 116                 throw new InvalidArgumentException(
 117                     "\$baseUri should be a string"
 118                 );
 119             } else {
 120                 $this->baseUri = new EasyRdf_ParsedUri($baseUri);
 121             }
 122         } else {
 123             $this->baseUri = null;
 124         }
 125
 126         // Prepare for parsing
 127         $this->resetBnodeMap();
 128         $this->tripleCount = 0;
 129     }
 130
 131     /**
 132      * Sub-classes must follow this protocol
 133      * @ignore
 134      */
 135     public function parse($graph, $data, $format, $baseUri)
 136     {
 137         throw new EasyRdf_Exception(
 138             "This method should be overridden by sub-classes."
 139         );
 140     }
 141
 142     /**
 143      * Add a triple to the current graph, and keep count of the number of triples
 144      * @ignore
 145      */
 146     protected function addTriple($resource, $property, $value)
 147     {
 148         $count = $this->graph->add($resource, $property, $value);
 149         $this->tripleCount += $count;
 150         return $count;
 151     }
 152 }