Code
/
islandora
7
0
Fork 0
Code Issues Pull Requests 1 Projects Releases Wiki Activity
Drupal modules for browsing and managing Fedora-based digital repositories.
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.
301 Commits
37 Branches
80 Tags
23 MiB
 
 
 
 
Tree: 8207e9f825
Branches Tags
${ item.name }
Create tag ${ searchTerm }
Create branch ${ searchTerm }
from '8207e9f825'
${ noResults }
islandora/docs/Islandora/rootdirectory/CollectionPolicy.html

1063 lines
44 KiB
Raw Blame History

<?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 CollectionPolicy</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/Class_logo.png"
alt=" Class"
title=" Class"
style="vertical-align: middle"> CollectionPolicy</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-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 ========= -->
<p class="notes">
Located in <a class="field" href="_CollectionPolicy.inc.html">/CollectionPolicy.inc</a> (line <span class="field">11</span>)
</p>
<pre><a href="../../Islandora/rootdirectory/XMLDatastream.html">XMLDatastream</a>
|
--CollectionPolicy</pre>
</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> |
<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="#$DEFAULT_DSID" title="details" class="var-name">$DEFAULT_DSID</a>
</div>
<div class="var-title">
<img src="../../media/images/StaticVariable.png" alt=" " />
static <span class="var-type">mixed</span>
<a href="#$SCHEMA_URI" title="details" class="var-name">$SCHEMA_URI</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-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="#getDefaultDSID" title="details" class="method-name">getDefaultDSID</a>
()
</div>
<div class="method-definition">
<img src="../../media/images/StaticMethod.png" alt=" "/>
static <span class="method-result"><a href="../../Islandora/rootdirectory/CollectionPolicy.html">CollectionPolicy</a></span>
<a href="#ingestBlankPolicy" title="details" class="method-name">ingestBlankPolicy</a>
(<span class="var-type">string</span>&nbsp;<span class="var-name">$pid</span>, <span class="var-type">string</span>&nbsp;<span class="var-name">$name</span>, <span class="var-type"></span>&nbsp;<span class="var-name">$policyDsid</span>, <span class="var-type">string</span>&nbsp;<span class="var-name">$model_pid</span>, <span class="var-type">string</span>&nbsp;<span class="var-name">$model_namespace</span>, <span class="var-type"></span>&nbsp;<span class="var-name">$relationship</span>, <span class="var-type">string</span>&nbsp;<span class="var-name">$searchField</span>, <span class="var-type">string</span>&nbsp;<span class="var-name">$searchValue</span>, <span class="var-type">string</span>&nbsp;<span class="var-name">$cpDsid</span>, <span class="var-type">string</span>&nbsp;<span class="var-name">$relationshiop</span>)
</div>
<div class="method-definition">
<img src="../../media/images/StaticMethod.png" alt=" "/>
static <span class="method-result"><a href="../../Islandora/rootdirectory/CollectionPolicy.html">CollectionPolicy</a></span>
<a href="#ingestFromCollection" title="details" class="method-name">ingestFromCollection</a>
(<span class="var-type">string</span>&nbsp;<span class="var-name">$pid</span>, <span class="var-type">string</span>&nbsp;<span class="var-name">$name</span>, <span class="var-type">string</span>&nbsp;<span class="var-name">$cpDsid</span>, <span class="var-type">string</span>&nbsp;<span class="var-name">$copy_collection_pid</span>)
</div>
<div class="method-definition">
<img src="../../media/images/StaticMethod.png" alt=" "/>
static <span class="method-result"><a href="../../Islandora/rootdirectory/CollectionPolicy.html">CollectionPolicy</a></span>
<a href="#ingestFromFile" title="details" class="method-name">ingestFromFile</a>
(<span class="var-type">string</span>&nbsp;<span class="var-name">$pid</span>, <span class="var-type">string</span>&nbsp;<span class="var-name">$name</span>, <span class="var-type">string</span>&nbsp;<span class="var-name">$cpDsid</span>, <span class="var-type">string</span>&nbsp;<span class="var-name">$file</span>)
</div>
<div class="method-definition">
<img src="../../media/images/StaticMethod.png" alt=" "/>
static <span class="method-result"><a href="../../Islandora/rootdirectory/CollectionPolicy.html">CollectionPolicy</a></span>
<a href="#loadFromCollection" title="details" class="method-name">loadFromCollection</a>
(<span class="var-type">string</span>&nbsp;<span class="var-name">$pid</span>, [<span class="var-type">boolean</span>&nbsp;<span class="var-name">$preFetch</span> = <span class="var-default">TRUE</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>&nbsp;<span class="var-name">$xmlStr</span>, [<span class="var-type">string</span>&nbsp;<span class="var-name">$pid</span> = <span class="var-default">NULL</span>], [<span class="var-type">string</span>&nbsp;<span class="var-name">$dsid</span> = <span class="var-default">NULL</span>])
</div>
<div class="method-definition">
<img src="../../media/images/Method.png" alt=" "/>
<span class="method-result">void</span>
<a href="#addModel" title="details" class="method-name">addModel</a>
(<span class="var-type"></span>&nbsp;<span class="var-name">$cm</span>, <span class="var-type"></span>&nbsp;<span class="var-name">$namespace</span>)
</div>
<div class="method-definition">
<img src="../../media/images/Method.png" alt=" "/>
<span class="method-result">boolean</span>
<a href="#addTerm" title="details" class="method-name">addTerm</a>
(<span class="var-type">string</span>&nbsp;<span class="var-name">$field</span>, <span class="var-type">string</span>&nbsp;<span class="var-name">$value</span>)
</div>
<div class="method-definition">
<img src="../../media/images/Method.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">ContentModel[]</span>
<a href="#getContentModels" title="details" class="method-name">getContentModels</a>
()
</div>
<div class="method-definition">
<img src="../../media/images/Method.png" alt=" "/>
<span class="method-result">void</span>
<a href="#getName" title="details" class="method-name">getName</a>
()
</div>
<div class="method-definition">
<img src="../../media/images/Method.png" alt=" "/>
<span class="method-result">string</span>
<a href="#getNextPid" title="details" class="method-name">getNextPid</a>
(<span class="var-type">string</span>&nbsp;<span class="var-name">$dsid</span>)
</div>
<div class="method-definition">
<img src="../../media/images/Method.png" alt=" "/>
<span class="method-result">string</span>
<a href="#getRelationship" title="details" class="method-name">getRelationship</a>
()
</div>
<div class="method-definition">
<img src="../../media/images/Method.png" alt=" "/>
<span class="method-result">string[]</span>
<a href="#getSearchTerms" title="details" class="method-name">getSearchTerms</a>
([<span class="var-type">boolean</span>&nbsp;<span class="var-name">$asArray</span> = <span class="var-default">FALSE</span>], [<span class="var-type">boolean</span>&nbsp;<span class="var-name">$recurse</span> = <span class="var-default">FALSE</span>], [<span class="var-type">boolean</span>&nbsp;<span class="var-name">$cache</span> = <span class="var-default">FALSE</span>])
</div>
<div class="method-definition">
<img src="../../media/images/Method.png" alt=" "/>
<span class="method-result">string</span>
<a href="#getStagingArea" title="details" class="method-name">getStagingArea</a>
([<span class="var-type">BOOLEAN</span>&nbsp;<span class="var-name">$recurse</span> = <span class="var-default">TRUE</span>])
</div>
<div class="method-definition">
<img src="../../media/images/Method.png" alt=" "/>
<span class="method-result">boolean</span>
<a href="#removeModel" title="details" class="method-name">removeModel</a>
(<span class="var-type"><a href="../../Islandora/rootdirectory/ContentModel.html">ContentModel</a></span>&nbsp;<span class="var-name">$cm</span>)
</div>
<div class="method-definition">
<img src="../../media/images/Method.png" alt=" "/>
<span class="method-result">boolean</span>
<a href="#removeTerm" title="details" class="method-name">removeTerm</a>
(<span class="var-type">string</span>&nbsp;<span class="var-name">$field</span>)
</div>
<div class="method-definition">
<img src="../../media/images/Method.png" alt=" "/>
<span class="method-result">void</span>
<a href="#setDefaultTerm" title="details" class="method-name">setDefaultTerm</a>
(<span class="var-type"></span>&nbsp;<span class="var-name">$field</span>)
</div>
<div class="method-definition">
<img src="../../media/images/Method.png" alt=" "/>
<span class="method-result">boolean</span>
<a href="#setRelationship" title="details" class="method-name">setRelationship</a>
(<span class="var-type">string</span>&nbsp;<span class="var-name">$relationship</span>)
</div>
<div class="method-definition">
<img src="../../media/images/Method.png" alt=" "/>
<span class="method-result">string</span>
<a href="#setStagingArea" title="details" class="method-name">setStagingArea</a>
(<span class="var-type">string</span>&nbsp;<span class="var-name">$path</span>)
</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-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$DEFAULT_DSID" id="$DEFAULT_DSID"><!-- --></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">$DEFAULT_DSID</span>
= <span class="var-default"> 'COLLECTION_POLICY'</span> (line <span class="line-number">14</span>)
</span>
</div>
<!-- ========== Info from phpDoc block ========= -->
</div>
<a name="var$SCHEMA_URI" id="$SCHEMA_URI"><!-- --></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">$SCHEMA_URI</span>
= <span class="var-default"> 'http://syn.lib.umanitoba.ca/collection_policy.xsd'</span> (line <span class="line-number">13</span>)
</span>
</div>
<!-- ========== Info from phpDoc block ========= -->
</div>
<h4>Inherited Variables</h4>
<A NAME='inherited_vars'><!-- --></A>
<p>Inherited from <span class="classname"><a href="../../Islandora/rootdirectory/XMLDatastream.html">XMLDatastream</a></span></p>
<blockquote>
<img src="../../media/images/Variable.png" />
<span class="var-title">
<span class="var-name"><a href="../../Islandora/rootdirectory/XMLDatastream.html#var$dsid">XMLDatastream::$dsid</a></span><br>
</span>
<img src="../../media/images/Variable.png" />
<span class="var-title">
<span class="var-name"><a href="../../Islandora/rootdirectory/XMLDatastream.html#var$errors">XMLDatastream::$errors</a></span><br>
</span>
<img src="../../media/images/Variable.png" />
<span class="var-title">
<span class="var-name"><a href="../../Islandora/rootdirectory/XMLDatastream.html#var$forceSchema">XMLDatastream::$forceSchema</a></span><br>
</span>
<img src="../../media/images/Variable.png" />
<span class="var-title">
<span class="var-name"><a href="../../Islandora/rootdirectory/XMLDatastream.html#var$pid">XMLDatastream::$pid</a></span><br>
</span>
<img src="../../media/images/Variable.png" />
<span class="var-title">
<span class="var-name"><a href="../../Islandora/rootdirectory/XMLDatastream.html#var$xml">XMLDatastream::$xml</a></span><br>
</span>
<img src="../../media/images/Variable.png" />
<span class="var-title">
<span class="var-name"><a href="../../Islandora/rootdirectory/XMLDatastream.html#var$XMLNS">XMLDatastream::$XMLNS</a></span><br>
</span>
</blockquote>
</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-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="methodgetDefaultDSID" id="getDefaultDSID"><!-- --></a>
<div class="evenrow">
<div class="method-header">
<img src="../../media/images/StaticMethod.png" />
<span class="method-title">static getDefaultDSID</span> (line <span class="line-number">23</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Gets the default DSID to use for ContentModel datastreams.</p>
<div class="method-signature">
static <span class="method-result">string</span>
<span class="method-name">
getDefaultDSID
</span>
()
</div>
</div>
<a name="methodingestBlankPolicy" id="ingestBlankPolicy"><!-- --></a>
<div class="oddrow">
<div class="method-header">
<img src="../../media/images/StaticMethod.png" />
<span class="method-title">static ingestBlankPolicy</span> (line <span class="line-number">138</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Ingests a new minimum Collection Policy datastream to the specified PID with the DSID specified. Initializes the policy with the specified values.</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/CollectionPolicy.html">CollectionPolicy</a></span>
<span class="method-name">
ingestBlankPolicy
</span>
(<span class="var-type">string</span>&nbsp;<span class="var-name">$pid</span>, <span class="var-type">string</span>&nbsp;<span class="var-name">$name</span>, <span class="var-type"></span>&nbsp;<span class="var-name">$policyDsid</span>, <span class="var-type">string</span>&nbsp;<span class="var-name">$model_pid</span>, <span class="var-type">string</span>&nbsp;<span class="var-name">$model_namespace</span>, <span class="var-type"></span>&nbsp;<span class="var-name">$relationship</span>, <span class="var-type">string</span>&nbsp;<span class="var-name">$searchField</span>, <span class="var-type">string</span>&nbsp;<span class="var-name">$searchValue</span>, <span class="var-type">string</span>&nbsp;<span class="var-name">$cpDsid</span>, <span class="var-type">string</span>&nbsp;<span class="var-name">$relationshiop</span>)
</div>
<ul class="parameters">
<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">$name</span> </li>
<li>
<span class="var-type">string</span>
<span class="var-name">$cpDsid</span> </li>
<li>
<span class="var-type">string</span>
<span class="var-name">$model_pid</span> </li>
<li>
<span class="var-type">string</span>
<span class="var-name">$model_namespace</span> </li>
<li>
<span class="var-type">string</span>
<span class="var-name">$relationshiop</span> </li>
<li>
<span class="var-type">string</span>
<span class="var-name">$searchField</span> </li>
<li>
<span class="var-type">string</span>
<span class="var-name">$searchValue</span> </li>
<li>
<span class="var-type"></span>
<span class="var-name">$policyDsid</span> </li>
<li>
<span class="var-type"></span>
<span class="var-name">$relationship</span> </li>
</ul>
</div>
<a name="methodingestFromCollection" id="ingestFromCollection"><!-- --></a>
<div class="evenrow">
<div class="method-header">
<img src="../../media/images/StaticMethod.png" />
<span class="method-title">static ingestFromCollection</span> (line <span class="line-number">104</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Ingests a new Collection Policy datastream to the specified PID with the DSID specified. Clones the collection policy from the source collection pid. Returns false on failure.</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/CollectionPolicy.html">CollectionPolicy</a></span>
<span class="method-name">
ingestFromCollection
</span>
(<span class="var-type">string</span>&nbsp;<span class="var-name">$pid</span>, <span class="var-type">string</span>&nbsp;<span class="var-name">$name</span>, <span class="var-type">string</span>&nbsp;<span class="var-name">$cpDsid</span>, <span class="var-type">string</span>&nbsp;<span class="var-name">$copy_collection_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">string</span>
<span class="var-name">$name</span> </li>
<li>
<span class="var-type">string</span>
<span class="var-name">$cpDsid</span> </li>
<li>
<span class="var-type">string</span>
<span class="var-name">$copy_collection_pid</span> </li>
</ul>
</div>
<a name="methodingestFromFile" id="ingestFromFile"><!-- --></a>
<div class="oddrow">
<div class="method-header">
<img src="../../media/images/StaticMethod.png" />
<span class="method-title">static ingestFromFile</span> (line <span class="line-number">76</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Ingests a new Collection Policy datastream to the specified PID with the DSID specified. The file should be a valid collection policy XML. Returns false on failure.</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/CollectionPolicy.html">CollectionPolicy</a></span>
<span class="method-name">
ingestFromFile
</span>
(<span class="var-type">string</span>&nbsp;<span class="var-name">$pid</span>, <span class="var-type">string</span>&nbsp;<span class="var-name">$name</span>, <span class="var-type">string</span>&nbsp;<span class="var-name">$cpDsid</span>, <span class="var-type">string</span>&nbsp;<span class="var-name">$file</span>)
</div>
<ul class="parameters">
<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">$name</span> </li>
<li>
<span class="var-type">string</span>
<span class="var-name">$cpDsid</span> </li>
<li>
<span class="var-type">string</span>
<span class="var-name">$file</span> </li>
</ul>
</div>
<a name="methodloadFromCollection" id="loadFromCollection"><!-- --></a>
<div class="evenrow">
<div class="method-header">
<img src="../../media/images/StaticMethod.png" />
<span class="method-title">static loadFromCollection</span> (line <span class="line-number">37</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Constructs a new CollectionPolicy object from the specified collection PID. If preFetch is disabled, then Islandora will not get the datastream until needed.</p>
<p class="description"><p>(useful when cacheing) Returns FALSE on failure.</p></p>
<div class="method-signature">
static <span class="method-result"><a href="../../Islandora/rootdirectory/CollectionPolicy.html">CollectionPolicy</a></span>
<span class="method-name">
loadFromCollection
</span>
(<span class="var-type">string</span>&nbsp;<span class="var-name">$pid</span>, [<span class="var-type">boolean</span>&nbsp;<span class="var-name">$preFetch</span> = <span class="var-default">TRUE</span>])
</div>
<ul class="parameters">
<li>
<span class="var-type">string</span>
<span class="var-name">$pid</span> </li>
<li>
<span class="var-type">boolean</span>
<span class="var-name">$preFetch</span><span class="var-description">: = TRUE</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">198</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>&nbsp;<span class="var-name">$xmlStr</span>, [<span class="var-type">string</span>&nbsp;<span class="var-name">$pid</span> = <span class="var-default">NULL</span>], [<span class="var-type">string</span>&nbsp;<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">Redefinition of:</div>
<dl>
<dt><a href="../../Islandora/rootdirectory/XMLDatastream.html#method__construct">XMLDatastream::__construct()</a></dt>
<dd>Constructor NOTE: Use the static constructor methods whenever possible.</dd>
</dl>
</div>
<a name="methodaddModel" id="addModel"><!-- --></a>
<div class="evenrow">
<div class="method-header">
<img src="../../media/images/Method.png" />
<span class="method-title">addModel</span> (line <span class="line-number">588</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<div class="method-signature">
<span class="method-result">void</span>
<span class="method-name">
addModel
</span>
(<span class="var-type"></span>&nbsp;<span class="var-name">$cm</span>, <span class="var-type"></span>&nbsp;<span class="var-name">$namespace</span>)
</div>
<ul class="parameters">
<li>
<span class="var-type"></span>
<span class="var-name">$cm</span> </li>
<li>
<span class="var-type"></span>
<span class="var-name">$namespace</span> </li>
</ul>
</div>
<a name="methodaddTerm" id="addTerm"><!-- --></a>
<div class="oddrow">
<div class="method-header">
<img src="../../media/images/Method.png" />
<span class="method-title">addTerm</span> (line <span class="line-number">482</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Adds a search term to the collection policy.</p>
<p class="description"><p>Returns fase on failure.</p></p>
<div class="method-signature">
<span class="method-result">boolean</span>
<span class="method-name">
addTerm
</span>
(<span class="var-type">string</span>&nbsp;<span class="var-name">$field</span>, <span class="var-type">string</span>&nbsp;<span class="var-name">$value</span>)
</div>
<ul class="parameters">
<li>
<span class="var-type">string</span>
<span class="var-name">$field</span> </li>
<li>
<span class="var-type">string</span>
<span class="var-name">$value</span> </li>
</ul>
</div>
<a name="methodconvertFromOldSchema" id="convertFromOldSchema"><!-- --></a>
<div class="evenrow">
<div class="method-header">
<img src="../../media/images/Method.png" />
<span class="method-title">convertFromOldSchema</span> (line <span class="line-number">210</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-&gt;xml is replaced by the newly created DOM..</p>
<ul class="tags">
<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">Redefinition of:</div>
<dl>
<dt><a href="../../Islandora/rootdirectory/XMLDatastream.html#methodconvertFromOldSchema">XMLDatastream::convertFromOldSchema()</a></dt>
<dd>Attempts to convert from the old XML schema to the new by traversing the XML DOM and building a new DOM. When done $this-&gt;xml is replaced by the newly created DOM..</dd>
</dl>
</div>
<a name="methodgetContentModels" id="getContentModels"><!-- --></a>
<div class="oddrow">
<div class="method-header">
<img src="../../media/images/Method.png" />
<span class="method-title">getContentModels</span> (line <span class="line-number">392</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Gets a list of ContentModel objects supported by this collection.</p>
<div class="method-signature">
<span class="method-result">ContentModel[]</span>
<span class="method-name">
getContentModels
</span>
()
</div>
</div>
<a name="methodgetName" id="getName"><!-- --></a>
<div class="evenrow">
<div class="method-header">
<img src="../../media/images/Method.png" />
<span class="method-title">getName</span> (line <span class="line-number">613</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<div class="method-signature">
<span class="method-result">void</span>
<span class="method-name">
getName
</span>
()
</div>
</div>
<a name="methodgetNextPid" id="getNextPid"><!-- --></a>
<div class="oddrow">
<div class="method-header">
<img src="../../media/images/Method.png" />
<span class="method-title">getNextPid</span> (line <span class="line-number">368</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Gets the next available PID for the content model specified by the DSID parameter.</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">
getNextPid
</span>
(<span class="var-type">string</span>&nbsp;<span class="var-name">$dsid</span>)
</div>
<ul class="parameters">
<li>
<span class="var-type">string</span>
<span class="var-name">$dsid</span> </li>
</ul>
</div>
<a name="methodgetRelationship" id="getRelationship"><!-- --></a>
<div class="evenrow">
<div class="method-header">
<img src="../../media/images/Method.png" />
<span class="method-title">getRelationship</span> (line <span class="line-number">262</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Gets the name of the relationship to use for members of this collection.</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">
getRelationship
</span>
()
</div>
</div>
<a name="methodgetSearchTerms" id="getSearchTerms"><!-- --></a>
<div class="oddrow">
<div class="method-header">
<img src="../../media/images/Method.png" />
<span class="method-title">getSearchTerms</span> (line <span class="line-number">426</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Gets a list of search terms from the Collection Policy. If asArray is set it will return an associative array with the value, field name, and the default value.</p>
<p class="description"><p>If not set, an array of just the values will be returned. If $recurse is TRUE, it will recurseively return the parents search terms if it has none until it returns a set of terms or reaches the top level collection. If $cache is TRUE, it will return a cached version (if available).</p></p>
<div class="method-signature">
<span class="method-result">string[]</span>
<span class="method-name">
getSearchTerms
</span>
([<span class="var-type">boolean</span>&nbsp;<span class="var-name">$asArray</span> = <span class="var-default">FALSE</span>], [<span class="var-type">boolean</span>&nbsp;<span class="var-name">$recurse</span> = <span class="var-default">FALSE</span>], [<span class="var-type">boolean</span>&nbsp;<span class="var-name">$cache</span> = <span class="var-default">FALSE</span>])
</div>
<ul class="parameters">
<li>
<span class="var-type">boolean</span>
<span class="var-name">$asArray</span> </li>
<li>
<span class="var-type">boolean</span>
<span class="var-name">$recurse</span> </li>
<li>
<span class="var-type">boolean</span>
<span class="var-name">$cache</span> </li>
</ul>
</div>
<a name="methodgetStagingArea" id="getStagingArea"><!-- --></a>
<div class="evenrow">
<div class="method-header">
<img src="../../media/images/Method.png" />
<span class="method-title">getStagingArea</span> (line <span class="line-number">296</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Gets the path to the staging area to use for this collection. By default recurses to the parent collection if the staging area is undefined</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">
getStagingArea
</span>
([<span class="var-type">BOOLEAN</span>&nbsp;<span class="var-name">$recurse</span> = <span class="var-default">TRUE</span>])
</div>
<ul class="parameters">
<li>
<span class="var-type">BOOLEAN</span>
<span class="var-name">$recurse</span> </li>
</ul>
</div>
<a name="methodremoveModel" id="removeModel"><!-- --></a>
<div class="oddrow">
<div class="method-header">
<img src="../../media/images/Method.png" />
<span class="method-title">removeModel</span> (line <span class="line-number">565</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Removes the specified content model from the collection policy. This will only prevent future ingests of the removed model to the collection. $cm should be a valid ContentModel object. Returns false on failure or when the CM was not found in the collection policy.</p>
<div class="method-signature">
<span class="method-result">boolean</span>
<span class="method-name">
removeModel
</span>
(<span class="var-type"><a href="../../Islandora/rootdirectory/ContentModel.html">ContentModel</a></span>&nbsp;<span class="var-name">$cm</span>)
</div>
<ul class="parameters">
<li>
<span class="var-type"><a href="../../Islandora/rootdirectory/ContentModel.html">ContentModel</a></span>
<span class="var-name">$cm</span> </li>
</ul>
</div>
<a name="methodremoveTerm" id="removeTerm"><!-- --></a>
<div class="evenrow">
<div class="method-header">
<img src="../../media/images/Method.png" />
<span class="method-title">removeTerm</span> (line <span class="line-number">510</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Removes the search term specified by the field parameter from the collection policy.</p>
<div class="method-signature">
<span class="method-result">boolean</span>
<span class="method-name">
removeTerm
</span>
(<span class="var-type">string</span>&nbsp;<span class="var-name">$field</span>)
</div>
<ul class="parameters">
<li>
<span class="var-type">string</span>
<span class="var-name">$field</span> </li>
</ul>
</div>
<a name="methodsetDefaultTerm" id="setDefaultTerm"><!-- --></a>
<div class="oddrow">
<div class="method-header">
<img src="../../media/images/Method.png" />
<span class="method-title">setDefaultTerm</span> (line <span class="line-number">531</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<div class="method-signature">
<span class="method-result">void</span>
<span class="method-name">
setDefaultTerm
</span>
(<span class="var-type"></span>&nbsp;<span class="var-name">$field</span>)
</div>
<ul class="parameters">
<li>
<span class="var-type"></span>
<span class="var-name">$field</span> </li>
</ul>
</div>
<a name="methodsetRelationship" id="setRelationship"><!-- --></a>
<div class="evenrow">
<div class="method-header">
<img src="../../media/images/Method.png" />
<span class="method-title">setRelationship</span> (line <span class="line-number">278</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Sets the name of the relationship to use for members of this collection.</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">boolean</span>
<span class="method-name">
setRelationship
</span>
(<span class="var-type">string</span>&nbsp;<span class="var-name">$relationship</span>)
</div>
<ul class="parameters">
<li>
<span class="var-type">string</span>
<span class="var-name">$relationship</span> </li>
</ul>
</div>
<a name="methodsetStagingArea" id="setStagingArea"><!-- --></a>
<div class="oddrow">
<div class="method-header">
<img src="../../media/images/Method.png" />
<span class="method-title">setStagingArea</span> (line <span class="line-number">335</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Sets the path to the staging area to use for this collection. If specified path is blank (or false) it will remove the staging are path element from the collection policy.</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">
setStagingArea
</span>
(<span class="var-type">string</span>&nbsp;<span class="var-name">$path</span>)
</div>
<ul class="parameters">
<li>
<span class="var-type">string</span>
<span class="var-name">$path</span> </li>
</ul>
</div>
<h4>Inherited Methods</h4>
<a name='inherited_methods'><!-- --></a>
<!-- =========== Summary =========== -->
<p>Inherited From <span class="classname"><a href="../../Islandora/rootdirectory/XMLDatastream.html">XMLDatastream</a></span></p>
<blockquote>
<img src="../../media/images/Constructor.png" alt=" "/>
<span class="method-name"><a href="../../Islandora/rootdirectory/XMLDatastream.html#method__construct">XMLDatastream::__construct()</a></span><br>
<img src="../../media/images/AbstractMethod.png" alt=" "/>
<span class="method-name"><a href="../../Islandora/rootdirectory/XMLDatastream.html#methodconvertFromOldSchema">XMLDatastream::convertFromOldSchema()</a></span><br>
<img src="../../media/images/Method.png" alt=" "/>
<span class="method-name"><a href="../../Islandora/rootdirectory/XMLDatastream.html#methoddumpXml">XMLDatastream::dumpXml()</a></span><br>
<img src="../../media/images/Method.png" alt=" "/>
<span class="method-name"><a href="../../Islandora/rootdirectory/XMLDatastream.html#methodgetDSIDFromIdentifier">XMLDatastream::getDSIDFromIdentifier()</a></span><br>
<img src="../../media/images/Method.png" alt=" "/>
<span class="method-name"><a href="../../Islandora/rootdirectory/XMLDatastream.html#methodgetHistory">XMLDatastream::getHistory()</a></span><br>
<img src="../../media/images/Method.png" alt=" "/>
<span class="method-name"><a href="../../Islandora/rootdirectory/XMLDatastream.html#methodgetIdentifier">XMLDatastream::getIdentifier()</a></span><br>
<img src="../../media/images/Method.png" alt=" "/>
<span class="method-name"><a href="../../Islandora/rootdirectory/XMLDatastream.html#methodgetPidFromIdentifier">XMLDatastream::getPidFromIdentifier()</a></span><br>
<img src="../../media/images/Method.png" alt=" "/>
<span class="method-name"><a href="../../Islandora/rootdirectory/XMLDatastream.html#methodloadFromFile">XMLDatastream::loadFromFile()</a></span><br>
<img src="../../media/images/Method.png" alt=" "/>
<span class="method-name"><a href="../../Islandora/rootdirectory/XMLDatastream.html#methodpurgeVersions">XMLDatastream::purgeVersions()</a></span><br>
<img src="../../media/images/Method.png" alt=" "/>
<span class="method-name"><a href="../../Islandora/rootdirectory/XMLDatastream.html#methodsaveToFedora">XMLDatastream::saveToFedora()</a></span><br>
<img src="../../media/images/Method.png" alt=" "/>
<span class="method-name"><a href="../../Islandora/rootdirectory/XMLDatastream.html#methodvalidate">XMLDatastream::validate()</a></span><br>
<img src="../../media/images/Method.png" alt=" "/>
<span class="method-name"><a href="../../Islandora/rootdirectory/XMLDatastream.html#methodvalidDsid">XMLDatastream::validDsid()</a></span><br>
<img src="../../media/images/Method.png" alt=" "/>
<span class="method-name"><a href="../../Islandora/rootdirectory/XMLDatastream.html#methodvalidPid">XMLDatastream::validPid()</a></span><br>
</blockquote>
</div>
</div>
<p class="notes" id="credit">
Documentation generated on Thu, 14 Jul 2011 16:29:53 -0300 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.3</a>
</p>
</div></body>
</html>