API Documentation

Zend/Service/DeveloperGarden/LocalSearch/SearchParameters.php

Show: inherited
Table of Contents

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.

Category
Zend  
Copyright
Copyright (c) 2005-2012 Zend Technologies USA Inc. (http://www.zend.com)  
License
New BSD License  
Package
Zend_Service  
Subpackage
DeveloperGarden  
Version
$Id: SearchParameters.php 24594 2012-01-05 21:27:01Z matthew $  

\Zend_Service_DeveloperGarden_LocalSearch_SearchParameters

Package: Zend\Service\DeveloperGarden

Author
Marco Kaiser  
Category
Zend  
Copyright
Copyright (c) 2005-2012 Zend Technologies USA Inc. (http://www.zend.com)  
License
New BSD License  

Properties

Propertyprivatearray  $_parameters= 'array( 'what' => null'

possible search parameters, incl. default values

Default valuearray( 'what' => nullDetails
Type
array
Propertyprivatearray  $_possibleCollapseValues= 'array( true'

possible collapse values

Default valuearray( trueDetails
Type
array

Methods

methodpublicdisableDidYouMeanRelated( ) : \Zend_Service_DeveloperGarden_LocalSearch_SearchParameters

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

methodpublicdisableDidYouMeanWhat( ) : \Zend_Service_DeveloperGarden_LocalSearch_SearchParameters

disable the did you mean what feature

methodpublicdisableDidYouMeanWhere( ) : \Zend_Service_DeveloperGarden_LocalSearch_SearchParameters

disable the did you mean where feature

methodpublicdisablePhoneSeparation( ) : \Zend_Service_DeveloperGarden_LocalSearch_SearchParameters

disable the separation of phone numbers

methodpublicdisableSpatial( ) : \Zend_Service_DeveloperGarden_LocalSearch_SearchParameters

disable the spatial search feature

methodpublicenableDidYouMeanRelated( ) : \Zend_Service_DeveloperGarden_LocalSearch_SearchParameters

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

methodpublicenableDidYouMeanWhat( ) : \Zend_Service_DeveloperGarden_LocalSearch_SearchParameters

enable the did you mean what feature

methodpublicenableDidYouMeanWhere( ) : \Zend_Service_DeveloperGarden_LocalSearch_SearchParameters

enable the did you mean where feature

methodpublicenablePhoneSeparation( ) : \Zend_Service_DeveloperGarden_LocalSearch_SearchParameters

enable the separation of phone numbers

methodpublicenableSpatial( ) : \Zend_Service_DeveloperGarden_LocalSearch_SearchParameters

enable the spatial search feature

methodpublicgetSearchParameters( ) : array

returns the parameters as an array

Returns
Type Description
array
methodpublicgetWhere( ) : string

returns the defined search location (ie city, country)

Returns
Type Description
string
methodpublicsetCategory( string $category = null ) : \Zend_Service_DeveloperGarden_LocalSearch_SearchParameters

sets a category filter

Parameters
Name Type Description
$category string
Returns
Type Description
\Zend_Service_DeveloperGarden_LocalSearch_SearchParameters
Details
See
\http://www.suchen.de/kategorie-katalog  
methodpublicsetCollapse( 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

Parameters
Name Type Description
$value mixed
Returns
Type Description
\Zend_Service_DeveloperGarden_LocalSearch_SearchParameters
methodpublicsetCounty( string $county ) : \Zend_Service_DeveloperGarden_LocalSearch_SearchParameters

sets a filter for the county

Parameters
Name Type Description
$county string
Returns
Type Description
\Zend_Service_DeveloperGarden_LocalSearch_SearchParameters
methodpublicsetDocumentType( string $type ) : \Zend_Service_DeveloperGarden_LocalSearch_SearchParameters

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

Parameters
Name Type Description
$type string
Returns
Type Description
\Zend_Service_DeveloperGarden_LocalSearch_SearchParameters
methodpublicsetFilterOffliner( ) : \Zend_Service_DeveloperGarden_LocalSearch_SearchParameters

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

methodpublicsetFilterOnliner( ) : \Zend_Service_DeveloperGarden_LocalSearch_SearchParameters

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

methodpublicsetHits( integer $hits = 10 ) : \Zend_Service_DeveloperGarden_LocalSearch_SearchParameters

set the max result hits for this search

Parameters
Name Type Description
$hits integer
Returns
Type Description
\Zend_Service_DeveloperGarden_LocalSearch_SearchParameters
methodpublicsetName( string $name ) : \Zend_Service_DeveloperGarden_LocalSearch_SearchParameters

sets a filter for the company name ie: Deutsche Telekom

Parameters
Name Type Description
$name string
Returns
Type Description
\Zend_Service_DeveloperGarden_LocalSearch_SearchParameters
methodpublicsetOpeningTime( 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)

Parameters
Name Type Description
$time string
Returns
Type Description
\Zend_Service_DeveloperGarden_LocalSearch_SearchParameters
methodpublicsetRadius( integer $radius ) : \Zend_Service_DeveloperGarden_LocalSearch_SearchParameters

sets spatial and the given radius for a circle search

Parameters
Name Type Description
$radius integer
Returns
Type Description
\Zend_Service_DeveloperGarden_LocalSearch_SearchParameters
methodpublicsetRawParameter( string $key, mixed $value ) : \unknown_type

sets a raw parameter with the value

Parameters
Name Type Description
$key string
$value mixed
Returns
Type Description
\unknown_type
methodpublicsetRectangle( float $lx, float $ly, float $rx, float $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

Parameters
Name Type Description
$lx float
$ly float
$rx float
$ry float
Returns
Type Description
\Zend_Service_DeveloperGarden_LocalSearch_SearchParameters
methodpublicsetSearchValue( string $searchValue ) : \Zend_Service_DeveloperGarden_LocalSearch_SearchParameters

sets a new search word alias for setWhat

Parameters
Name Type Description
$searchValue string
Returns
Type Description
\Zend_Service_DeveloperGarden_LocalSearch_SearchParameters
methodpublicsetSite( string $site ) : \Zend_Service_DeveloperGarden_LocalSearch_SearchParameters

sets the site filter ie: www.developergarden.com

Parameters
Name Type Description
$site string
Returns
Type Description
\Zend_Service_DeveloperGarden_LocalSearch_SearchParameters
methodpublicsetSort( string $sort ) : \Zend_Service_DeveloperGarden_LocalSearch_SearchParameters

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

Parameters
Name Type Description
$sort string
Returns
Type Description
\Zend_Service_DeveloperGarden_LocalSearch_SearchParameters
methodpublicsetStreet( string $street ) : \Zend_Service_DeveloperGarden_LocalSearch_SearchParameters

sets a filter for the street

Parameters
Name Type Description
$street string
Returns
Type Description
\Zend_Service_DeveloperGarden_LocalSearch_SearchParameters
methodpublicsetTransformGeoCode( ) : \Zend_Service_DeveloperGarden_LocalSearch_SearchParameters

if set, the service returns the zipcode for the result

methodpublicsetWhat( string $searchValue ) : \Zend_Service_DeveloperGarden_LocalSearch_SearchParameters

sets a new search word

Parameters
Name Type Description
$searchValue string
Returns
Type Description
\Zend_Service_DeveloperGarden_LocalSearch_SearchParameters
methodpublicsetWhere( 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

Parameters
Name Type Description
$where string
Returns
Type Description
\Zend_Service_DeveloperGarden_LocalSearch_SearchParameters
methodpublicsetZipCode( string $zip ) : \Zend_Service_DeveloperGarden_LocalSearch_SearchParameters

sets a filter for the zip code

Parameters
Name Type Description
$zip string
Returns
Type Description
\Zend_Service_DeveloperGarden_LocalSearch_SearchParameters
Documentation was generated by DocBlox 0.15.1.