Service/DeveloperGarden/LocalSearch/SearchParameters.php

category: Zend
copyright: Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
license: http://framework.zend.com/license/new-bsd New BSD License
package: Zend_Service
subpackage: DeveloperGarden
version: $Id: SearchParameters.php 20166 2010-01-09 19:00:17Z bkarwin $
Classes: Zend_Service_DeveloperGarden_LocalSearch_SearchParameters

Description

Zend Framework

LICENSE

This source file is subject to the new BSD license that is bundled with this package in the file LICENSE.txt. It is also available through the world-wide-web at this URL: http://framework.zend.com/license/new-bsd If you did not receive a copy of the license and are unable to obtain it through the world-wide-web, please send an email to license@zend.com so we can send you a copy immediately.

Zend_Service_DeveloperGarden_LocalSearch_SearchParameters
jump to top

author: Marco Kaiser
category: Zend
copyright: Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
license: http://framework.zend.com/license/new-bsd New BSD License
package: Zend_Service
subpackage: DeveloperGarden
Properties: $_parameters; $_possibleCollapseValues
Methods: setSearchValue; setWhat; enableDidYouMeanWhat; disableDidYouMeanWhat; enableDidYouMeanWhere; disableDidYouMeanWhere; enableDidYouMeanRelated; disableDidYouMeanRelated; setHits; setCollapse; setWhere; getWhere; enableSpatial; disableSpatial; setRadius; setRectangle; setTransformGeoCode; setSort; enablePhoneSeparation; disablePhoneSeparation; setFilterOnliner; setFilterOffliner; disableFilter; setOpeningTime; setCategory; setSite; setDocumentType; setName; setZipCode; setStreet; setCounty; setRawParameter; getSearchParameters

Description

Properties

$_parameters
jump to class

array $_parameters = 'array'

possible search parameters, incl. default values

Details

$_parameters: array
visibility: private
default: array
final: false
static: false

$_possibleCollapseValues
jump to class

array $_possibleCollapseValues = 'array'

possible collapse values

Details

$_possibleCollapseValues: array
visibility: private
default: array
final: false
static: false

Methods

disableDidYouMeanRelated
jump to class

disableDidYouMeanRelated(
          
          )
        
        :
        Zend_Service_DeveloperGarden_LocalSearch_SearchParameters

diable did you mean related, if false Kihno will not be corrected to Kino

Output

Zend_Service_DeveloperGarden_LocalSearch_SearchParameters

Details

visibility: public
final: false
static: false

disableDidYouMeanWhat
jump to class

disableDidYouMeanWhat(
          
          )
        
        :
        Zend_Service_DeveloperGarden_LocalSearch_SearchParameters

disable the did you mean what feature

Output

Zend_Service_DeveloperGarden_LocalSearch_SearchParameters

Details

visibility: public
final: false
static: false

disableDidYouMeanWhere
jump to class

disableDidYouMeanWhere(
          
          )
        
        :
        Zend_Service_DeveloperGarden_LocalSearch_SearchParameters

disable the did you mean where feature

Output

Zend_Service_DeveloperGarden_LocalSearch_SearchParameters

Details

visibility: public
final: false
static: false

disableFilter
jump to class

disableFilter(
          
          )
        
        :
        Zend_Service_DeveloperGarden_LocalSearch_SearchParameters

removes the filter value

Output

Zend_Service_DeveloperGarden_LocalSearch_SearchParameters

Details

visibility: public
final: false
static: false

disablePhoneSeparation
jump to class

disablePhoneSeparation(
          
          )
        
        :
        Zend_Service_DeveloperGarden_LocalSearch_SearchParameters

disable the separation of phone numbers

Output

Zend_Service_DeveloperGarden_LocalSearch_SearchParameters

Details

visibility: public
final: false
static: false

disableSpatial
jump to class

disableSpatial(
          
          )
        
        :
        Zend_Service_DeveloperGarden_LocalSearch_SearchParameters

disable the spatial search feature

Output

Zend_Service_DeveloperGarden_LocalSearch_SearchParameters

Details

visibility: public
final: false
static: false

enableDidYouMeanRelated
jump to class

enableDidYouMeanRelated(
          
          )
        
        :
        Zend_Service_DeveloperGarden_LocalSearch_SearchParameters

enable did you mean related, if true Kihno will be corrected to Kino

Output

Zend_Service_DeveloperGarden_LocalSearch_SearchParameters

Details

visibility: public
final: false
static: false

enableDidYouMeanWhat
jump to class

enableDidYouMeanWhat(
          
          )
        
        :
        Zend_Service_DeveloperGarden_LocalSearch_SearchParameters

enable the did you mean what feature

Output

Zend_Service_DeveloperGarden_LocalSearch_SearchParameters

Details

visibility: public
final: false
static: false

enableDidYouMeanWhere
jump to class

enableDidYouMeanWhere(
          
          )
        
        :
        Zend_Service_DeveloperGarden_LocalSearch_SearchParameters

enable the did you mean where feature

Output

Zend_Service_DeveloperGarden_LocalSearch_SearchParameters

Details

visibility: public
final: false
static: false

enablePhoneSeparation
jump to class

enablePhoneSeparation(
          
          )
        
        :
        Zend_Service_DeveloperGarden_LocalSearch_SearchParameters

enable the separation of phone numbers

Output

Zend_Service_DeveloperGarden_LocalSearch_SearchParameters

Details

visibility: public
final: false
static: false

enableSpatial
jump to class

enableSpatial(
          
          )
        
        :
        Zend_Service_DeveloperGarden_LocalSearch_SearchParameters

enable the spatial search feature

Output

Zend_Service_DeveloperGarden_LocalSearch_SearchParameters

Details

visibility: public
final: false
static: false

getSearchParameters
jump to class

getSearchParameters(
          
          )
        
        :
        array

returns the parameters as an array

Output

array

Details

visibility: public
final: false
static: false

getWhere
jump to class

getWhere(
          
          )
        
        :
        string

returns the defined search location (ie city, country)

Output

string

Details

visibility: public
final: false
static: false

setCategory
jump to class

setCategory(
           $category
              =
              null
          )
        
        :
        unknown_type

sets a category filter

Arguments

$category

Output

unknown_type

Details

visibility: public
final: false
static: false
see: http://www.suchen.de/kategorie-katalog

setCollapse
jump to class

setCollapse(
          mixed $value
          )
        
        :
        Zend_Service_DeveloperGarden_LocalSearch_SearchParameters

If true, addresses will be collapsed for a single domain, common values are: ADDRESS_COMPANY – to collapse by address DOMAIN – to collapse by domain (same like collapse=true) false

Arguments

$value: mixed

Output

Zend_Service_DeveloperGarden_LocalSearch_SearchParameters

Details

visibility: public
final: false
static: false

setCounty
jump to class

setCounty(
          string $county
          )
        
        :
        Zend_Service_DeveloperGarden_LocalSearch_SearchParameters

sets a filter for the county

Arguments

$county: string

Output

Zend_Service_DeveloperGarden_LocalSearch_SearchParameters

Details

visibility: public
final: false
static: false

setDocumentType
jump to class

setDocumentType(
          string $type
          )
        
        :
        Zend_Service_DeveloperGarden_LocalSearch_SearchParameters

sets a filter to the given document type ie: pdf, html

Arguments

$type: string

Output

Zend_Service_DeveloperGarden_LocalSearch_SearchParameters

Details

visibility: public
final: false
static: false

setFilterOffliner
jump to class

setFilterOffliner(
          
          )
        
        :
        Zend_Service_DeveloperGarden_LocalSearch_SearchParameters

if this filter is set, only results without a website are returned

Output

Zend_Service_DeveloperGarden_LocalSearch_SearchParameters

Details

visibility: public
final: false
static: false

setFilterOnliner
jump to class

setFilterOnliner(
          
          )
        
        :
        Zend_Service_DeveloperGarden_LocalSearch_SearchParameters

if this filter is set, only results with a website are returned

Output

Zend_Service_DeveloperGarden_LocalSearch_SearchParameters

Details

visibility: public
final: false
static: false

setHits
jump to class

setHits(
          integer $hits
              =
              10
          )
        
        :
        Zend_Service_DeveloperGarden_LocalSearch_SearchParameters

set the max result hits for this search

Arguments

$hits: integer

Output

Zend_Service_DeveloperGarden_LocalSearch_SearchParameters

Details

visibility: public
final: false
static: false

setName
jump to class

setName(
          string $name
          )
        
        :
        Zend_Service_DeveloperGarden_LocalSearch_SearchParameters

sets a filter for the company name ie: Deutsche Telekom

Arguments

$name: string

Output

Zend_Service_DeveloperGarden_LocalSearch_SearchParameters

Details

visibility: public
final: false
static: false

setOpeningTime
jump to class

setOpeningTime(
          string $time
              =
              null
          )
        
        :
        Zend_Service_DeveloperGarden_LocalSearch_SearchParameters

set a filter to get just results who are open at the given time possible values: now = open right now HH:MM = at the given time (ie 20:00)

Arguments

$time: string

Output

Zend_Service_DeveloperGarden_LocalSearch_SearchParameters

Details

visibility: public
final: false
static: false

setRadius
jump to class

setRadius(
          integer $radius
          )
        
        :
        Zend_Service_DeveloperGarden_LocalSearch_SearchParameters

sets spatial and the given radius for a circle search

Arguments

$radius: integer

Output

Zend_Service_DeveloperGarden_LocalSearch_SearchParameters

Details

visibility: public
final: false
static: false

setRawParameter
jump to class

setRawParameter(
          string $key, mixed $value
          )
        
        :
        unknown_type

sets a raw parameter with the value

Arguments

$key: string
$value: mixed

Output

unknown_type

Details

visibility: public
final: false
static: false

setRectangle
jump to class

setRectangle(
           $lx,  $ly,  $rx,  $ry
          )
        
        :
        Zend_Service_DeveloperGarden_LocalSearch_SearchParameters

sets the values for a rectangle search lx = longitude left top ly = latitude left top rx = longitude right bottom ry = latitude right bottom

Arguments

$lx
$ly
$rx
$ry

Output

Zend_Service_DeveloperGarden_LocalSearch_SearchParameters

Details

visibility: public
final: false
static: false

setSearchValue
jump to class

setSearchValue(
          string $searchValue
          )
        
        :
        Zend_Service_DeveloperGarden_LocalSearch_SearchParameters

sets a new search word alias for setWhat

Arguments

$searchValue: string

Output

Zend_Service_DeveloperGarden_LocalSearch_SearchParameters

Details

visibility: public
final: false
static: false

setSite
jump to class

setSite(
          string $site
          )
        
        :
        Zend_Service_DeveloperGarden_LocalSearch_SearchParameters

sets the site filter ie: www.developergarden.com

Arguments

$site: string

Output

Zend_Service_DeveloperGarden_LocalSearch_SearchParameters

Details

visibility: public
final: false
static: false

setSort
jump to class

setSort(
          string $sort
          )
        
        :
        Zend_Service_DeveloperGarden_LocalSearch_SearchParameters

sets the sort value possible values are: 'relevance' and 'distance' (only with spatial enabled)

Arguments

$sort: string

Output

Zend_Service_DeveloperGarden_LocalSearch_SearchParameters

Details

visibility: public
final: false
static: false

setStreet
jump to class

setStreet(
          string $street
          )
        
        :
        Zend_Service_DeveloperGarden_LocalSearch_SearchParameters

sets a filter for the street

Arguments

$street: string

Output

Zend_Service_DeveloperGarden_LocalSearch_SearchParameters

Details

visibility: public
final: false
static: false

setTransformGeoCode
jump to class

setTransformGeoCode(
          
          )
        
        :
        Zend_Service_DeveloperGarden_LocalSearch_SearchParameters

if set, the service returns the zipcode for the result

Output

Zend_Service_DeveloperGarden_LocalSearch_SearchParameters

Details

visibility: public
final: false
static: false

setWhat
jump to class

setWhat(
          string $searchValue
          )
        
        :
        Zend_Service_DeveloperGarden_LocalSearch_SearchParameters

sets a new search word

Arguments

$searchValue: string

Output

Zend_Service_DeveloperGarden_LocalSearch_SearchParameters

Details

visibility: public
final: false
static: false

setWhere
jump to class

setWhere(
          string $where
          )
        
        :
        Zend_Service_DeveloperGarden_LocalSearch_SearchParameters

set a specific search location examples: +47°54’53.10”, 11° 10’ 56.76” 47°54’53.10;11°10’56.76” 47.914750,11.182533 +47.914750 ; +11.1824 Darmstadt Berlin

Arguments

$where: string

Output

Zend_Service_DeveloperGarden_LocalSearch_SearchParameters

Details

visibility: public
final: false
static: false

setZipCode
jump to class

setZipCode(
          string $zip
          )
        
        :
        Zend_Service_DeveloperGarden_LocalSearch_SearchParameters

sets a filter for the zip code

Arguments

$zip: string

Output

Zend_Service_DeveloperGarden_LocalSearch_SearchParameters

Details

visibility: public
final: false
static: false

API Documentation

Service/DeveloperGarden/LocalSearch/SearchParameters.php

Description

Zend_Service_DeveloperGarden_LocalSearch_SearchParametersjump to top

Description

Properties

$_parametersjump to class

Details

$_possibleCollapseValuesjump to class

Details

Methods

disableDidYouMeanRelatedjump to class

Output

Details

disableDidYouMeanWhatjump to class

Output

Details

disableDidYouMeanWherejump to class

Output

Details

disableFilterjump to class

Output

Details

disablePhoneSeparationjump to class

Output

Details

disableSpatialjump to class

Output

Details

enableDidYouMeanRelatedjump to class

Output

Details

enableDidYouMeanWhatjump to class

Output

Details

enableDidYouMeanWherejump to class

Output

Details

enablePhoneSeparationjump to class

Output

Details

enableSpatialjump to class

Output

Details

getSearchParametersjump to class

Output

Details

getWherejump to class

Output

Details

setCategoryjump to class

Arguments

Output

Details

setCollapsejump to class

Arguments

Output

Details

setCountyjump to class

Arguments

Output

Details

setDocumentTypejump to class

Arguments

Output

Details

setFilterOfflinerjump to class

Output

Details

setFilterOnlinerjump to class

Output

Details

setHitsjump to class

Arguments

Output

Details

setNamejump to class

Arguments

Output

Details

Zend_Service_DeveloperGarden_LocalSearch_SearchParameters
jump to top

$_parameters
jump to class

$_possibleCollapseValues
jump to class

disableDidYouMeanRelated
jump to class

disableDidYouMeanWhat
jump to class

disableDidYouMeanWhere
jump to class

disableFilter
jump to class

disablePhoneSeparation
jump to class

disableSpatial
jump to class

enableDidYouMeanRelated
jump to class

enableDidYouMeanWhat
jump to class

enableDidYouMeanWhere
jump to class

enablePhoneSeparation
jump to class

enableSpatial
jump to class

getSearchParameters
jump to class

getWhere
jump to class

setCategory
jump to class

setCollapse
jump to class

setCounty
jump to class

setDocumentType
jump to class

setFilterOffliner
jump to class

setFilterOnliner
jump to class

setHits
jump to class

setName
jump to class

setOpeningTime
jump to class

setRadius
jump to class

setRawParameter
jump to class

setRectangle
jump to class

setSearchValue
jump to class

setSite
jump to class

setSort
jump to class

setStreet
jump to class

setTransformGeoCode
jump to class

setWhat
jump to class

setWhere
jump to class

setZipCode
jump to class