Service/DeveloperGarden/LocalSearch/SearchParameters.php

Show: PublicProtectedPrivateinherited
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-2014 Zend Technologies USA Inc. (http://www.zend.com)  
License
New BSD License  
Package
Zend_Service  
Subpackage
DeveloperGarden  
Version
$Id$  

\Zend_Service_DeveloperGarden_LocalSearch_SearchParameters

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

Properties

>VPropertyprivatearray $_parameters = array('what' => null, 'dymwhat' => null, 'dymrelated' => null, 'hits' => null, 'collapse' => null, 'where' => null, 'dywhere' => null, 'radius' => null, 'lx' => null, 'ly' => null, 'rx' => null, 'ry' => null, 'transformgeocode' => null, 'sort' => null, 'spatial' => null, 'sepcomm' => null, 'filter' => null, 'openingtime' => null, 'kategorie' => null, 'site' => null, 'typ' => null, 'name' => null, 'page' => null, 'city' => null, 'plz' => null, 'strasse' => null, 'bundesland' => null)
possible search parameters, incl. default values
Default valuearray('what' => null, 'dymwhat' => null, 'dymrelated' => null, 'hits' => null, 'collapse' => null, 'where' => null, 'dywhere' => null, 'radius' => null, 'lx' => null, 'ly' => null, 'rx' => null, 'ry' => null, 'transformgeocode' => null, 'sort' => null, 'spatial' => null, 'sepcomm' => null, 'filter' => null, 'openingtime' => null, 'kategorie' => null, 'site' => null, 'typ' => null, 'name' => null, 'page' => null, 'city' => null, 'plz' => null, 'strasse' => null, 'bundesland' => null)Details
Type
array
>VPropertyprivatearray $_possibleCollapseValues = array(true, false, 'ADDRESS_COMPANY', 'DOMAIN')
possible collapse values
Default valuearray(true, false, 'ADDRESS_COMPANY', 'DOMAIN')Details
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

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

methodpublicgetSearchParameters() : array

returns the parameters as an array

Returns
TypeDescription
array
methodpublicgetWhere() : string

returns the defined search location (ie city, country)

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

sets a category filter

Parameters
NameTypeDescription
$categorystring
Returns
TypeDescription
\Zend_Service_DeveloperGarden_LocalSearch_SearchParameters
Details
See
 
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
NameTypeDescription
$valuemixed
Returns
TypeDescription
\Zend_Service_DeveloperGarden_LocalSearch_SearchParameters
methodpublicsetCounty(string $county) : \Zend_Service_DeveloperGarden_LocalSearch_SearchParameters

sets a filter for the county

Parameters
NameTypeDescription
$countystring
Returns
TypeDescription
\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
NameTypeDescription
$typestring
Returns
TypeDescription
\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
NameTypeDescription
$hitsinteger
Returns
TypeDescription
\Zend_Service_DeveloperGarden_LocalSearch_SearchParameters
methodpublicsetName(string $name) : \Zend_Service_DeveloperGarden_LocalSearch_SearchParameters

sets a filter for the company name ie: Deutsche Telekom

Parameters
NameTypeDescription
$namestring
Returns
TypeDescription
\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
NameTypeDescription
$timestring
Returns
TypeDescription
\Zend_Service_DeveloperGarden_LocalSearch_SearchParameters
methodpublicsetRadius(integer $radius) : \Zend_Service_DeveloperGarden_LocalSearch_SearchParameters

sets spatial and the given radius for a circle search

Parameters
NameTypeDescription
$radiusinteger
Returns
TypeDescription
\Zend_Service_DeveloperGarden_LocalSearch_SearchParameters
methodpublicsetRawParameter(string $key, mixed $value) : \unknown_type

sets a raw parameter with the value

Parameters
NameTypeDescription
$keystring
$valuemixed
Returns
TypeDescription
\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
NameTypeDescription
$lxfloat
$lyfloat
$rxfloat
$ryfloat
Returns
TypeDescription
\Zend_Service_DeveloperGarden_LocalSearch_SearchParameters
methodpublicsetSearchValue(string $searchValue) : \Zend_Service_DeveloperGarden_LocalSearch_SearchParameters

sets a new search word alias for setWhat

Parameters
NameTypeDescription
$searchValuestring
Returns
TypeDescription
\Zend_Service_DeveloperGarden_LocalSearch_SearchParameters
methodpublicsetSite(string $site) : \Zend_Service_DeveloperGarden_LocalSearch_SearchParameters

sets the site filter ie: www.developergarden.com

Parameters
NameTypeDescription
$sitestring
Returns
TypeDescription
\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
NameTypeDescription
$sortstring
Returns
TypeDescription
\Zend_Service_DeveloperGarden_LocalSearch_SearchParameters
methodpublicsetStreet(string $street) : \Zend_Service_DeveloperGarden_LocalSearch_SearchParameters

sets a filter for the street

Parameters
NameTypeDescription
$streetstring
Returns
TypeDescription
\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
NameTypeDescription
$searchValuestring
Returns
TypeDescription
\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
NameTypeDescription
$wherestring
Returns
TypeDescription
\Zend_Service_DeveloperGarden_LocalSearch_SearchParameters
methodpublicsetZipCode(string $zip) : \Zend_Service_DeveloperGarden_LocalSearch_SearchParameters

sets a filter for the zip code

Parameters
NameTypeDescription
$zipstring
Returns
TypeDescription
\Zend_Service_DeveloperGarden_LocalSearch_SearchParameters
Documentation was generated by phpDocumentor 2.2.0 .