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.
247 lines
9.7 KiB
247 lines
9.7 KiB
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 page fedora_collection.inc</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="file-name"><img src="../../media/images/Page_logo.png" alt="File" style="vertical-align: middle">/api/fedora_collection.inc</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-functions">Functions</a>
|
||
|
|
</div>
|
||
|
|
<div class="info-box-body">
|
||
|
|
<!-- ========== Info from phpDoc block ========= -->
|
||
|
|
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<a name="sec-functions"></a>
|
||
|
|
<div class="info-box">
|
||
|
|
<div class="info-box-title">Functions</div>
|
||
|
|
<div class="nav-bar">
|
||
|
|
<a href="#sec-description">Description</a> |
|
||
|
|
<span class="disabled">Functions</span>
|
||
|
|
</div>
|
||
|
|
<div class="info-box-body">
|
||
|
|
<a name="functionexport_collection" id="functionexport_collection"><!-- --></a>
|
||
|
|
<div class="evenrow">
|
||
|
|
|
||
|
|
<div>
|
||
|
|
<img src="../../media/images/Function.png" />
|
||
|
|
<span class="method-title">export_collection</span> (line <span class="line-number">23</span>)
|
||
|
|
</div>
|
||
|
|
|
||
|
|
<!-- ========== Info from phpDoc block ========= -->
|
||
|
|
<p class="short-description">Exports a fedora collection object and all of its children in a format that will let you import them into another repository.</p>
|
||
|
|
<div class="method-signature">
|
||
|
|
<span class="method-result">void</span>
|
||
|
|
<span class="method-name">
|
||
|
|
export_collection
|
||
|
|
</span>
|
||
|
|
(<span class="var-type"></span> <span class="var-name">$collection_pid</span>, [<span class="var-type"></span> <span class="var-name">$relationship</span> = <span class="var-default">'isMemberOfCollection'</span>], [<span class="var-type"><type></span> <span class="var-name">$format</span> = <span class="var-default">'info:fedora/fedora-system:FOXML-1.1'</span>])
|
||
|
|
</div>
|
||
|
|
|
||
|
|
<ul class="parameters">
|
||
|
|
<li>
|
||
|
|
<span class="var-type"><type></span>
|
||
|
|
<span class="var-name">$format</span> </li>
|
||
|
|
<li>
|
||
|
|
<span class="var-type"></span>
|
||
|
|
<span class="var-name">$collection_pid</span> </li>
|
||
|
|
<li>
|
||
|
|
<span class="var-type"></span>
|
||
|
|
<span class="var-name">$relationship</span> </li>
|
||
|
|
</ul>
|
||
|
|
|
||
|
|
|
||
|
|
</div>
|
||
|
|
<a name="functionget_related_items_as_array" id="functionget_related_items_as_array"><!-- --></a>
|
||
|
|
<div class="oddrow">
|
||
|
|
|
||
|
|
<div>
|
||
|
|
<img src="../../media/images/Function.png" />
|
||
|
|
<span class="method-title">get_related_items_as_array</span> (line <span class="line-number">125</span>)
|
||
|
|
</div>
|
||
|
|
|
||
|
|
<!-- ========== Info from phpDoc block ========= -->
|
||
|
|
<div class="method-signature">
|
||
|
|
<span class="method-result">void</span>
|
||
|
|
<span class="method-name">
|
||
|
|
get_related_items_as_array
|
||
|
|
</span>
|
||
|
|
(<span class="var-type"></span> <span class="var-name">$collection_pid</span>, [<span class="var-type"></span> <span class="var-name">$relationship</span> = <span class="var-default">'isMemberOfCollection'</span>], [<span class="var-type"></span> <span class="var-name">$limit</span> = <span class="var-default">10000</span>], [<span class="var-type"></span> <span class="var-name">$offset</span> = <span class="var-default">0</span>], [<span class="var-type"></span> <span class="var-name">$active_objects_only</span> = <span class="var-default">TRUE</span>], [<span class="var-type"></span> <span class="var-name">$cmodel</span> = <span class="var-default">NULL</span>], [<span class="var-type"></span> <span class="var-name">$orderby</span> = <span class="var-default">'$title'</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">$relationship</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">$active_objects_only</span> </li>
|
||
|
|
<li>
|
||
|
|
<span class="var-type"></span>
|
||
|
|
<span class="var-name">$cmodel</span> </li>
|
||
|
|
<li>
|
||
|
|
<span class="var-type"></span>
|
||
|
|
<span class="var-name">$orderby</span> </li>
|
||
|
|
</ul>
|
||
|
|
|
||
|
|
|
||
|
|
</div>
|
||
|
|
<a name="functionget_related_items_as_xml" id="functionget_related_items_as_xml"><!-- --></a>
|
||
|
|
<div class="evenrow">
|
||
|
|
|
||
|
|
<div>
|
||
|
|
<img src="../../media/images/Function.png" />
|
||
|
|
<span class="method-title">get_related_items_as_xml</span> (line <span class="line-number">73</span>)
|
||
|
|
</div>
|
||
|
|
|
||
|
|
<!-- ========== Info from phpDoc block ========= -->
|
||
|
|
<p class="short-description">Returns an array of pids that match the query contained in teh collection object's QUERY datastream or in the suppled $query parameter.</p>
|
||
|
|
<div class="method-signature">
|
||
|
|
<span class="method-result">void</span>
|
||
|
|
<span class="method-name">
|
||
|
|
get_related_items_as_xml
|
||
|
|
</span>
|
||
|
|
(<span class="var-type"><type></span> <span class="var-name">$collection_pid</span>, [<span class="var-type"></span> <span class="var-name">$relationship</span> = <span class="var-default">array('isMemberOfCollection')</span>], [<span class="var-type"></span> <span class="var-name">$limit</span> = <span class="var-default">10000</span>], [<span class="var-type"></span> <span class="var-name">$offset</span> = <span class="var-default">0</span>], [<span class="var-type"></span> <span class="var-name">$active_objects_only</span> = <span class="var-default">TRUE</span>], [<span class="var-type"></span> <span class="var-name">$cmodel</span> = <span class="var-default">NULL</span>], [<span class="var-type"></span> <span class="var-name">$orderby</span> = <span class="var-default">'$title'</span>], <span class="var-type"><type></span> <span class="var-name">$query</span>, <span class="var-type"><type></span> <span class="var-name">$query_format</span>)
|
||
|
|
</div>
|
||
|
|
|
||
|
|
<ul class="parameters">
|
||
|
|
<li>
|
||
|
|
<span class="var-type"><type></span>
|
||
|
|
<span class="var-name">$collection_pid</span> </li>
|
||
|
|
<li>
|
||
|
|
<span class="var-type"><type></span>
|
||
|
|
<span class="var-name">$query</span> </li>
|
||
|
|
<li>
|
||
|
|
<span class="var-type"><type></span>
|
||
|
|
<span class="var-name">$query_format</span><span class="var-description">: R</span> </li>
|
||
|
|
<li>
|
||
|
|
<span class="var-type"></span>
|
||
|
|
<span class="var-name">$relationship</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">$active_objects_only</span> </li>
|
||
|
|
<li>
|
||
|
|
<span class="var-type"></span>
|
||
|
|
<span class="var-name">$cmodel</span> </li>
|
||
|
|
<li>
|
||
|
|
<span class="var-type"></span>
|
||
|
|
<span class="var-name">$orderby</span> </li>
|
||
|
|
</ul>
|
||
|
|
|
||
|
|
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
|
||
|
|
<p class="notes" id="credit">
|
||
|
|
Documentation generated on Thu, 14 Jul 2011 16:29:54 -0300 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.3</a>
|
||
|
|
</p>
|
||
|
|
</div></body>
|
||
|
|
</html>
|