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/plugins/Refworks.html

535 lines
20 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 Refworks</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"> Refworks</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-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="_plugins---Refworks.inc.html">/plugins/Refworks.inc</a> (line <span class="field">19</span>)
</p>
<pre></pre>
</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> |
<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">Refworks</span>
<a href="#Refworks" title="details" class="method-name">Refworks</a>
()
</div>
<div class="method-definition">
<img src="../../media/images/Method.png" alt=" "/>
<span class="method-result">void</span>
<a href="#buildForm" title="details" class="method-name">buildForm</a>
(<span class="var-type"></span>&nbsp;<span class="var-name">&$form</span>, <span class="var-type"></span>&nbsp;<span class="var-name">$ingest_form_definition</span>, <span class="var-type"></span>&nbsp;<span class="var-name">&$form_values</span>)
</div>
<div class="method-definition">
<img src="../../media/images/Method.png" alt=" "/>
<span class="method-result">void</span>
<a href="#createFedoraDataStreams" title="details" class="method-name">createFedoraDataStreams</a>
(<span class="var-type"></span>&nbsp;<span class="var-name">$form_values</span>, <span class="var-type"></span>&nbsp;<span class="var-name">&$dom</span>, <span class="var-type"></span>&nbsp;<span class="var-name">&$rootElement</span>, <span class="var-type"></span>&nbsp;<span class="var-name">$reference</span>)
</div>
<div class="method-definition">
<img src="../../media/images/Method.png" alt=" "/>
<span class="method-result">void</span>
<a href="#createQDCStream" title="details" class="method-name">createQDCStream</a>
(<span class="var-type"></span>&nbsp;<span class="var-name">&$dom</span>, <span class="var-type"></span>&nbsp;<span class="var-name">&$rootElement</span>, <span class="var-type"></span>&nbsp;<span class="var-name">$reference</span>)
</div>
<div class="method-definition">
<img src="../../media/images/Method.png" alt=" "/>
<span class="method-result">void</span>
<a href="#createRelationShips" title="details" class="method-name">createRelationShips</a>
(<span class="var-type"></span>&nbsp;<span class="var-name">$form_values</span>, <span class="var-type"></span>&nbsp;<span class="var-name">&$dom</span>, <span class="var-type"></span>&nbsp;<span class="var-name">&$rootElement</span>, [<span class="var-type"></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="#createRomeoDataStream" title="details" class="method-name">createRomeoDataStream</a>
(<span class="var-type"></span>&nbsp;<span class="var-name">&$dom</span>, <span class="var-type"></span>&nbsp;<span class="var-name">&$rootElement</span>)
</div>
<div class="method-definition">
<img src="../../media/images/Method.png" alt=" "/>
<span class="method-result">void</span>
<a href="#createStandardFedoraStuff" title="details" class="method-name">createStandardFedoraStuff</a>
(<span class="var-type"></span>&nbsp;<span class="var-name">$form_values</span>, <span class="var-type"></span>&nbsp;<span class="var-name">&$dom</span>, <span class="var-type"></span>&nbsp;<span class="var-name">&$rootElement</span>, <span class="var-type"></span>&nbsp;<span class="var-name">$reference</span>)
</div>
<div class="method-definition">
<img src="../../media/images/Method.png" alt=" "/>
<span class="method-result">void</span>
<a href="#create_security_policies" title="details" class="method-name">create_security_policies</a>
(<span class="var-type">DOMDocument</span>&nbsp;<span class="var-name">$dom</span>, <span class="var-type"></span>&nbsp;<span class="var-name">&$rootElement</span>, <span class="var-type">$rootElement</span>&nbsp;<span class="var-name">$reference</span>, <span class="var-type">array</span>&nbsp;<span class="var-name">$form_values</span>)
</div>
<div class="method-definition">
<img src="../../media/images/Method.png" alt=" "/>
<span class="method-result">void</span>
<a href="#handleForm" title="details" class="method-name">handleForm</a>
(<span class="var-type"></span>&nbsp;<span class="var-name">&$form_values</span>)
</div>
<div class="method-definition">
<img src="../../media/images/Method.png" alt=" "/>
<span class="method-result">SimpleXMLElement</span>
<a href="#parse_refworks_item" title="details" class="method-name">parse_refworks_item</a>
(<span class="var-type"></span>&nbsp;<span class="var-name">&$form_values</span>, <span class="var-type">array</span>&nbsp;<span class="var-name">$form_values</span>, <span class="var-type">SimpleXMLElement</span>&nbsp;<span class="var-name">$dom</span>)
</div>
</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-method-summary">Methods</a> (<span class="disabled">details</span>)
</div>
<div class="info-box-body">
<A NAME='method_detail'></A>
<a name="methodRefworks" id="Refworks"><!-- --></a>
<div class="evenrow">
<div class="method-header">
<img src="../../media/images/Constructor.png" />
<span class="method-title">Constructor Refworks</span> (line <span class="line-number">26</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<div class="method-signature">
<span class="method-result">Refworks</span>
<span class="method-name">
Refworks
</span>
()
</div>
</div>
<a name="methodbuildForm" id="buildForm"><!-- --></a>
<div class="oddrow">
<div class="method-header">
<img src="../../media/images/Method.png" />
<span class="method-title">buildForm</span> (line <span class="line-number">30</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<div class="method-signature">
<span class="method-result">void</span>
<span class="method-name">
buildForm
</span>
(<span class="var-type"></span>&nbsp;<span class="var-name">&$form</span>, <span class="var-type"></span>&nbsp;<span class="var-name">$ingest_form_definition</span>, <span class="var-type"></span>&nbsp;<span class="var-name">&$form_values</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">$ingest_form_definition</span> </li>
<li>
<span class="var-type"></span>
<span class="var-name">&$form_values</span> </li>
</ul>
</div>
<a name="methodcreateFedoraDataStreams" id="createFedoraDataStreams"><!-- --></a>
<div class="evenrow">
<div class="method-header">
<img src="../../media/images/Method.png" />
<span class="method-title">createFedoraDataStreams</span> (line <span class="line-number">358</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<div class="method-signature">
<span class="method-result">void</span>
<span class="method-name">
createFedoraDataStreams
</span>
(<span class="var-type"></span>&nbsp;<span class="var-name">$form_values</span>, <span class="var-type"></span>&nbsp;<span class="var-name">&$dom</span>, <span class="var-type"></span>&nbsp;<span class="var-name">&$rootElement</span>, <span class="var-type"></span>&nbsp;<span class="var-name">$reference</span>)
</div>
<ul class="parameters">
<li>
<span class="var-type"></span>
<span class="var-name">$form_values</span> </li>
<li>
<span class="var-type"></span>
<span class="var-name">&$dom</span> </li>
<li>
<span class="var-type"></span>
<span class="var-name">&$rootElement</span> </li>
<li>
<span class="var-type"></span>
<span class="var-name">$reference</span> </li>
</ul>
</div>
<a name="methodcreateQDCStream" id="createQDCStream"><!-- --></a>
<div class="oddrow">
<div class="method-header">
<img src="../../media/images/Method.png" />
<span class="method-title">createQDCStream</span> (line <span class="line-number">92</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<div class="method-signature">
<span class="method-result">void</span>
<span class="method-name">
createQDCStream
</span>
(<span class="var-type"></span>&nbsp;<span class="var-name">&$dom</span>, <span class="var-type"></span>&nbsp;<span class="var-name">&$rootElement</span>, <span class="var-type"></span>&nbsp;<span class="var-name">$reference</span>)
</div>
<ul class="parameters">
<li>
<span class="var-type"></span>
<span class="var-name">&$dom</span> </li>
<li>
<span class="var-type"></span>
<span class="var-name">&$rootElement</span> </li>
<li>
<span class="var-type"></span>
<span class="var-name">$reference</span> </li>
</ul>
</div>
<a name="methodcreateRelationShips" id="createRelationShips"><!-- --></a>
<div class="evenrow">
<div class="method-header">
<img src="../../media/images/Method.png" />
<span class="method-title">createRelationShips</span> (line <span class="line-number">307</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Creates the RELS-EXT for the foxml</p>
<div class="method-signature">
<span class="method-result">void</span>
<span class="method-name">
createRelationShips
</span>
(<span class="var-type"></span>&nbsp;<span class="var-name">$form_values</span>, <span class="var-type"></span>&nbsp;<span class="var-name">&$dom</span>, <span class="var-type"></span>&nbsp;<span class="var-name">&$rootElement</span>, [<span class="var-type"></span>&nbsp;<span class="var-name">$pid</span> = <span class="var-default">NULL</span>])
</div>
<ul class="parameters">
<li>
<span class="var-type"></span>
<span class="var-name">$form_values</span> </li>
<li>
<span class="var-type"></span>
<span class="var-name">&$dom</span> </li>
<li>
<span class="var-type"></span>
<span class="var-name">&$rootElement</span> </li>
<li>
<span class="var-type"></span>
<span class="var-name">$pid</span> </li>
</ul>
</div>
<a name="methodcreateRomeoDataStream" id="createRomeoDataStream"><!-- --></a>
<div class="oddrow">
<div class="method-header">
<img src="../../media/images/Method.png" />
<span class="method-title">createRomeoDataStream</span> (line <span class="line-number">339</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<div class="method-signature">
<span class="method-result">void</span>
<span class="method-name">
createRomeoDataStream
</span>
(<span class="var-type"></span>&nbsp;<span class="var-name">&$dom</span>, <span class="var-type"></span>&nbsp;<span class="var-name">&$rootElement</span>)
</div>
<ul class="parameters">
<li>
<span class="var-type"></span>
<span class="var-name">&$dom</span> </li>
<li>
<span class="var-type"></span>
<span class="var-name">&$rootElement</span> </li>
</ul>
</div>
<a name="methodcreateStandardFedoraStuff" id="createStandardFedoraStuff"><!-- --></a>
<div class="evenrow">
<div class="method-header">
<img src="../../media/images/Method.png" />
<span class="method-title">createStandardFedoraStuff</span> (line <span class="line-number">385</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Creates the standard foxml properties</p>
<div class="method-signature">
<span class="method-result">void</span>
<span class="method-name">
createStandardFedoraStuff
</span>
(<span class="var-type"></span>&nbsp;<span class="var-name">$form_values</span>, <span class="var-type"></span>&nbsp;<span class="var-name">&$dom</span>, <span class="var-type"></span>&nbsp;<span class="var-name">&$rootElement</span>, <span class="var-type"></span>&nbsp;<span class="var-name">$reference</span>)
</div>
<ul class="parameters">
<li>
<span class="var-type"></span>
<span class="var-name">$form_values</span> </li>
<li>
<span class="var-type"></span>
<span class="var-name">&$dom</span> </li>
<li>
<span class="var-type"></span>
<span class="var-name">&$rootElement</span> </li>
<li>
<span class="var-type"></span>
<span class="var-name">$reference</span> </li>
</ul>
</div>
<a name="methodcreate_security_policies" id="create_security_policies"><!-- --></a>
<div class="oddrow">
<div class="method-header">
<img src="../../media/images/Method.png" />
<span class="method-title">create_security_policies</span> (line <span class="line-number">417</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Read the list of Users from the U1 field and Roles from the U2 field and add elements to the security policy record for this item, then add the record as the security policy datastream.</p>
<div class="method-signature">
<span class="method-result">void</span>
<span class="method-name">
create_security_policies
</span>
(<span class="var-type">DOMDocument</span>&nbsp;<span class="var-name">$dom</span>, <span class="var-type"></span>&nbsp;<span class="var-name">&$rootElement</span>, <span class="var-type">$rootElement</span>&nbsp;<span class="var-name">$reference</span>, <span class="var-type">array</span>&nbsp;<span class="var-name">$form_values</span>)
</div>
<ul class="parameters">
<li>
<span class="var-type">array</span>
<span class="var-name">$form_values</span> </li>
<li>
<span class="var-type">DOMDocument</span>
<span class="var-name">$dom</span> </li>
<li>
<span class="var-type">$rootElement</span>
<span class="var-name">$reference</span> </li>
<li>
<span class="var-type"></span>
<span class="var-name">&$rootElement</span> </li>
</ul>
</div>
<a name="methodhandleForm" id="handleForm"><!-- --></a>
<div class="evenrow">
<div class="method-header">
<img src="../../media/images/Method.png" />
<span class="method-title">handleForm</span> (line <span class="line-number">206</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<div class="method-signature">
<span class="method-result">void</span>
<span class="method-name">
handleForm
</span>
(<span class="var-type"></span>&nbsp;<span class="var-name">&$form_values</span>)
</div>
<ul class="parameters">
<li>
<span class="var-type"></span>
<span class="var-name">&$form_values</span> </li>
</ul>
</div>
<a name="methodparse_refworks_item" id="parse_refworks_item"><!-- --></a>
<div class="oddrow">
<div class="method-header">
<img src="../../media/images/Method.png" />
<span class="method-title">parse_refworks_item</span> (line <span class="line-number">67</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Read the input file and generate a list of Reference items.</p>
<div class="method-signature">
<span class="method-result">SimpleXMLElement</span>
<span class="method-name">
parse_refworks_item
</span>
(<span class="var-type"></span>&nbsp;<span class="var-name">&$form_values</span>, <span class="var-type">array</span>&nbsp;<span class="var-name">$form_values</span>, <span class="var-type">SimpleXMLElement</span>&nbsp;<span class="var-name">$dom</span>)
</div>
<ul class="parameters">
<li>
<span class="var-type">array</span>
<span class="var-name">$form_values</span> </li>
<li>
<span class="var-type">SimpleXMLElement</span>
<span class="var-name">$dom</span> </li>
<li>
<span class="var-type"></span>
<span class="var-name">&$form_values</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>