123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114 |
- <?xml version="1.0" encoding="iso-8859-1"?>
- <!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>
- <!-- template designed by Marco Von Ballmoos -->
- <title>File Source for Interface.php</title>
- <link rel="stylesheet" href="../media/stylesheet.css" />
- <meta http-equiv='Content-Type' content='text/html; charset=iso-8859-1'/>
- </head>
- <body>
- <h1>Source for file Interface.php</h1>
- <p>Documentation is available at <a href="../Apache/Solr/_HttpTransport---Interface.php.html">Interface.php</a></p>
- <div class="src-code">
- <div class="src-code"><ol><li><div class="src-line"><a name="a1"></a><span class="src-php"><?php</span></div></li>
- <li><div class="src-line"><a name="a2"></a><span class="src-doc">/**</span></div></li>
- <li><div class="src-line"><a name="a3"></a><span class="src-doc"> * Copyright (c) 2007-2011, Servigistics, Inc.</span></div></li>
- <li><div class="src-line"><a name="a4"></a><span class="src-doc"> * All rights reserved.</span></div></li>
- <li><div class="src-line"><a name="a5"></a><span class="src-doc"> *</span></div></li>
- <li><div class="src-line"><a name="a6"></a><span class="src-doc"> * Redistribution and use in source and binary forms, with or without</span></div></li>
- <li><div class="src-line"><a name="a7"></a><span class="src-doc"> * modification, are permitted provided that the following conditions are met:</span></div></li>
- <li><div class="src-line"><a name="a8"></a><span class="src-doc"> *</span></div></li>
- <li><div class="src-line"><a name="a9"></a><span class="src-doc"> * - Redistributions of source code must retain the above copyright notice,</span></div></li>
- <li><div class="src-line"><a name="a10"></a><span class="src-doc"> * this list of conditions and the following disclaimer.</span></div></li>
- <li><div class="src-line"><a name="a11"></a><span class="src-doc"> * - Redistributions in binary form must reproduce the above copyright</span></div></li>
- <li><div class="src-line"><a name="a12"></a><span class="src-doc"> * notice, this list of conditions and the following disclaimer in the</span></div></li>
- <li><div class="src-line"><a name="a13"></a><span class="src-doc"> * documentation and/or other materials provided with the distribution.</span></div></li>
- <li><div class="src-line"><a name="a14"></a><span class="src-doc"> * - Neither the name of Servigistics, Inc. nor the names of</span></div></li>
- <li><div class="src-line"><a name="a15"></a><span class="src-doc"> * its contributors may be used to endorse or promote products derived from</span></div></li>
- <li><div class="src-line"><a name="a16"></a><span class="src-doc"> * this software without specific prior written permission.</span></div></li>
- <li><div class="src-line"><a name="a17"></a><span class="src-doc"> *</span></div></li>
- <li><div class="src-line"><a name="a18"></a><span class="src-doc"> * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"</span></div></li>
- <li><div class="src-line"><a name="a19"></a><span class="src-doc"> * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE</span></div></li>
- <li><div class="src-line"><a name="a20"></a><span class="src-doc"> * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE</span></div></li>
- <li><div class="src-line"><a name="a21"></a><span class="src-doc"> * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE</span></div></li>
- <li><div class="src-line"><a name="a22"></a><span class="src-doc"> * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR</span></div></li>
- <li><div class="src-line"><a name="a23"></a><span class="src-doc"> * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF</span></div></li>
- <li><div class="src-line"><a name="a24"></a><span class="src-doc"> * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS</span></div></li>
- <li><div class="src-line"><a name="a25"></a><span class="src-doc"> * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN</span></div></li>
- <li><div class="src-line"><a name="a26"></a><span class="src-doc"> * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)</span></div></li>
- <li><div class="src-line"><a name="a27"></a><span class="src-doc"> * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE</span></div></li>
- <li><div class="src-line"><a name="a28"></a><span class="src-doc"> * POSSIBILITY OF SUCH DAMAGE.</span></div></li>
- <li><div class="src-line"><a name="a29"></a><span class="src-doc"> *</span></div></li>
- <li><div class="src-line"><a name="a30"></a><span class="src-doc"> * </span><span class="src-doc-coretag">@copyright</span><span class="src-doc"> Copyright 2007-2011 Servigistics, Inc. (http://servigistics.com)</span></div></li>
- <li><div class="src-line"><a name="a31"></a><span class="src-doc"> * </span><span class="src-doc-coretag">@license</span><span class="src-doc"> http://solr-php-client.googlecode.com/svn/trunk/COPYING New BSD</span></div></li>
- <li><div class="src-line"><a name="a32"></a><span class="src-doc"> * </span><span class="src-doc-coretag">@version</span><span class="src-doc"> $Id: $</span></div></li>
- <li><div class="src-line"><a name="a33"></a><span class="src-doc"> *</span></div></li>
- <li><div class="src-line"><a name="a34"></a><span class="src-doc"> * </span><span class="src-doc-coretag">@package</span><span class="src-doc"> Apache</span></div></li>
- <li><div class="src-line"><a name="a35"></a><span class="src-doc"> * </span><span class="src-doc-coretag">@subpackage</span><span class="src-doc"> Solr</span></div></li>
- <li><div class="src-line"><a name="a36"></a><span class="src-doc"> * </span><span class="src-doc-coretag">@author</span><span class="src-doc"> Timo Schmidt <timo.schmidt@aoemedia.de>, Donovan Jimenez <djimenez@conduit-it.com></span></div></li>
- <li><div class="src-line"><a name="a37"></a><span class="src-doc"> */</span></div></li>
- <li><div class="src-line"><a name="a38"></a> </div></li>
- <li><div class="src-line"><a name="a39"></a><span class="src-comm">// require Apache_Solr_HttpTransport_Response</span></div></li>
- <li><div class="src-line"><a name="a40"></a><span class="src-inc">require_once</span><span class="src-sym">(</span><span class="src-id">dirname</span><span class="src-sym">(</span>__FILE__<span class="src-sym">) </span>. <span class="src-str">'/Response.php'</span><span class="src-sym">)</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a41"></a> </div></li>
- <li><div class="src-line"><a name="a42"></a><span class="src-doc">/**</span></div></li>
- <li><div class="src-line"><a name="a43"></a><span class="src-doc"> * Interface that all Transport (HTTP Requester) implementations must implement. These</span></div></li>
- <li><div class="src-line"><a name="a44"></a><span class="src-doc"> * Implementations can then be plugged into the Service instance in order to user their</span></div></li>
- <li><div class="src-line"><a name="a45"></a><span class="src-doc"> * the desired method for making HTTP requests</span></div></li>
- <li><div class="src-line"><a name="a46"></a><span class="src-doc"> */</span></div></li>
- <li><div class="src-line"><a name="a47"></a><span class="src-key">interface </span><a href="../Apache/Solr/Apache_Solr_HttpTransport_Interface.html">Apache_Solr_HttpTransport_Interface</a></div></li>
- <li><div class="src-line"><a name="a48"></a><span class="src-sym">{</span></div></li>
- <li><div class="src-line"><a name="a49"></a> <span class="src-doc">/**</span></div></li>
- <li><div class="src-line"><a name="a50"></a><span class="src-doc"> * Get the current default timeout for all HTTP requests</span></div></li>
- <li><div class="src-line"><a name="a51"></a><span class="src-doc"> *</span></div></li>
- <li><div class="src-line"><a name="a52"></a><span class="src-doc"> * </span><span class="src-doc-coretag">@return </span><span class="src-doc-type">float </span></div></li>
- <li><div class="src-line"><a name="a53"></a><span class="src-doc"> */</span></div></li>
- <li><div class="src-line"><a name="a54"></a> <span class="src-key">public </span><span class="src-key">function </span><a href="../Apache/Solr/Apache_Solr_HttpTransport_Interface.html#methodgetDefaultTimeout">getDefaultTimeout</a><span class="src-sym">(</span><span class="src-sym">)</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a55"></a> </div></li>
- <li><div class="src-line"><a name="a56"></a> <span class="src-doc">/**</span></div></li>
- <li><div class="src-line"><a name="a57"></a><span class="src-doc"> * Set the current default timeout for all HTTP requests</span></div></li>
- <li><div class="src-line"><a name="a58"></a><span class="src-doc"> *</span></div></li>
- <li><div class="src-line"><a name="a59"></a><span class="src-doc"> * </span><span class="src-doc-coretag">@param </span><span class="src-doc-type">float </span><span class="src-doc-var">$timeout </span></div></li>
- <li><div class="src-line"><a name="a60"></a><span class="src-doc"> */</span></div></li>
- <li><div class="src-line"><a name="a61"></a> <span class="src-key">public </span><span class="src-key">function </span><a href="../Apache/Solr/Apache_Solr_HttpTransport_Interface.html#methodsetDefaultTimeout">setDefaultTimeout</a><span class="src-sym">(</span><span class="src-var">$timeout</span><span class="src-sym">)</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a62"></a> </div></li>
- <li><div class="src-line"><a name="a63"></a> <span class="src-doc">/**</span></div></li>
- <li><div class="src-line"><a name="a64"></a><span class="src-doc"> * Perform a GET HTTP operation with an optional timeout and return the response</span></div></li>
- <li><div class="src-line"><a name="a65"></a><span class="src-doc"> * contents, use getLastResponseHeaders to retrieve HTTP headers</span></div></li>
- <li><div class="src-line"><a name="a66"></a><span class="src-doc"> *</span></div></li>
- <li><div class="src-line"><a name="a67"></a><span class="src-doc"> * </span><span class="src-doc-coretag">@param </span><span class="src-doc-type">string </span><span class="src-doc-var">$url </span></div></li>
- <li><div class="src-line"><a name="a68"></a><span class="src-doc"> * </span><span class="src-doc-coretag">@param </span><span class="src-doc-type">float </span><span class="src-doc-var">$timeout </span></div></li>
- <li><div class="src-line"><a name="a69"></a><span class="src-doc"> * </span><span class="src-doc-coretag">@return </span><span class="src-doc-type">Apache_Solr_HttpTransport_Response </span><span class="src-doc">HTTP response</span></div></li>
- <li><div class="src-line"><a name="a70"></a><span class="src-doc"> */</span></div></li>
- <li><div class="src-line"><a name="a71"></a> <span class="src-key">public </span><span class="src-key">function </span><a href="../Apache/Solr/Apache_Solr_HttpTransport_Interface.html#methodperformGetRequest">performGetRequest</a><span class="src-sym">(</span><span class="src-var">$url</span><span class="src-sym">, </span><span class="src-var">$timeout </span>= <span class="src-id">false</span><span class="src-sym">)</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a72"></a> </div></li>
- <li><div class="src-line"><a name="a73"></a> <span class="src-doc">/**</span></div></li>
- <li><div class="src-line"><a name="a74"></a><span class="src-doc"> * Perform a HEAD HTTP operation with an optional timeout and return the response</span></div></li>
- <li><div class="src-line"><a name="a75"></a><span class="src-doc"> * headers - NOTE: head requests have no response body</span></div></li>
- <li><div class="src-line"><a name="a76"></a><span class="src-doc"> *</span></div></li>
- <li><div class="src-line"><a name="a77"></a><span class="src-doc"> * </span><span class="src-doc-coretag">@param </span><span class="src-doc-type">string </span><span class="src-doc-var">$url </span></div></li>
- <li><div class="src-line"><a name="a78"></a><span class="src-doc"> * </span><span class="src-doc-coretag">@param </span><span class="src-doc-type">float </span><span class="src-doc-var">$timeout </span></div></li>
- <li><div class="src-line"><a name="a79"></a><span class="src-doc"> * </span><span class="src-doc-coretag">@return </span><span class="src-doc-type">Apache_Solr_HttpTransport_Response </span><span class="src-doc">HTTP response</span></div></li>
- <li><div class="src-line"><a name="a80"></a><span class="src-doc"> */</span></div></li>
- <li><div class="src-line"><a name="a81"></a> <span class="src-key">public </span><span class="src-key">function </span><a href="../Apache/Solr/Apache_Solr_HttpTransport_Interface.html#methodperformHeadRequest">performHeadRequest</a><span class="src-sym">(</span><span class="src-var">$url</span><span class="src-sym">, </span><span class="src-var">$timeout </span>= <span class="src-id">false</span><span class="src-sym">)</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a82"></a> </div></li>
- <li><div class="src-line"><a name="a83"></a> <span class="src-doc">/**</span></div></li>
- <li><div class="src-line"><a name="a84"></a><span class="src-doc"> * Perform a POST HTTP operation with an optional timeout and return the response</span></div></li>
- <li><div class="src-line"><a name="a85"></a><span class="src-doc"> * contents, use getLastResponseHeaders to retrieve HTTP headers</span></div></li>
- <li><div class="src-line"><a name="a86"></a><span class="src-doc"> *</span></div></li>
- <li><div class="src-line"><a name="a87"></a><span class="src-doc"> * </span><span class="src-doc-coretag">@param </span><span class="src-doc-type">string </span><span class="src-doc-var">$url </span></div></li>
- <li><div class="src-line"><a name="a88"></a><span class="src-doc"> * </span><span class="src-doc-coretag">@param </span><span class="src-doc-type">string </span><span class="src-doc-var">$rawPost </span></div></li>
- <li><div class="src-line"><a name="a89"></a><span class="src-doc"> * </span><span class="src-doc-coretag">@param </span><span class="src-doc-type">string </span><span class="src-doc-var">$contentType </span></div></li>
- <li><div class="src-line"><a name="a90"></a><span class="src-doc"> * </span><span class="src-doc-coretag">@param </span><span class="src-doc-type">float </span><span class="src-doc-var">$timeout </span></div></li>
- <li><div class="src-line"><a name="a91"></a><span class="src-doc"> * </span><span class="src-doc-coretag">@return </span><span class="src-doc-type">Apache_Solr_HttpTransport_Response </span><span class="src-doc">HTTP response</span></div></li>
- <li><div class="src-line"><a name="a92"></a><span class="src-doc"> */</span></div></li>
- <li><div class="src-line"><a name="a93"></a> <span class="src-key">public </span><span class="src-key">function </span><a href="../Apache/Solr/Apache_Solr_HttpTransport_Interface.html#methodperformPostRequest">performPostRequest</a><span class="src-sym">(</span><span class="src-var">$url</span><span class="src-sym">, </span><span class="src-var">$rawPost</span><span class="src-sym">, </span><span class="src-var">$contentType</span><span class="src-sym">, </span><span class="src-var">$timeout </span>= <span class="src-id">false</span><span class="src-sym">)</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a94"></a><span class="src-sym">}</span></div></li>
- </ol></div>
- </div>
- <p class="notes" id="credit">
- Documentation generated on Wed, 04 May 2011 11:01:15 -0400 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.3</a>
- </p>
- </body>
- </html>
|