git.m6w6.name Git - m6w6/ext-raphf/blob - v1.1.x/index.html

   1 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
   2 <html xmlns="http://www.w3.org/1999/xhtml">
   3 <head>
   4 <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
   5 <meta http-equiv="X-UA-Compatible" content="IE=9"/>
   6 <meta name="generator" content="Doxygen 1.8.10"/>
   7 <title>Resource and persistent handle factory API: Main Page</title>
   8 <link href="tabs.css" rel="stylesheet" type="text/css"/>
   9 <script type="text/javascript" src="jquery.js"></script>
  10 <script type="text/javascript" src="dynsections.js"></script>
  11 <link href="navtree.css" rel="stylesheet" type="text/css"/>
  12 <script type="text/javascript" src="resize.js"></script>
  13 <script type="text/javascript" src="navtreedata.js"></script>
  14 <script type="text/javascript" src="navtree.js"></script>
  15 <script type="text/javascript">
  16   $(document).ready(initResizable);
  17   $(window).load(resizeHeight);
  18 </script>
  19 <link href="search/search.css" rel="stylesheet" type="text/css"/>
  20 <script type="text/javascript" src="search/searchdata.js"></script>
  21 <script type="text/javascript" src="search/search.js"></script>
  22 <script type="text/javascript">
  23   $(document).ready(function() { init_search(); });
  24 </script>
  25 <link href="doxygen.css" rel="stylesheet" type="text/css" />
  26 </head>
  27 <body>
  28 <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
  29 <div id="titlearea">
  30 <table cellspacing="0" cellpadding="0">
  31  <tbody>
  32  <tr style="height: 56px;">
  33   <td id="projectlogo"><img alt="Logo" src="raphf.png"/></td>
  34   <td id="projectalign" style="padding-left: 0.5em;">
  35    <div id="projectname">Resource and persistent handle factory API
  36    </div>
  37    <div id="projectbrief">A facility to manage possibly persistent resources with a comprehensible API.  Provides simliar functionality like the zend_list API, but with more flexiblity and freedom.</div>
  38   </td>
  39  </tr>
  40  </tbody>
  41 </table>
  42 </div>
  43 <!-- end header part -->
  44 <!-- Generated by Doxygen 1.8.10 -->
  45 <script type="text/javascript">
  46 var searchBox = new SearchBox("searchBox", "search",false,'Search');
  47 </script>
  48   <div id="navrow1" class="tabs">
  49     <ul class="tablist">
  50       <li class="current"><a href="index.html"><span>Main&#160;Page</span></a></li>
  51       <li><a href="pages.html"><span>Related&#160;Pages</span></a></li>
  52       <li><a href="annotated.html"><span>Data&#160;Structures</span></a></li>
  53       <li><a href="files.html"><span>Files</span></a></li>
  54       <li>
  55         <div id="MSearchBox" class="MSearchBoxInactive">
  56         <span class="left">
  57           <img id="MSearchSelect" src="search/mag_sel.png"
  58                onmouseover="return searchBox.OnSearchSelectShow()"
  59                onmouseout="return searchBox.OnSearchSelectHide()"
  60                alt=""/>
  61           <input type="text" id="MSearchField" value="Search" accesskey="S"
  62                onfocus="searchBox.OnSearchFieldFocus(true)"
  63                onblur="searchBox.OnSearchFieldFocus(false)"
  64                onkeyup="searchBox.OnSearchFieldChange(event)"/>
  65           </span><span class="right">
  66             <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
  67           </span>
  68         </div>
  69       </li>
  70     </ul>
  71   </div>
  72 </div><!-- top -->
  73 <div id="side-nav" class="ui-resizable side-nav-resizable">
  74   <div id="nav-tree">
  75     <div id="nav-tree-contents">
  76       <div id="nav-sync" class="sync"></div>
  77     </div>
  78   </div>
  79   <div id="splitbar" style="-moz-user-select:none;"
  80        class="ui-resizable-handle">
  81   </div>
  82 </div>
  83 <script type="text/javascript">
  84 $(document).ready(function(){initNavTree('index.html','');});
  85 </script>
  86 <div id="doc-content">
  87 <!-- window showing the filter options -->
  88 <div id="MSearchSelectWindow"
  89      onmouseover="return searchBox.OnSearchSelectShow()"
  90      onmouseout="return searchBox.OnSearchSelectHide()"
  91      onkeydown="return searchBox.OnSearchSelectKey(event)">
  92 </div>
  93
  94 <!-- iframe showing the search results (closed by default) -->
  95 <div id="MSearchResultsWindow">
  96 <iframe src="javascript:void(0)" frameborder="0"
  97         name="MSearchResults" id="MSearchResults">
  98 </iframe>
  99 </div>
 100
 101 <div class="header">
 102   <div class="headertitle">
 103 <div class="title">Resource and persistent handle factory API Documentation</div>  </div>
 104 </div><!--header-->
 105 <div class="contents">
 106 <div class="textblock"><p><a href="https://travis-ci.org/m6w6/ext-raphf">![Build Status](https://travis-ci.org/m6w6/ext-raphf.svg?branch=v1.1.x)</a></p>
 107 <p>The "Resource and Persistent Handle Factory" extension provides facilities to manage those in a convenient manner.</p>
 108 <h2>Documentation</h2>
 109 <p>See the <a href="https://mdref.m6w6.name/raphf">online markdown reference</a>.</p>
 110 <p>Known issues are listed in <a href="./BUGS">BUGS</a> and future ideas can be found in <a href="./TODO">TODO</a>.</p>
 111 <h2>Installing</h2>
 112 <h3>PECL</h3>
 113 <pre class="fragment">pecl install raphf
 114 </pre><h3>PHARext</h3>
 115 <p>Watch out for <a href="https://replicator.pharext.org?raphf">PECL replicates</a> and pharext packages attached to <a href="./releases">releases</a>.</p>
 116 <h3>Checkout</h3>
 117 <pre class="fragment">git clone github.com:m6w6/ext-raphf
 118 cd ext-raphf
 119 /path/to/phpize
 120 ./configure --with-php-config=/path/to/php-config
 121 make
 122 sudo make install
 123 </pre><h2>ChangeLog</h2>
 124 <p>A comprehensive list of changes can be obtained from the <a href="https://pecl.php.net/package-changelog.php?package=raphf">PECL website</a>.</p>
 125 <h2>License</h2>
 126 <p>ext-raphf is licensed under the 2-Clause-BSD license, which can be found in the accompanying <a href="./LICENSE">LICENSE</a> file.</p>
 127 <h2>Contributing</h2>
 128 <p>All forms of contribution are welcome! Please see the bundled ./CONTRIBUTING.md "CONTRIBUTING" note for the general principles followed.</p>
 129 <p>The list of past and current contributors is maintained in <a href="./THANKS">THANKS</a>. </p>
 130 </div></div><!-- contents -->
 131 </div><!-- doc-content -->
 132 <!-- start footer part -->
 133 <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
 134   <ul>
 135     <li class="footer">Generated by
 136     <a href="http://www.doxygen.org/index.html">
 137     <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.10 </li>
 138   </ul>
 139 </div>
 140 </body>
 141 </html>