opencultureconsulting
/
simple-oai-pmh
mirror of https://github.com/opencultureconsulting/simple-oai-pmh.git
2
0
Fork 0
Code Issues Releases Activity
simple-oai-pmh/doc/classANDS__RIFCS.html

809 lines
39 KiB
HTML
Raw Blame History

<!-- This comment will put IE 6, 7 and 8 in quirks mode -->
<!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>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<title>OAI PHP: ANDS_RIFCS Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javaScript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css"/>
</head>
<body onload='searchBox.OnSelectItem(0);'>
<!-- Generated by Doxygen 1.6.3 -->
<script type="text/javascript"><!--
var searchBox = new SearchBox("searchBox", "search",false,'Search');
--></script>
<div class="navigation" id="top">
<div class="tabs">
<ul>
<li><a href="index.html"><span>Main&nbsp;Page</span></a></li>
<li><a href="pages.html"><span>Related&nbsp;Pages</span></a></li>
<li class="current"><a href="annotated.html"><span>Classes</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
<li>
<div id="MSearchBox" class="MSearchBoxInactive">
<img id="MSearchSelect" src="search/search.png"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
alt=""/>
<input type="text" id="MSearchField" value="Search" accesskey="S"
onfocus="searchBox.OnSearchFieldFocus(true)"
onblur="searchBox.OnSearchFieldFocus(false)"
onkeyup="searchBox.OnSearchFieldChange(event)"/>
<a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
</div>
</li>
</ul>
</div>
<div class="tabs">
<ul>
<li><a href="annotated.html"><span>Class&nbsp;List</span></a></li>
<li><a href="hierarchy.html"><span>Class&nbsp;Hierarchy</span></a></li>
<li><a href="functions.html"><span>Class&nbsp;Members</span></a></li>
</ul>
</div>
</div>
<div class="contents">
<h1>ANDS_RIFCS Class Reference</h1><!-- doxytag: class="ANDS_RIFCS" -->
<p>For creating RIF-CS metadata to meet the requirement of ANDS.
<a href="#_details">More...</a></p>
<div class="dynheader">
Inheritance diagram for ANDS_RIFCS:</div>
<div class="dynsection">
<div class="center">
<img src="classANDS__RIFCS.png" usemap="#ANDS_RIFCS_map" alt=""/>
<map id="ANDS_RIFCS_map" name="ANDS_RIFCS_map">
<area href="classANDS__TPA.html" alt="ANDS_TPA" shape="rect" coords="0,56,90,80"/>
</map>
</div>
</div>
<p><a href="classANDS__RIFCS-members.html">List of all members.</a></p>
<table border="0" cellpadding="0" cellspacing="0">
<tr><td colspan="2"><h2>Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classANDS__RIFCS.html#a67f449c266668b19a5d95540bd3178fb">__construct</a> ($ands_response_doc, $metadata_node)</td></tr>
<tr><td colspan="2"><h2>Protected Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classANDS__RIFCS.html#a24fea7a11291d9568c86a13112c1f017">addChild</a> ($mom_node, $name, $value='')</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classANDS__RIFCS.html#a1c1c253099ed365f7a786279529536d3">create_regObjects</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classANDS__RIFCS.html#af777635e3ebed4551fe754945279fc53">create_regObject</a> ($group, $key, $originatingSource)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classANDS__RIFCS.html#a5f69e0c470302e983eb52ece06305e23">create_rifcs_node</a> ($set_name, $set_type)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classANDS__RIFCS.html#ac58a89025c2bcf5384c1666ee3bfccf1">create_name_node</a> ($name_type= 'primary')</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classANDS__RIFCS.html#ae6d15b868f2ccd2b944592369c85976c">create_namePart</a> ($name_node, $value, $part_type= '')</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classANDS__RIFCS.html#a6b3a8aeb03ceeb24951221a8902409a7">create_relatedObject</a> ($key, $relation_type)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classANDS__RIFCS.html#abe4ec68b3ea64e1fddfd38414871a412">create_description_node</a> ($value, $des_type='brief')</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classANDS__RIFCS.html#a57e72cea6e3b5e2df35686fa830bc90e">create_identifier_node</a> ($key, $i_type='local')</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classANDS__RIFCS.html#a94c58b9755aed78fc921ff74dfe11387">create_location_node</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classANDS__RIFCS.html#ad7da5d27e5e6fed89c4b75394c71d582">create_address_node</a> ($location_node)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classANDS__RIFCS.html#aa3d9f08bb89449e93ce4b70835f95cb3">create_e_node</a> ($addr_node, $e_node, $e_type= 'email')</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classANDS__RIFCS.html#a37b22e3b286f3798913716e89ccd5bd4">create_physcial_fone_fax</a> ($addr_node, $number, $fone_fax='telephoneNumber')</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classANDS__RIFCS.html#a55351d4041009e241c669b820e979abf">create_physcial_addr_txt</a> ($addr_node, $txt_addr, $phys_type='streetAddress')</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classANDS__RIFCS.html#aa2e55220f585c419f16a41c79f97b478">create_spatial_node</a> ($location_node, $value= '138.6396,-34.97063', $sp_type= 'kmlPolyCoords')</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classANDS__RIFCS.html#a6ed186de44b59812af0be9028c998d29">create_coverage_tempo</a> ($values)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classANDS__RIFCS.html#ae392667bf59b03f38f3f64688b45b852">create_subject_node</a> ($value, $subject_type= 'anzsrc-for')</td></tr>
<tr><td colspan="2"><h2>Protected Attributes</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classANDS__RIFCS.html#a66a8d2400e1c62cccf30a84f4614f737">$oai_pmh</a></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classANDS__RIFCS.html#a4800d5ca80abaaa005e7ea4bf5b995fa">$working_node</a></td></tr>
<tr><td colspan="2"><h2>Private Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classANDS__RIFCS.html#a7c6f429232d092a4dfe55df22bd695ff">create_coverage_tempo_date</a> ($t, $value)</td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<p>Class <a class="el" href="classANDS__RIFCS.html" title="For creating RIF-CS metadata to meet the requirement of ANDS.">ANDS_RIFCS</a> provides all essential functionalities for creating ANDS RIF-CS records. The protected member functions are the backbone functions which can be used for creating any ANDS RIF-CS records. </p>
<hr/><h2>Constructor &amp; Destructor Documentation</h2>
<a class="anchor" id="a67f449c266668b19a5d95540bd3178fb"></a><!-- doxytag: member="ANDS_RIFCS::__construct" ref="a67f449c266668b19a5d95540bd3178fb" args="($ands_response_doc, $metadata_node)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">ANDS_RIFCS::__construct </td>
<td>(</td>
<td class="paramtype">$&nbsp;</td>
<td class="paramname"> <em>ands_response_doc</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">$&nbsp;</td>
<td class="paramname"> <em>metadata_node</em></td><td>&nbsp;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Constructor</p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>$ands_response_doc</em>&nbsp;</td><td><a class="el" href="classANDS__Response__XML.html">ANDS_Response_XML</a>. A XML Doc acts as the parent node. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>$metadata_node</em>&nbsp;</td><td>DOMElement. The meta node which all subsequent nodes will be added to. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="a24fea7a11291d9568c86a13112c1f017"></a><!-- doxytag: member="ANDS_RIFCS::addChild" ref="a24fea7a11291d9568c86a13112c1f017" args="($mom_node, $name, $value='')" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">ANDS_RIFCS::addChild </td>
<td>(</td>
<td class="paramtype">$&nbsp;</td>
<td class="paramname"> <em>mom_node</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">$&nbsp;</td>
<td class="paramname"> <em>name</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">$&nbsp;</td>
<td class="paramname"> <em>value</em> = <code>''</code></td><td>&nbsp;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td><code> [protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>A worker function for easily adding a newly created node to current XML Doc. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>$mom_node</em>&nbsp;</td><td>Type: DOMElement. Node the new child will be attached to. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>$name</em>&nbsp;</td><td>Type: sting. The name of the child node is being added. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>$value</em>&nbsp;</td><td>Type: sting. The text content of the child node is being added. The default is ''. </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>DOMElement. The added child node </dd></dl>
</div>
</div>
<a class="anchor" id="a1c1c253099ed365f7a786279529536d3"></a><!-- doxytag: member="ANDS_RIFCS::create_regObjects" ref="a1c1c253099ed365f7a786279529536d3" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">ANDS_RIFCS::create_regObjects </td>
<td>(</td>
<td class="paramname"></td>
<td>&nbsp;)&nbsp;</td>
<td><code> [protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Create a registryObjects node to hold individual registryObject's. This is only a holder node. </p>
</div>
</div>
<a class="anchor" id="af777635e3ebed4551fe754945279fc53"></a><!-- doxytag: member="ANDS_RIFCS::create_regObject" ref="af777635e3ebed4551fe754945279fc53" args="($group, $key, $originatingSource)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">ANDS_RIFCS::create_regObject </td>
<td>(</td>
<td class="paramtype">$&nbsp;</td>
<td class="paramname"> <em>group</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">$&nbsp;</td>
<td class="paramname"> <em>key</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">$&nbsp;</td>
<td class="paramname"> <em>originatingSource</em></td><td>&nbsp;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td><code> [protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Create a single registryObject node. Each set has its own structure but they all have an attribute of group, a key node and an originatingSource node. The newly created node will be used as the working node.</p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>$group</em>&nbsp;</td><td>string, group attribute of the new registryObject node . </td></tr>
<tr><td valign="top"></td><td valign="top"><em>$key</em>&nbsp;</td><td>string, key node, used as an identifier. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>$originatingSource</em>&nbsp;</td><td>string, an url of the data provider. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="a5f69e0c470302e983eb52ece06305e23"></a><!-- doxytag: member="ANDS_RIFCS::create_rifcs_node" ref="a5f69e0c470302e983eb52ece06305e23" args="($set_name, $set_type)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">ANDS_RIFCS::create_rifcs_node </td>
<td>(</td>
<td class="paramtype">$&nbsp;</td>
<td class="paramname"> <em>set_name</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">$&nbsp;</td>
<td class="paramname"> <em>set_type</em></td><td>&nbsp;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td><code> [protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>RIF-CS node is the content node of RIF-CS metadata node which starts from regObjects. Each set supportted in RIF-CS has its own content model. The created node will be used as the root node of this record for following nodes will be created.</p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>$set_name</em>&nbsp;</td><td>string, the name of set. For ANDS, they are Activity, Party and Collection </td></tr>
<tr><td valign="top"></td><td valign="top"><em>$set_type</em>&nbsp;</td><td>string, the type of set. For example, Activity can have project as a type. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="ac58a89025c2bcf5384c1666ee3bfccf1"></a><!-- doxytag: member="ANDS_RIFCS::create_name_node" ref="ac58a89025c2bcf5384c1666ee3bfccf1" args="($name_type= 'primary')" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">ANDS_RIFCS::create_name_node </td>
<td>(</td>
<td class="paramtype">$&nbsp;</td>
<td class="paramname"> <em>name_type</em> = <code>'primary'</code></td>
<td>&nbsp;)&nbsp;</td>
<td><code> [protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Create a top level name node. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>$name_type</em>&nbsp;</td><td>string. Text for the types, can be either primary or abbreviated. Default: primary</td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>DOMElement $added_name_node. The newly created node, it will be used for further expansion by adding namePart. </dd></dl>
</div>
</div>
<a class="anchor" id="ae6d15b868f2ccd2b944592369c85976c"></a><!-- doxytag: member="ANDS_RIFCS::create_namePart" ref="ae6d15b868f2ccd2b944592369c85976c" args="($name_node, $value, $part_type= '')" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">ANDS_RIFCS::create_namePart </td>
<td>(</td>
<td class="paramtype">$&nbsp;</td>
<td class="paramname"> <em>name_node</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">$&nbsp;</td>
<td class="paramname"> <em>value</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">$&nbsp;</td>
<td class="paramname"> <em>part_type</em> = <code>''</code></td><td>&nbsp;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td><code> [protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Create a namePart of a name node. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>$name_node</em>&nbsp;</td><td>Type: DOMElement. Node of name_node created previously</td></tr>
<tr><td valign="top"></td><td valign="top"><em>$value</em>&nbsp;</td><td>Type: string. Text fror this namePart</td></tr>
<tr><td valign="top"></td><td valign="top"><em>$part_type</em>&nbsp;</td><td>Type: string, used for group:person record. Types can be: titile, given, family </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="a6b3a8aeb03ceeb24951221a8902409a7"></a><!-- doxytag: member="ANDS_RIFCS::create_relatedObject" ref="a6b3a8aeb03ceeb24951221a8902409a7" args="($key, $relation_type)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">ANDS_RIFCS::create_relatedObject </td>
<td>(</td>
<td class="paramtype">$&nbsp;</td>
<td class="paramname"> <em>key</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">$&nbsp;</td>
<td class="paramname"> <em>relation_type</em></td><td>&nbsp;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td><code> [protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Create related object. One RIF-CS can have more than one related object nodes, each object is described by one node. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>$key</em>&nbsp;</td><td>Type: string. The identifier of the related object. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>$relation_type</em>&nbsp;</td><td>Type: string. Type of relationship. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="abe4ec68b3ea64e1fddfd38414871a412"></a><!-- doxytag: member="ANDS_RIFCS::create_description_node" ref="abe4ec68b3ea64e1fddfd38414871a412" args="($value, $des_type='brief')" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">ANDS_RIFCS::create_description_node </td>
<td>(</td>
<td class="paramtype">$&nbsp;</td>
<td class="paramname"> <em>value</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">$&nbsp;</td>
<td class="paramname"> <em>des_type</em> = <code>'brief'</code></td><td>&nbsp;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td><code> [protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Create description node. One RIF-CS can have more than one description nodes. Each description node has only one description. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>$value</em>&nbsp;</td><td>Type: string. The content of the description. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>$des_type</em>&nbsp;</td><td>Type: string. Type of the description. Types can be brief, full, acessRights and note. Default is 'brief'. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="a57e72cea6e3b5e2df35686fa830bc90e"></a><!-- doxytag: member="ANDS_RIFCS::create_identifier_node" ref="a57e72cea6e3b5e2df35686fa830bc90e" args="($key, $i_type='local')" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">ANDS_RIFCS::create_identifier_node </td>
<td>(</td>
<td class="paramtype">$&nbsp;</td>
<td class="paramname"> <em>key</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">$&nbsp;</td>
<td class="paramname"> <em>i_type</em> = <code>'local'</code></td><td>&nbsp;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td><code> [protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Create local or other type of identifier inside of RIF-CS metadata node </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>$key</em>&nbsp;</td><td>Type string. The indentifier itself. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>$i_type</em>&nbsp;</td><td>Type string. Type of identifier. Can be abn, uri, local, etc.. Default is local. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="a94c58b9755aed78fc921ff74dfe11387"></a><!-- doxytag: member="ANDS_RIFCS::create_location_node" ref="a94c58b9755aed78fc921ff74dfe11387" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">ANDS_RIFCS::create_location_node </td>
<td>(</td>
<td class="paramname"></td>
<td>&nbsp;)&nbsp;</td>
<td><code> [protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Location node is a holder node for either address or spatial nodes </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>DOMElement node, for adding address or spatial nodes. </dd></dl>
</div>
</div>
<a class="anchor" id="ad7da5d27e5e6fed89c4b75394c71d582"></a><!-- doxytag: member="ANDS_RIFCS::create_address_node" ref="ad7da5d27e5e6fed89c4b75394c71d582" args="($location_node)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">ANDS_RIFCS::create_address_node </td>
<td>(</td>
<td class="paramtype">$&nbsp;</td>
<td class="paramname"> <em>location_node</em></td>
<td>&nbsp;)&nbsp;</td>
<td><code> [protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Address node is a holder node for phiscal or electrical nodes. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>$location_node</em>&nbsp;</td><td>Type: DOMElement. Location node created previously. </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>DOMElement </dd></dl>
</div>
</div>
<a class="anchor" id="aa3d9f08bb89449e93ce4b70835f95cb3"></a><!-- doxytag: member="ANDS_RIFCS::create_e_node" ref="aa3d9f08bb89449e93ce4b70835f95cb3" args="($addr_node, $e_node, $e_type= 'email')" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">ANDS_RIFCS::create_e_node </td>
<td>(</td>
<td class="paramtype">$&nbsp;</td>
<td class="paramname"> <em>addr_node</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">$&nbsp;</td>
<td class="paramname"> <em>e_node</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">$&nbsp;</td>
<td class="paramname"> <em>e_type</em> = <code>'email'</code></td><td>&nbsp;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td><code> [protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Electrical address node. Used for email, url, etc </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>$addr_node</em>&nbsp;</td><td>Type: DOMElement. Previously created address node. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>$e_node</em>&nbsp;</td><td>Type: string. The content of the adding node. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>$e_type</em>&nbsp;</td><td>Type: string. Default is email. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="a37b22e3b286f3798913716e89ccd5bd4"></a><!-- doxytag: member="ANDS_RIFCS::create_physcial_fone_fax" ref="a37b22e3b286f3798913716e89ccd5bd4" args="($addr_node, $number, $fone_fax='telephoneNumber')" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">ANDS_RIFCS::create_physcial_fone_fax </td>
<td>(</td>
<td class="paramtype">$&nbsp;</td>
<td class="paramname"> <em>addr_node</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">$&nbsp;</td>
<td class="paramname"> <em>number</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">$&nbsp;</td>
<td class="paramname"> <em>fone_fax</em> = <code>'telephoneNumber'</code></td><td>&nbsp;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td><code> [protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Physical node is a holder node for phone or fax nodes. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>$addr_node</em>&nbsp;</td><td>Type: DOMelement. Address node created before to which the new phiscial-&gt;addressPart will be attached. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>$number</em>&nbsp;</td><td>Type: string. Telephone or fax number as a string. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>$fone_fax</em>&nbsp;</td><td>Type: string. Either telehoneNumber or faxNumber. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="a55351d4041009e241c669b820e979abf"></a><!-- doxytag: member="ANDS_RIFCS::create_physcial_addr_txt" ref="a55351d4041009e241c669b820e979abf" args="($addr_node, $txt_addr, $phys_type='streetAddress')" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">ANDS_RIFCS::create_physcial_addr_txt </td>
<td>(</td>
<td class="paramtype">$&nbsp;</td>
<td class="paramname"> <em>addr_node</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">$&nbsp;</td>
<td class="paramname"> <em>txt_addr</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">$&nbsp;</td>
<td class="paramname"> <em>phys_type</em> = <code>'streetAddress'</code></td><td>&nbsp;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td><code> [protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>create address node under location node, either streetAddress or postalAddress. But they are in text (one block) format. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>$addr_node</em>&nbsp;</td><td>Type: DOMelement. Address node created before to which the new phiscial-&gt;addressPart will be attached. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>$txt_addr</em>&nbsp;</td><td>string, full street address in text block format </td></tr>
<tr><td valign="top"></td><td valign="top"><em>$phys_type</em>&nbsp;</td><td>string, default is 'streetAddress', can be 'postalAddress' </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="aa2e55220f585c419f16a41c79f97b478"></a><!-- doxytag: member="ANDS_RIFCS::create_spatial_node" ref="aa2e55220f585c419f16a41c79f97b478" args="($location_node, $value= '138.6396,&#45;34.97063', $sp_type= 'kmlPolyCoords')" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">ANDS_RIFCS::create_spatial_node </td>
<td>(</td>
<td class="paramtype">$&nbsp;</td>
<td class="paramname"> <em>location_node</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">$&nbsp;</td>
<td class="paramname"> <em>value</em> = <code>'138.6396</code>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">-34.97063'&nbsp;</td>
<td class="paramname">, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">$&nbsp;</td>
<td class="paramname"> <em>sp_type</em> = <code>'kmlPolyCoords'</code></td><td>&nbsp;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td><code> [protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Create spatial node under a location node. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>$location_node</em>&nbsp;</td><td>Type: DOMElement. Location node where spatial node is being added to. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>$value</em>&nbsp;</td><td>Type: string. The value of spatial information. Default is local latitude and longitude. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>$sp_type</em>&nbsp;</td><td>Type: string. Type of spaitial informaion. Default is kmlPolyCoords. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="a6ed186de44b59812af0be9028c998d29"></a><!-- doxytag: member="ANDS_RIFCS::create_coverage_tempo" ref="a6ed186de44b59812af0be9028c998d29" args="($values)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">ANDS_RIFCS::create_coverage_tempo </td>
<td>(</td>
<td class="paramtype">$&nbsp;</td>
<td class="paramname"> <em>values</em></td>
<td>&nbsp;)&nbsp;</td>
<td><code> [protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Create temporal coverage node for collection or activity records. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>$values</em>&nbsp;</td><td>Type: 2-D array. The values of temporal coverage. It can has maximal two elements: one from 'dateFrom' and another for 'dateTo'. Either can be ommited according to RIF-CS schema. Each element of $values is an array and has keys: date, type and format. ['date'] is a string represents date. It has to be in W3CDTF or UTC format. ['type'] has to be either 'dateFrom' or 'dateTo'. ['format'] is optional and its default is 'W3CDTF'. UTC format requires date has to be in UTC: dateTtimeZ. It throws an exception if the input parameter is not an array. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="a7c6f429232d092a4dfe55df22bd695ff"></a><!-- doxytag: member="ANDS_RIFCS::create_coverage_tempo_date" ref="a7c6f429232d092a4dfe55df22bd695ff" args="($t, $value)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">ANDS_RIFCS::create_coverage_tempo_date </td>
<td>(</td>
<td class="paramtype">$&nbsp;</td>
<td class="paramname"> <em>t</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">$&nbsp;</td>
<td class="paramname"> <em>value</em></td><td>&nbsp;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td><code> [private]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Create temporal coverage node for collection or activity records. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>$t</em>&nbsp;</td><td>Type: DOMElement. The &lt;coverage&gt;&lt;temporal/&gt;&lt;/coverage&gt; node to which &lt;date&gt; nodes will be attached to. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>$value</em>&nbsp;</td><td>Type: array. The value of temporal coverage. It has maxmimal three elements with keys: type, date and format. It throws an exception if the input parameter is not an array. </td></tr>
</table>
</dd>
</dl>
<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="classANDS__RIFCS.html#a6ed186de44b59812af0be9028c998d29">create_coverage_tempo</a> </dd></dl>
</div>
</div>
<a class="anchor" id="ae392667bf59b03f38f3f64688b45b852"></a><!-- doxytag: member="ANDS_RIFCS::create_subject_node" ref="ae392667bf59b03f38f3f64688b45b852" args="($value, $subject_type= 'anzsrc&#45;for')" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">ANDS_RIFCS::create_subject_node </td>
<td>(</td>
<td class="paramtype">$&nbsp;</td>
<td class="paramname"> <em>value</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">$&nbsp;</td>
<td class="paramname"> <em>subject_type</em> = <code>'anzsrc-for'</code></td><td>&nbsp;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td><code> [protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Create a subject node for a researcher, project, project, etc </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>$value</em>&nbsp;</td><td>Type: string. A string representing the new namePart. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>$subject_type</em>&nbsp;</td><td>Type: string. A string representing the type of subject. The default value is anzsrc-for. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<hr/><h2>Member Data Documentation</h2>
<a class="anchor" id="a66a8d2400e1c62cccf30a84f4614f737"></a><!-- doxytag: member="ANDS_RIFCS::$oai_pmh" ref="a66a8d2400e1c62cccf30a84f4614f737" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">ANDS_RIFCS::$oai_pmh<code> [protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Type: <a class="el" href="classANDS__Response__XML.html">ANDS_Response_XML</a>. Assigned by constructor. </p>
<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="classANDS__RIFCS.html#a67f449c266668b19a5d95540bd3178fb">__construct</a> </dd></dl>
</div>
</div>
<a class="anchor" id="a4800d5ca80abaaa005e7ea4bf5b995fa"></a><!-- doxytag: member="ANDS_RIFCS::$working_node" ref="a4800d5ca80abaaa005e7ea4bf5b995fa" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">ANDS_RIFCS::$working_node<code> [protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Type: DOMElement. Assigned by constructor. </p>
<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="classANDS__RIFCS.html#a67f449c266668b19a5d95540bd3178fb">__construct</a> </dd></dl>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="ands__rifcs_8php.html">ands_rifcs.php</a></li>
</ul>
</div>
<!--- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark">&nbsp;</span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark">&nbsp;</span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark">&nbsp;</span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark">&nbsp;</span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark">&nbsp;</span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark">&nbsp;</span>Enumerations</a></div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
<hr class="footer"/><address style="text-align: right;"><small>Generated on Thu Jun 16 12:49:22 2011 for OAI PHP by&nbsp;
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.6.3 </small></address>
</body>
</html>
View Git Blame Copy Permalink