387 lines
71 KiB
HTML
387 lines
71 KiB
HTML
<?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 Document.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 Document.php</h1>
|
|
<p>Documentation is available at <a href="../Apache/Solr/_Document.php.html">Document.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: Document.php 54 2011-02-04 16:29:18Z donovan.jimenez $</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"> 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-doc">/**</span></div></li>
|
|
<li><div class="src-line"><a name="a40"></a><span class="src-doc"> * Holds Key / Value pairs that represent a Solr Document along with any associated boost</span></div></li>
|
|
<li><div class="src-line"><a name="a41"></a><span class="src-doc"> * values. Field values can be accessed by direct dereferencing such as:</span></div></li>
|
|
<li><div class="src-line"><a name="a42"></a><span class="src-doc"> * <code></span></div></li>
|
|
<li><div class="src-line"><a name="a43"></a><span class="src-doc"> * ...</span></div></li>
|
|
<li><div class="src-line"><a name="a44"></a><span class="src-doc"> * $document->title = 'Something';</span></div></li>
|
|
<li><div class="src-line"><a name="a45"></a><span class="src-doc"> * echo $document->title;</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-doc"> * </code></span></div></li>
|
|
<li><div class="src-line"><a name="a48"></a><span class="src-doc"> *</span></div></li>
|
|
<li><div class="src-line"><a name="a49"></a><span class="src-doc"> * Additionally, the field values can be iterated with foreach</span></div></li>
|
|
<li><div class="src-line"><a name="a50"></a><span class="src-doc"> *</span></div></li>
|
|
<li><div class="src-line"><a name="a51"></a><span class="src-doc"> * <code></span></div></li>
|
|
<li><div class="src-line"><a name="a52"></a><span class="src-doc"> * foreach ($document as $fieldName => $fieldValue)</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-doc"> * ...</span></div></li>
|
|
<li><div class="src-line"><a name="a55"></a><span class="src-doc"> * }</span></div></li>
|
|
<li><div class="src-line"><a name="a56"></a><span class="src-doc"> * </code></span></div></li>
|
|
<li><div class="src-line"><a name="a57"></a><span class="src-doc"> */</span></div></li>
|
|
<li><div class="src-line"><a name="a58"></a><span class="src-key">class </span><a href="../Apache/Solr/Apache_Solr_Document.html">Apache_Solr_Document</a> <span class="src-key">implements </span><span class="src-id">IteratorAggregate</span></div></li>
|
|
<li><div class="src-line"><a name="a59"></a><span class="src-sym">{</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-doc"> * SVN Revision meta data for this class</span></div></li>
|
|
<li><div class="src-line"><a name="a62"></a><span class="src-doc"> */</span></div></li>
|
|
<li><div class="src-line"><a name="a63"></a> <span class="src-key">const </span><span class="src-id">SVN_REVISION </span>= <span class="src-str">'$Revision: 54 $'</span><span class="src-sym">;</span></div></li>
|
|
<li><div class="src-line"><a name="a64"></a> </div></li>
|
|
<li><div class="src-line"><a name="a65"></a> <span class="src-doc">/**</span></div></li>
|
|
<li><div class="src-line"><a name="a66"></a><span class="src-doc"> * SVN ID meta data for this class</span></div></li>
|
|
<li><div class="src-line"><a name="a67"></a><span class="src-doc"> */</span></div></li>
|
|
<li><div class="src-line"><a name="a68"></a> <span class="src-key">const </span><span class="src-id">SVN_ID </span>= <span class="src-str">'$Id: Document.php 54 2011-02-04 16:29:18Z donovan.jimenez $'</span><span class="src-sym">;</span></div></li>
|
|
<li><div class="src-line"><a name="a69"></a> </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-doc"> * Document boost value</span></div></li>
|
|
<li><div class="src-line"><a name="a72"></a><span class="src-doc"> *</span></div></li>
|
|
<li><div class="src-line"><a name="a73"></a><span class="src-doc"> * </span><span class="src-doc-coretag">@var </span><span class="src-doc-type">float </span></div></li>
|
|
<li><div class="src-line"><a name="a74"></a><span class="src-doc"> */</span></div></li>
|
|
<li><div class="src-line"><a name="a75"></a> <span class="src-key">protected </span><a href="../Apache/Solr/Apache_Solr_Document.html#var$_documentBoost">$_documentBoost</a> = <span class="src-id">false</span><span class="src-sym">;</span></div></li>
|
|
<li><div class="src-line"><a name="a76"></a> </div></li>
|
|
<li><div class="src-line"><a name="a77"></a> <span class="src-doc">/**</span></div></li>
|
|
<li><div class="src-line"><a name="a78"></a><span class="src-doc"> * Document field values, indexed by name</span></div></li>
|
|
<li><div class="src-line"><a name="a79"></a><span class="src-doc"> *</span></div></li>
|
|
<li><div class="src-line"><a name="a80"></a><span class="src-doc"> * </span><span class="src-doc-coretag">@var </span><span class="src-doc-type">array </span></div></li>
|
|
<li><div class="src-line"><a name="a81"></a><span class="src-doc"> */</span></div></li>
|
|
<li><div class="src-line"><a name="a82"></a> <span class="src-key">protected </span><a href="../Apache/Solr/Apache_Solr_Document.html#var$_fields">$_fields</a> = <span class="src-key">array</span><span class="src-sym">(</span><span class="src-sym">)</span><span class="src-sym">;</span></div></li>
|
|
<li><div class="src-line"><a name="a83"></a> </div></li>
|
|
<li><div class="src-line"><a name="a84"></a> <span class="src-doc">/**</span></div></li>
|
|
<li><div class="src-line"><a name="a85"></a><span class="src-doc"> * Document field boost values, indexed by name</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">@var </span><span class="src-doc-type">array </span><span class="src-doc">array of floats</span></div></li>
|
|
<li><div class="src-line"><a name="a88"></a><span class="src-doc"> */</span></div></li>
|
|
<li><div class="src-line"><a name="a89"></a> <span class="src-key">protected </span><a href="../Apache/Solr/Apache_Solr_Document.html#var$_fieldBoosts">$_fieldBoosts</a> = <span class="src-key">array</span><span class="src-sym">(</span><span class="src-sym">)</span><span class="src-sym">;</span></div></li>
|
|
<li><div class="src-line"><a name="a90"></a> </div></li>
|
|
<li><div class="src-line"><a name="a91"></a> <span class="src-doc">/**</span></div></li>
|
|
<li><div class="src-line"><a name="a92"></a><span class="src-doc"> * Clear all boosts and fields from this document</span></div></li>
|
|
<li><div class="src-line"><a name="a93"></a><span class="src-doc"> */</span></div></li>
|
|
<li><div class="src-line"><a name="a94"></a> <span class="src-key">public </span><span class="src-key">function </span><a href="../Apache/Solr/Apache_Solr_Document.html#methodclear">clear</a><span class="src-sym">(</span><span class="src-sym">)</span></div></li>
|
|
<li><div class="src-line"><a name="a95"></a> <span class="src-sym">{</span></div></li>
|
|
<li><div class="src-line"><a name="a96"></a> <span class="src-var">$this</span><span class="src-sym">-></span><a href="../Apache/Solr/Apache_Solr_Document.html#var$_documentBoost">_documentBoost</a> = <span class="src-id">false</span><span class="src-sym">;</span></div></li>
|
|
<li><div class="src-line"><a name="a97"></a> </div></li>
|
|
<li><div class="src-line"><a name="a98"></a> <span class="src-var">$this</span><span class="src-sym">-></span><a href="../Apache/Solr/Apache_Solr_Document.html#var$_fields">_fields</a> = <span class="src-key">array</span><span class="src-sym">(</span><span class="src-sym">)</span><span class="src-sym">;</span></div></li>
|
|
<li><div class="src-line"><a name="a99"></a> <span class="src-var">$this</span><span class="src-sym">-></span><a href="../Apache/Solr/Apache_Solr_Document.html#var$_fieldBoosts">_fieldBoosts</a> = <span class="src-key">array</span><span class="src-sym">(</span><span class="src-sym">)</span><span class="src-sym">;</span></div></li>
|
|
<li><div class="src-line"><a name="a100"></a> <span class="src-sym">}</span></div></li>
|
|
<li><div class="src-line"><a name="a101"></a> </div></li>
|
|
<li><div class="src-line"><a name="a102"></a> <span class="src-doc">/**</span></div></li>
|
|
<li><div class="src-line"><a name="a103"></a><span class="src-doc"> * Get current document boost</span></div></li>
|
|
<li><div class="src-line"><a name="a104"></a><span class="src-doc"> *</span></div></li>
|
|
<li><div class="src-line"><a name="a105"></a><span class="src-doc"> * </span><span class="src-doc-coretag">@return </span><span class="src-doc-type">mixed </span><span class="src-doc">will be false for default, or else a float</span></div></li>
|
|
<li><div class="src-line"><a name="a106"></a><span class="src-doc"> */</span></div></li>
|
|
<li><div class="src-line"><a name="a107"></a> <span class="src-key">public </span><span class="src-key">function </span><a href="../Apache/Solr/Apache_Solr_Document.html#methodgetBoost">getBoost</a><span class="src-sym">(</span><span class="src-sym">)</span></div></li>
|
|
<li><div class="src-line"><a name="a108"></a> <span class="src-sym">{</span></div></li>
|
|
<li><div class="src-line"><a name="a109"></a> <span class="src-key">return </span><span class="src-var">$this</span><span class="src-sym">-></span><a href="../Apache/Solr/Apache_Solr_Document.html#var$_documentBoost">_documentBoost</a><span class="src-sym">;</span></div></li>
|
|
<li><div class="src-line"><a name="a110"></a> <span class="src-sym">}</span></div></li>
|
|
<li><div class="src-line"><a name="a111"></a> </div></li>
|
|
<li><div class="src-line"><a name="a112"></a> <span class="src-doc">/**</span></div></li>
|
|
<li><div class="src-line"><a name="a113"></a><span class="src-doc"> * Set document boost factor</span></div></li>
|
|
<li><div class="src-line"><a name="a114"></a><span class="src-doc"> *</span></div></li>
|
|
<li><div class="src-line"><a name="a115"></a><span class="src-doc"> * </span><span class="src-doc-coretag">@param </span><span class="src-doc-type">mixed </span><span class="src-doc-var">$boost </span><span class="src-doc">Use false for default boost, else cast to float that should be > 0 or will be treated as false</span></div></li>
|
|
<li><div class="src-line"><a name="a116"></a><span class="src-doc"> */</span></div></li>
|
|
<li><div class="src-line"><a name="a117"></a> <span class="src-key">public </span><span class="src-key">function </span><a href="../Apache/Solr/Apache_Solr_Document.html#methodsetBoost">setBoost</a><span class="src-sym">(</span><span class="src-var">$boost</span><span class="src-sym">)</span></div></li>
|
|
<li><div class="src-line"><a name="a118"></a> <span class="src-sym">{</span></div></li>
|
|
<li><div class="src-line"><a name="a119"></a> <span class="src-var">$boost </span>= (float) <span class="src-var">$boost</span><span class="src-sym">;</span></div></li>
|
|
<li><div class="src-line"><a name="a120"></a> </div></li>
|
|
<li><div class="src-line"><a name="a121"></a> <span class="src-key">if </span><span class="src-sym">(</span><span class="src-var">$boost </span>> <span class="src-num">0.0</span><span class="src-sym">)</span></div></li>
|
|
<li><div class="src-line"><a name="a122"></a> <span class="src-sym">{</span></div></li>
|
|
<li><div class="src-line"><a name="a123"></a> <span class="src-var">$this</span><span class="src-sym">-></span><a href="../Apache/Solr/Apache_Solr_Document.html#var$_documentBoost">_documentBoost</a> = <span class="src-var">$boost</span><span class="src-sym">;</span></div></li>
|
|
<li><div class="src-line"><a name="a124"></a> <span class="src-sym">}</span></div></li>
|
|
<li><div class="src-line"><a name="a125"></a> <span class="src-key">else</span></div></li>
|
|
<li><div class="src-line"><a name="a126"></a> <span class="src-sym">{</span></div></li>
|
|
<li><div class="src-line"><a name="a127"></a> <span class="src-var">$this</span><span class="src-sym">-></span><a href="../Apache/Solr/Apache_Solr_Document.html#var$_documentBoost">_documentBoost</a> = <span class="src-id">false</span><span class="src-sym">;</span></div></li>
|
|
<li><div class="src-line"><a name="a128"></a> <span class="src-sym">}</span></div></li>
|
|
<li><div class="src-line"><a name="a129"></a> <span class="src-sym">}</span></div></li>
|
|
<li><div class="src-line"><a name="a130"></a> </div></li>
|
|
<li><div class="src-line"><a name="a131"></a> <span class="src-doc">/**</span></div></li>
|
|
<li><div class="src-line"><a name="a132"></a><span class="src-doc"> * Add a value to a multi-valued field</span></div></li>
|
|
<li><div class="src-line"><a name="a133"></a><span class="src-doc"> *</span></div></li>
|
|
<li><div class="src-line"><a name="a134"></a><span class="src-doc"> * NOTE: the solr XML format allows you to specify boosts</span></div></li>
|
|
<li><div class="src-line"><a name="a135"></a><span class="src-doc"> * PER value even though the underlying Lucene implementation</span></div></li>
|
|
<li><div class="src-line"><a name="a136"></a><span class="src-doc"> * only allows a boost per field. To remedy this, the final</span></div></li>
|
|
<li><div class="src-line"><a name="a137"></a><span class="src-doc"> * field boost value will be the product of all specified boosts</span></div></li>
|
|
<li><div class="src-line"><a name="a138"></a><span class="src-doc"> * on field values - this is similar to SolrJ's functionality.</span></div></li>
|
|
<li><div class="src-line"><a name="a139"></a><span class="src-doc"> *</span></div></li>
|
|
<li><div class="src-line"><a name="a140"></a><span class="src-doc"> * <code></span></div></li>
|
|
<li><div class="src-line"><a name="a141"></a><span class="src-doc"> * $doc = new Apache_Solr_Document();</span></div></li>
|
|
<li><div class="src-line"><a name="a142"></a><span class="src-doc"> *</span></div></li>
|
|
<li><div class="src-line"><a name="a143"></a><span class="src-doc"> * $doc->addField('foo', 'bar', 2.0);</span></div></li>
|
|
<li><div class="src-line"><a name="a144"></a><span class="src-doc"> * $doc->addField('foo', 'baz', 3.0);</span></div></li>
|
|
<li><div class="src-line"><a name="a145"></a><span class="src-doc"> *</span></div></li>
|
|
<li><div class="src-line"><a name="a146"></a><span class="src-doc"> * // resultant field boost will be 6!</span></div></li>
|
|
<li><div class="src-line"><a name="a147"></a><span class="src-doc"> * echo $doc->getFieldBoost('foo');</span></div></li>
|
|
<li><div class="src-line"><a name="a148"></a><span class="src-doc"> * </code></span></div></li>
|
|
<li><div class="src-line"><a name="a149"></a><span class="src-doc"> *</span></div></li>
|
|
<li><div class="src-line"><a name="a150"></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">$key </span></div></li>
|
|
<li><div class="src-line"><a name="a151"></a><span class="src-doc"> * </span><span class="src-doc-coretag">@param </span><span class="src-doc-type">mixed </span><span class="src-doc-var">$value </span></div></li>
|
|
<li><div class="src-line"><a name="a152"></a><span class="src-doc"> * </span><span class="src-doc-coretag">@param </span><span class="src-doc-type">mixed </span><span class="src-doc-var">$boost </span><span class="src-doc">Use false for default boost, else cast to float that should be > 0 or will be treated as false</span></div></li>
|
|
<li><div class="src-line"><a name="a153"></a><span class="src-doc"> */</span></div></li>
|
|
<li><div class="src-line"><a name="a154"></a> <span class="src-key">public </span><span class="src-key">function </span><a href="../Apache/Solr/Apache_Solr_Document.html#methodaddField">addField</a><span class="src-sym">(</span><span class="src-var">$key</span><span class="src-sym">, </span><span class="src-var">$value</span><span class="src-sym">, </span><span class="src-var">$boost </span>= <span class="src-id">false</span><span class="src-sym">)</span></div></li>
|
|
<li><div class="src-line"><a name="a155"></a> <span class="src-sym">{</span></div></li>
|
|
<li><div class="src-line"><a name="a156"></a> <span class="src-key">if </span><span class="src-sym">(</span><span class="src-sym">!</span>isset<span class="src-sym">(</span><span class="src-var">$this</span><span class="src-sym">-></span><a href="../Apache/Solr/Apache_Solr_Document.html#var$_fields">_fields</a><span class="src-sym">[</span><span class="src-var">$key</span><span class="src-sym">]</span><span class="src-sym">))</span></div></li>
|
|
<li><div class="src-line"><a name="a157"></a> <span class="src-sym">{</span></div></li>
|
|
<li><div class="src-line"><a name="a158"></a> <span class="src-comm">// create holding array if this is the first value</span></div></li>
|
|
<li><div class="src-line"><a name="a159"></a> <span class="src-var">$this</span><span class="src-sym">-></span><a href="../Apache/Solr/Apache_Solr_Document.html#var$_fields">_fields</a><span class="src-sym">[</span><span class="src-var">$key</span><span class="src-sym">] </span>= <span class="src-key">array</span><span class="src-sym">(</span><span class="src-sym">)</span><span class="src-sym">;</span></div></li>
|
|
<li><div class="src-line"><a name="a160"></a> <span class="src-sym">}</span></div></li>
|
|
<li><div class="src-line"><a name="a161"></a> <span class="src-key">else </span><span class="src-key">if </span><span class="src-sym">(</span><span class="src-sym">!</span><a href="http://www.php.net/is_array">is_array</a><span class="src-sym">(</span><span class="src-var">$this</span><span class="src-sym">-></span><a href="../Apache/Solr/Apache_Solr_Document.html#var$_fields">_fields</a><span class="src-sym">[</span><span class="src-var">$key</span><span class="src-sym">]</span><span class="src-sym">))</span></div></li>
|
|
<li><div class="src-line"><a name="a162"></a> <span class="src-sym">{</span></div></li>
|
|
<li><div class="src-line"><a name="a163"></a> <span class="src-comm">// move existing value into array if it is not already an array</span></div></li>
|
|
<li><div class="src-line"><a name="a164"></a> <span class="src-var">$this</span><span class="src-sym">-></span><a href="../Apache/Solr/Apache_Solr_Document.html#var$_fields">_fields</a><span class="src-sym">[</span><span class="src-var">$key</span><span class="src-sym">] </span>= <span class="src-key">array</span><span class="src-sym">(</span><span class="src-var">$this</span><span class="src-sym">-></span><a href="../Apache/Solr/Apache_Solr_Document.html#var$_fields">_fields</a><span class="src-sym">[</span><span class="src-var">$key</span><span class="src-sym">]</span><span class="src-sym">)</span><span class="src-sym">;</span></div></li>
|
|
<li><div class="src-line"><a name="a165"></a> <span class="src-sym">}</span></div></li>
|
|
<li><div class="src-line"><a name="a166"></a> </div></li>
|
|
<li><div class="src-line"><a name="a167"></a> <span class="src-key">if </span><span class="src-sym">(</span><span class="src-var">$this</span><span class="src-sym">-></span><a href="../Apache/Solr/Apache_Solr_Document.html#methodgetFieldBoost">getFieldBoost</a><span class="src-sym">(</span><span class="src-var">$key</span><span class="src-sym">) </span>=== <span class="src-id">false</span><span class="src-sym">)</span></div></li>
|
|
<li><div class="src-line"><a name="a168"></a> <span class="src-sym">{</span></div></li>
|
|
<li><div class="src-line"><a name="a169"></a> <span class="src-comm">// boost not already set, set it now</span></div></li>
|
|
<li><div class="src-line"><a name="a170"></a> <span class="src-var">$this</span><span class="src-sym">-></span><a href="../Apache/Solr/Apache_Solr_Document.html#methodsetFieldBoost">setFieldBoost</a><span class="src-sym">(</span><span class="src-var">$key</span><span class="src-sym">, </span><span class="src-var">$boost</span><span class="src-sym">)</span><span class="src-sym">;</span></div></li>
|
|
<li><div class="src-line"><a name="a171"></a> <span class="src-sym">}</span></div></li>
|
|
<li><div class="src-line"><a name="a172"></a> <span class="src-key">else </span><span class="src-key">if </span><span class="src-sym">(</span>(float) <span class="src-var">$boost </span>> <span class="src-num">0.0</span><span class="src-sym">)</span></div></li>
|
|
<li><div class="src-line"><a name="a173"></a> <span class="src-sym">{</span></div></li>
|
|
<li><div class="src-line"><a name="a174"></a> <span class="src-comm">// multiply passed boost with current field boost - similar to SolrJ implementation</span></div></li>
|
|
<li><div class="src-line"><a name="a175"></a> <span class="src-var">$this</span><span class="src-sym">-></span><a href="../Apache/Solr/Apache_Solr_Document.html#var$_fieldBoosts">_fieldBoosts</a><span class="src-sym">[</span><span class="src-var">$key</span><span class="src-sym">] </span>*= (float) <span class="src-var">$boost</span><span class="src-sym">;</span></div></li>
|
|
<li><div class="src-line"><a name="a176"></a> <span class="src-sym">}</span></div></li>
|
|
<li><div class="src-line"><a name="a177"></a> </div></li>
|
|
<li><div class="src-line"><a name="a178"></a> <span class="src-comm">// add value to array</span></div></li>
|
|
<li><div class="src-line"><a name="a179"></a> <span class="src-var">$this</span><span class="src-sym">-></span><a href="../Apache/Solr/Apache_Solr_Document.html#var$_fields">_fields</a><span class="src-sym">[</span><span class="src-var">$key</span><span class="src-sym">]</span><span class="src-sym">[</span><span class="src-sym">] </span>= <span class="src-var">$value</span><span class="src-sym">;</span></div></li>
|
|
<li><div class="src-line"><a name="a180"></a> <span class="src-sym">}</span></div></li>
|
|
<li><div class="src-line"><a name="a181"></a> </div></li>
|
|
<li><div class="src-line"><a name="a182"></a> <span class="src-doc">/**</span></div></li>
|
|
<li><div class="src-line"><a name="a183"></a><span class="src-doc"> * Handle the array manipulation for a multi-valued field</span></div></li>
|
|
<li><div class="src-line"><a name="a184"></a><span class="src-doc"> *</span></div></li>
|
|
<li><div class="src-line"><a name="a185"></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">$key </span></div></li>
|
|
<li><div class="src-line"><a name="a186"></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">$value </span></div></li>
|
|
<li><div class="src-line"><a name="a187"></a><span class="src-doc"> * </span><span class="src-doc-coretag">@param </span><span class="src-doc-type">mixed </span><span class="src-doc-var">$boost </span><span class="src-doc">Use false for default boost, else cast to float that should be > 0 or will be treated as false</span></div></li>
|
|
<li><div class="src-line"><a name="a188"></a><span class="src-doc"> *</span></div></li>
|
|
<li><div class="src-line"><a name="a189"></a><span class="src-doc"> * </span><span class="src-doc-coretag">@deprecated</span><span class="src-doc"> Use addField(...) instead</span></div></li>
|
|
<li><div class="src-line"><a name="a190"></a><span class="src-doc"> */</span></div></li>
|
|
<li><div class="src-line"><a name="a191"></a> <span class="src-key">public </span><span class="src-key">function </span><a href="../Apache/Solr/Apache_Solr_Document.html#methodsetMultiValue">setMultiValue</a><span class="src-sym">(</span><span class="src-var">$key</span><span class="src-sym">, </span><span class="src-var">$value</span><span class="src-sym">, </span><span class="src-var">$boost </span>= <span class="src-id">false</span><span class="src-sym">)</span></div></li>
|
|
<li><div class="src-line"><a name="a192"></a> <span class="src-sym">{</span></div></li>
|
|
<li><div class="src-line"><a name="a193"></a> <span class="src-var">$this</span><span class="src-sym">-></span><a href="../Apache/Solr/Apache_Solr_Document.html#methodaddField">addField</a><span class="src-sym">(</span><span class="src-var">$key</span><span class="src-sym">, </span><span class="src-var">$value</span><span class="src-sym">, </span><span class="src-var">$boost</span><span class="src-sym">)</span><span class="src-sym">;</span></div></li>
|
|
<li><div class="src-line"><a name="a194"></a> <span class="src-sym">}</span></div></li>
|
|
<li><div class="src-line"><a name="a195"></a> </div></li>
|
|
<li><div class="src-line"><a name="a196"></a> <span class="src-doc">/**</span></div></li>
|
|
<li><div class="src-line"><a name="a197"></a><span class="src-doc"> * Get field information</span></div></li>
|
|
<li><div class="src-line"><a name="a198"></a><span class="src-doc"> *</span></div></li>
|
|
<li><div class="src-line"><a name="a199"></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">$key </span></div></li>
|
|
<li><div class="src-line"><a name="a200"></a><span class="src-doc"> * </span><span class="src-doc-coretag">@return </span><span class="src-doc-type">mixed </span><span class="src-doc">associative array of info if field exists, false otherwise</span></div></li>
|
|
<li><div class="src-line"><a name="a201"></a><span class="src-doc"> */</span></div></li>
|
|
<li><div class="src-line"><a name="a202"></a> <span class="src-key">public </span><span class="src-key">function </span><a href="../Apache/Solr/Apache_Solr_Document.html#methodgetField">getField</a><span class="src-sym">(</span><span class="src-var">$key</span><span class="src-sym">)</span></div></li>
|
|
<li><div class="src-line"><a name="a203"></a> <span class="src-sym">{</span></div></li>
|
|
<li><div class="src-line"><a name="a204"></a> <span class="src-key">if </span><span class="src-sym">(</span>isset<span class="src-sym">(</span><span class="src-var">$this</span><span class="src-sym">-></span><a href="../Apache/Solr/Apache_Solr_Document.html#var$_fields">_fields</a><span class="src-sym">[</span><span class="src-var">$key</span><span class="src-sym">]</span><span class="src-sym">))</span></div></li>
|
|
<li><div class="src-line"><a name="a205"></a> <span class="src-sym">{</span></div></li>
|
|
<li><div class="src-line"><a name="a206"></a> <span class="src-key">return </span><span class="src-key">array</span><span class="src-sym">(</span></div></li>
|
|
<li><div class="src-line"><a name="a207"></a> <span class="src-str">'name' </span>=> <span class="src-var">$key</span><span class="src-sym">,</span></div></li>
|
|
<li><div class="src-line"><a name="a208"></a> <span class="src-str">'value' </span>=> <span class="src-var">$this</span><span class="src-sym">-></span><a href="../Apache/Solr/Apache_Solr_Document.html#var$_fields">_fields</a><span class="src-sym">[</span><span class="src-var">$key</span><span class="src-sym">]</span><span class="src-sym">,</span></div></li>
|
|
<li><div class="src-line"><a name="a209"></a> <span class="src-str">'boost' </span>=> <span class="src-var">$this</span><span class="src-sym">-></span><a href="../Apache/Solr/Apache_Solr_Document.html#methodgetFieldBoost">getFieldBoost</a><span class="src-sym">(</span><span class="src-var">$key</span><span class="src-sym">)</span></div></li>
|
|
<li><div class="src-line"><a name="a210"></a> <span class="src-sym">)</span><span class="src-sym">;</span></div></li>
|
|
<li><div class="src-line"><a name="a211"></a> <span class="src-sym">}</span></div></li>
|
|
<li><div class="src-line"><a name="a212"></a> </div></li>
|
|
<li><div class="src-line"><a name="a213"></a> <span class="src-key">return </span><span class="src-id">false</span><span class="src-sym">;</span></div></li>
|
|
<li><div class="src-line"><a name="a214"></a> <span class="src-sym">}</span></div></li>
|
|
<li><div class="src-line"><a name="a215"></a> </div></li>
|
|
<li><div class="src-line"><a name="a216"></a> <span class="src-doc">/**</span></div></li>
|
|
<li><div class="src-line"><a name="a217"></a><span class="src-doc"> * Set a field value. Multi-valued fields should be set as arrays</span></div></li>
|
|
<li><div class="src-line"><a name="a218"></a><span class="src-doc"> * or instead use the addField(...) function which will automatically</span></div></li>
|
|
<li><div class="src-line"><a name="a219"></a><span class="src-doc"> * make sure the field is an array.</span></div></li>
|
|
<li><div class="src-line"><a name="a220"></a><span class="src-doc"> *</span></div></li>
|
|
<li><div class="src-line"><a name="a221"></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">$key </span></div></li>
|
|
<li><div class="src-line"><a name="a222"></a><span class="src-doc"> * </span><span class="src-doc-coretag">@param </span><span class="src-doc-type">mixed </span><span class="src-doc-var">$value </span></div></li>
|
|
<li><div class="src-line"><a name="a223"></a><span class="src-doc"> * </span><span class="src-doc-coretag">@param </span><span class="src-doc-type">mixed </span><span class="src-doc-var">$boost </span><span class="src-doc">Use false for default boost, else cast to float that should be > 0 or will be treated as false</span></div></li>
|
|
<li><div class="src-line"><a name="a224"></a><span class="src-doc"> */</span></div></li>
|
|
<li><div class="src-line"><a name="a225"></a> <span class="src-key">public </span><span class="src-key">function </span><a href="../Apache/Solr/Apache_Solr_Document.html#methodsetField">setField</a><span class="src-sym">(</span><span class="src-var">$key</span><span class="src-sym">, </span><span class="src-var">$value</span><span class="src-sym">, </span><span class="src-var">$boost </span>= <span class="src-id">false</span><span class="src-sym">)</span></div></li>
|
|
<li><div class="src-line"><a name="a226"></a> <span class="src-sym">{</span></div></li>
|
|
<li><div class="src-line"><a name="a227"></a> <span class="src-var">$this</span><span class="src-sym">-></span><a href="../Apache/Solr/Apache_Solr_Document.html#var$_fields">_fields</a><span class="src-sym">[</span><span class="src-var">$key</span><span class="src-sym">] </span>= <span class="src-var">$value</span><span class="src-sym">;</span></div></li>
|
|
<li><div class="src-line"><a name="a228"></a> <span class="src-var">$this</span><span class="src-sym">-></span><a href="../Apache/Solr/Apache_Solr_Document.html#methodsetFieldBoost">setFieldBoost</a><span class="src-sym">(</span><span class="src-var">$key</span><span class="src-sym">, </span><span class="src-var">$boost</span><span class="src-sym">)</span><span class="src-sym">;</span></div></li>
|
|
<li><div class="src-line"><a name="a229"></a> <span class="src-sym">}</span></div></li>
|
|
<li><div class="src-line"><a name="a230"></a> </div></li>
|
|
<li><div class="src-line"><a name="a231"></a> <span class="src-doc">/**</span></div></li>
|
|
<li><div class="src-line"><a name="a232"></a><span class="src-doc"> * Get the currently set field boost for a document field</span></div></li>
|
|
<li><div class="src-line"><a name="a233"></a><span class="src-doc"> *</span></div></li>
|
|
<li><div class="src-line"><a name="a234"></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">$key </span></div></li>
|
|
<li><div class="src-line"><a name="a235"></a><span class="src-doc"> * </span><span class="src-doc-coretag">@return </span><span class="src-doc-type">float </span><span class="src-doc">currently set field boost, false if one is not set</span></div></li>
|
|
<li><div class="src-line"><a name="a236"></a><span class="src-doc"> */</span></div></li>
|
|
<li><div class="src-line"><a name="a237"></a> <span class="src-key">public </span><span class="src-key">function </span><a href="../Apache/Solr/Apache_Solr_Document.html#methodgetFieldBoost">getFieldBoost</a><span class="src-sym">(</span><span class="src-var">$key</span><span class="src-sym">)</span></div></li>
|
|
<li><div class="src-line"><a name="a238"></a> <span class="src-sym">{</span></div></li>
|
|
<li><div class="src-line"><a name="a239"></a> <span class="src-key">return </span>isset<span class="src-sym">(</span><span class="src-var">$this</span><span class="src-sym">-></span><a href="../Apache/Solr/Apache_Solr_Document.html#var$_fieldBoosts">_fieldBoosts</a><span class="src-sym">[</span><span class="src-var">$key</span><span class="src-sym">]</span><span class="src-sym">) </span>? <span class="src-var">$this</span><span class="src-sym">-></span><a href="../Apache/Solr/Apache_Solr_Document.html#var$_fieldBoosts">_fieldBoosts</a><span class="src-sym">[</span><span class="src-var">$key</span><span class="src-sym">] </span>: <span class="src-id">false</span><span class="src-sym">;</span></div></li>
|
|
<li><div class="src-line"><a name="a240"></a> <span class="src-sym">}</span></div></li>
|
|
<li><div class="src-line"><a name="a241"></a> </div></li>
|
|
<li><div class="src-line"><a name="a242"></a> <span class="src-doc">/**</span></div></li>
|
|
<li><div class="src-line"><a name="a243"></a><span class="src-doc"> * Set the field boost for a document field</span></div></li>
|
|
<li><div class="src-line"><a name="a244"></a><span class="src-doc"> *</span></div></li>
|
|
<li><div class="src-line"><a name="a245"></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">$key </span><span class="src-doc">field name for the boost</span></div></li>
|
|
<li><div class="src-line"><a name="a246"></a><span class="src-doc"> * </span><span class="src-doc-coretag">@param </span><span class="src-doc-type">mixed </span><span class="src-doc-var">$boost </span><span class="src-doc">Use false for default boost, else cast to float that should be > 0 or will be treated as false</span></div></li>
|
|
<li><div class="src-line"><a name="a247"></a><span class="src-doc"> */</span></div></li>
|
|
<li><div class="src-line"><a name="a248"></a> <span class="src-key">public </span><span class="src-key">function </span><a href="../Apache/Solr/Apache_Solr_Document.html#methodsetFieldBoost">setFieldBoost</a><span class="src-sym">(</span><span class="src-var">$key</span><span class="src-sym">, </span><span class="src-var">$boost</span><span class="src-sym">)</span></div></li>
|
|
<li><div class="src-line"><a name="a249"></a> <span class="src-sym">{</span></div></li>
|
|
<li><div class="src-line"><a name="a250"></a> <span class="src-var">$boost </span>= (float) <span class="src-var">$boost</span><span class="src-sym">;</span></div></li>
|
|
<li><div class="src-line"><a name="a251"></a> </div></li>
|
|
<li><div class="src-line"><a name="a252"></a> <span class="src-key">if </span><span class="src-sym">(</span><span class="src-var">$boost </span>> <span class="src-num">0.0</span><span class="src-sym">)</span></div></li>
|
|
<li><div class="src-line"><a name="a253"></a> <span class="src-sym">{</span></div></li>
|
|
<li><div class="src-line"><a name="a254"></a> <span class="src-var">$this</span><span class="src-sym">-></span><a href="../Apache/Solr/Apache_Solr_Document.html#var$_fieldBoosts">_fieldBoosts</a><span class="src-sym">[</span><span class="src-var">$key</span><span class="src-sym">] </span>= <span class="src-var">$boost</span><span class="src-sym">;</span></div></li>
|
|
<li><div class="src-line"><a name="a255"></a> <span class="src-sym">}</span></div></li>
|
|
<li><div class="src-line"><a name="a256"></a> <span class="src-key">else</span></div></li>
|
|
<li><div class="src-line"><a name="a257"></a> <span class="src-sym">{</span></div></li>
|
|
<li><div class="src-line"><a name="a258"></a> <span class="src-var">$this</span><span class="src-sym">-></span><a href="../Apache/Solr/Apache_Solr_Document.html#var$_fieldBoosts">_fieldBoosts</a><span class="src-sym">[</span><span class="src-var">$key</span><span class="src-sym">] </span>= <span class="src-id">false</span><span class="src-sym">;</span></div></li>
|
|
<li><div class="src-line"><a name="a259"></a> <span class="src-sym">}</span></div></li>
|
|
<li><div class="src-line"><a name="a260"></a> <span class="src-sym">}</span></div></li>
|
|
<li><div class="src-line"><a name="a261"></a> </div></li>
|
|
<li><div class="src-line"><a name="a262"></a> <span class="src-doc">/**</span></div></li>
|
|
<li><div class="src-line"><a name="a263"></a><span class="src-doc"> * Return current field boosts, indexed by field name</span></div></li>
|
|
<li><div class="src-line"><a name="a264"></a><span class="src-doc"> *</span></div></li>
|
|
<li><div class="src-line"><a name="a265"></a><span class="src-doc"> * </span><span class="src-doc-coretag">@return </span><span class="src-doc-type">array </span></div></li>
|
|
<li><div class="src-line"><a name="a266"></a><span class="src-doc"> */</span></div></li>
|
|
<li><div class="src-line"><a name="a267"></a> <span class="src-key">public </span><span class="src-key">function </span><a href="../Apache/Solr/Apache_Solr_Document.html#methodgetFieldBoosts">getFieldBoosts</a><span class="src-sym">(</span><span class="src-sym">)</span></div></li>
|
|
<li><div class="src-line"><a name="a268"></a> <span class="src-sym">{</span></div></li>
|
|
<li><div class="src-line"><a name="a269"></a> <span class="src-key">return </span><span class="src-var">$this</span><span class="src-sym">-></span><a href="../Apache/Solr/Apache_Solr_Document.html#var$_fieldBoosts">_fieldBoosts</a><span class="src-sym">;</span></div></li>
|
|
<li><div class="src-line"><a name="a270"></a> <span class="src-sym">}</span></div></li>
|
|
<li><div class="src-line"><a name="a271"></a> </div></li>
|
|
<li><div class="src-line"><a name="a272"></a> <span class="src-doc">/**</span></div></li>
|
|
<li><div class="src-line"><a name="a273"></a><span class="src-doc"> * Get the names of all fields in this document</span></div></li>
|
|
<li><div class="src-line"><a name="a274"></a><span class="src-doc"> *</span></div></li>
|
|
<li><div class="src-line"><a name="a275"></a><span class="src-doc"> * </span><span class="src-doc-coretag">@return </span><span class="src-doc-type">array </span></div></li>
|
|
<li><div class="src-line"><a name="a276"></a><span class="src-doc"> */</span></div></li>
|
|
<li><div class="src-line"><a name="a277"></a> <span class="src-key">public </span><span class="src-key">function </span><a href="../Apache/Solr/Apache_Solr_Document.html#methodgetFieldNames">getFieldNames</a><span class="src-sym">(</span><span class="src-sym">)</span></div></li>
|
|
<li><div class="src-line"><a name="a278"></a> <span class="src-sym">{</span></div></li>
|
|
<li><div class="src-line"><a name="a279"></a> <span class="src-key">return </span><a href="http://www.php.net/array_keys">array_keys</a><span class="src-sym">(</span><span class="src-var">$this</span><span class="src-sym">-></span><a href="../Apache/Solr/Apache_Solr_Document.html#var$_fields">_fields</a><span class="src-sym">)</span><span class="src-sym">;</span></div></li>
|
|
<li><div class="src-line"><a name="a280"></a> <span class="src-sym">}</span></div></li>
|
|
<li><div class="src-line"><a name="a281"></a> </div></li>
|
|
<li><div class="src-line"><a name="a282"></a> <span class="src-doc">/**</span></div></li>
|
|
<li><div class="src-line"><a name="a283"></a><span class="src-doc"> * Get the values of all fields in this document</span></div></li>
|
|
<li><div class="src-line"><a name="a284"></a><span class="src-doc"> *</span></div></li>
|
|
<li><div class="src-line"><a name="a285"></a><span class="src-doc"> * </span><span class="src-doc-coretag">@return </span><span class="src-doc-type">array </span></div></li>
|
|
<li><div class="src-line"><a name="a286"></a><span class="src-doc"> */</span></div></li>
|
|
<li><div class="src-line"><a name="a287"></a> <span class="src-key">public </span><span class="src-key">function </span><a href="../Apache/Solr/Apache_Solr_Document.html#methodgetFieldValues">getFieldValues</a><span class="src-sym">(</span><span class="src-sym">)</span></div></li>
|
|
<li><div class="src-line"><a name="a288"></a> <span class="src-sym">{</span></div></li>
|
|
<li><div class="src-line"><a name="a289"></a> <span class="src-key">return </span><a href="http://www.php.net/array_values">array_values</a><span class="src-sym">(</span><span class="src-var">$this</span><span class="src-sym">-></span><a href="../Apache/Solr/Apache_Solr_Document.html#var$_fields">_fields</a><span class="src-sym">)</span><span class="src-sym">;</span></div></li>
|
|
<li><div class="src-line"><a name="a290"></a> <span class="src-sym">}</span></div></li>
|
|
<li><div class="src-line"><a name="a291"></a> </div></li>
|
|
<li><div class="src-line"><a name="a292"></a> <span class="src-doc">/**</span></div></li>
|
|
<li><div class="src-line"><a name="a293"></a><span class="src-doc"> * IteratorAggregate implementation function. Allows usage:</span></div></li>
|
|
<li><div class="src-line"><a name="a294"></a><span class="src-doc"> *</span></div></li>
|
|
<li><div class="src-line"><a name="a295"></a><span class="src-doc"> * <code></span></div></li>
|
|
<li><div class="src-line"><a name="a296"></a><span class="src-doc"> * foreach ($document as $key => $value)</span></div></li>
|
|
<li><div class="src-line"><a name="a297"></a><span class="src-doc"> * {</span></div></li>
|
|
<li><div class="src-line"><a name="a298"></a><span class="src-doc"> * ...</span></div></li>
|
|
<li><div class="src-line"><a name="a299"></a><span class="src-doc"> * }</span></div></li>
|
|
<li><div class="src-line"><a name="a300"></a><span class="src-doc"> * </code></span></div></li>
|
|
<li><div class="src-line"><a name="a301"></a><span class="src-doc"> */</span></div></li>
|
|
<li><div class="src-line"><a name="a302"></a> <span class="src-key">public </span><span class="src-key">function </span><a href="../Apache/Solr/Apache_Solr_Document.html#methodgetIterator">getIterator</a><span class="src-sym">(</span><span class="src-sym">)</span></div></li>
|
|
<li><div class="src-line"><a name="a303"></a> <span class="src-sym">{</span></div></li>
|
|
<li><div class="src-line"><a name="a304"></a> <span class="src-var">$arrayObject </span>= <span class="src-key">new </span><span class="src-id">ArrayObject</span><span class="src-sym">(</span><span class="src-var">$this</span><span class="src-sym">-></span><a href="../Apache/Solr/Apache_Solr_Document.html#var$_fields">_fields</a><span class="src-sym">)</span><span class="src-sym">;</span></div></li>
|
|
<li><div class="src-line"><a name="a305"></a> </div></li>
|
|
<li><div class="src-line"><a name="a306"></a> <span class="src-key">return </span><span class="src-var">$arrayObject</span><span class="src-sym">-></span><span class="src-id">getIterator</span><span class="src-sym">(</span><span class="src-sym">)</span><span class="src-sym">;</span></div></li>
|
|
<li><div class="src-line"><a name="a307"></a> <span class="src-sym">}</span></div></li>
|
|
<li><div class="src-line"><a name="a308"></a> </div></li>
|
|
<li><div class="src-line"><a name="a309"></a> <span class="src-doc">/**</span></div></li>
|
|
<li><div class="src-line"><a name="a310"></a><span class="src-doc"> * Magic get for field values</span></div></li>
|
|
<li><div class="src-line"><a name="a311"></a><span class="src-doc"> *</span></div></li>
|
|
<li><div class="src-line"><a name="a312"></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">$key </span></div></li>
|
|
<li><div class="src-line"><a name="a313"></a><span class="src-doc"> * </span><span class="src-doc-coretag">@return </span><span class="src-doc-type">mixed </span></div></li>
|
|
<li><div class="src-line"><a name="a314"></a><span class="src-doc"> */</span></div></li>
|
|
<li><div class="src-line"><a name="a315"></a> <span class="src-key">public </span><span class="src-key">function </span><a href="../Apache/Solr/Apache_Solr_Document.html#method__get">__get</a><span class="src-sym">(</span><span class="src-var">$key</span><span class="src-sym">)</span></div></li>
|
|
<li><div class="src-line"><a name="a316"></a> <span class="src-sym">{</span></div></li>
|
|
<li><div class="src-line"><a name="a317"></a> <span class="src-key">if </span><span class="src-sym">(</span>isset<span class="src-sym">(</span><span class="src-var">$this</span><span class="src-sym">-></span><a href="../Apache/Solr/Apache_Solr_Document.html#var$_fields">_fields</a><span class="src-sym">[</span><span class="src-var">$key</span><span class="src-sym">]</span><span class="src-sym">))</span></div></li>
|
|
<li><div class="src-line"><a name="a318"></a> <span class="src-sym">{</span></div></li>
|
|
<li><div class="src-line"><a name="a319"></a> <span class="src-key">return </span><span class="src-var">$this</span><span class="src-sym">-></span><a href="../Apache/Solr/Apache_Solr_Document.html#var$_fields">_fields</a><span class="src-sym">[</span><span class="src-var">$key</span><span class="src-sym">]</span><span class="src-sym">;</span></div></li>
|
|
<li><div class="src-line"><a name="a320"></a> <span class="src-sym">}</span></div></li>
|
|
<li><div class="src-line"><a name="a321"></a> </div></li>
|
|
<li><div class="src-line"><a name="a322"></a> <span class="src-key">return </span><span class="src-id">null</span><span class="src-sym">;</span></div></li>
|
|
<li><div class="src-line"><a name="a323"></a> <span class="src-sym">}</span></div></li>
|
|
<li><div class="src-line"><a name="a324"></a> </div></li>
|
|
<li><div class="src-line"><a name="a325"></a> <span class="src-doc">/**</span></div></li>
|
|
<li><div class="src-line"><a name="a326"></a><span class="src-doc"> * Magic set for field values. Multi-valued fields should be set as arrays</span></div></li>
|
|
<li><div class="src-line"><a name="a327"></a><span class="src-doc"> * or instead use the addField(...) function which will automatically</span></div></li>
|
|
<li><div class="src-line"><a name="a328"></a><span class="src-doc"> * make sure the field is an array.</span></div></li>
|
|
<li><div class="src-line"><a name="a329"></a><span class="src-doc"> *</span></div></li>
|
|
<li><div class="src-line"><a name="a330"></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">$key </span></div></li>
|
|
<li><div class="src-line"><a name="a331"></a><span class="src-doc"> * </span><span class="src-doc-coretag">@param </span><span class="src-doc-type">mixed </span><span class="src-doc-var">$value </span></div></li>
|
|
<li><div class="src-line"><a name="a332"></a><span class="src-doc"> */</span></div></li>
|
|
<li><div class="src-line"><a name="a333"></a> <span class="src-key">public </span><span class="src-key">function </span><a href="../Apache/Solr/Apache_Solr_Document.html#method__set">__set</a><span class="src-sym">(</span><span class="src-var">$key</span><span class="src-sym">, </span><span class="src-var">$value</span><span class="src-sym">)</span></div></li>
|
|
<li><div class="src-line"><a name="a334"></a> <span class="src-sym">{</span></div></li>
|
|
<li><div class="src-line"><a name="a335"></a> <span class="src-var">$this</span><span class="src-sym">-></span><a href="../Apache/Solr/Apache_Solr_Document.html#methodsetField">setField</a><span class="src-sym">(</span><span class="src-var">$key</span><span class="src-sym">, </span><span class="src-var">$value</span><span class="src-sym">)</span><span class="src-sym">;</span></div></li>
|
|
<li><div class="src-line"><a name="a336"></a> <span class="src-sym">}</span></div></li>
|
|
<li><div class="src-line"><a name="a337"></a> </div></li>
|
|
<li><div class="src-line"><a name="a338"></a> <span class="src-doc">/**</span></div></li>
|
|
<li><div class="src-line"><a name="a339"></a><span class="src-doc"> * Magic isset for fields values. Do not call directly. Allows usage:</span></div></li>
|
|
<li><div class="src-line"><a name="a340"></a><span class="src-doc"> *</span></div></li>
|
|
<li><div class="src-line"><a name="a341"></a><span class="src-doc"> * <code></span></div></li>
|
|
<li><div class="src-line"><a name="a342"></a><span class="src-doc"> * isset($document->some_field);</span></div></li>
|
|
<li><div class="src-line"><a name="a343"></a><span class="src-doc"> * </code></span></div></li>
|
|
<li><div class="src-line"><a name="a344"></a><span class="src-doc"> *</span></div></li>
|
|
<li><div class="src-line"><a name="a345"></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">$key </span></div></li>
|
|
<li><div class="src-line"><a name="a346"></a><span class="src-doc"> * </span><span class="src-doc-coretag">@return </span><span class="src-doc-type">boolean </span></div></li>
|
|
<li><div class="src-line"><a name="a347"></a><span class="src-doc"> */</span></div></li>
|
|
<li><div class="src-line"><a name="a348"></a> <span class="src-key">public </span><span class="src-key">function </span><a href="../Apache/Solr/Apache_Solr_Document.html#method__isset">__isset</a><span class="src-sym">(</span><span class="src-var">$key</span><span class="src-sym">)</span></div></li>
|
|
<li><div class="src-line"><a name="a349"></a> <span class="src-sym">{</span></div></li>
|
|
<li><div class="src-line"><a name="a350"></a> <span class="src-key">return </span>isset<span class="src-sym">(</span><span class="src-var">$this</span><span class="src-sym">-></span><a href="../Apache/Solr/Apache_Solr_Document.html#var$_fields">_fields</a><span class="src-sym">[</span><span class="src-var">$key</span><span class="src-sym">]</span><span class="src-sym">)</span><span class="src-sym">;</span></div></li>
|
|
<li><div class="src-line"><a name="a351"></a> <span class="src-sym">}</span></div></li>
|
|
<li><div class="src-line"><a name="a352"></a> </div></li>
|
|
<li><div class="src-line"><a name="a353"></a> <span class="src-doc">/**</span></div></li>
|
|
<li><div class="src-line"><a name="a354"></a><span class="src-doc"> * Magic unset for field values. Do not call directly. Allows usage:</span></div></li>
|
|
<li><div class="src-line"><a name="a355"></a><span class="src-doc"> *</span></div></li>
|
|
<li><div class="src-line"><a name="a356"></a><span class="src-doc"> * <code></span></div></li>
|
|
<li><div class="src-line"><a name="a357"></a><span class="src-doc"> * unset($document->some_field);</span></div></li>
|
|
<li><div class="src-line"><a name="a358"></a><span class="src-doc"> * </code></span></div></li>
|
|
<li><div class="src-line"><a name="a359"></a><span class="src-doc"> *</span></div></li>
|
|
<li><div class="src-line"><a name="a360"></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">$key </span></div></li>
|
|
<li><div class="src-line"><a name="a361"></a><span class="src-doc"> */</span></div></li>
|
|
<li><div class="src-line"><a name="a362"></a> <span class="src-key">public </span><span class="src-key">function </span><a href="../Apache/Solr/Apache_Solr_Document.html#method__unset">__unset</a><span class="src-sym">(</span><span class="src-var">$key</span><span class="src-sym">)</span></div></li>
|
|
<li><div class="src-line"><a name="a363"></a> <span class="src-sym">{</span></div></li>
|
|
<li><div class="src-line"><a name="a364"></a> unset<span class="src-sym">(</span><span class="src-var">$this</span><span class="src-sym">-></span><a href="../Apache/Solr/Apache_Solr_Document.html#var$_fields">_fields</a><span class="src-sym">[</span><span class="src-var">$key</span><span class="src-sym">]</span><span class="src-sym">)</span><span class="src-sym">;</span></div></li>
|
|
<li><div class="src-line"><a name="a365"></a> unset<span class="src-sym">(</span><span class="src-var">$this</span><span class="src-sym">-></span><a href="../Apache/Solr/Apache_Solr_Document.html#var$_fieldBoosts">_fieldBoosts</a><span class="src-sym">[</span><span class="src-var">$key</span><span class="src-sym">]</span><span class="src-sym">)</span><span class="src-sym">;</span></div></li>
|
|
<li><div class="src-line"><a name="a366"></a> <span class="src-sym">}</span></div></li>
|
|
<li><div class="src-line"><a name="a367"></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:13 -0400 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.3</a>
|
|
</p>
|
|
</body>
|
|
</html> |