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/CollectionClass.html

1015 lines
38 KiB
Raw Normal View History Unescape

started adding documentation
14 years ago
<?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 CollectionClass</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"> CollectionClass</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="_CollectionClass.inc.html">/CollectionClass.inc</a> (line <span class="field">18</span>)
</p>
<pre></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="#$COLLECTION_CLASS_COLLECTION_POLICY_STREAM" title="details" class="var-name">$COLLECTION_CLASS_COLLECTION_POLICY_STREAM</a>
</div>
<div class="var-title">
<img src="../../media/images/StaticVariable.png" alt=" " />
static <span class="var-type">mixed</span>
<a href="#$COLLECTION_CLASS_COLLECTION_VIEW_STREAM" title="details" class="var-name">$COLLECTION_CLASS_COLLECTION_VIEW_STREAM</a>
</div>
<div class="var-title">
<img src="../../media/images/Variable.png" alt=" " />
<span class="var-type">mixed</span>
<a href="#$collectionObject" title="details" class="var-name">$collectionObject</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/Constructor.png" alt=" "/>
<span class="method-result"><a href="../../Islandora/rootdirectory/CollectionClass.html">CollectionClass</a></span>
<a href="#__construct" title="details" class="method-name">__construct</a>
([<span class="var-type">string</span>&nbsp;<span class="var-name">$pid</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="#build_ingest_form" title="details" class="method-name">build_ingest_form</a>
(<span class="var-type"></span>&nbsp;<span class="var-name">&$form</span>, <span class="var-type"></span>&nbsp;<span class="var-name">&$form_state</span>, <span class="var-type"></span>&nbsp;<span class="var-name">$contentModelPid</span>, <span class="var-type"></span>&nbsp;<span class="var-name">$contentModelDsid</span>)
</div>
<div class="method-definition">
<img src="../../media/images/Method.png" alt=" "/>
<span class="method-result">void</span>
<a href="#callMethods" title="details" class="method-name">callMethods</a>
(<span class="var-type"></span>&nbsp;<span class="var-name">$file</span>, <span class="var-type"></span>&nbsp;<span class="var-name">$methods</span>)
</div>
<div class="method-definition">
<img src="../../media/images/Method.png" alt=" "/>
<span class="method-result">void</span>
<a href="#createUserCollection" title="details" class="method-name">createUserCollection</a>
(<span class="var-type"></span>&nbsp;<span class="var-name">&$user</span>)
</div>
<div class="method-definition">
<img src="../../media/images/Method.png" alt=" "/>
<span class="method-result">void</span>
<a href="#getAllowedMimeTypes" title="details" class="method-name">getAllowedMimeTypes</a>
(<span class="var-type"></span>&nbsp;<span class="var-name">$contentModelPid</span>, <span class="var-type"></span>&nbsp;<span class="var-name">$contentModel_dsid</span>)
</div>
<div class="method-definition">
<img src="../../media/images/Method.png" alt=" "/>
<span class="method-result">void</span>
<a href="#getAndDoRules" title="details" class="method-name">getAndDoRules</a>
(<span class="var-type"></span>&nbsp;<span class="var-name">$file</span>, <span class="var-type"></span>&nbsp;<span class="var-name">$mimetype</span>, <span class="var-type"></span>&nbsp;<span class="var-name">$pid</span>, <span class="var-type"></span>&nbsp;<span class="var-name">$dsid</span>)
</div>
<div class="method-definition">
<img src="../../media/images/Method.png" alt=" "/>
<span class="method-result">void</span>
<a href="#getCollectionPolicyStream" title="details" class="method-name">getCollectionPolicyStream</a>
(<span class="var-type"></span>&nbsp;<span class="var-name">$collection_pid</span>)
</div>
<div class="method-definition">
<img src="../../media/images/Method.png" alt=" "/>
<span class="method-result">void</span>
<a href="#getCollectionViewStream" title="details" class="method-name">getCollectionViewStream</a>
(<span class="var-type"></span>&nbsp;<span class="var-name">$collection_pid</span>)
</div>
<div class="method-definition">
<img src="../../media/images/Method.png" alt=" "/>
<span class="method-result">void</span>
<a href="#getContentModels" title="details" class="method-name">getContentModels</a>
(<span class="var-type"></span>&nbsp;<span class="var-name">$collection_pid</span>, [<span class="var-type"></span>&nbsp;<span class="var-name">$showError</span> = <span class="var-default">TRUE</span>])
</div>
<div class="method-definition">
<img src="../../media/images/Method.png" alt=" "/>
<span class="method-result">array</span>
<a href="#getFormHandler" title="details" class="method-name">getFormHandler</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">$dsid</span>)
</div>
<div class="method-definition">
<img src="../../media/images/Method.png" alt=" "/>
<span class="method-result">void</span>
<a href="#getIngestInterface" title="details" class="method-name">getIngestInterface</a>
()
</div>
<div class="method-definition">
<img src="../../media/images/Method.png" alt=" "/>
<span class="method-result">void</span>
<a href="#getNextPid" title="details" class="method-name">getNextPid</a>
(<span class="var-type"></span>&nbsp;<span class="var-name">$pid</span>, <span class="var-type"></span>&nbsp;<span class="var-name">$dsid</span>)
</div>
<div class="method-definition">
<img src="../../media/images/Method.png" alt=" "/>
<span class="method-result">void</span>
<a href="#getPidNameSpace" title="details" class="method-name">getPidNameSpace</a>
(<span class="var-type"></span>&nbsp;<span class="var-name">$pid</span>, <span class="var-type"></span>&nbsp;<span class="var-name">$dsid</span>)
</div>
<div class="method-definition">
<img src="../../media/images/Method.png" alt=" "/>
<span class="method-result">void</span>
<a href="#getRelatedItems" title="details" class="method-name">getRelatedItems</a>
(<span class="var-type"></span>&nbsp;<span class="var-name">$pid</span>, [<span class="var-type"></span>&nbsp;<span class="var-name">$itqlquery</span> = <span class="var-default">NULL</span>], [<span class="var-type"></span>&nbsp;<span class="var-name">$limit</span> = <span class="var-default">NULL</span>], [<span class="var-type"></span>&nbsp;<span class="var-name">$offset</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="#getRelatedObjects" title="details" class="method-name">getRelatedObjects</a>
(<span class="var-type"></span>&nbsp;<span class="var-name">$pid</span>, <span class="var-type"></span>&nbsp;<span class="var-name">$limit</span>, <span class="var-type"></span>&nbsp;<span class="var-name">$offset</span>, [<span class="var-type"></span>&nbsp;<span class="var-name">$itqlquery</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="#getRelationshipElement" title="details" class="method-name">getRelationshipElement</a>
(<span class="var-type"></span>&nbsp;<span class="var-name">$collection_pid</span>)
</div>
<div class="method-definition">
<img src="../../media/images/Method.png" alt=" "/>
<span class="method-result">void</span>
<a href="#getStream" title="details" class="method-name">getStream</a>
(<span class="var-type"></span>&nbsp;<span class="var-name">$pid</span>, <span class="var-type"></span>&nbsp;<span class="var-name">$dsid</span>, [<span class="var-type"></span>&nbsp;<span class="var-name">$showError</span> = <span class="var-default">1</span>])
</div>
<div class="method-definition">
<img src="../../media/images/Method.png" alt=" "/>
<span class="method-result">void</span>
<a href="#getXslContent" title="details" class="method-name">getXslContent</a>
(<span class="var-type"></span>&nbsp;<span class="var-name">$pid</span>, <span class="var-type"></span>&nbsp;<span class="var-name">$path</span>, [<span class="var-type"></span>&nbsp;<span class="var-name">$canUseDefault</span> = <span class="var-default">TRUE</span>])
</div>
<div class="method-definition">
<img src="../../media/images/Method.png" alt=" "/>
<span class="method-result">void</span>
<a href="#renderCollection" title="details" class="method-name">renderCollection</a>
(<span class="var-type"></span>&nbsp;<span class="var-name">$content</span>, <span class="var-type"></span>&nbsp;<span class="var-name">$pid</span>, <span class="var-type"></span>&nbsp;<span class="var-name">$dsId</span>, <span class="var-type"></span>&nbsp;<span class="var-name">$collection</span>, [<span class="var-type"></span>&nbsp;<span class="var-name">$pageNumber</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="#showFieldSets" title="details" class="method-name">showFieldSets</a>
(<span class="var-type"></span>&nbsp;<span class="var-name">$page_number</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$COLLECTION_CLASS_COLLECTION_POLICY_STREAM" id="$COLLECTION_CLASS_COLLECTION_POLICY_STREAM"><!-- --></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">$COLLECTION_CLASS_COLLECTION_POLICY_STREAM</span>
= <span class="var-default"> 'COLLECTION_POLICY'</span> (line <span class="line-number">20</span>)
</span>
</div>
<!-- ========== Info from phpDoc block ========= -->
<ul class="tags">
<li><span class="field">access:</span> public</li>
</ul>
</div>
<a name="var$COLLECTION_CLASS_COLLECTION_VIEW_STREAM" id="$COLLECTION_CLASS_COLLECTION_VIEW_STREAM"><!-- --></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">$COLLECTION_CLASS_COLLECTION_VIEW_STREAM</span>
= <span class="var-default"> 'COLLECTION_VIEW'</span> (line <span class="line-number">21</span>)
</span>
</div>
<!-- ========== Info from phpDoc block ========= -->
<ul class="tags">
<li><span class="field">access:</span> public</li>
</ul>
</div>
<a name="var$collectionObject" id="$collectionObject"><!-- --></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">$collectionObject</span>
= <span class="var-default"> NULL</span> (line <span class="line-number">25</span>)
</span>
</div>
<!-- ========== Info from phpDoc block ========= -->
<ul class="tags">
<li><span class="field">access:</span> public</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-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="method__construct" id="__construct"><!-- --></a>
<div class="evenrow">
<div class="method-header">
<img src="../../media/images/Constructor.png" />
<span class="method-title">Constructor __construct</span> (line <span class="line-number">33</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Creates a collection object. Optionally can associate it with a single collection with parameter $pid.</p>
<div class="method-signature">
<span class="method-result"><a href="../../Islandora/rootdirectory/CollectionClass.html">CollectionClass</a></span>
<span class="method-name">
__construct
</span>
([<span class="var-type">string</span>&nbsp;<span class="var-name">$pid</span> = <span class="var-default">NULL</span>])
</div>
<ul class="parameters">
<li>
<span class="var-type">string</span>
<span class="var-name">$pid</span><span class="var-description">: The pid of the collection to represent.</span> </li>
</ul>
</div>
<a name="methodbuild_ingest_form" id="build_ingest_form"><!-- --></a>
<div class="oddrow">
<div class="method-header">
<img src="../../media/images/Method.png" />
<span class="method-title">build_ingest_form</span> (line <span class="line-number">302</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">grabs a xml form definition from a content model and builds</p>
<p class="description"><p>the form using drupals forms api</p></p>
<div class="method-signature">
<span class="method-result">void</span>
<span class="method-name">
build_ingest_form
</span>
(<span class="var-type"></span>&nbsp;<span class="var-name">&$form</span>, <span class="var-type"></span>&nbsp;<span class="var-name">&$form_state</span>, <span class="var-type"></span>&nbsp;<span class="var-name">$contentModelPid</span>, <span class="var-type"></span>&nbsp;<span class="var-name">$contentModelDsid</span>)
</div>
<ul class="parameters">
<li>
<span class="var-type"></span>
<span class="var-name">&$form</span> </li>
<li>
<span class="var-type"></span>
<span class="var-name">&$form_state</span> </li>
<li>
<span class="var-type"></span>
<span class="var-name">$contentModelPid</span> </li>
<li>
<span class="var-type"></span>
<span class="var-name">$contentModelDsid</span> </li>
</ul>
</div>
<a name="methodcallMethods" id="callMethods"><!-- --></a>
<div class="evenrow">
<div class="method-header">
<img src="../../media/images/Method.png" />
<span class="method-title">callMethods</span> (line <span class="line-number">270</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">calls the methods defined in the content model rules .xml file stored in a Fedora object</p>
<div class="method-signature">
<span class="method-result">void</span>
<span class="method-name">
callMethods
</span>
(<span class="var-type"></span>&nbsp;<span class="var-name">$file</span>, <span class="var-type"></span>&nbsp;<span class="var-name">$methods</span>)
</div>
<ul class="parameters">
<li>
<span class="var-type"></span>
<span class="var-name">$file</span> </li>
<li>
<span class="var-type"></span>
<span class="var-name">$methods</span> </li>
</ul>
</div>
<a name="methodcreateUserCollection" id="createUserCollection"><!-- --></a>
<div class="oddrow">
<div class="method-header">
<img src="../../media/images/Method.png" />
<span class="method-title">createUserCollection</span> (line <span class="line-number">366</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<div class="method-signature">
<span class="method-result">void</span>
<span class="method-name">
createUserCollection
</span>
(<span class="var-type"></span>&nbsp;<span class="var-name">&$user</span>)
</div>
<ul class="parameters">
<li>
<span class="var-type"></span>
<span class="var-name">&$user</span> </li>
</ul>
</div>
<a name="methodgetAllowedMimeTypes" id="getAllowedMimeTypes"><!-- --></a>
<div class="evenrow">
<div class="method-header">
<img src="../../media/images/Method.png" />
<span class="method-title">getAllowedMimeTypes</span> (line <span class="line-number">225</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<div class="method-signature">
<span class="method-result">void</span>
<span class="method-name">
getAllowedMimeTypes
</span>
(<span class="var-type"></span>&nbsp;<span class="var-name">$contentModelPid</span>, <span class="var-type"></span>&nbsp;<span class="var-name">$contentModel_dsid</span>)
</div>
<ul class="parameters">
<li>
<span class="var-type"></span>
<span class="var-name">$contentModelPid</span> </li>
<li>
<span class="var-type"></span>
<span class="var-name">$contentModel_dsid</span> </li>
</ul>
</div>
<a name="methodgetAndDoRules" id="getAndDoRules"><!-- --></a>
<div class="oddrow">
<div class="method-header">
<img src="../../media/images/Method.png" />
<span class="method-title">getAndDoRules</span> (line <span class="line-number">243</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Grabs the rules from the content model stream</p>
<p class="description"><p>file the file that has been uploaded</p></p>
<div class="method-signature">
<span class="method-result">void</span>
<span class="method-name">
getAndDoRules
</span>
(<span class="var-type"></span>&nbsp;<span class="var-name">$file</span>, <span class="var-type"></span>&nbsp;<span class="var-name">$mimetype</span>, <span class="var-type"></span>&nbsp;<span class="var-name">$pid</span>, <span class="var-type"></span>&nbsp;<span class="var-name">$dsid</span>)
</div>
<ul class="parameters">
<li>
<span class="var-type"></span>
<span class="var-name">$file</span> </li>
<li>
<span class="var-type"></span>
<span class="var-name">$mimetype</span> </li>
<li>
<span class="var-type"></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="methodgetCollectionPolicyStream" id="getCollectionPolicyStream"><!-- --></a>
<div class="evenrow">
<div class="method-header">
<img src="../../media/images/Method.png" />
<span class="method-title">getCollectionPolicyStream</span> (line <span class="line-number">103</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<div class="method-signature">
<span class="method-result">void</span>
<span class="method-name">
getCollectionPolicyStream
</span>
(<span class="var-type"></span>&nbsp;<span class="var-name">$collection_pid</span>)
</div>
<ul class="parameters">
<li>
<span class="var-type"></span>
<span class="var-name">$collection_pid</span> </li>
</ul>
</div>
<a name="methodgetCollectionViewStream" id="getCollectionViewStream"><!-- --></a>
<div class="oddrow">
<div class="method-header">
<img src="../../media/images/Method.png" />
<span class="method-title">getCollectionViewStream</span> (line <span class="line-number">123</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<div class="method-signature">
<span class="method-result">void</span>
<span class="method-name">
getCollectionViewStream
</span>
(<span class="var-type"></span>&nbsp;<span class="var-name">$collection_pid</span>)
</div>
<ul class="parameters">
<li>
<span class="var-type"></span>
<span class="var-name">$collection_pid</span> </li>
</ul>
</div>
<a name="methodgetContentModels" id="getContentModels"><!-- --></a>
<div class="evenrow">
<div class="method-header">
<img src="../../media/images/Method.png" />
<span class="method-title">getContentModels</span> (line <span class="line-number">156</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">gets a list of content models from a collection policy</p>
<div class="method-signature">
<span class="method-result">void</span>
<span class="method-name">
getContentModels
</span>
(<span class="var-type"></span>&nbsp;<span class="var-name">$collection_pid</span>, [<span class="var-type"></span>&nbsp;<span class="var-name">$showError</span> = <span class="var-default">TRUE</span>])
</div>
<ul class="parameters">
<li>
<span class="var-type"></span>
<span class="var-name">$collection_pid</span> </li>
<li>
<span class="var-type"></span>
<span class="var-name">$showError</span> </li>
</ul>
</div>
<a name="methodgetFormHandler" id="getFormHandler"><!-- --></a>
<div class="oddrow">
<div class="method-header">
<img src="../../media/images/Method.png" />
<span class="method-title">getFormHandler</span> (line <span class="line-number">198</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">gets the form handler file, class and method and returns them in an array</p>
<ul class="tags">
<li><span class="field">return:</span> The file, class and method name to handle the ingest form.</li>
</ul>
<div class="method-signature">
<span class="method-result">array</span>
<span class="method-name">
getFormHandler
</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">$dsid</span>)
</div>
<ul class="parameters">
<li>
<span class="var-type">string</span>
<span class="var-name">$pid</span><span class="var-description">: The content model PID</span> </li>
<li>
<span class="var-type">string</span>
<span class="var-name">$dsid</span><span class="var-description">: The content model DSID</span> </li>
</ul>
</div>
<a name="methodgetIngestInterface" id="getIngestInterface"><!-- --></a>
<div class="evenrow">
<div class="method-header">
<img src="../../media/images/Method.png" />
<span class="method-title">getIngestInterface</span> (line <span class="line-number">458</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<div class="method-signature">
<span class="method-result">void</span>
<span class="method-name">
getIngestInterface
</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">183</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">using the collection policies pid namespace get a new pid by calling fedora' get next pid and appending it to the namespace $pid is the $pid of the content model $dsid is the datastream id of the content model.</p>
<div class="method-signature">
<span class="method-result">void</span>
<span class="method-name">
getNextPid
</span>
(<span class="var-type"></span>&nbsp;<span class="var-name">$pid</span>, <span class="var-type"></span>&nbsp;<span class="var-name">$dsid</span>)
</div>
<ul class="parameters">
<li>
<span class="var-type"></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="methodgetPidNameSpace" id="getPidNameSpace"><!-- --></a>
<div class="evenrow">
<div class="method-header">
<img src="../../media/images/Method.png" />
<span class="method-title">getPidNameSpace</span> (line <span class="line-number">134</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<div class="method-signature">
<span class="method-result">void</span>
<span class="method-name">
getPidNameSpace
</span>
(<span class="var-type"></span>&nbsp;<span class="var-name">$pid</span>, <span class="var-type"></span>&nbsp;<span class="var-name">$dsid</span>)
</div>
<ul class="parameters">
<li>
<span class="var-type"></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="methodgetRelatedItems" id="getRelatedItems"><!-- --></a>
<div class="oddrow">
<div class="method-header">
<img src="../../media/images/Method.png" />
<span class="method-title">getRelatedItems</span> (line <span class="line-number">59</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Gets objects related to this item. It will query the object for a Query stream and use that as a itql query</p>
<p class="description"><p>or if there is no query stream it will use the default. If you pass a query to this method it will use the passed in query no matter what</p></p>
<div class="method-signature">
<span class="method-result">void</span>
<span class="method-name">
getRelatedItems
</span>
(<span class="var-type"></span>&nbsp;<span class="var-name">$pid</span>, [<span class="var-type"></span>&nbsp;<span class="var-name">$itqlquery</span> = <span class="var-default">NULL</span>], [<span class="var-type"></span>&nbsp;<span class="var-name">$limit</span> = <span class="var-default">NULL</span>], [<span class="var-type"></span>&nbsp;<span class="var-name">$offset</span> = <span class="var-default">NULL</span>])
</div>
<ul class="parameters">
<li>
<span class="var-type"></span>
<span class="var-name">$pid</span> </li>
<li>
<span class="var-type"></span>
<span class="var-name">$itqlquery</span> </li>
<li>
<span class="var-type"></span>
<span class="var-name">$limit</span> </li>
<li>
<span class="var-type"></span>
<span class="var-name">$offset</span> </li>
</ul>
</div>
<a name="methodgetRelatedObjects" id="getRelatedObjects"><!-- --></a>
<div class="evenrow">
<div class="method-header">
<img src="../../media/images/Method.png" />
<span class="method-title">getRelatedObjects</span> (line <span class="line-number">45</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<div class="method-signature">
<span class="method-result">void</span>
<span class="method-name">
getRelatedObjects
</span>
(<span class="var-type"></span>&nbsp;<span class="var-name">$pid</span>, <span class="var-type"></span>&nbsp;<span class="var-name">$limit</span>, <span class="var-type"></span>&nbsp;<span class="var-name">$offset</span>, [<span class="var-type"></span>&nbsp;<span class="var-name">$itqlquery</span> = <span class="var-default">NULL</span>])
</div>
<ul class="parameters">
<li>
<span class="var-type"></span>
<span class="var-name">$pid</span> </li>
<li>
<span class="var-type"></span>
<span class="var-name">$limit</span> </li>
<li>
<span class="var-type"></span>
<span class="var-name">$offset</span> </li>
<li>
<span class="var-type"></span>
<span class="var-name">$itqlquery</span> </li>
</ul>
</div>
<a name="methodgetRelationshipElement" id="getRelationshipElement"><!-- --></a>
<div class="oddrow">
<div class="method-header">
<img src="../../media/images/Method.png" />
<span class="method-title">getRelationshipElement</span> (line <span class="line-number">111</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<div class="method-signature">
<span class="method-result">void</span>
<span class="method-name">
getRelationshipElement
</span>
(<span class="var-type"></span>&nbsp;<span class="var-name">$collection_pid</span>)
</div>
<ul class="parameters">
<li>
<span class="var-type"></span>
<span class="var-name">$collection_pid</span> </li>
</ul>
</div>
<a name="methodgetStream" id="getStream"><!-- --></a>
<div class="evenrow">
<div class="method-header">
<img src="../../media/images/Method.png" />
<span class="method-title">getStream</span> (line <span class="line-number">128</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<div class="method-signature">
<span class="method-result">void</span>
<span class="method-name">
getStream
</span>
(<span class="var-type"></span>&nbsp;<span class="var-name">$pid</span>, <span class="var-type"></span>&nbsp;<span class="var-name">$dsid</span>, [<span class="var-type"></span>&nbsp;<span class="var-name">$showError</span> = <span class="var-default">1</span>])
</div>
<ul class="parameters">
<li>
<span class="var-type"></span>
<span class="var-name">$pid</span> </li>
<li>
<span class="var-type"></span>
<span class="var-name">$dsid</span> </li>
<li>
<span class="var-type"></span>
<span class="var-name">$showError</span> </li>
</ul>
</div>
<a name="methodgetXslContent" id="getXslContent"><!-- --></a>
<div class="oddrow">
<div class="method-header">
<img src="../../media/images/Method.png" />
<span class="method-title">getXslContent</span> (line <span class="line-number">411</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Queries a collection object for an xslt to format how the collection of objects is displayed.</p>
<div class="method-signature">
<span class="method-result">void</span>
<span class="method-name">
getXslContent
</span>
(<span class="var-type"></span>&nbsp;<span class="var-name">$pid</span>, <span class="var-type"></span>&nbsp;<span class="var-name">$path</span>, [<span class="var-type"></span>&nbsp;<span class="var-name">$canUseDefault</span> = <span class="var-default">TRUE</span>])
</div>
<ul class="parameters">
<li>
<span class="var-type"></span>
<span class="var-name">$pid</span> </li>
<li>
<span class="var-type"></span>
<span class="var-name">$path</span> </li>
<li>
<span class="var-type"></span>
<span class="var-name">$canUseDefault</span> </li>
</ul>
</div>
<a name="methodrenderCollection" id="renderCollection"><!-- --></a>
<div class="evenrow">
<div class="method-header">
<img src="../../media/images/Method.png" />
<span class="method-title">renderCollection</span> (line <span class="line-number">481</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<div class="method-signature">
<span class="method-result">void</span>
<span class="method-name">
renderCollection
</span>
(<span class="var-type"></span>&nbsp;<span class="var-name">$content</span>, <span class="var-type"></span>&nbsp;<span class="var-name">$pid</span>, <span class="var-type"></span>&nbsp;<span class="var-name">$dsId</span>, <span class="var-type"></span>&nbsp;<span class="var-name">$collection</span>, [<span class="var-type"></span>&nbsp;<span class="var-name">$pageNumber</span> = <span class="var-default">NULL</span>])
</div>
<ul class="parameters">
<li>
<span class="var-type"></span>
<span class="var-name">$content</span> </li>
<li>
<span class="var-type"></span>
<span class="var-name">$pid</span> </li>
<li>
<span class="var-type"></span>
<span class="var-name">$dsId</span> </li>
<li>
<span class="var-type"></span>
<span class="var-name">$collection</span> </li>
<li>
<span class="var-type"></span>
<span class="var-name">$pageNumber</span> </li>
</ul>
</div>
<a name="methodshowFieldSets" id="showFieldSets"><!-- --></a>
<div class="oddrow">
<div class="method-header">
<img src="../../media/images/Method.png" />
<span class="method-title">showFieldSets</span> (line <span class="line-number">421</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<div class="method-signature">
<span class="method-result">void</span>
<span class="method-name">
showFieldSets
</span>
(<span class="var-type"></span>&nbsp;<span class="var-name">$page_number</span>)
</div>
<ul class="parameters">
<li>
<span class="var-type"></span>
<span class="var-name">$page_number</span> </li>
</ul>
</div>
</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>