diff options
Diffstat (limited to 'doc/html/classIsis__Rec.html')
| -rw-r--r-- | doc/html/classIsis__Rec.html | 1223 |
1 files changed, 1223 insertions, 0 deletions
diff --git a/doc/html/classIsis__Rec.html b/doc/html/classIsis__Rec.html new file mode 100644 index 0000000..b70c47a --- /dev/null +++ b/doc/html/classIsis__Rec.html @@ -0,0 +1,1223 @@ +<!-- 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>IsisReader: Isis_Rec 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.1 --> +<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="namespaces.html"><span>Namespaces</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 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>Isis_Rec Class Reference</h1><!-- doxytag: class="Isis_Rec" --> +<p><a href="classIsis__Rec-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="classIsis__Rec.html#a843b24c9f8bc3c983c4ad18a4c6d5084">fmt</a> ($val, $fmt=ISIS_REC_MHL)</td></tr> +<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classIsis__Rec.html#a7d7c374fffde0ef375a0bbf491a3351a">Isis_Rec</a> ()</td></tr> +<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classIsis__Rec.html#a0c210032f044e4e47745ec83ab8c4db9">len</a> ()</td></tr> +<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classIsis__Rec.html#a4edad66517aeef9a7b5b1e91233a4171">fdt</a> (&$tag)</td></tr> +<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classIsis__Rec.html#ab53a78c36253b1b2785a0230c894be7d">res</a> ()</td></tr> +<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classIsis__Rec.html#a22e341f329a5fc094d080335ffc85480">get</a> ($tag)</td></tr> +<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classIsis__Rec.html#aad847c02614284611548db1b1823e670">v</a> ($tag=null, $fmt=null)</td></tr> +<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classIsis__Rec.html#ab757ca6826d4053cb7a4a57df8af3043">recs</a> ($db=null)</td></tr> +<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classIsis__Rec.html#a0ae71f43d31c780dcb3f517141121e06">h</a> ($tag=null, $fmt= '')</td></tr> +<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classIsis__Rec.html#a77facd8e3924726c22ef4ca74b563895">mhl</a> ($tag=null)</td></tr> +<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classIsis__Rec.html#ab12588fe60324def7c215e3b6b224734">append</a> ($tag, $val)</td></tr> +<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classIsis__Rec.html#abd94eb565a84bc659700b326116f7bb0">add</a> ($argv)</td></tr> +<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a2fbe3a60bc435ba86bb0e2bf05ffce77"></a><!-- doxytag: member="Isis_Rec::addglobals" ref="a2fbe3a60bc435ba86bb0e2bf05ffce77" args="()" --> + </td><td class="memItemRight" valign="bottom"><b>addglobals</b> ()</td></tr> +<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classIsis__Rec.html#a8a4802aff33fa040a4526f878d77cc4c">pack</a> ()</td></tr> +<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classIsis__Rec.html#a9e9989207dca4f70845b127011ad252f">rm</a> ($pos, $pack=FALSE)</td></tr> +<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classIsis__Rec.html#aa8568802a1d20b5fa41f3bdf1f6d3994">del</a> ($tag=null, $pack=FALSE)</td></tr> +<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classIsis__Rec.html#aa28d26f98e0b13ed748d937981e40de4">set</a> ($tag)</td></tr> +<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a65e6fa7bca0fe0bb0e6cb1dcca0aea62"></a><!-- doxytag: member="Isis_Rec::embed" ref="a65e6fa7bca0fe0bb0e6cb1dcca0aea62" args="($that)" --> + </td><td class="memItemRight" valign="bottom"><b>embed</b> ($that)</td></tr> +<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classIsis__Rec.html#a818daec5d31c24cb5d0b15dda6def053">toString</a> ($mode=ISIS_REC_TEXT)</td></tr> +<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classIsis__Rec.html#a7a836b039efeeac996645db5238152e6">parse</a> ($text, $repl=null)</td></tr> +<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classIsis__Rec.html#aa426ef5341a314555e121240287f1082">map</a> ($func=null)</td></tr> +<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classIsis__Rec.html#a843b24c9f8bc3c983c4ad18a4c6d5084">fmt</a> ($val, $fmt=ISIS_REC_MHL)</td></tr> +<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classIsis__Rec.html#a7d7c374fffde0ef375a0bbf491a3351a">Isis_Rec</a> ()</td></tr> +<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classIsis__Rec.html#a0c210032f044e4e47745ec83ab8c4db9">len</a> ()</td></tr> +<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classIsis__Rec.html#a4edad66517aeef9a7b5b1e91233a4171">fdt</a> (&$tag)</td></tr> +<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classIsis__Rec.html#ab53a78c36253b1b2785a0230c894be7d">res</a> ()</td></tr> +<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classIsis__Rec.html#a22e341f329a5fc094d080335ffc85480">get</a> ($tag)</td></tr> +<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classIsis__Rec.html#aad847c02614284611548db1b1823e670">v</a> ($tag=null, $fmt=null)</td></tr> +<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classIsis__Rec.html#a0ae71f43d31c780dcb3f517141121e06">h</a> ($tag=null, $fmt= '')</td></tr> +<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classIsis__Rec.html#a77facd8e3924726c22ef4ca74b563895">mhl</a> ($tag=null)</td></tr> +<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classIsis__Rec.html#ab12588fe60324def7c215e3b6b224734">append</a> ($tag, $val)</td></tr> +<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classIsis__Rec.html#abd94eb565a84bc659700b326116f7bb0">add</a> ($argv)</td></tr> +<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a2fbe3a60bc435ba86bb0e2bf05ffce77"></a><!-- doxytag: member="Isis_Rec::addglobals" ref="a2fbe3a60bc435ba86bb0e2bf05ffce77" args="()" --> + </td><td class="memItemRight" valign="bottom"><b>addglobals</b> ()</td></tr> +<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classIsis__Rec.html#a8a4802aff33fa040a4526f878d77cc4c">pack</a> ()</td></tr> +<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classIsis__Rec.html#a9e9989207dca4f70845b127011ad252f">rm</a> ($pos, $pack=FALSE)</td></tr> +<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classIsis__Rec.html#aa8568802a1d20b5fa41f3bdf1f6d3994">del</a> ($tag=null, $pack=FALSE)</td></tr> +<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classIsis__Rec.html#aa28d26f98e0b13ed748d937981e40de4">set</a> ($tag)</td></tr> +<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a2109b3401b377ec2c75d47a2a4cb0e2f"></a><!-- doxytag: member="Isis_Rec::embed" ref="a2109b3401b377ec2c75d47a2a4cb0e2f" args="($tag, $that)" --> + </td><td class="memItemRight" valign="bottom"><b>embed</b> ($tag, $that)</td></tr> +<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classIsis__Rec.html#a899d168bd9473b8764db5ada5015d465">toString</a> ($mode=ISIS_REC_BIN)</td></tr> +<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classIsis__Rec.html#a7a836b039efeeac996645db5238152e6">parse</a> ($text, $repl=null)</td></tr> +<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classIsis__Rec.html#aa426ef5341a314555e121240287f1082">map</a> ($func=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="classIsis__Rec.html#a901196734fc54128b773b6c6354c7d27">$db</a> = 0</td></tr> +<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classIsis__Rec.html#a10ff6088d0640d0570093897b8899cd0">$mfn</a> = 0</td></tr> +<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classIsis__Rec.html#a6722cea4ffb9d92a800afd2b18805fb7">$head</a> = ''</td></tr> +<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classIsis__Rec.html#af0822123d76deb5a8bab34977df55b48">$tag</a></td></tr> +<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ade5898b819cb7dad81d64413336a7c29"></a><!-- doxytag: member="Isis_Rec::$val" ref="ade5898b819cb7dad81d64413336a7c29" args="" --> + </td><td class="memItemRight" valign="bottom"><b>$val</b></td></tr> +<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classIsis__Rec.html#a75cf067689da98cfcea436030a18c3e5">$v</a> = null</td></tr> +<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classIsis__Rec.html#a1b479f528e680ecdea3ff839c7325bce">$holy</a> = 0</td></tr> +</table> +<hr/><h2>Member Function Documentation</h2> +<a class="anchor" id="abd94eb565a84bc659700b326116f7bb0"></a><!-- doxytag: member="Isis_Rec::add" ref="abd94eb565a84bc659700b326116f7bb0" args="($argv)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">Isis_Rec::add </td> + <td>(</td> + <td class="paramtype">$ </td> + <td class="paramname"> <em>argv</em></td> + <td> ) </td> + <td></td> + </tr> + </table> +</div> +<div class="memdoc"> +<p>add an array to the record. </p> +<dl><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>mixed</em> </td><td>$argv an array either as a single parameter or as a variable number of arguments. The array is processed as follows:</p> +<ul> +<li>if an item is an int, it is appended, with the following item as value.</li> +<li>if an item is an array, add is called recursively on this array</li> +<li>if an item is '-db' or '-mfn', the corresponding properties are set</li> +<li>if we have an fdt which maps the item to an int, the following item as value is added with the tag given by the fdt.</li> +<li>if an item is ISIS_REC_TEXT, the following item is parsed in text mode.</li> +<li>else the item is parsed in standard mode. </li> +</ul> +</td></tr> + </table> + </dd> +</dl> + +</div> +</div> +<a class="anchor" id="abd94eb565a84bc659700b326116f7bb0"></a><!-- doxytag: member="Isis_Rec::add" ref="abd94eb565a84bc659700b326116f7bb0" args="($argv)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">Isis_Rec::add </td> + <td>(</td> + <td class="paramtype">$ </td> + <td class="paramname"> <em>argv</em></td> + <td> ) </td> + <td></td> + </tr> + </table> +</div> +<div class="memdoc"> +<p>add an array to the record. </p> +<dl><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>mixed</em> </td><td>$argv an array either as a single parameter or as a variable number of arguments. The array is processed as follows:</p> +<ul> +<li>if an item is an int, it is appended, with the following item as value.</li> +<li>if an item is an array, add is called recursively on this array</li> +<li>if an item is '-db' or '-mfn', the corresponding properties are set</li> +<li>if we have an fdt which maps the item to an int, the following item as value is added with the tag given by the fdt.</li> +<li>if an item is ISIS_REC_TEXT, the following item is parsed in text mode.</li> +<li>else the item is parsed in standard mode. </li> +</ul> +</td></tr> + </table> + </dd> +</dl> + +</div> +</div> +<a class="anchor" id="ab12588fe60324def7c215e3b6b224734"></a><!-- doxytag: member="Isis_Rec::append" ref="ab12588fe60324def7c215e3b6b224734" args="($tag, $val)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">Isis_Rec::append </td> + <td>(</td> + <td class="paramtype">$ </td> + <td class="paramname"> <em>tag</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">$ </td> + <td class="paramname"> <em>val</em></td><td> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td><td></td> + </tr> + </table> +</div> +<div class="memdoc"> +<p>append a new field (tag-value-pair) to the end of the record. </p> +<dl><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>int</em> </td><td>$tag tag to use in the field. It is not enforced that tag is an integer. </td></tr> + <tr><td valign="top"></td><td valign="top"><em>string</em> </td><td>$val the new fields value. The string type is not enforced here. </td></tr> + </table> + </dd> +</dl> +<dl class="return"><dt><b>Returns:</b></dt><dd>the new value </dd></dl> + +</div> +</div> +<a class="anchor" id="ab12588fe60324def7c215e3b6b224734"></a><!-- doxytag: member="Isis_Rec::append" ref="ab12588fe60324def7c215e3b6b224734" args="($tag, $val)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">Isis_Rec::append </td> + <td>(</td> + <td class="paramtype">$ </td> + <td class="paramname"> <em>tag</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">$ </td> + <td class="paramname"> <em>val</em></td><td> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td><td></td> + </tr> + </table> +</div> +<div class="memdoc"> +<p>append a new field (tag-value-pair) to the end of the record. </p> +<dl><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>int</em> </td><td>$tag tag to use in the field. fdt is applied </td></tr> + <tr><td valign="top"></td><td valign="top"><em>string</em> </td><td>$val the new fields value. The string type is not enforced here. </td></tr> + </table> + </dd> +</dl> +<dl class="return"><dt><b>Returns:</b></dt><dd>the new value </dd></dl> + +</div> +</div> +<a class="anchor" id="aa8568802a1d20b5fa41f3bdf1f6d3994"></a><!-- doxytag: member="Isis_Rec::del" ref="aa8568802a1d20b5fa41f3bdf1f6d3994" args="($tag=null, $pack=FALSE)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">Isis_Rec::del </td> + <td>(</td> + <td class="paramtype">$ </td> + <td class="paramname"> <em>tag</em> = <code>null</code>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">$ </td> + <td class="paramname"> <em>pack</em> = <code>FALSE</code></td><td> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td><td></td> + </tr> + </table> +</div> +<div class="memdoc"> +<p>remove all fields or all with a given tag. </p> + +</div> +</div> +<a class="anchor" id="aa8568802a1d20b5fa41f3bdf1f6d3994"></a><!-- doxytag: member="Isis_Rec::del" ref="aa8568802a1d20b5fa41f3bdf1f6d3994" args="($tag=null, $pack=FALSE)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">Isis_Rec::del </td> + <td>(</td> + <td class="paramtype">$ </td> + <td class="paramname"> <em>tag</em> = <code>null</code>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">$ </td> + <td class="paramname"> <em>pack</em> = <code>FALSE</code></td><td> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td><td></td> + </tr> + </table> +</div> +<div class="memdoc"> +<p>remove all fields or all with a given tag. </p> + +</div> +</div> +<a class="anchor" id="a4edad66517aeef9a7b5b1e91233a4171"></a><!-- doxytag: member="Isis_Rec::fdt" ref="a4edad66517aeef9a7b5b1e91233a4171" args="(&$tag)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">Isis_Rec::fdt </td> + <td>(</td> + <td class="paramtype">&$ </td> + <td class="paramname"> <em>tag</em></td> + <td> ) </td> + <td></td> + </tr> + </table> +</div> +<div class="memdoc"> +<p>try to look up non-numeric tags in the fdt </p> + +</div> +</div> +<a class="anchor" id="a4edad66517aeef9a7b5b1e91233a4171"></a><!-- doxytag: member="Isis_Rec::fdt" ref="a4edad66517aeef9a7b5b1e91233a4171" args="(&$tag)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">Isis_Rec::fdt </td> + <td>(</td> + <td class="paramtype">&$ </td> + <td class="paramname"> <em>tag</em></td> + <td> ) </td> + <td></td> + </tr> + </table> +</div> +<div class="memdoc"> +<p>try to look up non-numeric tags in the fdt </p> + +</div> +</div> +<a class="anchor" id="a843b24c9f8bc3c983c4ad18a4c6d5084"></a><!-- doxytag: member="Isis_Rec::fmt" ref="a843b24c9f8bc3c983c4ad18a4c6d5084" args="($val, $fmt=ISIS_REC_MHL)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">Isis_Rec::fmt </td> + <td>(</td> + <td class="paramtype">$ </td> + <td class="paramname"> <em>val</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">$ </td> + <td class="paramname"> <em>fmt</em> = <code>ISIS_REC_MHL</code></td><td> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td><td></td> + </tr> + </table> +</div> +<div class="memdoc"> +<p>static function to format a value. maybe used as <a class="el" href="classIsis__Rec.html#a843b24c9f8bc3c983c4ad18a4c6d5084">Isis_Rec::fmt</a>. </p> +<dl><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>string</em> </td><td>$val a value to be formatted </td></tr> + <tr><td valign="top"></td><td valign="top"><em>string</em> </td><td>$fmt a format specification, defaults to 'MHL'</p> +<ul> +<li>if $fmt is null, the value is returned unchanged</li> +<li>if $fmt starts with '&' or '', that character is stripped and htmlspecialchars or urlencode, resp., is applied to the (each) value as last step</li> +<li>if $fmt starts with 'MHL' (the constant ISIS_REC_MHL), that is stripped and the classical MHL ISIS formatting applied to values (before & or % mangling, rarely needed with subfields)</li> +<li>if $fmt is (now) empty, the complete value is used</li> +<li>else we're going for subfields:</li> +<li>if $fmt starts with a hat, the hat is stripped an used as subfield delimiter (TAB otherwise)</li> +<li>if $fmt matches /^([^(]*)\((*)(\.\.(*))?/, the part from the first '(' on is stripped as occurence selector (note that an optional closing ')' and additional chars are ignored)</li> +<li>the (remaining) characters in $fmt are subfield names, '*' selects any subfield (including the initial unnamed, even if it's empty !), '' any without stripping subfield names</li> +<li>if there is a occurence or range selected, for every character in the $fmt the specified occurences are used (counted from 0). If either bound is empty, 0 is used. If a range is specified (.. given), an upper bound of 0 means up to end. By default, only the first occurence (0) is used. </li> +</ul> +</td></tr> + </table> + </dd> +</dl> +<dl class="return"><dt><b>Returns:</b></dt><dd>if there is only a single character (remaining) in $fmt, and only a single occurence selectedi (no ..), a string is returned. Else you've been asking for an array, and so an array is returned even if it contains only a single value. If more than one subfield name was specified or the '*', the names are used ('' for the initial). If a range is selected, the index is used (in addition). Fields are added by first looping over subfield names, then occurences. PHP may or may not loop the array in that order. Example: '^ab' gives keys 'a' and 'b', 'b(1..' gives keys '1','2'...m '^cab(..', gives 'c0', 'c1', ... 'a0', ... </dd></dl> + +</div> +</div> +<a class="anchor" id="a843b24c9f8bc3c983c4ad18a4c6d5084"></a><!-- doxytag: member="Isis_Rec::fmt" ref="a843b24c9f8bc3c983c4ad18a4c6d5084" args="($val, $fmt=ISIS_REC_MHL)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">Isis_Rec::fmt </td> + <td>(</td> + <td class="paramtype">$ </td> + <td class="paramname"> <em>val</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">$ </td> + <td class="paramname"> <em>fmt</em> = <code>ISIS_REC_MHL</code></td><td> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td><td></td> + </tr> + </table> +</div> +<div class="memdoc"> +<p>static function to format a value. maybe used as <a class="el" href="classIsis__Rec.html#a843b24c9f8bc3c983c4ad18a4c6d5084">Isis_Rec::fmt</a>. </p> +<dl><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>string</em> </td><td>$val a value to be formatted </td></tr> + <tr><td valign="top"></td><td valign="top"><em>string</em> </td><td>$fmt a format specification, defaults to 'MHL'</p> +<ul> +<li>if $fmt is null, the value is returned unchanged</li> +<li>if $fmt starts with '&' or '', that character is stripped and htmlspecialchars or urlencode, resp., is applied to the (each) value as last step</li> +<li>if $fmt starts with 'MHL' (the constant ISIS_REC_MHL), that is stripped and the classical MHL ISIS formatting applied to values (before & or % mangling, rarely needed with subfields)</li> +<li>if $fmt is (now) empty, the complete value is used</li> +<li>else we're going for subfields:</li> +<li>if $fmt starts with a hat, the hat is stripped an used as subfield delimiter (TAB otherwise)</li> +<li>if $fmt matches /^([^(]*)\((*)(\.\.(*))?/, the part from the first '(' on is stripped as occurence selector (note that an optional closing ')' and additional chars are ignored)</li> +<li>the (remaining) characters in $fmt are subfield names, '*' selects any subfield (including the initial unnamed, even if it's empty !), '' any without stripping subfield names</li> +<li>if there is a occurence or range selected, for every character in the $fmt the specified occurences are used (counted from 0). If either bound is empty, 0 is used. If a range is specified (.. given), an upper bound of 0 means up to end. By default, only the first occurence (0) is used. </li> +</ul> +</td></tr> + </table> + </dd> +</dl> +<dl class="return"><dt><b>Returns:</b></dt><dd>if there is only a single character (remaining) in $fmt, and only a single occurence selectedi (no ..), a string is returned. Else you've been asking for an array, and so an array is returned even if it contains only a single value. If more than one subfield name was specified or the '*', the names are used ('' for the initial). If a range is selected, the index is used (in addition). Fields are added by first looping over subfield names, then occurences. PHP may or may not loop the array in that order. Example: '^ab' gives keys 'a' and 'b', 'b(1..' gives keys '1','2'...m '^cab(..', gives 'c0', 'c1', ... 'a0', ... </dd></dl> + +</div> +</div> +<a class="anchor" id="a22e341f329a5fc094d080335ffc85480"></a><!-- doxytag: member="Isis_Rec::get" ref="a22e341f329a5fc094d080335ffc85480" args="($tag)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">Isis_Rec::get </td> + <td>(</td> + <td class="paramtype">$ </td> + <td class="paramname"> <em>tag</em></td> + <td> ) </td> + <td></td> + </tr> + </table> +</div> +<div class="memdoc"> +<p>get all values for tag as array </p> + +</div> +</div> +<a class="anchor" id="a22e341f329a5fc094d080335ffc85480"></a><!-- doxytag: member="Isis_Rec::get" ref="a22e341f329a5fc094d080335ffc85480" args="($tag)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">Isis_Rec::get </td> + <td>(</td> + <td class="paramtype">$ </td> + <td class="paramname"> <em>tag</em></td> + <td> ) </td> + <td></td> + </tr> + </table> +</div> +<div class="memdoc"> +<p>get all values for tag as array </p> + +</div> +</div> +<a class="anchor" id="a0ae71f43d31c780dcb3f517141121e06"></a><!-- doxytag: member="Isis_Rec::h" ref="a0ae71f43d31c780dcb3f517141121e06" args="($tag=null, $fmt= '')" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">Isis_Rec::h </td> + <td>(</td> + <td class="paramtype">$ </td> + <td class="paramname"> <em>tag</em> = <code>null</code>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">$ </td> + <td class="paramname"> <em>fmt</em> = <code>''</code></td><td> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td><td></td> + </tr> + </table> +</div> +<div class="memdoc"> +<p>same as v($tag,'&'.$fmt) </p> + +</div> +</div> +<a class="anchor" id="a0ae71f43d31c780dcb3f517141121e06"></a><!-- doxytag: member="Isis_Rec::h" ref="a0ae71f43d31c780dcb3f517141121e06" args="($tag=null, $fmt= '')" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">Isis_Rec::h </td> + <td>(</td> + <td class="paramtype">$ </td> + <td class="paramname"> <em>tag</em> = <code>null</code>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">$ </td> + <td class="paramname"> <em>fmt</em> = <code>''</code></td><td> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td><td></td> + </tr> + </table> +</div> +<div class="memdoc"> +<p>same as v($tag,'&'.$fmt) </p> + +</div> +</div> +<a class="anchor" id="a7d7c374fffde0ef375a0bbf491a3351a"></a><!-- doxytag: member="Isis_Rec::Isis_Rec" ref="a7d7c374fffde0ef375a0bbf491a3351a" args="()" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">Isis_Rec::Isis_Rec </td> + <td>(</td> + <td class="paramname"></td> + <td> ) </td> + <td></td> + </tr> + </table> +</div> +<div class="memdoc"> +<p>create an ISIS record. </p> +<dl class="return"><dt><b>Returns:</b></dt><dd>object <a class="el" href="classIsis__Rec.html">Isis_Rec</a> a new ISIS record </dd></dl> + +</div> +</div> +<a class="anchor" id="a7d7c374fffde0ef375a0bbf491a3351a"></a><!-- doxytag: member="Isis_Rec::Isis_Rec" ref="a7d7c374fffde0ef375a0bbf491a3351a" args="()" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">Isis_Rec::Isis_Rec </td> + <td>(</td> + <td class="paramname"></td> + <td> ) </td> + <td></td> + </tr> + </table> +</div> +<div class="memdoc"> +<p>create an ISIS record. </p> +<dl class="return"><dt><b>Returns:</b></dt><dd>object <a class="el" href="classIsis__Rec.html">Isis_Rec</a> a new ISIS record </dd></dl> + +</div> +</div> +<a class="anchor" id="a0c210032f044e4e47745ec83ab8c4db9"></a><!-- doxytag: member="Isis_Rec::len" ref="a0c210032f044e4e47745ec83ab8c4db9" args="()" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">Isis_Rec::len </td> + <td>(</td> + <td class="paramname"></td> + <td> ) </td> + <td></td> + </tr> + </table> +</div> +<div class="memdoc"> +<dl class="return"><dt><b>Returns:</b></dt><dd>the number of fields </dd></dl> + +</div> +</div> +<a class="anchor" id="a0c210032f044e4e47745ec83ab8c4db9"></a><!-- doxytag: member="Isis_Rec::len" ref="a0c210032f044e4e47745ec83ab8c4db9" args="()" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">Isis_Rec::len </td> + <td>(</td> + <td class="paramname"></td> + <td> ) </td> + <td></td> + </tr> + </table> +</div> +<div class="memdoc"> +<dl class="return"><dt><b>Returns:</b></dt><dd>the number of fields </dd></dl> + +</div> +</div> +<a class="anchor" id="aa426ef5341a314555e121240287f1082"></a><!-- doxytag: member="Isis_Rec::map" ref="aa426ef5341a314555e121240287f1082" args="($func=null)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">Isis_Rec::map </td> + <td>(</td> + <td class="paramtype">$ </td> + <td class="paramname"> <em>func</em> = <code>null</code></td> + <td> ) </td> + <td></td> + </tr> + </table> +</div> +<div class="memdoc"> +<p>return the "data fork" of this record by mapping a function to tags and values in parallel. </p> +<dl><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>function</em> </td><td>$func defaults to null, resulting in an array of fields, each an array [0] => $tag, [1] => $val. </td></tr> + </table> + </dd> +</dl> +<dl class="return"><dt><b>Returns:</b></dt><dd>a new array as of array_map </dd></dl> + +</div> +</div> +<a class="anchor" id="aa426ef5341a314555e121240287f1082"></a><!-- doxytag: member="Isis_Rec::map" ref="aa426ef5341a314555e121240287f1082" args="($func=null)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">Isis_Rec::map </td> + <td>(</td> + <td class="paramtype">$ </td> + <td class="paramname"> <em>func</em> = <code>null</code></td> + <td> ) </td> + <td></td> + </tr> + </table> +</div> +<div class="memdoc"> +<p>return the "data fork" of this record by mapping a function to tags and values in parallel. </p> +<dl><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>function</em> </td><td>$func defaults to null, resulting in an array of fields, each an array [0] => $tag, [1] => $val. </td></tr> + </table> + </dd> +</dl> +<dl class="return"><dt><b>Returns:</b></dt><dd>a new array as of array_map </dd></dl> + +</div> +</div> +<a class="anchor" id="a77facd8e3924726c22ef4ca74b563895"></a><!-- doxytag: member="Isis_Rec::mhl" ref="a77facd8e3924726c22ef4ca74b563895" args="($tag=null)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">Isis_Rec::mhl </td> + <td>(</td> + <td class="paramtype">$ </td> + <td class="paramname"> <em>tag</em> = <code>null</code></td> + <td> ) </td> + <td></td> + </tr> + </table> +</div> +<div class="memdoc"> +<p>same as v($tag,'&MHL') </p> + +</div> +</div> +<a class="anchor" id="a77facd8e3924726c22ef4ca74b563895"></a><!-- doxytag: member="Isis_Rec::mhl" ref="a77facd8e3924726c22ef4ca74b563895" args="($tag=null)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">Isis_Rec::mhl </td> + <td>(</td> + <td class="paramtype">$ </td> + <td class="paramname"> <em>tag</em> = <code>null</code></td> + <td> ) </td> + <td></td> + </tr> + </table> +</div> +<div class="memdoc"> +<p>same as v($tag,'&MHL') </p> + +</div> +</div> +<a class="anchor" id="a8a4802aff33fa040a4526f878d77cc4c"></a><!-- doxytag: member="Isis_Rec::pack" ref="a8a4802aff33fa040a4526f878d77cc4c" args="()" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">Isis_Rec::pack </td> + <td>(</td> + <td class="paramname"></td> + <td> ) </td> + <td></td> + </tr> + </table> +</div> +<div class="memdoc"> +<p>recompact after unsetting </p> + +</div> +</div> +<a class="anchor" id="a8a4802aff33fa040a4526f878d77cc4c"></a><!-- doxytag: member="Isis_Rec::pack" ref="a8a4802aff33fa040a4526f878d77cc4c" args="()" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">Isis_Rec::pack </td> + <td>(</td> + <td class="paramname"></td> + <td> ) </td> + <td></td> + </tr> + </table> +</div> +<div class="memdoc"> +<p>recompact after unsetting </p> + +</div> +</div> +<a class="anchor" id="a7a836b039efeeac996645db5238152e6"></a><!-- doxytag: member="Isis_Rec::parse" ref="a7a836b039efeeac996645db5238152e6" args="($text, $repl=null)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">Isis_Rec::parse </td> + <td>(</td> + <td class="paramtype">$ </td> + <td class="paramname"> <em>text</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">$ </td> + <td class="paramname"> <em>repl</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>parse text as record fields to add. For each non-empty line, initial digits are used as tag (empty == 0), an optional following tab is skipped, and the rest used as value, after replacing $repl, if given, with newlines. If the line starts with a tab and the record is not empty, a newline and the value are appended to the last field, else a new field is appended to the record. </p> +<dl><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>string</em> </td><td>$repl string to be converted back to newlines. use ISIS_REC_TEXT, if you know text is from toString(ISIS_REC_TEXT) </td></tr> + </table> + </dd> +</dl> +<dl class="return"><dt><b>Returns:</b></dt><dd>number of fields added </dd></dl> + +</div> +</div> +<a class="anchor" id="a7a836b039efeeac996645db5238152e6"></a><!-- doxytag: member="Isis_Rec::parse" ref="a7a836b039efeeac996645db5238152e6" args="($text, $repl=null)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">Isis_Rec::parse </td> + <td>(</td> + <td class="paramtype">$ </td> + <td class="paramname"> <em>text</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">$ </td> + <td class="paramname"> <em>repl</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>parse text as record fields to add. For each non-empty line, initial digits are used as tag (empty == 0), an optional following tab is skipped, and the rest used as value, after replacing $repl, if given, with newlines. If the line starts with a tab and the record is not empty, a newline and the value are appended to the last field, else a new field is appended to the record. </p> +<dl><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>string</em> </td><td>$repl string to be converted back to newlines. use ISIS_REC_TEXT, if you know text is from toString(ISIS_REC_TEXT) </td></tr> + </table> + </dd> +</dl> +<dl class="return"><dt><b>Returns:</b></dt><dd>number of fields added </dd></dl> + +</div> +</div> +<a class="anchor" id="ab757ca6826d4053cb7a4a57df8af3043"></a><!-- doxytag: member="Isis_Rec::recs" ref="ab757ca6826d4053cb7a4a57df8af3043" args="($db=null)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">Isis_Rec::recs </td> + <td>(</td> + <td class="paramtype">$ </td> + <td class="paramname"> <em>db</em> = <code>null</code></td> + <td> ) </td> + <td></td> + </tr> + </table> +</div> +<div class="memdoc"> +<p>return an array of subrecords </p> + +</div> +</div> +<a class="anchor" id="ab53a78c36253b1b2785a0230c894be7d"></a><!-- doxytag: member="Isis_Rec::res" ref="ab53a78c36253b1b2785a0230c894be7d" args="()" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">Isis_Rec::res </td> + <td>(</td> + <td class="paramname"></td> + <td> ) </td> + <td></td> + </tr> + </table> +</div> +<div class="memdoc"> +<p>reset tag and val array pointers </p> + +</div> +</div> +<a class="anchor" id="ab53a78c36253b1b2785a0230c894be7d"></a><!-- doxytag: member="Isis_Rec::res" ref="ab53a78c36253b1b2785a0230c894be7d" args="()" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">Isis_Rec::res </td> + <td>(</td> + <td class="paramname"></td> + <td> ) </td> + <td></td> + </tr> + </table> +</div> +<div class="memdoc"> +<p>reset tag and val array pointers </p> + +</div> +</div> +<a class="anchor" id="a9e9989207dca4f70845b127011ad252f"></a><!-- doxytag: member="Isis_Rec::rm" ref="a9e9989207dca4f70845b127011ad252f" args="($pos, $pack=FALSE)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">Isis_Rec::rm </td> + <td>(</td> + <td class="paramtype">$ </td> + <td class="paramname"> <em>pos</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">$ </td> + <td class="paramname"> <em>pack</em> = <code>FALSE</code></td><td> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td><td></td> + </tr> + </table> +</div> +<div class="memdoc"> +<p>remove a field at given pos, poking a hole in the field list. </p> + +</div> +</div> +<a class="anchor" id="a9e9989207dca4f70845b127011ad252f"></a><!-- doxytag: member="Isis_Rec::rm" ref="a9e9989207dca4f70845b127011ad252f" args="($pos, $pack=FALSE)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">Isis_Rec::rm </td> + <td>(</td> + <td class="paramtype">$ </td> + <td class="paramname"> <em>pos</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">$ </td> + <td class="paramname"> <em>pack</em> = <code>FALSE</code></td><td> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td><td></td> + </tr> + </table> +</div> +<div class="memdoc"> +<p>remove a field at given pos, poking a hole in the field list. </p> + +</div> +</div> +<a class="anchor" id="aa28d26f98e0b13ed748d937981e40de4"></a><!-- doxytag: member="Isis_Rec::set" ref="aa28d26f98e0b13ed748d937981e40de4" args="($tag)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">Isis_Rec::set </td> + <td>(</td> + <td class="paramtype">$ </td> + <td class="paramname"> <em>tag</em></td> + <td> ) </td> + <td></td> + </tr> + </table> +</div> +<div class="memdoc"> +<p>set fields with tag to values. set( 42, 'foo', 'bar', 'baz' ) will change the first three occurences of 42 to 'foo', 'bar' and 'baz', resp.</p> +<ul> +<li>if there are less than three occurences, the remaining values are appended</li> +<li>if there are more than three occurences, the remaining occurences are deleted</li> +<li>if a value is the integer 0, processing stops (i.e. remaining occurences are left unchanged)</li> +<li>if a value is a positive integer n, processing skips n occurences (letting them unchanged)</li> +<li>if a value is an array, it's elements are used (it is flattened out non-recursively) <dl><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>mixed</em> </td><td>$tag tag by int or name </td></tr> + <tr><td valign="top"></td><td valign="top"><em>mixed</em> </td><td>values... variable number of values </td></tr> + </table> + </dd> +</dl> +</li> +</ul> + +</div> +</div> +<a class="anchor" id="aa28d26f98e0b13ed748d937981e40de4"></a><!-- doxytag: member="Isis_Rec::set" ref="aa28d26f98e0b13ed748d937981e40de4" args="($tag)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">Isis_Rec::set </td> + <td>(</td> + <td class="paramtype">$ </td> + <td class="paramname"> <em>tag</em></td> + <td> ) </td> + <td></td> + </tr> + </table> +</div> +<div class="memdoc"> +<p>set fields with tag to values. set( 42, 'foo', 'bar', 'baz' ) will change the first three occurences of 42 to 'foo', 'bar' and 'baz', resp.</p> +<ul> +<li>if there are less than three occurences, the remaining values are appended</li> +<li>if there are more than three occurences, the remaining occurences are deleted</li> +<li>if a value is the integer 0, processing stops (i.e. remaining occurences are left unchanged)</li> +<li>if a value is a positive integer n, processing skips n occurences (letting them unchanged)</li> +<li>if a value is an array, it's elements are used (it is flattened out non-recursively) <dl><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>mixed</em> </td><td>$tag tag by int or name </td></tr> + <tr><td valign="top"></td><td valign="top"><em>mixed</em> </td><td>values... variable number of values </td></tr> + </table> + </dd> +</dl> +</li> +</ul> + +</div> +</div> +<a class="anchor" id="a899d168bd9473b8764db5ada5015d465"></a><!-- doxytag: member="Isis_Rec::toString" ref="a899d168bd9473b8764db5ada5015d465" args="($mode=ISIS_REC_BIN)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">Isis_Rec::toString </td> + <td>(</td> + <td class="paramtype">$ </td> + <td class="paramname"> <em>mode</em> = <code>ISIS_REC_BIN</code></td> + <td> ) </td> + <td></td> + </tr> + </table> +</div> +<div class="memdoc"> +<p>serialize record to a string. After each field, including the last one, a newline is added. </p> +<dl><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>string</em> </td><td>$mode replacement value for newlines. suggested is one of the predefined constants. defaults to ISIS_REC_BIN. </td></tr> + </table> + </dd> +</dl> +<dl class="return"><dt><b>Returns:</b></dt><dd>the string representation of the record </dd></dl> + +</div> +</div> +<a class="anchor" id="a818daec5d31c24cb5d0b15dda6def053"></a><!-- doxytag: member="Isis_Rec::toString" ref="a818daec5d31c24cb5d0b15dda6def053" args="($mode=ISIS_REC_TEXT)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">Isis_Rec::toString </td> + <td>(</td> + <td class="paramtype">$ </td> + <td class="paramname"> <em>mode</em> = <code>ISIS_REC_TEXT</code></td> + <td> ) </td> + <td></td> + </tr> + </table> +</div> +<div class="memdoc"> +<p>serialize record to a string. After each field, including the last one, a newline is added. </p> +<dl><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>string</em> </td><td>$mode replacement value for newlines. suggested is one of the predefined constants. defaults to ISIS_REC_TEXT. </td></tr> + </table> + </dd> +</dl> +<dl class="return"><dt><b>Returns:</b></dt><dd>the string representation of the record </dd></dl> + +</div> +</div> +<a class="anchor" id="aad847c02614284611548db1b1823e670"></a><!-- doxytag: member="Isis_Rec::v" ref="aad847c02614284611548db1b1823e670" args="($tag=null, $fmt=null)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">Isis_Rec::v </td> + <td>(</td> + <td class="paramtype">$ </td> + <td class="paramname"> <em>tag</em> = <code>null</code>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">$ </td> + <td class="paramname"> <em>fmt</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>v is for value -- get the value of the next occurence of tag in the record. The position is reset by res or when using v with a different tag. </p> +<dl><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>mixed</em> </td><td>$fmt format to apply</p> +<ul> +<li>if $fmt is null (or the value is null), the value is returned unmodified</li> +<li>if $fmt is a string, the value is formatted by <a class="el" href="classIsis__Rec.html#a843b24c9f8bc3c983c4ad18a4c6d5084">Isis_Rec::fmt</a> (returns string or array).</li> +<li>if $fmt is 0, a new <a class="el" href="classIsis__Rec.html">Isis_Rec</a> is used as $fmt</li> +<li>if $fmt is an object, it is assumed to be a record, into which a subrecord (as of embed) is to be extracted. This also advances the loop position to after the child fields. The record is returned.</li> +<li>other values of $fmt are reserved for future extensions and currently return null. </li> +</ul> +</td></tr> + </table> + </dd> +</dl> + +</div> +</div> +<a class="anchor" id="aad847c02614284611548db1b1823e670"></a><!-- doxytag: member="Isis_Rec::v" ref="aad847c02614284611548db1b1823e670" args="($tag=null, $fmt=null)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">Isis_Rec::v </td> + <td>(</td> + <td class="paramtype">$ </td> + <td class="paramname"> <em>tag</em> = <code>null</code>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">$ </td> + <td class="paramname"> <em>fmt</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>v is for value -- get the value of the next occurence of tag in the record. The position is reset by res or when using v with a different tag. </p> +<dl><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>mixed</em> </td><td>$fmt format to apply</p> +<ul> +<li>if $fmt is null (or the value is null), the value is returned unmodified</li> +<li>if $fmt is a string, the value is formatted by <a class="el" href="classIsis__Rec.html#a843b24c9f8bc3c983c4ad18a4c6d5084">Isis_Rec::fmt</a> (returns string or array).</li> +<li>other values of $fmt are reserved for future extensions and currently return null. </li> +</ul> +</td></tr> + </table> + </dd> +</dl> + +</div> +</div> +<hr/><h2>Member Data Documentation</h2> +<a class="anchor" id="a901196734fc54128b773b6c6354c7d27"></a><!-- doxytag: member="Isis_Rec::$db" ref="a901196734fc54128b773b6c6354c7d27" args="" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">object Isis_Rec::$db = 0</td> + </tr> + </table> +</div> +<div class="memdoc"> +<p>The associated database, if any. Better be an <a class="el" href="classIsis__Db.html">Isis_Db</a>. </p> + +</div> +</div> +<a class="anchor" id="a6722cea4ffb9d92a800afd2b18805fb7"></a><!-- doxytag: member="Isis_Rec::$head" ref="a6722cea4ffb9d92a800afd2b18805fb7" args="" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">Isis_Rec::$head = ''</td> + </tr> + </table> +</div> +<div class="memdoc"> +<p>The record's header. For data records, this is mfn[][], where leader can any be any MARC leader data. </p> + +</div> +</div> +<a class="anchor" id="a1b479f528e680ecdea3ff839c7325bce"></a><!-- doxytag: member="Isis_Rec::$holy" ref="a1b479f528e680ecdea3ff839c7325bce" args="" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">Isis_Rec::$holy = 0</td> + </tr> + </table> +</div> +<div class="memdoc"> +<p>number of holes in record </p> + +</div> +</div> +<a class="anchor" id="a10ff6088d0640d0570093897b8899cd0"></a><!-- doxytag: member="Isis_Rec::$mfn" ref="a10ff6088d0640d0570093897b8899cd0" args="" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">int Isis_Rec::$mfn = 0</td> + </tr> + </table> +</div> +<div class="memdoc"> +<p>The record's MFN ("master file number", a.k.a. rowid). A value of 0 means the record did not yet have a number in it's db, a write will be handled as insert.</p> +<p>The records MFN ("master file number", a.k.a. rowid). A value of 0 means the record did not yet have a number in it's db, a write will be handled as insert. </p> + +</div> +</div> +<a class="anchor" id="af0822123d76deb5a8bab34977df55b48"></a><!-- doxytag: member="Isis_Rec::$tag" ref="af0822123d76deb5a8bab34977df55b48" args="" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">array Isis_Rec::$tag</td> + </tr> + </table> +</div> +<div class="memdoc"> +<p>Array of tags for the record. Keys and values better be integers (others might be ignored or yield unexpected results in some contexts). The count of the tag array is taken as length of the record. The tag array may have holes (unassigned ints) if unset is used.</p> +<p>Array of values for the record. Values better be strings (i.e. will be forced to strings by some operations). </p> + +</div> +</div> +<a class="anchor" id="a75cf067689da98cfcea436030a18c3e5"></a><!-- doxytag: member="Isis_Rec::$v" ref="a75cf067689da98cfcea436030a18c3e5" args="" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">Isis_Rec::$v = null</td> + </tr> + </table> +</div> +<div class="memdoc"> +<p>last tag accessed using function v </p> + +</div> +</div> +<hr/>The documentation for this class was generated from the following files:<ul> +<li>contrib/malete/php/Isis/Rec.php</li> +<li>contrib/openisis/php/Isis/Rec.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>Namespaces</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark"> </span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><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 size="1"/><address style="text-align: right;"><small>Generated on Tue Mar 30 14:47:15 2010 for IsisReader by +<a href="http://www.doxygen.org/index.html"> +<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.6.1 </small></address> +</body> +</html> |