php_solr
[ class tree: php_solr ] [ index: php_solr ] [ all elements ]

Class: SolrFacetField

Source Location: /src/search/SolrFacetField.php

Class Overview

SolrFacetFieldParameters
   |
   --SolrFacetField

A facet field.


Author(s):

Methods


Inherited Variables

Inherited Methods

Class: SolrFacetFieldParameters

SolrFacetFieldParameters::buildQueryParameter()
Builds a query parameter.
SolrFacetFieldParameters::getQueryStringPart()
Returns the faceting part of the HTTP query.
SolrFacetFieldParameters::setLimit()
Sets the maximum number of constraint counts.
SolrFacetFieldParameters::setMinCount()
Sets the minimum counts for facet fields.
SolrFacetFieldParameters::setMissing()
Include "missing value" as a facet count?
SolrFacetFieldParameters::setOffset()
Sets the offset for the the list of constraints to allow paging.
SolrFacetFieldParameters::setPrefix()
Sets the facet prefix.
SolrFacetFieldParameters::setSort()
Sets the ordering of the facets.

Class Details

[line 52]
A facet field.



Tags:

author:  Alexander M. Turek <rabus@users.sourceforge.net>
see:  http://wiki.apache.org/solr/SimpleFacetParameters
since:  0.4.1


[ Top ]


Class Methods


constructor __construct [line 58]

SolrFacetField __construct( $fieldName, string $name)

Constructor for SolrFacetField.



Tags:

access:  public


Parameters:

string   $name   The name of the field.
   $fieldName  

[ Top ]

method getName [line 84]

string getName( )

Returns the name of this field.



Tags:

access:  public


[ Top ]

method getQueryStringPart [line 74]

string getQueryStringPart( [string $solrSpecVersion = null])

Returns the faceting part of the HTTP query.



Tags:

access:  public
uses:  urlencode()


Overrides SolrFacetFieldParameters::getQueryStringPart() (Returns the faceting part of the HTTP query.)

Parameters:

string   $solrSpecVersion   The servers specification version (optional).

[ Top ]


Documentation generated on Wed, 20 May 2009 12:51:11 +0000 by phpDocumentor 1.4.2