opencultureconsulting
/
simple-oai-pmh
mirror of https://github.com/opencultureconsulting/simple-oai-pmh.git
2
0
Fork 0
Code Issues Releases Activity

Add method for appending XML fragments

This commit is contained in:
Sebastian Meyer 2017-05-12 18:13:26 +02:00
parent 0151f262f2
commit bb0fbe39fa
1 changed files with 81 additions and 63 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

114
oai2xml.php
View File

@ -1,28 +1,44 @@
<?php <?php
/**
* Simple OAI-PMH 2.0 Data Provider
* Copyright (C) 2011 Jianfeng Li
* Copyright (C) 2013 Daniel Neis Araujo <danielneis@gmail.com>
* Copyright (C) 2017 Sebastian Meyer <sebastian.meyer@opencultureconsulting.com>
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program. If not, see <http://www.gnu.org/licenses/>.
*/
class OAI2XMLResponse { class OAI2XMLResponse {
public $doc; // DOMDocument. Handle of current XML Document object public $doc; // DOMDocument. Handle of current XML Document object
function __construct($uri, $verb, $request_args) { public function __construct($uri, $verb, $request_args) {
$this->verb = $verb; $this->verb = $verb;
$this->doc = new DOMDocument("1.0","UTF-8"); $this->doc = new DOMDocument('1.0', 'UTF-8');
$oai_node = $this->doc->createElement("OAI-PMH"); $oai_node = $this->doc->createElement('OAI-PMH');
$oai_node->setAttribute("xmlns","http://www.openarchives.org/OAI/2.0/"); $oai_node->setAttribute('xmlns', 'http://www.openarchives.org/OAI/2.0/');
$oai_node->setAttribute("xmlns:xsi","http://www.w3.org/2001/XMLSchema-instance"); $oai_node->setAttribute('xmlns:xsi', 'http://www.w3.org/2001/XMLSchema-instance');
$oai_node->setAttribute("xsi:schemaLocation","http://www.openarchives.org/OAI/2.0/ http://www.openarchives.org/OAI/2.0/OAI-PMH.xsd"); $oai_node->setAttribute('xsi:schemaLocation', 'http://www.openarchives.org/OAI/2.0/ http://www.openarchives.org/OAI/2.0/OAI-PMH.xsd');
$this->addChild($oai_node,"responseDate",gmdate("Y-m-d\TH:i:s\Z")); $this->addChild($oai_node, 'responseDate', gmdate('Y-m-d\TH:i:s\Z'));
$this->doc->appendChild($oai_node); $this->doc->appendChild($oai_node);
$request = $this->addChild($this->doc->documentElement, 'request', $uri);
$request = $this->addChild($this->doc->documentElement,"request",$uri);
$request->setAttribute('verb', $this->verb); $request->setAttribute('verb', $this->verb);
foreach($request_args as $key => $value) { foreach($request_args as $key => $value) {
$request->setAttribute($key,$value); $request->setAttribute($key, $value);
} }
if (!empty($this->verb)) { if (!empty($this->verb)) {
$this->verbNode = $this->addChild($this->doc->documentElement,$this->verb); $this->verbNode = $this->addChild($this->doc->documentElement, $this->verb);
} }
} }
@ -30,14 +46,13 @@ class OAI2XMLResponse {
* Add a child node to a parent node on a XML Doc: a worker function. * Add a child node to a parent node on a XML Doc: a worker function.
* *
* @param $mom_node Type: DOMNode. The target node. * @param $mom_node Type: DOMNode. The target node.
* @param $name Type: string. The name of child nade is being added * @param $name Type: string. The name of child node is being added
* @param $value Type: string. Text for the adding node if it is a text node. * @param $value Type: string. Text for the adding node if it is a text node.
* *
* @return DOMElement $added_node * The newly created node * @return DOMElement $added_node * The newly created node
*/ */
function addChild($mom_node, $name, $value = '') {
function addChild($mom_node,$name, $value='') { $added_node = $this->doc->createElement($name, $value);
$added_node = $this->doc->createElement($name,$value);
$added_node = $mom_node->appendChild($added_node); $added_node = $mom_node->appendChild($added_node);
return $added_node; return $added_node;
} }
@ -45,44 +60,33 @@ class OAI2XMLResponse {
/** /**
* Add direct child nodes to verb node (OAI-PMH), e.g. response to ListMetadataFormats. * Add direct child nodes to verb node (OAI-PMH), e.g. response to ListMetadataFormats.
* Different verbs can have different required child nodes. * Different verbs can have different required child nodes.
* \see create_record, create_header * @see create_record, create_header
* *
* \param $nodeName Type: string. The name of appending node. * @param $nodeName Type: string. The name of appending node.
* \param $value Type: string. The content of appending node. * @param $value Type: string. The content of appending node.
*/ */
function addToVerbNode($nodeName, $value=null) { function addToVerbNode($nodeName, $value = null) {
return $this->addChild($this->verbNode,$nodeName,$value); return $this->addChild($this->verbNode, $nodeName, $value);
} }
/** /**
* Headers are enclosed inside of \<record\> to the query of ListRecords, ListIdentifiers and etc. * Headers are enclosed inside of <record> to the query of ListRecords, ListIdentifiers and etc.
* *
* \param $identifier Type: string. The identifier string for node \<identifier\>. * @param $identifier Type: string. The identifier string for node <identifier>.
* \param $timestamp Type: timestamp. Timestapme in UTC format for node \<datastamp\>. * @param $timestamp Type: timestamp. Timestapme in UTC format for node <datastamp>.
* \param $setSpec Type: mix. Can be an array or just a string. Content of \<setSpec\>. * @param $add_to_node Type: DOMElement. Default value is null.
* \param $add_to_node Type: DOMElement. Default value is null. * In normal cases, $add_to_node is the <record> node created previously.
* In normal cases, $add_to_node is the \<record\> node created previously.
* When it is null, the newly created header node is attatched to $this->verbNode. * When it is null, the newly created header node is attatched to $this->verbNode.
* Otherwise it will be attatched to the desired node defined in $add_to_node. * Otherwise it will be attatched to the desired node defined in $add_to_node.
*/ */
function createHeader($identifier, $timestamp, $setSpec, $add_to_node=null) { function createHeader($identifier, $timestamp, $add_to_node = null) {
if(is_null($add_to_node)) { if(is_null($add_to_node)) {
$header_node = $this->addToVerbNode("header"); $header_node = $this->addToVerbNode('header');
} else { } else {
$header_node = $this->addChild($add_to_node,"header"); $header_node = $this->addChild($add_to_node, 'header');
}
$this->addChild($header_node, "identifier", $identifier);
$this->addChild($header_node, "datestamp", $timestamp);
if (is_array($setSpec)) {
foreach ($setSpec as $set) {
$this->addChild($header_node,"setSpec",$set);
}
} else {
$this->addChild($header_node,"setSpec",$setSpec);
} }
$this->addChild($header_node, 'identifier', $identifier);
$this->addChild($header_node, 'datestamp', $timestamp);
return $header_node; return $header_node;
} }
@ -94,12 +98,26 @@ class OAI2XMLResponse {
* @param $num_rows Type: integer. Number of records retrieved. * @param $num_rows Type: integer. Number of records retrieved.
* @param $cursor Type: string. Cursor can be used for database to retrieve next time. * @param $cursor Type: string. Cursor can be used for database to retrieve next time.
*/ */
function createResumptionToken($token, $expirationdatetime, $num_rows, $cursor=null) { function createResumptionToken($token, $expirationdatetime, $num_rows, $cursor = null) {
$resump_node = $this->addChild($this->verbNode,"resumptionToken",$token); $resump_node = $this->addChild($this->verbNode, 'resumptionToken', $token);
if(isset($expirationdatetime)) { if(isset($expirationdatetime)) {
$resump_node->setAttribute("expirationDate",$expirationdatetime); $resump_node->setAttribute('expirationDate', $expirationdatetime);
} }
$resump_node->setAttribute("completeListSize",$num_rows); $resump_node->setAttribute('completeListSize', $num_rows);
$resump_node->setAttribute("cursor",$cursor); $resump_node->setAttribute('cursor', $cursor);
} }
/**
* Imports a XML fragment into a parent node on a XML Doc: a worker function.
*
* @param $mom_node Type: DOMNode. The target node.
* @param $fragment Type: DOMDocument. The XML fragment is being added
*
* @return DOMElement $added_node * The newly created node
*/
function importFragment($mom_node, $fragment) {
$added_node = $mom_node->appendChild($this->doc->importNode($fragment->documentElement, true));
return $added_node;
}
} }