Source for file N3Serializer.php

Documentation is available at N3Serializer.php

  1. <?php
  2.  
  3. // ----------------------------------------------------------------------------------
  4. // Class: N3Serializer
  5. // ----------------------------------------------------------------------------------
  6.  
  7. /**
  8.  * PHP Notation3 Serializer
  9.  * 
  10.  * This class serialises models to N3 Syntax.
  11.  * 
  12.  * Supported N3 features:
  13.  * <ul>
  14.  *   <li>Using [ ] for blank nodes, or _: if nescessary</li>
  15.  *   <li>Literal datytype- and xmlLanguageTag support</li>
  16.  * </ul>
  17.  * 
  18.  * Un-supported N3 Features include:
  19.  * <ul>
  20.  *   <li>Reification</li>
  21.  * </ul>
  22.  *
  23.  *
  24.  * TODO: * added namespace prefixes are persisent...
  25.  *
  26.  * @author Gunnar AA. Grimnes <ggrimnes@csd.abdn.ac.uk>, Daniel Westphal <mail@d-westphal.de>
  27.  * @version $Id: fsource_syntax__syntaxN3Serializer.php.html 443 2007-06-01 16:25:38Z cax $
  28.  * @package syntax
  29.  * @access public
  30.  ***/
  31.  
  32. define('MAGIC_STRING', '~~~');
  33.  
  34. class N3Serializer extends Object {
  35.  
  36.   var $debug; 
  37.  
  38.   var $prefixes; 
  39.  
  40.   var $done;  // keeps track of already serialized resources
  41.   var $resourcetext; 
  42.   var $resourcetext_taken; 
  43.   var $model;
  44.   var $res; 
  45.   var $anon;
  46.  
  47.    /**
  48.     * Constructor
  49.     *
  50.     * @access   public
  51.     */
  52.   function N3Serializer() { 
  53.     $this->debug=FALSE;
  54.   }
  55.  
  56.  
  57.   /** 
  58.    * Adds a new namespace prefix to use.
  59.    * Unknown namespaces will become ns0, ns1 etc.
  60.    * @access public
  61.    * @param string $s 
  62.    * @returns void
  63.    ***/
  64.  
  65.   function addNSPrefix( $ns, $prefix) { 
  66.     $this->prefixes[$ns]=$prefix; 
  67.   }
  68.  
  69.   /**
  70.    * Serializes a model to N3 syntax.
  71.    *
  72.    * @param     object Model $model 
  73.    * @return    string 
  74.    * @access    public
  75.    */
  76.   function & serialize(&$m) { 
  77.  
  78.     if (is_a($m, 'DbModel')) 
  79.         $m=$m->getMemModel();
  80.     
  81.     $this->reset();
  82.     $this->model=$m;
  83.     $this->res=""; 
  84.     
  85.     // copy default namespaces
  86.     global $default_prefixes;
  87.     foreach($default_prefixes as $prefix => $namespace)
  88.             $this->addNSPrefix($namespace,$prefix);
  89.     
  90.     $nps= $this->model->getParsedNamespaces(); 
  91.     if($nps!=false){
  92.         foreach($nps as $uri => $prefix){
  93.             $this->addNSPrefix($uri,$prefix);
  94.         }
  95.     }
  96.     
  97.     $namespaces=array();
  98.     $count=array();
  99.     $resources=array(); 
  100.     foreach ($this->model->triples as $t) { 
  101.       $s=$t->getSubject();
  102.       if ( is_a($s, 'Resource')) 
  103.         $namespaces[$s->getNamespace()]=1;
  104.  
  105.       $p=$t->getPredicate();
  106.       if ( is_a($p, 'Resource')) 
  107.         $namespaces[$p->getNamespace()]=1;
  108.  
  109.       $o=$t->getObject();
  110.       if ( is_a($o, 'Resource')) 
  111.         $namespaces[$o->getNamespace()]=1;
  112.      
  113.       $uri=$s->getURI();
  114.       
  115.       if (isset($count[$uri])) { 
  116.         $count[$uri]++;
  117.       } else {     
  118.         $count[$uri]=0;
  119.         $resources[$uri]=$s;
  120.       }
  121.     }
  122.  
  123.     if (!HIDE_ADVERTISE) 
  124.         $this->res .= '# Generated by N3Serializer.php from RDF RAP.'.LINEFEED
  125.                      .'# http://www.wiwiss.fu-berlin.de/suhl/bizer/rdfapi/index.html'
  126.                      .LINEFEED.LINEFEED;
  127.  
  128.     $this->doNamespaces($namespaces); 
  129.  
  130.     $this->res.=LINEFEED.LINEFEED;
  131.  
  132.     arsort($count);
  133.     
  134.     foreach ( $count as $k=>$v) { 
  135.       $this->doResource($resources[$k]); 
  136.       //      $this->res.=" .\n";
  137.     }
  138.  
  139.     $c=0;
  140.     foreach ( $this->resourcetext as $r=>$t) { 
  141.  
  142.       if ( preg_match_all('/'.MAGIC_STRING.'([^ ]+)'.MAGIC_STRING.'/', $t, $ms, PREG_SET_ORDER)) {
  143.  
  144.     foreach($ms as $mseach) { 
  145.       $rp=$this->resourcetext[$mseach[1]];
  146.       $t=preg_replace('/'.MAGIC_STRING.$mseach[1].MAGIC_STRING.'/', $rp, $t);
  147.     }
  148.       }
  149.  
  150.       if ($this->debug) $this->res.=$c.': ';
  151.       if ( !( isset($this->resourcetext_taken[$r]) && $this->resourcetext_taken[$r]>0) ) 
  152.          $this->res.=$t.' .'.LINEFEED; 
  153.       else if ( $this->debug ) 
  154.          $this->res.=' Skipping : '.$t.LINEFEED;
  155.       $c++;
  156.     } 
  157.  
  158. //     $max=-1111;
  159. //     $maxkey="";
  160. //     foreach ($count as $k=>$c) { 
  161. //       if ( $c>$max) { $maxkey=$k; $max=$c; }
  162. //     }
  163.     
  164. //     if ($this->debug) { 
  165. //       print "$maxkey is subject of most triples! ($max) \n"; 
  166. //     }
  167.  
  168.     return $this->res;
  169.   }
  170.  
  171. /**
  172.  * Serializes a model and saves it into a file.
  173.  * Returns FALSE if the model couldn't be saved to the file.
  174.  *
  175.  * @param     object MemModel $model 
  176.  * @param     string $filename 
  177.  * @return    boolean 
  178.  * @access    public
  179.  */
  180.  function  saveAs(&$model, $filename) {
  181.  
  182.    // serialize model
  183.    $n3 = $this->serialize($model);
  184.  
  185.    // write serialized model to file
  186.    $file_handle = @fopen($filename, 'w');
  187.    if ($file_handle) {
  188.       fwrite($file_handle, $n3);
  189.       fclose($file_handle);
  190.       return TRUE;
  191.    }else{
  192.       return FALSE;
  193.    };
  194.  }
  195.   
  196.  
  197.   /* ==================== Private Methods from here ==================== */
  198.  
  199.  
  200. /**
  201.  * Readies this object for serializing another model
  202.  * @access private
  203.  * @param void 
  204.  * @returns void
  205.  ***/
  206.   function reset() {
  207.     $this->anon=0;
  208.     $this->done=array();
  209.     $this->resourcetext_taken=array();
  210.     $this->resourcetext=array();
  211.     $this->res='';
  212.     $this->model=NULL;
  213.     unset($this->prefixes);
  214.   }
  215.  
  216. /**
  217.  * Makes ns0, ns1 etc. prefixes for unknown prefixes.
  218.  * Outputs @prefix lines.
  219.  * @access private
  220.  * @param array $n 
  221.  * @returns void
  222.  ***/
  223.   function doNamespaces(&$n) { 
  224.     $c=0;
  225.     foreach ($n as $ns => $nonsense) { 
  226.       if ( !$ns ) continue;  
  227.       if ( isset($this->prefixes[$ns]) ) {
  228.     $p=$this->prefixes[$ns];
  229.       } else { 
  230.     $p='ns'.$c;
  231.     $this->prefixes[$ns]=$p;
  232.     $c++;
  233.       }
  234.       $this->res.="@prefix $p: <".$ns.'> .'.LINEFEED;
  235.     }
  236.   }
  237.  
  238. /**
  239.  * Fill in $resourcetext for a single resource.
  240.  * Will recurse into Objects of triples, but should never look ? (really?)
  241.  * @access private
  242.  * @param object Resource $r 
  243.  * @returns boolean
  244.  ***/
  245.  
  246.   function doResource(&$r) { 
  247.     //    print $r->getURI(); 
  248.  
  249.     $ts=$this->model->find($r, null, null);
  250.     if (count($ts->triples)==0) return; 
  251.     
  252.     $out="";
  253.  
  254.     if ( isset($this->done[$r->getURI()]) && $this->done[$r->getURI()] ) {
  255.       if ( is_a($r, 'BlankNode')) { 
  256.       
  257.           if ( $this->resourcetext_taken[$r->getURI()] == 1) { 
  258.               //Oh bother, we must use the _:blah construct. 
  259.               $a=$this->resourcetext[$r->getURI()];
  260.               $this->resourcetext[$r->getURI()]='_:anon'.$this->anon;
  261.               $this->resourcetext['_:anon'.$this->anon]=$this->fixAnon($a, '_:anon'.$this->anon);
  262.               $this->resourcetext_taken[$r->getURI()]=2; 
  263.               $this->anon++;
  264.         }
  265.  
  266.       }
  267.       return false; 
  268.     }
  269.  
  270.     $this->done[$r->getURI()]=TRUE;
  271.  
  272.     if ( is_a($r, 'Resource') ) {
  273.  
  274.       if ( is_a($r, 'BlankNode') ) { 
  275.  
  276.            //test, if this blanknode is referenced somewhere
  277.           $rbn=$this->model->find(null, null, $r);
  278.  
  279.           if (count($rbn->triples)>0 | !N3SER_BNODE_SHORT) {
  280.               $out.='_:'.$r->getLabel();
  281.           } else {
  282.               $out.='[ ';
  283.           };    
  284.       } else { 
  285.  
  286.         $this->doURI($r, $out);
  287.  
  288.       };
  289.     };
  290.   
  291.     usort($ts->triples, 'statementsorter');
  292.     $lastp='';
  293.  
  294.     $out.=' ';
  295.  
  296.     foreach ($ts->triples as $t) { 
  297.       
  298.       $p=$t->getPredicate(); 
  299.       
  300.       if ($p == $lastp) {
  301.     $out.=' , '; 
  302.       } else { 
  303.     if ($lastp!='') $out.=' ; '; 
  304.     $this->doURI($p, $out);
  305.     $lastp=$p;
  306.       }
  307.  
  308.       $out.=' ';
  309.       
  310.       $o=$t->getObject();
  311.       
  312.       if ( is_a($o, 'Literal')) { 
  313.     $l=$o->getLabel();
  314.     if ( strpos($l, LINEFEED) === FALSE ) { 
  315.       $out.="\"$l\"";
  316.     } else { 
  317.       $out.="\"\"\"$l\"\"\"";      
  318.     }
  319.     if ( $o->getLanguage()!='' ) { 
  320.       $out.='@'.$o->getLanguage();
  321.     }
  322.     if ( $o->getDatatype()!='' ) { 
  323.       $out.='^^<'.$o->getDatatype().'>';
  324.     }
  325.     
  326.       } 
  327.       
  328.       if (is_a($o, 'Resource')) {
  329.     if ($this->debug) print 'Doing object: '.$o->getURI().LINEFEED;
  330.     if ( is_a($o,'BlankNode')) {
  331.  
  332. //    $this->doResource($o);
  333. //      $out.=MAGIC_STRING.$o->getURI().MAGIC_STRING; #$this->resourcetext[$o->getURI()];
  334. //      $this->resourcetext_taken[$o->getURI()]=1;
  335.  
  336.     $out .='_:'.$o->getLabel();
  337.     } else { 
  338.  
  339.       $this->doURI($o, $out);
  340.     }
  341.       }
  342.     }
  343.  
  344.     if (isset($rbn) && !count($rbn->triples)>0 && N3SER_BNODE_SHORT) {$out.=' ] ';};
  345.     $this->resourcetext[$r->getURI()]=$out; 
  346.  
  347.     return TRUE;
  348.   }
  349.  
  350.   /** 
  351.    * Format a single URI
  352.    * @param string $s 
  353.    * @access private
  354.    * @return void 
  355.    ***/
  356.   function doURI(&$r, &$out) { 
  357.     if ( $r->getURI()=='http://www.w3.org/1999/02/22-rdf-syntax-ns#type') {
  358.       $out.='a';
  359.       return; 
  360.     }
  361.     if ($r->getNamespace()!='') {
  362.       $out.=$this->prefixes[$r->getNamespace()].':'.$r->getLocalName();
  363.     } else { 
  364.       //Will this ever happen? 
  365.       $out.=$r->getURI();
  366.     }
  367.   }
  368.  
  369.   
  370.   /** 
  371.    * Fix the resourcetext for a blanknode where the _: construct was used
  372.    * @param string $s 
  373.    * @param string $a 
  374.    * @access private
  375.    * @return void 
  376.    ***/
  377.   function fixAnon($t,$a) { 
  378.     $t=preg_replace("/( \] $|^\[ )/", '', $t); 
  379.  
  380.     return $a.$t;
  381.   }
  382.  
  383. }
  384.  
  385. ?>

Documentation generated on Fri, 1 Jun 2007 16:50:01 +0200 by phpDocumentor 1.3.2