<?php
include_once $_SERVER['DOCUMENT_ROOT'] . '/include/shared-manual.inc';
$TOC = array();
$TOC_DEPRECATED = array();
$PARENTS = array();
include_once dirname(__FILE__) ."/toc/book.solr.inc";
$setup = array (
  'home' => 
  array (
    0 => 'index.php',
    1 => 'PHP Manual',
  ),
  'head' => 
  array (
    0 => 'UTF-8',
    1 => 'it',
  ),
  'this' => 
  array (
    0 => 'class.solrdocument.php',
    1 => 'SolrDocument',
    2 => 'The SolrDocument class',
  ),
  'up' => 
  array (
    0 => 'book.solr.php',
    1 => 'Solr',
  ),
  'prev' => 
  array (
    0 => 'solrinputdocument.toarray.php',
    1 => 'SolrInputDocument::toArray',
  ),
  'next' => 
  array (
    0 => 'solrdocument.addfield.php',
    1 => 'SolrDocument::addField',
  ),
  'alternatives' => 
  array (
  ),
  'source' => 
  array (
    'lang' => 'en',
    'path' => 'reference/solr/solrdocument.xml',
  ),
  'history' => 
  array (
  ),
  'extra_header_links' => 
  array (
    'rel' => 'alternate',
    'href' => '/manual/en/feeds/class.solrdocument.atom',
    'type' => 'application/atom+xml',
  ),
);
$setup["toc"] = $TOC;
$setup["toc_deprecated"] = $TOC_DEPRECATED;
$setup["parents"] = $PARENTS;
manual_setup($setup);

contributors($setup);

?>
<div id="class.solrdocument" class="reference">

 <h1 class="title">The SolrDocument class</h1>
 

 <div class="partintro"><p class="verinfo">(PECL solr &gt;= 0.9.2)</p>


  <div class="section" id="solrdocument.intro">
   <h2 class="title">Introduzione</h2>
   <p class="para">
    Represents a Solr document retrieved from a query response.
   </p>
  </div>


  <div class="section" id="solrdocument.synopsis">
   <h2 class="title">Sommario della classe</h2>


   <div class="classsynopsis">
    <span class="ooclass"><strong class="classname"></strong></span>


    <div class="classsynopsisinfo">
     <span class="ooclass">
      <span class="modifier">final</span>
      <span class="modifier">class</span> <strong class="classname">SolrDocument</strong>
     </span>
     
     <span class="oointerface"><span class="modifier">implements</span> 
       <a href="class.arrayaccess.php" class="interfacename">ArrayAccess</a></span><span class="oointerface">,  <a href="class.iterator.php" class="interfacename">Iterator</a></span><span class="oointerface">,  <a href="class.serializable.php" class="interfacename">Serializable</a></span> {</div>

    <div class="classsynopsisinfo classsynopsisinfo_comment">/* Costanti */</div>
    <div class="fieldsynopsis">
     <span class="modifier">const</span>
     <span class="type"><a href="language.types.integer.php" class="type int">int</a></span>
      <var class="fieldsynopsis_varname"><a href="class.solrdocument.php#solrdocument.constants.sort-default"><var class="varname">SORT_DEFAULT</var></a></var><span class="initializer"> = 1</span>;</div>

    <div class="fieldsynopsis"><span class="modifier">const</span>
     <span class="type"><a href="language.types.integer.php" class="type int">int</a></span>
      <var class="fieldsynopsis_varname"><a href="class.solrdocument.php#solrdocument.constants.sort-asc"><var class="varname">SORT_ASC</var></a></var><span class="initializer"> = 1</span>;</div>

    <div class="fieldsynopsis"><span class="modifier">const</span>
     <span class="type"><a href="language.types.integer.php" class="type int">int</a></span>
      <var class="fieldsynopsis_varname"><a href="class.solrdocument.php#solrdocument.constants.sort-desc"><var class="varname">SORT_DESC</var></a></var><span class="initializer"> = 2</span>;</div>

    <div class="fieldsynopsis"><span class="modifier">const</span>
     <span class="type"><a href="language.types.integer.php" class="type int">int</a></span>
      <var class="fieldsynopsis_varname"><a href="class.solrdocument.php#solrdocument.constants.sort-field-name"><var class="varname">SORT_FIELD_NAME</var></a></var><span class="initializer"> = 1</span>;</div>

    <div class="fieldsynopsis"><span class="modifier">const</span>
     <span class="type"><a href="language.types.integer.php" class="type int">int</a></span>
      <var class="fieldsynopsis_varname"><a href="class.solrdocument.php#solrdocument.constants.sort-field-value-count"><var class="varname">SORT_FIELD_VALUE_COUNT</var></a></var><span class="initializer"> = 2</span>;</div>

    <div class="fieldsynopsis"><span class="modifier">const</span>
     <span class="type"><a href="language.types.integer.php" class="type int">int</a></span>
      <var class="fieldsynopsis_varname"><a href="class.solrdocument.php#solrdocument.constants.sort-field-boost-value"><var class="varname">SORT_FIELD_BOOST_VALUE</var></a></var><span class="initializer"> = 4</span>;</div>

    
    <div class="classsynopsisinfo classsynopsisinfo_comment">/* Metodi */</div>
    <div class="constructorsynopsis dc-description">
   <span class="modifier">public</span> <span class="methodname"><a href="solrdocument.construct.php" class="methodname">__construct</a></span>()</div>

    <div class="methodsynopsis dc-description"><span class="modifier">public</span> <span class="methodname"><a href="solrdocument.addfield.php" class="methodname">addField</a></span>(<span class="methodparam"><span class="type"><a href="language.types.string.php" class="type string">string</a></span> <code class="parameter">$fieldName</code></span>, <span class="methodparam"><span class="type"><a href="language.types.string.php" class="type string">string</a></span> <code class="parameter">$fieldValue</code></span>): <span class="type"><a href="language.types.boolean.php" class="type bool">bool</a></span></div>
<div class="methodsynopsis dc-description"><span class="modifier">public</span> <span class="methodname"><a href="solrdocument.clear.php" class="methodname">clear</a></span>(): <span class="type"><a href="language.types.boolean.php" class="type bool">bool</a></span></div>
<div class="methodsynopsis dc-description"><span class="modifier">public</span> <span class="methodname"><a href="solrdocument.clone.php" class="methodname">__clone</a></span>(): <span class="type"><a href="language.types.void.php" class="type void">void</a></span></div>
<div class="methodsynopsis dc-description"><span class="modifier">public</span> <span class="methodname"><a href="solrdocument.current.php" class="methodname">current</a></span>(): <span class="type"><a href="class.solrdocumentfield.php" class="type SolrDocumentField">SolrDocumentField</a></span></div>
<div class="methodsynopsis dc-description"><span class="modifier">public</span> <span class="methodname"><a href="solrdocument.deletefield.php" class="methodname">deleteField</a></span>(<span class="methodparam"><span class="type"><a href="language.types.string.php" class="type string">string</a></span> <code class="parameter">$fieldName</code></span>): <span class="type"><a href="language.types.boolean.php" class="type bool">bool</a></span></div>
<div class="methodsynopsis dc-description"><span class="modifier">public</span> <span class="methodname"><a href="solrdocument.fieldexists.php" class="methodname">fieldExists</a></span>(<span class="methodparam"><span class="type"><a href="language.types.string.php" class="type string">string</a></span> <code class="parameter">$fieldName</code></span>): <span class="type"><a href="language.types.boolean.php" class="type bool">bool</a></span></div>
<div class="methodsynopsis dc-description"><span class="modifier">public</span> <span class="methodname"><a href="solrdocument.get.php" class="methodname">__get</a></span>(<span class="methodparam"><span class="type"><a href="language.types.string.php" class="type string">string</a></span> <code class="parameter">$fieldName</code></span>): <span class="type"><a href="class.solrdocumentfield.php" class="type SolrDocumentField">SolrDocumentField</a></span></div>
<div class="methodsynopsis dc-description"><span class="modifier">public</span> <span class="methodname"><a href="solrdocument.getchilddocuments.php" class="methodname">getChildDocuments</a></span>(): <span class="type"><a href="language.types.array.php" class="type array">array</a></span></div>
<div class="methodsynopsis dc-description"><span class="modifier">public</span> <span class="methodname"><a href="solrdocument.getchilddocumentscount.php" class="methodname">getChildDocumentsCount</a></span>(): <span class="type"><a href="language.types.integer.php" class="type int">int</a></span></div>
<div class="methodsynopsis dc-description"><span class="modifier">public</span> <span class="methodname"><a href="solrdocument.getfield.php" class="methodname">getField</a></span>(<span class="methodparam"><span class="type"><a href="language.types.string.php" class="type string">string</a></span> <code class="parameter">$fieldName</code></span>): <span class="type"><a href="class.solrdocumentfield.php" class="type SolrDocumentField">SolrDocumentField</a></span></div>
<div class="methodsynopsis dc-description"><span class="modifier">public</span> <span class="methodname"><a href="solrdocument.getfieldcount.php" class="methodname">getFieldCount</a></span>(): <span class="type"><a href="language.types.integer.php" class="type int">int</a></span></div>
<div class="methodsynopsis dc-description"><span class="modifier">public</span> <span class="methodname"><a href="solrdocument.getfieldnames.php" class="methodname">getFieldNames</a></span>(): <span class="type"><a href="language.types.array.php" class="type array">array</a></span></div>
<div class="methodsynopsis dc-description"><span class="modifier">public</span> <span class="methodname"><a href="solrdocument.getinputdocument.php" class="methodname">getInputDocument</a></span>(): <span class="type"><a href="class.solrinputdocument.php" class="type SolrInputDocument">SolrInputDocument</a></span></div>
<div class="methodsynopsis dc-description"><span class="modifier">public</span> <span class="methodname"><a href="solrdocument.haschilddocuments.php" class="methodname">hasChildDocuments</a></span>(): <span class="type"><a href="language.types.boolean.php" class="type bool">bool</a></span></div>
<div class="methodsynopsis dc-description"><span class="modifier">public</span> <span class="methodname"><a href="solrdocument.isset.php" class="methodname">__isset</a></span>(<span class="methodparam"><span class="type"><a href="language.types.string.php" class="type string">string</a></span> <code class="parameter">$fieldName</code></span>): <span class="type"><a href="language.types.boolean.php" class="type bool">bool</a></span></div>
<div class="methodsynopsis dc-description"><span class="modifier">public</span> <span class="methodname"><a href="solrdocument.key.php" class="methodname">key</a></span>(): <span class="type"><a href="language.types.string.php" class="type string">string</a></span></div>
<div class="methodsynopsis dc-description"><span class="modifier">public</span> <span class="methodname"><a href="solrdocument.merge.php" class="methodname">merge</a></span>(<span class="methodparam"><span class="type"><a href="class.solrdocument.php" class="type SolrDocument">SolrDocument</a></span> <code class="parameter">$sourceDoc</code></span>, <span class="methodparam"><span class="type"><a href="language.types.boolean.php" class="type bool">bool</a></span> <code class="parameter">$overwrite</code><span class="initializer"> = <strong><code><a href="reserved.constants.php#constant.true">true</a></code></strong></span></span>): <span class="type"><a href="language.types.boolean.php" class="type bool">bool</a></span></div>
<div class="methodsynopsis dc-description"><span class="modifier">public</span> <span class="methodname"><a href="solrdocument.next.php" class="methodname">next</a></span>(): <span class="type"><a href="language.types.void.php" class="type void">void</a></span></div>
<div class="methodsynopsis dc-description"><span class="modifier">public</span> <span class="methodname"><a href="solrdocument.offsetexists.php" class="methodname">offsetExists</a></span>(<span class="methodparam"><span class="type"><a href="language.types.string.php" class="type string">string</a></span> <code class="parameter">$fieldName</code></span>): <span class="type"><a href="language.types.boolean.php" class="type bool">bool</a></span></div>
<div class="methodsynopsis dc-description"><span class="modifier">public</span> <span class="methodname"><a href="solrdocument.offsetget.php" class="methodname">offsetGet</a></span>(<span class="methodparam"><span class="type"><a href="language.types.string.php" class="type string">string</a></span> <code class="parameter">$fieldName</code></span>): <span class="type"><a href="class.solrdocumentfield.php" class="type SolrDocumentField">SolrDocumentField</a></span></div>
<div class="methodsynopsis dc-description"><span class="modifier">public</span> <span class="methodname"><a href="solrdocument.offsetset.php" class="methodname">offsetSet</a></span>(<span class="methodparam"><span class="type"><a href="language.types.string.php" class="type string">string</a></span> <code class="parameter">$fieldName</code></span>, <span class="methodparam"><span class="type"><a href="language.types.string.php" class="type string">string</a></span> <code class="parameter">$fieldValue</code></span>): <span class="type"><a href="language.types.void.php" class="type void">void</a></span></div>
<div class="methodsynopsis dc-description"><span class="modifier">public</span> <span class="methodname"><a href="solrdocument.offsetunset.php" class="methodname">offsetUnset</a></span>(<span class="methodparam"><span class="type"><a href="language.types.string.php" class="type string">string</a></span> <code class="parameter">$fieldName</code></span>): <span class="type"><a href="language.types.void.php" class="type void">void</a></span></div>
<div class="methodsynopsis dc-description"><span class="modifier">public</span> <span class="methodname"><a href="solrdocument.reset.php" class="methodname">reset</a></span>(): <span class="type"><a href="language.types.boolean.php" class="type bool">bool</a></span></div>
<div class="methodsynopsis dc-description"><span class="modifier">public</span> <span class="methodname"><a href="solrdocument.rewind.php" class="methodname">rewind</a></span>(): <span class="type"><a href="language.types.void.php" class="type void">void</a></span></div>
<div class="methodsynopsis dc-description"><span class="modifier">public</span> <span class="methodname"><a href="solrdocument.serialize.php" class="methodname">serialize</a></span>(): <span class="type"><a href="language.types.string.php" class="type string">string</a></span></div>
<div class="methodsynopsis dc-description"><span class="modifier">public</span> <span class="methodname"><a href="solrdocument.set.php" class="methodname">__set</a></span>(<span class="methodparam"><span class="type"><a href="language.types.string.php" class="type string">string</a></span> <code class="parameter">$fieldName</code></span>, <span class="methodparam"><span class="type"><a href="language.types.string.php" class="type string">string</a></span> <code class="parameter">$fieldValue</code></span>): <span class="type"><a href="language.types.boolean.php" class="type bool">bool</a></span></div>
<div class="methodsynopsis dc-description"><span class="modifier">public</span> <span class="methodname"><a href="solrdocument.sort.php" class="methodname">sort</a></span>(<span class="methodparam"><span class="type"><a href="language.types.integer.php" class="type int">int</a></span> <code class="parameter">$sortOrderBy</code></span>, <span class="methodparam"><span class="type"><a href="language.types.integer.php" class="type int">int</a></span> <code class="parameter">$sortDirection</code><span class="initializer"> = SolrDocument::SORT_ASC</span></span>): <span class="type"><a href="language.types.boolean.php" class="type bool">bool</a></span></div>
<div class="methodsynopsis dc-description"><span class="modifier">public</span> <span class="methodname"><a href="solrdocument.toarray.php" class="methodname">toArray</a></span>(): <span class="type"><a href="language.types.array.php" class="type array">array</a></span></div>
<div class="methodsynopsis dc-description"><span class="modifier">public</span> <span class="methodname"><a href="solrdocument.unserialize.php" class="methodname">unserialize</a></span>(<span class="methodparam"><span class="type"><a href="language.types.string.php" class="type string">string</a></span> <code class="parameter">$serialized</code></span>): <span class="type"><a href="language.types.void.php" class="type void">void</a></span></div>
<div class="methodsynopsis dc-description"><span class="modifier">public</span> <span class="methodname"><a href="solrdocument.unset.php" class="methodname">__unset</a></span>(<span class="methodparam"><span class="type"><a href="language.types.string.php" class="type string">string</a></span> <code class="parameter">$fieldName</code></span>): <span class="type"><a href="language.types.boolean.php" class="type bool">bool</a></span></div>
<div class="methodsynopsis dc-description"><span class="modifier">public</span> <span class="methodname"><a href="solrdocument.valid.php" class="methodname">valid</a></span>(): <span class="type"><a href="language.types.boolean.php" class="type bool">bool</a></span></div>

    <div class="destructorsynopsis dc-description"><span class="modifier">public</span> <span class="methodname"><a href="solrdocument.destruct.php" class="methodname">__destruct</a></span>()</div>

   }</div>


  </div>

  

  <div class="section" id="solrdocument.constants">
   <h2 class="title">Costanti predefinite</h2>
   <dl>

    
     <dt id="solrdocument.constants.sort-default"><strong><code><a href="class.solrdocument.php#solrdocument.constants.sort-default">SolrDocument::SORT_DEFAULT</a></code></strong></dt>
     <dd>
      <p class="para">Default mode for sorting fields within the document.</p>
     </dd>
    

    
     <dt id="solrdocument.constants.sort-asc"><strong><code><a href="class.solrdocument.php#solrdocument.constants.sort-asc">SolrDocument::SORT_ASC</a></code></strong></dt>
     <dd>
      <p class="para">Sorts the fields in ascending order</p>
     </dd>
    

    
     <dt id="solrdocument.constants.sort-desc"><strong><code><a href="class.solrdocument.php#solrdocument.constants.sort-desc">SolrDocument::SORT_DESC</a></code></strong></dt>
     <dd>
      <p class="para">Sorts the fields in descending order</p>
     </dd>
    

    
     <dt id="solrdocument.constants.sort-field-name"><strong><code><a href="class.solrdocument.php#solrdocument.constants.sort-field-name">SolrDocument::SORT_FIELD_NAME</a></code></strong></dt>
     <dd>
      <p class="para">Sorts the fields by field name.</p>
     </dd>
    

    
     <dt id="solrdocument.constants.sort-field-value-count"><strong><code><a href="class.solrdocument.php#solrdocument.constants.sort-field-value-count">SolrDocument::SORT_FIELD_VALUE_COUNT</a></code></strong></dt>
     <dd>
      <p class="para">Sorts the fields by number of values in each field.</p>
     </dd>
    

    
     <dt id="solrdocument.constants.sort-field-boost-value"><strong><code><a href="class.solrdocument.php#solrdocument.constants.sort-field-boost-value">SolrDocument::SORT_FIELD_BOOST_VALUE</a></code></strong></dt>
     <dd>
      <p class="para">Sorts the fields by their boost values.</p>
     </dd>
    

   </dl>
  </div>



 </div>

 







































































































































































































































<h2>Indice dei contenuti</h2><ul class="chunklist chunklist_reference"><li><a href="solrdocument.addfield.php">SolrDocument::addField</a> — Adds a field to the document</li><li><a href="solrdocument.clear.php">SolrDocument::clear</a> — Drops all the fields in the document</li><li><a href="solrdocument.clone.php">SolrDocument::__clone</a> — Creates a copy of a SolrDocument object</li><li><a href="solrdocument.construct.php">SolrDocument::__construct</a> — Constructor</li><li><a href="solrdocument.current.php">SolrDocument::current</a> — Retrieves the current field</li><li><a href="solrdocument.deletefield.php">SolrDocument::deleteField</a> — Removes a field from the document</li><li><a href="solrdocument.destruct.php">SolrDocument::__destruct</a> — Destructor</li><li><a href="solrdocument.fieldexists.php">SolrDocument::fieldExists</a> — Checks if a field exists in the document</li><li><a href="solrdocument.get.php">SolrDocument::__get</a> — Access the field as a property</li><li><a href="solrdocument.getchilddocuments.php">SolrDocument::getChildDocuments</a> — Returns an array of child documents (SolrDocument)</li><li><a href="solrdocument.getchilddocumentscount.php">SolrDocument::getChildDocumentsCount</a> — Returns the number of child documents</li><li><a href="solrdocument.getfield.php">SolrDocument::getField</a> — Retrieves a field by name</li><li><a href="solrdocument.getfieldcount.php">SolrDocument::getFieldCount</a> — Returns the number of fields in this document</li><li><a href="solrdocument.getfieldnames.php">SolrDocument::getFieldNames</a> — Returns an array of fields names in the document</li><li><a href="solrdocument.getinputdocument.php">SolrDocument::getInputDocument</a> — Returns a SolrInputDocument equivalent of the object</li><li><a href="solrdocument.haschilddocuments.php">SolrDocument::hasChildDocuments</a> — Checks whether the document has any child documents</li><li><a href="solrdocument.isset.php">SolrDocument::__isset</a> — Checks if a field exists</li><li><a href="solrdocument.key.php">SolrDocument::key</a> — Retrieves the current key</li><li><a href="solrdocument.merge.php">SolrDocument::merge</a> — Merges source to the current SolrDocument</li><li><a href="solrdocument.next.php">SolrDocument::next</a> — Moves the internal pointer to the next field</li><li><a href="solrdocument.offsetexists.php">SolrDocument::offsetExists</a> — Checks if a particular field exists</li><li><a href="solrdocument.offsetget.php">SolrDocument::offsetGet</a> — Retrieves a field</li><li><a href="solrdocument.offsetset.php">SolrDocument::offsetSet</a> — Adds a field to the document</li><li><a href="solrdocument.offsetunset.php">SolrDocument::offsetUnset</a> — Removes a field</li><li><a href="solrdocument.reset.php">SolrDocument::reset</a> — Alias di SolrDocument::clear</li><li><a href="solrdocument.rewind.php">SolrDocument::rewind</a> — Resets the internal pointer to the beginning</li><li><a href="solrdocument.serialize.php">SolrDocument::serialize</a> — Used for custom serialization</li><li><a href="solrdocument.set.php">SolrDocument::__set</a> — Adds another field to the document</li><li><a href="solrdocument.sort.php">SolrDocument::sort</a> — Sorts the fields in the document</li><li><a href="solrdocument.toarray.php">SolrDocument::toArray</a> — Returns an array representation of the document</li><li><a href="solrdocument.unserialize.php">SolrDocument::unserialize</a> — Custom serialization of SolrDocument objects</li><li><a href="solrdocument.unset.php">SolrDocument::__unset</a> — Removes a field from the document</li><li><a href="solrdocument.valid.php">SolrDocument::valid</a> — Checks if the current position internally is still valid</li></ul>
</div>
<?php manual_footer($setup); ?>