diff options
Diffstat (limited to 'doc/html/classSpyc.html')
| -rw-r--r-- | doc/html/classSpyc.html | 294 |
1 files changed, 294 insertions, 0 deletions
diff --git a/doc/html/classSpyc.html b/doc/html/classSpyc.html new file mode 100644 index 0000000..8914c12 --- /dev/null +++ b/doc/html/classSpyc.html @@ -0,0 +1,294 @@ +<!-- 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: Spyc 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>Spyc Class Reference</h1><!-- doxytag: class="Spyc" --> +<p><a href="classSpyc-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="classSpyc.html#a0980981b6dbc7fe5394f24811809d830">load</a> ($input)</td></tr> +<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classSpyc.html#a9e2554e7fd8ab44c6018656855643410">loadFile</a> ($file)</td></tr> +<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classSpyc.html#a69045b2f05093364b6e722f1ddb38822">dump</a> ($array, $indent=false, $wordwrap=false)</td></tr> +<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a7d945badd39cfde27b5e36ddfeb100e4"></a><!-- doxytag: member="Spyc::revertLiteralPlaceHolder" ref="a7d945badd39cfde27b5e36ddfeb100e4" args="($lineArray, $literalBlock)" --> + </td><td class="memItemRight" valign="bottom"><b>revertLiteralPlaceHolder</b> ($lineArray, $literalBlock)</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="classSpyc.html#a867396b82fd2a392d2187441ca788e13">YAMLLoad</a> ($input)</td></tr> +<tr><td class="memItemLeft" align="right" valign="top">static </td><td class="memItemRight" valign="bottom"><a class="el" href="classSpyc.html#acc3c5661ad0891034e8035c3a00834bf">YAMLLoadString</a> ($input)</td></tr> +<tr><td class="memItemLeft" align="right" valign="top">static </td><td class="memItemRight" valign="bottom"><a class="el" href="classSpyc.html#af7349c4e5f95f03ab3c4482e2403cb48">YAMLDump</a> ($array, $indent=false, $wordwrap=false)</td></tr> +<tr><td colspan="2"><h2>Public Attributes</h2></td></tr> +<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a93cae742d53c82125484d61ee7b97932"></a><!-- doxytag: member="Spyc::$setting_dump_force_quotes" ref="a93cae742d53c82125484d61ee7b97932" args="" --> + </td><td class="memItemRight" valign="bottom"><b>$setting_dump_force_quotes</b> = false</td></tr> +<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a415178eb916c804b2ca988803b8ba8d3"></a><!-- doxytag: member="Spyc::$setting_use_syck_is_possible" ref="a415178eb916c804b2ca988803b8ba8d3" args="" --> + </td><td class="memItemRight" valign="bottom"><b>$setting_use_syck_is_possible</b> = false</td></tr> +<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ae3346d9acb186cf1a25a12dee074f9e8"></a><!-- doxytag: member="Spyc::$_nodeId" ref="ae3346d9acb186cf1a25a12dee074f9e8" args="" --> + </td><td class="memItemRight" valign="bottom"><b>$_nodeId</b></td></tr> +</table> +<hr/><h2>Member Function Documentation</h2> +<a class="anchor" id="a69045b2f05093364b6e722f1ddb38822"></a><!-- doxytag: member="Spyc::dump" ref="a69045b2f05093364b6e722f1ddb38822" args="($array, $indent=false, $wordwrap=false)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">Spyc::dump </td> + <td>(</td> + <td class="paramtype">$ </td> + <td class="paramname"> <em>array</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">$ </td> + <td class="paramname"> <em>indent</em> = <code>false</code>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">$ </td> + <td class="paramname"> <em>wordwrap</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>Dump PHP array to YAML</p> +<p>The dump method, when supplied with an array, will do its best to convert the array into friendly YAML. Pretty simple. Feel free to save the returned string as tasteful.yaml and pass it around.</p> +<p>Oh, and you can decide how big the indent is and what the wordwrap for folding is. Pretty cool -- just pass in 'false' for either if you want to use the default.</p> +<p>Indent's default is 2 spaces, wordwrap's default is 40 characters. And you can turn off wordwrap by passing in 0.</p> +<p>public </p> +<dl class="return"><dt><b>Returns:</b></dt><dd>string </dd></dl> +<dl><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>array</em> </td><td>$array PHP array </td></tr> + <tr><td valign="top"></td><td valign="top"><em>int</em> </td><td>$indent Pass in false to use the default, which is 2 </td></tr> + <tr><td valign="top"></td><td valign="top"><em>int</em> </td><td>$wordwrap Pass in 0 for no wordwrap, false for default (40) </td></tr> + </table> + </dd> +</dl> + +</div> +</div> +<a class="anchor" id="a0980981b6dbc7fe5394f24811809d830"></a><!-- doxytag: member="Spyc::load" ref="a0980981b6dbc7fe5394f24811809d830" args="($input)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">Spyc::load </td> + <td>(</td> + <td class="paramtype">$ </td> + <td class="paramname"> <em>input</em></td> + <td> ) </td> + <td></td> + </tr> + </table> +</div> +<div class="memdoc"> +<p>Load a valid YAML string to <a class="el" href="classSpyc.html">Spyc</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>$input </td></tr> + </table> + </dd> +</dl> +<dl class="return"><dt><b>Returns:</b></dt><dd>array </dd></dl> + +</div> +</div> +<a class="anchor" id="a9e2554e7fd8ab44c6018656855643410"></a><!-- doxytag: member="Spyc::loadFile" ref="a9e2554e7fd8ab44c6018656855643410" args="($file)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">Spyc::loadFile </td> + <td>(</td> + <td class="paramtype">$ </td> + <td class="paramname"> <em>file</em></td> + <td> ) </td> + <td></td> + </tr> + </table> +</div> +<div class="memdoc"> +<p>Load a valid YAML file to <a class="el" href="classSpyc.html">Spyc</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>$file </td></tr> + </table> + </dd> +</dl> +<dl class="return"><dt><b>Returns:</b></dt><dd>array </dd></dl> + +</div> +</div> +<a class="anchor" id="af7349c4e5f95f03ab3c4482e2403cb48"></a><!-- doxytag: member="Spyc::YAMLDump" ref="af7349c4e5f95f03ab3c4482e2403cb48" args="($array, $indent=false, $wordwrap=false)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">static Spyc::YAMLDump </td> + <td>(</td> + <td class="paramtype">$ </td> + <td class="paramname"> <em>array</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">$ </td> + <td class="paramname"> <em>indent</em> = <code>false</code>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">$ </td> + <td class="paramname"> <em>wordwrap</em> = <code>false</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>Dump YAML from PHP array statically</p> +<p>The dump method, when supplied with an array, will do its best to convert the array into friendly YAML. Pretty simple. Feel free to save the returned string as nothing.yaml and pass it around.</p> +<p>Oh, and you can decide how big the indent is and what the wordwrap for folding is. Pretty cool -- just pass in 'false' for either if you want to use the default.</p> +<p>Indent's default is 2 spaces, wordwrap's default is 40 characters. And you can turn off wordwrap by passing in 0.</p> +<p>public </p> +<dl class="return"><dt><b>Returns:</b></dt><dd>string </dd></dl> +<dl><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>array</em> </td><td>$array PHP array </td></tr> + <tr><td valign="top"></td><td valign="top"><em>int</em> </td><td>$indent Pass in false to use the default, which is 2 </td></tr> + <tr><td valign="top"></td><td valign="top"><em>int</em> </td><td>$wordwrap Pass in 0 for no wordwrap, false for default (40) </td></tr> + </table> + </dd> +</dl> + +</div> +</div> +<a class="anchor" id="a867396b82fd2a392d2187441ca788e13"></a><!-- doxytag: member="Spyc::YAMLLoad" ref="a867396b82fd2a392d2187441ca788e13" args="($input)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">static Spyc::YAMLLoad </td> + <td>(</td> + <td class="paramtype">$ </td> + <td class="paramname"> <em>input</em></td> + <td> ) </td> + <td><code> [static]</code></td> + </tr> + </table> +</div> +<div class="memdoc"> +<p>Load YAML into a PHP array statically</p> +<p>The load method, when supplied with a YAML stream (string or file), will do its best to convert YAML in a file into a PHP array. Pretty simple. Usage: <code> $array = <a class="el" href="classSpyc.html#a867396b82fd2a392d2187441ca788e13">Spyc::YAMLLoad</a>('lucky.yaml'); print_r($array); </code> public </p> +<dl class="return"><dt><b>Returns:</b></dt><dd>array </dd></dl> +<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>$input Path of YAML file or string containing YAML </td></tr> + </table> + </dd> +</dl> + +</div> +</div> +<a class="anchor" id="acc3c5661ad0891034e8035c3a00834bf"></a><!-- doxytag: member="Spyc::YAMLLoadString" ref="acc3c5661ad0891034e8035c3a00834bf" args="($input)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">static Spyc::YAMLLoadString </td> + <td>(</td> + <td class="paramtype">$ </td> + <td class="paramname"> <em>input</em></td> + <td> ) </td> + <td><code> [static]</code></td> + </tr> + </table> +</div> +<div class="memdoc"> +<p>Load a string of YAML into a PHP array statically</p> +<p>The load method, when supplied with a YAML string, will do its best to convert YAML in a string into a PHP array. Pretty simple.</p> +<p>Note: use this function if you don't want files from the file system loaded and processed as YAML. This is of interest to people concerned about security whose input is from a string.</p> +<p>Usage: <code> $array = <a class="el" href="classSpyc.html#acc3c5661ad0891034e8035c3a00834bf">Spyc::YAMLLoadString</a>("---\n0: hello world\n"); print_r($array); </code> public </p> +<dl class="return"><dt><b>Returns:</b></dt><dd>array </dd></dl> +<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>$input String containing YAML </td></tr> + </table> + </dd> +</dl> + +</div> +</div> +<hr/>The documentation for this class was generated from the following file:<ul> +<li>contrib/spyc/spyc.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:16 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> |