You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
890 lines
30 KiB
890 lines
30 KiB
<?xml version="1.0" encoding="iso-8859-1"?> |
|
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> |
|
<html xmlns="http://www.w3.org/1999/xhtml"> |
|
<head> |
|
<!-- template designed by Marco Von Ballmoos --> |
|
<title>Docs For Class XMLDatastream</title> |
|
<link rel="stylesheet" href="../../media/stylesheet.css" /> |
|
<script src="../../media/lib/classTree.js"></script> |
|
<script language="javascript" type="text/javascript"> |
|
var imgPlus = new Image(); |
|
var imgMinus = new Image(); |
|
imgPlus.src = "../../media/images/plus.png"; |
|
imgMinus.src = "../../media/images/minus.png"; |
|
|
|
function showNode(Node){ |
|
switch(navigator.family){ |
|
case 'nn4': |
|
// Nav 4.x code fork... |
|
var oTable = document.layers["span" + Node]; |
|
var oImg = document.layers["img" + Node]; |
|
break; |
|
case 'ie4': |
|
// IE 4/5 code fork... |
|
var oTable = document.all["span" + Node]; |
|
var oImg = document.all["img" + Node]; |
|
break; |
|
case 'gecko': |
|
// Standards Compliant code fork... |
|
var oTable = document.getElementById("span" + Node); |
|
var oImg = document.getElementById("img" + Node); |
|
break; |
|
} |
|
oImg.src = imgMinus.src; |
|
oTable.style.display = "block"; |
|
} |
|
|
|
function hideNode(Node){ |
|
switch(navigator.family){ |
|
case 'nn4': |
|
// Nav 4.x code fork... |
|
var oTable = document.layers["span" + Node]; |
|
var oImg = document.layers["img" + Node]; |
|
break; |
|
case 'ie4': |
|
// IE 4/5 code fork... |
|
var oTable = document.all["span" + Node]; |
|
var oImg = document.all["img" + Node]; |
|
break; |
|
case 'gecko': |
|
// Standards Compliant code fork... |
|
var oTable = document.getElementById("span" + Node); |
|
var oImg = document.getElementById("img" + Node); |
|
break; |
|
} |
|
oImg.src = imgPlus.src; |
|
oTable.style.display = "none"; |
|
} |
|
|
|
function nodeIsVisible(Node){ |
|
switch(navigator.family){ |
|
case 'nn4': |
|
// Nav 4.x code fork... |
|
var oTable = document.layers["span" + Node]; |
|
break; |
|
case 'ie4': |
|
// IE 4/5 code fork... |
|
var oTable = document.all["span" + Node]; |
|
break; |
|
case 'gecko': |
|
// Standards Compliant code fork... |
|
var oTable = document.getElementById("span" + Node); |
|
break; |
|
} |
|
return (oTable && oTable.style.display == "block"); |
|
} |
|
|
|
function toggleNodeVisibility(Node){ |
|
if (nodeIsVisible(Node)){ |
|
hideNode(Node); |
|
}else{ |
|
showNode(Node); |
|
} |
|
} |
|
</script> |
|
</head> |
|
<body> |
|
<div class="page-body"> |
|
<h2 class="class-name"><img src="../../media/images/AbstractClass_logo.png" |
|
alt="Abstract Class" |
|
title="Abstract Class" |
|
style="vertical-align: middle"> XMLDatastream</h2> |
|
|
|
<a name="sec-description"></a> |
|
<div class="info-box"> |
|
<div class="info-box-title">Description</div> |
|
<div class="nav-bar"> |
|
<span class="disabled">Description</span> | |
|
<a href="#sec-descendents">Descendents</a> |
|
| <a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>) |
|
| <a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>) |
|
|
|
</div> |
|
<div class="info-box-body"> |
|
<!-- ========== Info from phpDoc block ========= --> |
|
<ul class="tags"> |
|
<li><span class="field">abstract:</span> </li> |
|
</ul> |
|
<p class="notes"> |
|
Located in <a class="field" href="_XMLDatastream.inc.html">/XMLDatastream.inc</a> (line <span class="field">9</span>) |
|
</p> |
|
|
|
|
|
<pre></pre> |
|
|
|
</div> |
|
</div> |
|
|
|
<a name="sec-descendents"></a> |
|
<div class="info-box"> |
|
<div class="info-box-title">Direct descendents</div> |
|
<div class="nav-bar"> |
|
<a href="#sec-description">Description</a> | |
|
<span class="disabled">Descendents</span> |
|
| <a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>) |
|
| <a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>) |
|
|
|
</div> |
|
<div class="info-box-body"> |
|
<table cellpadding="2" cellspacing="0" class="class-table"> |
|
<tr> |
|
<th class="class-table-header">Class</th> |
|
<th class="class-table-header">Description</th> |
|
</tr> |
|
<tr> |
|
<td style="padding-right: 2em; white-space: nowrap"> |
|
<img src="../../media/images/Class.png" |
|
alt=" class" |
|
title=" class" |
|
style="vertical-align: center"/> |
|
<a href="../../Islandora/rootdirectory/CollectionPolicy.html">CollectionPolicy</a> |
|
</td> |
|
<td> |
|
|
|
</td> |
|
</tr> |
|
<tr> |
|
<td style="padding-right: 2em; white-space: nowrap"> |
|
<img src="../../media/images/Class.png" |
|
alt=" class" |
|
title=" class" |
|
style="vertical-align: center"/> |
|
<a href="../../Islandora/rootdirectory/ContentModel.html">ContentModel</a> |
|
</td> |
|
<td> |
|
|
|
</td> |
|
</tr> |
|
</table> |
|
</div> |
|
</div> |
|
|
|
|
|
<a name="sec-var-summary"></a> |
|
<div class="info-box"> |
|
<div class="info-box-title">Variable Summary</span></div> |
|
<div class="nav-bar"> |
|
<a href="#sec-description">Description</a> | |
|
<a href="#sec-descendents">Descendants</a> | |
|
<span class="disabled">Vars</span> (<a href="#sec-vars">details</a>) |
|
| |
|
<a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>) |
|
|
|
</div> |
|
<div class="info-box-body"> |
|
<div class="var-summary"> |
|
<div class="var-title"> |
|
<img src="../../media/images/StaticVariable.png" alt=" " /> |
|
static <span class="var-type">mixed</span> |
|
<a href="#$errors" title="details" class="var-name">$errors</a> |
|
</div> |
|
<div class="var-title"> |
|
<img src="../../media/images/StaticVariable.png" alt=" " /> |
|
static <span class="var-type">mixed</span> |
|
<a href="#$XMLNS" title="details" class="var-name">$XMLNS</a> |
|
</div> |
|
<div class="var-title"> |
|
<img src="../../media/images/Variable.png" alt=" " /> |
|
<span class="var-type">mixed</span> |
|
<a href="#$dsid" title="details" class="var-name">$dsid</a> |
|
</div> |
|
<div class="var-title"> |
|
<img src="../../media/images/Variable.png" alt=" " /> |
|
<span class="var-type">mixed</span> |
|
<a href="#$forceSchema" title="details" class="var-name">$forceSchema</a> |
|
</div> |
|
<div class="var-title"> |
|
<img src="../../media/images/Variable.png" alt=" " /> |
|
<span class="var-type">mixed</span> |
|
<a href="#$pid" title="details" class="var-name">$pid</a> |
|
</div> |
|
<div class="var-title"> |
|
<img src="../../media/images/Variable.png" alt=" " /> |
|
<span class="var-type">mixed</span> |
|
<a href="#$xml" title="details" class="var-name">$xml</a> |
|
</div> |
|
</div> |
|
</div> |
|
</div> |
|
|
|
<a name="sec-method-summary"></a> |
|
<div class="info-box"> |
|
<div class="info-box-title">Method Summary</span></div> |
|
<div class="nav-bar"> |
|
<a href="#sec-description">Description</a> | |
|
<a href="#sec-descendents">Descendants</a> | |
|
<a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>) |
|
|
|
| |
|
<span class="disabled">Methods</span> (<a href="#sec-methods">details</a>) |
|
</div> |
|
<div class="info-box-body"> |
|
<div class="method-summary"> |
|
|
|
<div class="method-definition"> |
|
<img src="../../media/images/StaticMethod.png" alt=" "/> |
|
static <span class="method-result">string</span> |
|
<a href="#getDSIDFromIdentifier" title="details" class="method-name">getDSIDFromIdentifier</a> |
|
(<span class="var-type">string</span> <span class="var-name">$identifier</span>) |
|
</div> |
|
|
|
<div class="method-definition"> |
|
<img src="../../media/images/StaticMethod.png" alt=" "/> |
|
static <span class="method-result">string</span> |
|
<a href="#getPidFromIdentifier" title="details" class="method-name">getPidFromIdentifier</a> |
|
(<span class="var-type">string</span> <span class="var-name">$identifier</span>) |
|
</div> |
|
|
|
<div class="method-definition"> |
|
<img src="../../media/images/StaticMethod.png" alt=" "/> |
|
static <span class="method-result"><a href="../../Islandora/rootdirectory/XMLDatastream.html">XMLDatastream</a></span> |
|
<a href="#loadFromFile" title="details" class="method-name">loadFromFile</a> |
|
(<span class="var-type">string</span> <span class="var-name">$filename</span>) |
|
</div> |
|
|
|
<div class="method-definition"> |
|
<img src="../../media/images/StaticMethod.png" alt=" "/> |
|
static <span class="method-result">boolean</span> |
|
<a href="#validDsid" title="details" class="method-name">validDsid</a> |
|
(<span class="var-type"></span> <span class="var-name">$dsid</span>, <span class="var-type">String</span> <span class="var-name">$pid</span>) |
|
</div> |
|
|
|
<div class="method-definition"> |
|
<img src="../../media/images/StaticMethod.png" alt=" "/> |
|
static <span class="method-result">boolean</span> |
|
<a href="#validPid" title="details" class="method-name">validPid</a> |
|
(<span class="var-type">String</span> <span class="var-name">$pid</span>) |
|
</div> |
|
|
|
<div class="method-definition"> |
|
<img src="../../media/images/Constructor.png" alt=" "/> |
|
<span class="method-result"><a href="../../Islandora/rootdirectory/XMLDatastream.html">XMLDatastream</a></span> |
|
<a href="#__construct" title="details" class="method-name">__construct</a> |
|
(<span class="var-type">string</span> <span class="var-name">$xmlStr</span>, [<span class="var-type">string</span> <span class="var-name">$pid</span> = <span class="var-default">NULL</span>], [<span class="var-type">string</span> <span class="var-name">$dsid</span> = <span class="var-default">NULL</span>]) |
|
</div> |
|
|
|
<div class="method-definition"> |
|
<img src="../../media/images/AbstractMethod.png" alt=" "/> |
|
<span class="method-result">void</span> |
|
<a href="#convertFromOldSchema" title="details" class="method-name">convertFromOldSchema</a> |
|
() |
|
</div> |
|
|
|
<div class="method-definition"> |
|
<img src="../../media/images/Method.png" alt=" "/> |
|
<span class="method-result">string</span> |
|
<a href="#dumpXml" title="details" class="method-name">dumpXml</a> |
|
() |
|
</div> |
|
|
|
<div class="method-definition"> |
|
<img src="../../media/images/Method.png" alt=" "/> |
|
<span class="method-result">string[]</span> |
|
<a href="#getHistory" title="details" class="method-name">getHistory</a> |
|
() |
|
</div> |
|
|
|
<div class="method-definition"> |
|
<img src="../../media/images/Method.png" alt=" "/> |
|
<span class="method-result">string</span> |
|
<a href="#getIdentifier" title="details" class="method-name">getIdentifier</a> |
|
() |
|
</div> |
|
|
|
<div class="method-definition"> |
|
<img src="../../media/images/Method.png" alt=" "/> |
|
<span class="method-result">boolean</span> |
|
<a href="#purgeVersions" title="details" class="method-name">purgeVersions</a> |
|
(<span class="var-type">string</span> <span class="var-name">$start_date</span>, [<span class="var-type">string</span> <span class="var-name">$end_date</span> = <span class="var-default">NULL</span>]) |
|
</div> |
|
|
|
<div class="method-definition"> |
|
<img src="../../media/images/Method.png" alt=" "/> |
|
<span class="method-result">boolean</span> |
|
<a href="#saveToFedora" title="details" class="method-name">saveToFedora</a> |
|
() |
|
</div> |
|
|
|
<div class="method-definition"> |
|
<img src="../../media/images/Method.png" alt=" "/> |
|
<span class="method-result">boolean</span> |
|
<a href="#validate" title="details" class="method-name">validate</a> |
|
() |
|
</div> |
|
</div> |
|
</div> |
|
</div> |
|
|
|
<a name="sec-vars"></a> |
|
<div class="info-box"> |
|
<div class="info-box-title">Variables</div> |
|
<div class="nav-bar"> |
|
<a href="#sec-description">Description</a> | |
|
<a href="#sec-descendents">Descendents</a> | |
|
<a href="#sec-var-summary">Vars</a> (<span class="disabled">details</span>) |
|
|
|
|
|
| |
|
<a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>) |
|
|
|
</div> |
|
<div class="info-box-body"> |
|
<a name="var$errors" id="$errors"><!-- --></A> |
|
<div class="evenrow"> |
|
|
|
<div class="var-header"> |
|
<img src="../../media/images/StaticVariable.png" /> |
|
<span class="var-title"> |
|
static <span class="var-type">mixed</span> |
|
<span class="var-name">$errors</span> |
|
= <span class="var-default"> NULL</span> (line <span class="line-number">12</span>) |
|
</span> |
|
</div> |
|
|
|
<!-- ========== Info from phpDoc block ========= --> |
|
|
|
|
|
|
|
|
|
|
|
</div> |
|
<a name="var$XMLNS" id="$XMLNS"><!-- --></A> |
|
<div class="oddrow"> |
|
|
|
<div class="var-header"> |
|
<img src="../../media/images/StaticVariable.png" /> |
|
<span class="var-title"> |
|
static <span class="var-type">mixed</span> |
|
<span class="var-name">$XMLNS</span> |
|
= <span class="var-default"> 'http://www.islandora.ca'</span> (line <span class="line-number">11</span>) |
|
</span> |
|
</div> |
|
|
|
<!-- ========== Info from phpDoc block ========= --> |
|
|
|
|
|
|
|
|
|
|
|
</div> |
|
|
|
<a name="var$dsid" id="$dsid"><!-- --></A> |
|
<div class="evenrow"> |
|
|
|
<div class="var-header"> |
|
<img src="../../media/images/Variable.png" /> |
|
<span class="var-title"> |
|
<span class="var-type">mixed</span> |
|
<span class="var-name">$dsid</span> |
|
(line <span class="line-number">18</span>) |
|
</span> |
|
</div> |
|
|
|
<!-- ========== Info from phpDoc block ========= --> |
|
<ul class="tags"> |
|
<li><span class="field">access:</span> public</li> |
|
</ul> |
|
|
|
|
|
|
|
|
|
|
|
</div> |
|
<a name="var$forceSchema" id="$forceSchema"><!-- --></A> |
|
<div class="oddrow"> |
|
|
|
<div class="var-header"> |
|
<img src="../../media/images/Variable.png" /> |
|
<span class="var-title"> |
|
<span class="var-type">mixed</span> |
|
<span class="var-name">$forceSchema</span> |
|
= <span class="var-default"> FALSE</span> (line <span class="line-number">15</span>) |
|
</span> |
|
</div> |
|
|
|
<!-- ========== Info from phpDoc block ========= --> |
|
<ul class="tags"> |
|
<li><span class="field">access:</span> protected</li> |
|
</ul> |
|
|
|
|
|
|
|
|
|
|
|
</div> |
|
<a name="var$pid" id="$pid"><!-- --></A> |
|
<div class="evenrow"> |
|
|
|
<div class="var-header"> |
|
<img src="../../media/images/Variable.png" /> |
|
<span class="var-title"> |
|
<span class="var-type">mixed</span> |
|
<span class="var-name">$pid</span> |
|
(line <span class="line-number">17</span>) |
|
</span> |
|
</div> |
|
|
|
<!-- ========== Info from phpDoc block ========= --> |
|
<ul class="tags"> |
|
<li><span class="field">access:</span> public</li> |
|
</ul> |
|
|
|
|
|
|
|
|
|
|
|
</div> |
|
<a name="var$xml" id="$xml"><!-- --></A> |
|
<div class="oddrow"> |
|
|
|
<div class="var-header"> |
|
<img src="../../media/images/Variable.png" /> |
|
<span class="var-title"> |
|
<span class="var-type">mixed</span> |
|
<span class="var-name">$xml</span> |
|
= <span class="var-default"> NULL</span> (line <span class="line-number">13</span>) |
|
</span> |
|
</div> |
|
|
|
<!-- ========== Info from phpDoc block ========= --> |
|
<ul class="tags"> |
|
<li><span class="field">access:</span> protected</li> |
|
</ul> |
|
|
|
|
|
|
|
|
|
|
|
</div> |
|
|
|
</div> |
|
</div> |
|
|
|
<a name="sec-methods"></a> |
|
<div class="info-box"> |
|
<div class="info-box-title">Methods</div> |
|
<div class="nav-bar"> |
|
<a href="#sec-description">Description</a> | |
|
<a href="#sec-descendents">Descendents</a> | |
|
<a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>) |
|
<a href="#sec-method-summary">Methods</a> (<span class="disabled">details</span>) |
|
|
|
</div> |
|
<div class="info-box-body"> |
|
<A NAME='method_detail'></A> |
|
<a name="methodgetDSIDFromIdentifier" id="getDSIDFromIdentifier"><!-- --></a> |
|
<div class="evenrow"> |
|
|
|
<div class="method-header"> |
|
<img src="../../media/images/StaticMethod.png" /> |
|
<span class="method-title">static getDSIDFromIdentifier</span> (line <span class="line-number">72</span>) |
|
</div> |
|
|
|
<!-- ========== Info from phpDoc block ========= --> |
|
<p class="short-description">Parses the DSID from an identifier.</p> |
|
<p class="description"><p>TODO: combine this method with getPidFromIdentifier?</p></p> |
|
<ul class="tags"> |
|
<li><span class="field">access:</span> public</li> |
|
</ul> |
|
|
|
<div class="method-signature"> |
|
static <span class="method-result">string</span> |
|
<span class="method-name"> |
|
getDSIDFromIdentifier |
|
</span> |
|
(<span class="var-type">string</span> <span class="var-name">$identifier</span>) |
|
</div> |
|
|
|
<ul class="parameters"> |
|
<li> |
|
<span class="var-type">string</span> |
|
<span class="var-name">$identifier</span> </li> |
|
</ul> |
|
|
|
|
|
</div> |
|
<a name="methodgetPidFromIdentifier" id="getPidFromIdentifier"><!-- --></a> |
|
<div class="oddrow"> |
|
|
|
<div class="method-header"> |
|
<img src="../../media/images/StaticMethod.png" /> |
|
<span class="method-title">static getPidFromIdentifier</span> (line <span class="line-number">25</span>) |
|
</div> |
|
|
|
<!-- ========== Info from phpDoc block ========= --> |
|
<p class="short-description">Parses an PID from an identifier.</p> |
|
<ul class="tags"> |
|
<li><span class="field">access:</span> public</li> |
|
</ul> |
|
|
|
<div class="method-signature"> |
|
static <span class="method-result">string</span> |
|
<span class="method-name"> |
|
getPidFromIdentifier |
|
</span> |
|
(<span class="var-type">string</span> <span class="var-name">$identifier</span>) |
|
</div> |
|
|
|
<ul class="parameters"> |
|
<li> |
|
<span class="var-type">string</span> |
|
<span class="var-name">$identifier</span> </li> |
|
</ul> |
|
|
|
|
|
</div> |
|
<a name="methodloadFromFile" id="loadFromFile"><!-- --></a> |
|
<div class="evenrow"> |
|
|
|
<div class="method-header"> |
|
<img src="../../media/images/StaticMethod.png" /> |
|
<span class="method-title">static loadFromFile</span> (line <span class="line-number">84</span>) |
|
</div> |
|
|
|
<!-- ========== Info from phpDoc block ========= --> |
|
<p class="short-description">Constructs an XMLDatastream object from the XML file specified.</p> |
|
<p class="description"><p>Returns FALSE on failure.</p></p> |
|
<ul class="tags"> |
|
<li><span class="field">access:</span> public</li> |
|
</ul> |
|
|
|
<div class="method-signature"> |
|
static <span class="method-result"><a href="../../Islandora/rootdirectory/XMLDatastream.html">XMLDatastream</a></span> |
|
<span class="method-name"> |
|
loadFromFile |
|
</span> |
|
(<span class="var-type">string</span> <span class="var-name">$filename</span>) |
|
</div> |
|
|
|
<ul class="parameters"> |
|
<li> |
|
<span class="var-type">string</span> |
|
<span class="var-name">$filename</span> </li> |
|
</ul> |
|
|
|
|
|
</div> |
|
<a name="methodvalidDsid" id="validDsid"><!-- --></a> |
|
<div class="oddrow"> |
|
|
|
<div class="method-header"> |
|
<img src="../../media/images/StaticMethod.png" /> |
|
<span class="method-title">static validDsid</span> (line <span class="line-number">57</span>) |
|
</div> |
|
|
|
<!-- ========== Info from phpDoc block ========= --> |
|
<p class="short-description">validDsid Validates a fedora Dsid based on the the allowed XML standard NCName.</p> |
|
<p class="description"><p>The regexp is a "regular" subset of names allowed, it excludes some extended hex characters that are technically permitted. http://www.fedora-commons.org/confluence/display/FCR30/Fedora+Identifiers</p></p> |
|
<ul class="tags"> |
|
<li><span class="field">access:</span> public</li> |
|
</ul> |
|
|
|
<div class="method-signature"> |
|
static <span class="method-result">boolean</span> |
|
<span class="method-name"> |
|
validDsid |
|
</span> |
|
(<span class="var-type"></span> <span class="var-name">$dsid</span>, <span class="var-type">String</span> <span class="var-name">$pid</span>) |
|
</div> |
|
|
|
<ul class="parameters"> |
|
<li> |
|
<span class="var-type">String</span> |
|
<span class="var-name">$pid</span> </li> |
|
<li> |
|
<span class="var-type"></span> |
|
<span class="var-name">$dsid</span> </li> |
|
</ul> |
|
|
|
|
|
</div> |
|
<a name="methodvalidPid" id="validPid"><!-- --></a> |
|
<div class="evenrow"> |
|
|
|
<div class="method-header"> |
|
<img src="../../media/images/StaticMethod.png" /> |
|
<span class="method-title">static validPid</span> (line <span class="line-number">38</span>) |
|
</div> |
|
|
|
<!-- ========== Info from phpDoc block ========= --> |
|
<p class="short-description">validPid Validates a fedora PID based on the regexp provided in the fedora 3.3 documentation.</p> |
|
<p class="description"><p>http://www.fedora-commons.org/confluence/display/FCR30/Fedora+Identifiers</p></p> |
|
<ul class="tags"> |
|
<li><span class="field">access:</span> public</li> |
|
</ul> |
|
|
|
<div class="method-signature"> |
|
static <span class="method-result">boolean</span> |
|
<span class="method-name"> |
|
validPid |
|
</span> |
|
(<span class="var-type">String</span> <span class="var-name">$pid</span>) |
|
</div> |
|
|
|
<ul class="parameters"> |
|
<li> |
|
<span class="var-type">String</span> |
|
<span class="var-name">$pid</span> </li> |
|
</ul> |
|
|
|
|
|
</div> |
|
<a name="method__construct" id="__construct"><!-- --></a> |
|
<div class="oddrow"> |
|
|
|
<div class="method-header"> |
|
<img src="../../media/images/Constructor.png" /> |
|
<span class="method-title">Constructor __construct</span> (line <span class="line-number">97</span>) |
|
</div> |
|
|
|
<!-- ========== Info from phpDoc block ========= --> |
|
<p class="short-description">Constructor NOTE: Use the static constructor methods whenever possible.</p> |
|
<ul class="tags"> |
|
<li><span class="field">access:</span> public</li> |
|
</ul> |
|
|
|
<div class="method-signature"> |
|
<span class="method-result"><a href="../../Islandora/rootdirectory/XMLDatastream.html">XMLDatastream</a></span> |
|
<span class="method-name"> |
|
__construct |
|
</span> |
|
(<span class="var-type">string</span> <span class="var-name">$xmlStr</span>, [<span class="var-type">string</span> <span class="var-name">$pid</span> = <span class="var-default">NULL</span>], [<span class="var-type">string</span> <span class="var-name">$dsid</span> = <span class="var-default">NULL</span>]) |
|
</div> |
|
|
|
<ul class="parameters"> |
|
<li> |
|
<span class="var-type">string</span> |
|
<span class="var-name">$xmlStr</span> </li> |
|
<li> |
|
<span class="var-type">string</span> |
|
<span class="var-name">$pid</span> </li> |
|
<li> |
|
<span class="var-type">string</span> |
|
<span class="var-name">$dsid</span> </li> |
|
</ul> |
|
|
|
|
|
<hr class="separator" /> |
|
<div class="notes">Redefined in descendants as:</div> |
|
<ul class="redefinitions"> |
|
<li> |
|
<a href="../../Islandora/rootdirectory/CollectionPolicy.html#method__construct">CollectionPolicy::__construct()</a> |
|
: Constructor NOTE: Use the static constructor methods whenever possible. |
|
</li> |
|
<li> |
|
<a href="../../Islandora/rootdirectory/ContentModel.html#method__construct">ContentModel::__construct()</a> |
|
: Constructor NOTE: Use the static constructor methods whenever possible. |
|
</li> |
|
</ul> |
|
</div> |
|
<a name="methodconvertFromOldSchema" id="convertFromOldSchema"><!-- --></a> |
|
<div class="evenrow"> |
|
|
|
<div class="method-header"> |
|
<img src="../../media/images/AbstractMethod.png" /> |
|
<span class="method-title">convertFromOldSchema</span> (line <span class="line-number">273</span>) |
|
</div> |
|
|
|
<!-- ========== Info from phpDoc block ========= --> |
|
<p class="short-description">Attempts to convert from the old XML schema to the new by traversing the XML DOM and building a new DOM. When done $this->xml is replaced by the newly created DOM..</p> |
|
<ul class="tags"> |
|
<li><span class="field">abstract:</span> </li> |
|
<li><span class="field">access:</span> protected</li> |
|
</ul> |
|
|
|
<div class="method-signature"> |
|
<span class="method-result">void</span> |
|
<span class="method-name"> |
|
convertFromOldSchema |
|
</span> |
|
() |
|
</div> |
|
|
|
|
|
|
|
<hr class="separator" /> |
|
<div class="notes">Redefined in descendants as:</div> |
|
<ul class="redefinitions"> |
|
<li> |
|
<a href="../../Islandora/rootdirectory/CollectionPolicy.html#methodconvertFromOldSchema">CollectionPolicy::convertFromOldSchema()</a> |
|
: Attempts to convert from the old XML schema to the new by traversing the XML DOM and building a new DOM. When done $this->xml is replaced by the newly created DOM.. |
|
</li> |
|
<li> |
|
<a href="../../Islandora/rootdirectory/ContentModel.html#methodconvertFromOldSchema">ContentModel::convertFromOldSchema()</a> |
|
: Attempts to convert from the old XML schema to the new by traversing the XML DOM and building a new DOM. When done $this->xml is replaced by the newly created DOM.. |
|
</li> |
|
</ul> |
|
</div> |
|
<a name="methoddumpXml" id="dumpXml"><!-- --></a> |
|
<div class="oddrow"> |
|
|
|
<div class="method-header"> |
|
<img src="../../media/images/Method.png" /> |
|
<span class="method-title">dumpXml</span> (line <span class="line-number">131</span>) |
|
</div> |
|
|
|
<!-- ========== Info from phpDoc block ========= --> |
|
<p class="short-description">Dumps the XMLDatastream as an XML String</p> |
|
<ul class="tags"> |
|
<li><span class="field">return:</span> xml</li> |
|
<li><span class="field">access:</span> public</li> |
|
</ul> |
|
|
|
<div class="method-signature"> |
|
<span class="method-result">string</span> |
|
<span class="method-name"> |
|
dumpXml |
|
</span> |
|
() |
|
</div> |
|
|
|
|
|
|
|
</div> |
|
<a name="methodgetHistory" id="getHistory"><!-- --></a> |
|
<div class="evenrow"> |
|
|
|
<div class="method-header"> |
|
<img src="../../media/images/Method.png" /> |
|
<span class="method-title">getHistory</span> (line <span class="line-number">250</span>) |
|
</div> |
|
|
|
<!-- ========== Info from phpDoc block ========= --> |
|
<p class="short-description">Gets the history of the datastream from fedora.</p> |
|
<p class="description"><p>Returns false on failure.</p></p> |
|
<ul class="tags"> |
|
<li><span class="field">access:</span> public</li> |
|
</ul> |
|
|
|
<div class="method-signature"> |
|
<span class="method-result">string[]</span> |
|
<span class="method-name"> |
|
getHistory |
|
</span> |
|
() |
|
</div> |
|
|
|
|
|
|
|
</div> |
|
<a name="methodgetIdentifier" id="getIdentifier"><!-- --></a> |
|
<div class="oddrow"> |
|
|
|
<div class="method-header"> |
|
<img src="../../media/images/Method.png" /> |
|
<span class="method-title">getIdentifier</span> (line <span class="line-number">121</span>) |
|
</div> |
|
|
|
<!-- ========== Info from phpDoc block ========= --> |
|
<p class="short-description">Gets the identifier for this XMLDatastream Returns FALSE on failure.</p> |
|
<p class="description"><p>NOTE: not available if constructed directly from file.</p></p> |
|
<ul class="tags"> |
|
<li><span class="field">return:</span> identifier</li> |
|
<li><span class="field">access:</span> public</li> |
|
</ul> |
|
|
|
<div class="method-signature"> |
|
<span class="method-result">string</span> |
|
<span class="method-name"> |
|
getIdentifier |
|
</span> |
|
() |
|
</div> |
|
|
|
|
|
|
|
</div> |
|
<a name="methodpurgeVersions" id="purgeVersions"><!-- --></a> |
|
<div class="evenrow"> |
|
|
|
<div class="method-header"> |
|
<img src="../../media/images/Method.png" /> |
|
<span class="method-title">purgeVersions</span> (line <span class="line-number">238</span>) |
|
</div> |
|
|
|
<!-- ========== Info from phpDoc block ========= --> |
|
<p class="short-description">Purges veersions of the datastream newer than and including the start_date. If End date is specified, it can be used to purge a range of versions instead. Date should be in DATE_RFC822 format</p> |
|
<ul class="tags"> |
|
<li><span class="field">access:</span> public</li> |
|
</ul> |
|
|
|
<div class="method-signature"> |
|
<span class="method-result">boolean</span> |
|
<span class="method-name"> |
|
purgeVersions |
|
</span> |
|
(<span class="var-type">string</span> <span class="var-name">$start_date</span>, [<span class="var-type">string</span> <span class="var-name">$end_date</span> = <span class="var-default">NULL</span>]) |
|
</div> |
|
|
|
<ul class="parameters"> |
|
<li> |
|
<span class="var-type">string</span> |
|
<span class="var-name">$start_date</span> </li> |
|
<li> |
|
<span class="var-type">string</span> |
|
<span class="var-name">$end_date</span> </li> |
|
</ul> |
|
|
|
|
|
</div> |
|
<a name="methodsaveToFedora" id="saveToFedora"><!-- --></a> |
|
<div class="oddrow"> |
|
|
|
<div class="method-header"> |
|
<img src="../../media/images/Method.png" /> |
|
<span class="method-title">saveToFedora</span> (line <span class="line-number">219</span>) |
|
</div> |
|
|
|
<!-- ========== Info from phpDoc block ========= --> |
|
<p class="short-description">Saves the current XML datastream back to fedora. The XML must validate.</p> |
|
<ul class="tags"> |
|
<li><span class="field">access:</span> public</li> |
|
</ul> |
|
|
|
<div class="method-signature"> |
|
<span class="method-result">boolean</span> |
|
<span class="method-name"> |
|
saveToFedora |
|
</span> |
|
() |
|
</div> |
|
|
|
|
|
|
|
</div> |
|
<a name="methodvalidate" id="validate"><!-- --></a> |
|
<div class="evenrow"> |
|
|
|
<div class="method-header"> |
|
<img src="../../media/images/Method.png" /> |
|
<span class="method-title">validate</span> (line <span class="line-number">151</span>) |
|
</div> |
|
|
|
<!-- ========== Info from phpDoc block ========= --> |
|
<p class="short-description">Validates the XMLDatastream against the schema location</p> |
|
<p class="description"><p>defined by the xmlns:schemaLocation attribute of the root element. If the xmlns:schemaLocation attribute does not exist, then it is assumed to be the old schema and it attempts to convert using the convertFromOldSchema method.</p><p>TODO: Maybe change it so that it always validates against a known schema. This makes more sense because this class assumes the structure to be known after it has been validated.</p></p> |
|
<ul class="tags"> |
|
<li><span class="field">access:</span> public</li> |
|
</ul> |
|
|
|
<div class="method-signature"> |
|
<span class="method-result">boolean</span> |
|
<span class="method-name"> |
|
validate |
|
</span> |
|
() |
|
</div> |
|
|
|
|
|
|
|
</div> |
|
|
|
</div> |
|
</div> |
|
|
|
|
|
<p class="notes" id="credit"> |
|
Documentation generated on Thu, 14 Jul 2011 16:56:05 -0300 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.3</a> |
|
</p> |
|
</div></body> |
|
</html> |