diff options
Diffstat (limited to 'doc/html/classBiblioIsisDb.html')
| -rw-r--r-- | doc/html/classBiblioIsisDb.html | 674 |
1 files changed, 674 insertions, 0 deletions
diff --git a/doc/html/classBiblioIsisDb.html b/doc/html/classBiblioIsisDb.html new file mode 100644 index 0000000..f61a2ab --- /dev/null +++ b/doc/html/classBiblioIsisDb.html @@ -0,0 +1,674 @@ +<!-- 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>Cinisis Database Reader: BiblioIsisDb 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 Page</span></a></li> + <li><a href="pages.html"><span>Related Pages</span></a></li> + <li class="current"><a href="annotated.html"><span>Classes</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 List</span></a></li> + <li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li> + <li><a href="functions.html"><span>Class Members</span></a></li> + </ul> + </div> +</div> +<div class="contents"> +<h1>BiblioIsisDb Class Reference</h1><!-- doxytag: class="BiblioIsisDb" --><!-- doxytag: inherits="IsisDb" --><div class="dynheader"> +Inheritance diagram for BiblioIsisDb:</div> +<div class="dynsection"> + <div class="center"> + <img src="classBiblioIsisDb.png" usemap="#BiblioIsisDb_map" alt=""/> + <map id="BiblioIsisDb_map" name="BiblioIsisDb_map"> +<area href="interfaceIsisDb.html" alt="IsisDb" shape="rect" coords="0,0,77,24"/> +</map> + </div> +</div> + +<p><a href="classBiblioIsisDb-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"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classBiblioIsisDb.html#ab2c5ec782b324847e104d8ad35a230af">__construct</a> ($schema)</td></tr> +<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classBiblioIsisDb.html#a286fb16de5797785d28021068efca561">logger</a> ($message)</td></tr> +<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classBiblioIsisDb.html#ad5704f5c9454ac053e66a489797ba221">backend</a> ($method= 'count', $args=NULL)</td></tr> +<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classBiblioIsisDb.html#a808cdbc0d4c8f62a1465e74064f4422f">read</a> ($id, $method= 'fetch')</td></tr> +<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classBiblioIsisDb.html#ab6b0a977c066c25c6bdca5c1d3a083e8">entries</a> ()</td></tr> +<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classBiblioIsisDb.html#a8e76b289b9e3a9893b9469094753d2bc">example</a> ()</td></tr> +<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classBiblioIsisDb.html#a34483b463d81ba1d8031576b5735efbc">tag</a> ($results, $method= 'fetch')</td></tr> +<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classBiblioIsisDb.html#a73d5d998f9ab7e410c5f71f65e83948b">has_subfields</a> ($key)</td></tr> +<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classBiblioIsisDb.html#af0be305b211b96dcb4aeb8452c8331a9">subfields_switch</a> ($key, &$value)</td></tr> +<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classBiblioIsisDb.html#a450e26ae0b7f4967d8e25c9a3d023c75">subfields</a> ($name, $key, $method)</td></tr> +<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classBiblioIsisDb.html#a8c6a0081c5296a6db520e98998502ef7">subfields_from_to_hash</a> ($name, $key)</td></tr> +<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classBiblioIsisDb.html#a2b08c6a7ba20f6f5eb07edb2b4a914c1">subfields_from_fetch</a> ($name, $key)</td></tr> +<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classBiblioIsisDb.html#aa86380f9e66ea8f175c50675d1fe0a88">is_repetitive</a> ($field, $value)</td></tr> +<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classBiblioIsisDb.html#a04089d61ce04b18aa6a78c94ca02edb9">repetition</a> ($key, $value)</td></tr> +<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classBiblioIsisDb.html#a2b6fd7b7316f63ac5649ebf3947c4fae">charset</a> (&$data)</td></tr> +<tr><td colspan="2"><h2>Static Public Member Functions</h2></td></tr> +<tr><td class="memItemLeft" align="right" valign="top">static </td><td class="memItemRight" valign="bottom"><a class="el" href="classBiblioIsisDb.html#a929467f1907d3aeaeebe493f0c188c5b">check</a> ($schema, $section=NULL)</td></tr> +<tr><td colspan="2"><h2>Public Attributes</h2></td></tr> +<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classBiblioIsisDb.html#a978a9243ea53b1f2426115d7b4191b07">$fdt</a></td></tr> +<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classBiblioIsisDb.html#a7eccfa964dcd1469a263340447c38143">$perl</a></td></tr> +<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classBiblioIsisDb.html#ab9fb3b6f10d2734a198ca7802ee38c2d">$format</a></td></tr> +<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classBiblioIsisDb.html#a67337d78af0fc21d0ff10471aa638c62">$log</a></td></tr> +</table> +<hr/><a name="_details"></a><h2>Detailed Description</h2> +<p>Biblio::Isis implementation of <a class="el" href="interfaceIsisDb.html">IsisDb</a>. </p> +<hr/><h2>Constructor & Destructor Documentation</h2> +<a class="anchor" id="ab2c5ec782b324847e104d8ad35a230af"></a><!-- doxytag: member="BiblioIsisDb::__construct" ref="ab2c5ec782b324847e104d8ad35a230af" args="($schema)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">BiblioIsisDb::__construct </td> + <td>(</td> + <td class="paramtype">$ </td> + <td class="paramname"> <em>schema</em></td> + <td> ) </td> + <td></td> + </tr> + </table> +</div> +<div class="memdoc"> +<p>Constructor.</p> +<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="interfaceIsisDb.html#ae1c0a3496d55f710d34c5c19ada7a66b">IsisDb::__construct()</a> </dd></dl> + +<p>Implements <a class="el" href="interfaceIsisDb.html#ae1c0a3496d55f710d34c5c19ada7a66b">IsisDb</a>.</p> + +</div> +</div> +<hr/><h2>Member Function Documentation</h2> +<a class="anchor" id="ad5704f5c9454ac053e66a489797ba221"></a><!-- doxytag: member="BiblioIsisDb::backend" ref="ad5704f5c9454ac053e66a489797ba221" args="($method= 'count', $args=NULL)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">BiblioIsisDb::backend </td> + <td>(</td> + <td class="paramtype">$ </td> + <td class="paramname"> <em>method</em> = <code>'count'</code>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">$ </td> + <td class="paramname"> <em>args</em> = <code>NULL</code></td><td> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td><td></td> + </tr> + </table> +</div> +<div class="memdoc"> +<p>Send requests to the perl backend.</p> +<dl><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>$method</em> </td><td>Backend method name to invoke.</td></tr> + <tr><td valign="top"></td><td valign="top"><em>$args</em> </td><td>Backend method arguments.</td></tr> + </table> + </dd> +</dl> +<dl class="return"><dt><b>Returns:</b></dt><dd>Backend return value. </dd></dl> + +</div> +</div> +<a class="anchor" id="a2b6fd7b7316f63ac5649ebf3947c4fae"></a><!-- doxytag: member="BiblioIsisDb::charset" ref="a2b6fd7b7316f63ac5649ebf3947c4fae" args="(&$data)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">BiblioIsisDb::charset </td> + <td>(</td> + <td class="paramtype">&$ </td> + <td class="paramname"> <em>data</em></td> + <td> ) </td> + <td></td> + </tr> + </table> +</div> +<div class="memdoc"> +<p>Charset conversion.</p> +<p>Converts a string from the database charset to UTF-8.</p> +<dl><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>$data</em> </td><td>String to be converted.</td></tr> + </table> + </dd> +</dl> +<dl class="return"><dt><b>Returns:</b></dt><dd>String converted to UTF-8. </dd></dl> + +</div> +</div> +<a class="anchor" id="a929467f1907d3aeaeebe493f0c188c5b"></a><!-- doxytag: member="BiblioIsisDb::check" ref="a929467f1907d3aeaeebe493f0c188c5b" args="($schema, $section=NULL)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">static BiblioIsisDb::check </td> + <td>(</td> + <td class="paramtype">$ </td> + <td class="paramname"> <em>schema</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">$ </td> + <td class="paramname"> <em>section</em> = <code>NULL</code></td><td> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td><td><code> [static]</code></td> + </tr> + </table> +</div> +<div class="memdoc"> +<p>Check configuration.</p> +<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="interfaceIsisDb.html#af681b8f990b579f1835aa7ba4c83f1b8">IsisDb::check()</a> </dd></dl> + +<p>Implements <a class="el" href="interfaceIsisDb.html#af681b8f990b579f1835aa7ba4c83f1b8">IsisDb</a>.</p> + +</div> +</div> +<a class="anchor" id="ab6b0a977c066c25c6bdca5c1d3a083e8"></a><!-- doxytag: member="BiblioIsisDb::entries" ref="ab6b0a977c066c25c6bdca5c1d3a083e8" args="()" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">BiblioIsisDb::entries </td> + <td>(</td> + <td class="paramname"></td> + <td> ) </td> + <td></td> + </tr> + </table> +</div> +<div class="memdoc"> +<p>Return number of entries in the database.</p> +<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="interfaceIsisDb.html#a86f38eca2b6d0835b60770d8a4e511ff">IsisDb::entries()</a> </dd></dl> + +<p>Implements <a class="el" href="interfaceIsisDb.html#a86f38eca2b6d0835b60770d8a4e511ff">IsisDb</a>.</p> + +</div> +</div> +<a class="anchor" id="a8e76b289b9e3a9893b9469094753d2bc"></a><!-- doxytag: member="BiblioIsisDb::example" ref="a8e76b289b9e3a9893b9469094753d2bc" args="()" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">BiblioIsisDb::example </td> + <td>(</td> + <td class="paramname"></td> + <td> ) </td> + <td></td> + </tr> + </table> +</div> +<div class="memdoc"> +<p>Return an example schema.</p> +<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="interfaceIsisDb.html#a857c10d90da64067efa17afb2f32edb6">IsisDb::example()</a> </dd></dl> + +<p>Implements <a class="el" href="interfaceIsisDb.html#a857c10d90da64067efa17afb2f32edb6">IsisDb</a>.</p> + +</div> +</div> +<a class="anchor" id="a73d5d998f9ab7e410c5f71f65e83948b"></a><!-- doxytag: member="BiblioIsisDb::has_subfields" ref="a73d5d998f9ab7e410c5f71f65e83948b" args="($key)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">BiblioIsisDb::has_subfields </td> + <td>(</td> + <td class="paramtype">$ </td> + <td class="paramname"> <em>key</em></td> + <td> ) </td> + <td></td> + </tr> + </table> +</div> +<div class="memdoc"> +<p>Checks whether a field has subfields.</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> </td><td>Field key.</td></tr> + </table> + </dd> +</dl> +<dl class="return"><dt><b>Returns:</b></dt><dd>True if has subfields, false otherwise. </dd></dl> + +</div> +</div> +<a class="anchor" id="aa86380f9e66ea8f175c50675d1fe0a88"></a><!-- doxytag: member="BiblioIsisDb::is_repetitive" ref="aa86380f9e66ea8f175c50675d1fe0a88" args="($field, $value)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">BiblioIsisDb::is_repetitive </td> + <td>(</td> + <td class="paramtype">$ </td> + <td class="paramname"> <em>field</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">$ </td> + <td class="paramname"> <em>value</em></td><td> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td><td></td> + </tr> + </table> +</div> +<div class="memdoc"> +<p>Deals with repetition.</p> +<p>As Biblio::Isis always return field values as arrays, we have to check the database schema to see if we want to convert then to a single value.</p> +<dl><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>$field</em> </td><td>Database field.</td></tr> + <tr><td valign="top"></td><td valign="top"><em>$value</em> </td><td>Data (with or without repetition).</td></tr> + </table> + </dd> +</dl> +<dl class="return"><dt><b>Returns:</b></dt><dd>True if repetitive, false otherwise. </dd></dl> + +</div> +</div> +<a class="anchor" id="a286fb16de5797785d28021068efca561"></a><!-- doxytag: member="BiblioIsisDb::logger" ref="a286fb16de5797785d28021068efca561" args="($message)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">BiblioIsisDb::logger </td> + <td>(</td> + <td class="paramtype">$ </td> + <td class="paramname"> <em>message</em></td> + <td> ) </td> + <td></td> + </tr> + </table> +</div> +<div class="memdoc"> +<p>Class logger.</p> +<dl><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>$message</em> </td><td>Log message. </td></tr> + </table> + </dd> +</dl> + +</div> +</div> +<a class="anchor" id="a808cdbc0d4c8f62a1465e74064f4422f"></a><!-- doxytag: member="BiblioIsisDb::read" ref="a808cdbc0d4c8f62a1465e74064f4422f" args="($id, $method= 'fetch')" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">BiblioIsisDb::read </td> + <td>(</td> + <td class="paramtype">$ </td> + <td class="paramname"> <em>id</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">$ </td> + <td class="paramname"> <em>method</em> = <code>'fetch'</code></td><td> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td><td></td> + </tr> + </table> +</div> +<div class="memdoc"> +<p>Read an entry.</p> +<dl><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>$id</em> </td><td>Record Id.</td></tr> + <tr><td valign="top"></td><td valign="top"><em>$method</em> </td><td>Database read method.</td></tr> + </table> + </dd> +</dl> +<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="interfaceIsisDb.html#a68335ec0db01ef03f0725621b38b5686">IsisDb::read()</a> </dd></dl> + +</div> +</div> +<a class="anchor" id="a04089d61ce04b18aa6a78c94ca02edb9"></a><!-- doxytag: member="BiblioIsisDb::repetition" ref="a04089d61ce04b18aa6a78c94ca02edb9" args="($key, $value)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">BiblioIsisDb::repetition </td> + <td>(</td> + <td class="paramtype">$ </td> + <td class="paramname"> <em>key</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">$ </td> + <td class="paramname"> <em>value</em></td><td> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td><td></td> + </tr> + </table> +</div> +<div class="memdoc"> +<p>Deals with repetition.</p> +<p>As Biblio::Isis always return field values as arrays, we have to check the database schema to see if we want to convert then to a single value. The current implementation is just a placeholder as no conversion is done.</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> </td><td>Database key.</td></tr> + <tr><td valign="top"></td><td valign="top"><em>$value</em> </td><td>Query field result.</td></tr> + </table> + </dd> +</dl> +<dl class="return"><dt><b>Returns:</b></dt><dd>The value according to the repetition config. </dd></dl> + +</div> +</div> +<a class="anchor" id="a450e26ae0b7f4967d8e25c9a3d023c75"></a><!-- doxytag: member="BiblioIsisDb::subfields" ref="a450e26ae0b7f4967d8e25c9a3d023c75" args="($name, $key, $method)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">BiblioIsisDb::subfields </td> + <td>(</td> + <td class="paramtype">$ </td> + <td class="paramname"> <em>name</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">$ </td> + <td class="paramname"> <em>key</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">$ </td> + <td class="paramname"> <em>method</em></td><td> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td><td></td> + </tr> + </table> +</div> +<div class="memdoc"> +<p>Makes subfield substitution in a dataset.</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</em> </td><td>Dataset.</td></tr> + <tr><td valign="top"></td><td valign="top"><em>$key</em> </td><td>Field key.</td></tr> + <tr><td valign="top"></td><td valign="top"><em>$method</em> </td><td>Database read method.</td></tr> + </table> + </dd> +</dl> +<dl class="return"><dt><b>Returns:</b></dt><dd>Data with processed subfields. </dd></dl> + +</div> +</div> +<a class="anchor" id="a2b08c6a7ba20f6f5eb07edb2b4a914c1"></a><!-- doxytag: member="BiblioIsisDb::subfields_from_fetch" ref="a2b08c6a7ba20f6f5eb07edb2b4a914c1" args="($name, $key)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">BiblioIsisDb::subfields_from_fetch </td> + <td>(</td> + <td class="paramtype">$ </td> + <td class="paramname"> <em>name</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">$ </td> + <td class="paramname"> <em>key</em></td><td> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td><td></td> + </tr> + </table> +</div> +<div class="memdoc"> +<p>Subfield handling for data read by 'from_fetch' method.</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</em> </td><td>Dataset.</td></tr> + <tr><td valign="top"></td><td valign="top"><em>$key</em> </td><td>Field key.</td></tr> + </table> + </dd> +</dl> +<dl class="return"><dt><b>Returns:</b></dt><dd>Data with processed subfields. </dd></dl> + +</div> +</div> +<a class="anchor" id="a8c6a0081c5296a6db520e98998502ef7"></a><!-- doxytag: member="BiblioIsisDb::subfields_from_to_hash" ref="a8c6a0081c5296a6db520e98998502ef7" args="($name, $key)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">BiblioIsisDb::subfields_from_to_hash </td> + <td>(</td> + <td class="paramtype">$ </td> + <td class="paramname"> <em>name</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">$ </td> + <td class="paramname"> <em>key</em></td><td> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td><td></td> + </tr> + </table> +</div> +<div class="memdoc"> +<p>Subfield handling for data read by 'to_hash' method. This method is not fully supported and therefore not recommended.</p> +<p>It does not deal very well when data has "main" fields and subfields (like "data1^adata2^bdata3") and doesn't deal with advanced configuration such as 'join_subfields'.</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</em> </td><td>Dataset.</td></tr> + <tr><td valign="top"></td><td valign="top"><em>$key</em> </td><td>Field key.</td></tr> + </table> + </dd> +</dl> +<dl class="return"><dt><b>Returns:</b></dt><dd>Data with processed subfields. </dd></dl> + +</div> +</div> +<a class="anchor" id="af0be305b211b96dcb4aeb8452c8331a9"></a><!-- doxytag: member="BiblioIsisDb::subfields_switch" ref="af0be305b211b96dcb4aeb8452c8331a9" args="($key, &$value)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">BiblioIsisDb::subfields_switch </td> + <td>(</td> + <td class="paramtype">$ </td> + <td class="paramname"> <em>key</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">&$ </td> + <td class="paramname"> <em>value</em></td><td> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td><td></td> + </tr> + </table> +</div> +<div class="memdoc"> +<p>Switch keys on subfields.</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> </td><td>Field key.</td></tr> + <tr><td valign="top"></td><td valign="top"><em>$value</em> </td><td>Dataset. </td></tr> + </table> + </dd> +</dl> + +</div> +</div> +<a class="anchor" id="a34483b463d81ba1d8031576b5735efbc"></a><!-- doxytag: member="BiblioIsisDb::tag" ref="a34483b463d81ba1d8031576b5735efbc" args="($results, $method= 'fetch')" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">BiblioIsisDb::tag </td> + <td>(</td> + <td class="paramtype">$ </td> + <td class="paramname"> <em>results</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">$ </td> + <td class="paramname"> <em>method</em> = <code>'fetch'</code></td><td> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td><td></td> + </tr> + </table> +</div> +<div class="memdoc"> +<p>Tag results of a db query.</p> +<p>This function converts the keys of query result from field numbers to names.</p> +<dl><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>$results</em> </td><td>Database query results.</td></tr> + <tr><td valign="top"></td><td valign="top"><em>$method</em> </td><td>Database read method.</td></tr> + </table> + </dd> +</dl> +<dl class="return"><dt><b>Returns:</b></dt><dd>Tagged database result. </dd></dl> + +</div> +</div> +<hr/><h2>Member Data Documentation</h2> +<a class="anchor" id="a978a9243ea53b1f2426115d7b4191b07"></a><!-- doxytag: member="BiblioIsisDb::$fdt" ref="a978a9243ea53b1f2426115d7b4191b07" args="" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">BiblioIsisDb::$fdt</td> + </tr> + </table> +</div> +<div class="memdoc"> +<p>Field description table. </p> + +</div> +</div> +<a class="anchor" id="ab9fb3b6f10d2734a198ca7802ee38c2d"></a><!-- doxytag: member="BiblioIsisDb::$format" ref="ab9fb3b6f10d2734a198ca7802ee38c2d" args="" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">BiblioIsisDb::$format</td> + </tr> + </table> +</div> +<div class="memdoc"> +<p>Database format, derived from $schema. </p> + +</div> +</div> +<a class="anchor" id="a67337d78af0fc21d0ff10471aa638c62"></a><!-- doxytag: member="BiblioIsisDb::$log" ref="a67337d78af0fc21d0ff10471aa638c62" args="" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">BiblioIsisDb::$log</td> + </tr> + </table> +</div> +<div class="memdoc"> +<p>Class action log. </p> + +</div> +</div> +<a class="anchor" id="a7eccfa964dcd1469a263340447c38143"></a><!-- doxytag: member="BiblioIsisDb::$perl" ref="a7eccfa964dcd1469a263340447c38143" args="" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">BiblioIsisDb::$perl</td> + </tr> + </table> +</div> +<div class="memdoc"> +<p>Class instance of a perl interpreter; </p> + +</div> +</div> +<hr/>The documentation for this class was generated from the following file:<ul> +<li>classes/backends/BiblioIsisDb.php</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"> </span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark"> </span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark"> </span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark"> </span>Variables</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 Fri Aug 20 15:38:19 2010 for Cinisis Database Reader by +<a href="http://www.doxygen.org/index.html"> +<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.6.3 </small></address> +</body> +</html> |