www.aleph1.co.uk Git - yaffs-website/blob - vendor/easyrdf/easyrdf/lib/EasyRdf/Serialiser.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 serialiser
  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_Serialiser
  46 {
  47     protected $prefixes = array();
  48
  49     public function __construct()
  50     {
  51     }
  52
  53     /**
  54      * Keep track of the prefixes used while serialising
  55      * @ignore
  56      */
  57     protected function addPrefix($qname)
  58     {
  59         list ($prefix) = explode(':', $qname);
  60         $this->prefixes[$prefix] = true;
  61     }
  62
  63     /**
  64      * Check and cleanup parameters passed to serialise() method
  65      * @ignore
  66      */
  67     protected function checkSerialiseParams(&$graph, &$format)
  68     {
  69         if (is_null($graph) or !is_object($graph) or !($graph instanceof EasyRdf_Graph)) {
  70             throw new InvalidArgumentException(
  71                 "\$graph should be an EasyRdf_Graph object and cannot be null"
  72             );
  73         }
  74
  75         if (is_null($format) or $format == '') {
  76             throw new InvalidArgumentException(
  77                 "\$format cannot be null or empty"
  78             );
  79         } elseif (is_object($format) and ($format instanceof EasyRdf_Format)) {
  80             $format = $format->getName();
  81         } elseif (!is_string($format)) {
  82             throw new InvalidArgumentException(
  83                 "\$format should be a string or an EasyRdf_Format object"
  84             );
  85         }
  86     }
  87
  88     /**
  89      * Protected method to get the number of reverse properties for a resource
  90      * If a resource only has a single property, the number of values for that
  91      * property is returned instead.
  92      * @ignore
  93      */
  94     protected function reversePropertyCount($resource)
  95     {
  96         $properties = $resource->reversePropertyUris();
  97         $count = count($properties);
  98         if ($count == 1) {
  99             $property = $properties[0];
 100             return $resource->countValues("^<$property>");
 101         } else {
 102             return $count;
 103         }
 104     }
 105
 106     /**
 107      * Sub-classes must follow this protocol
 108      * @ignore
 109      */
 110     public function serialise($graph, $format, array $options = array())
 111     {
 112         throw new EasyRdf_Exception(
 113             "This method should be overridden by sub-classes."
 114         );
 115     }
 116 }