Class: BingAPI

Source Location: /library/BingAPI.php

Class Overview [line 31]


Bing API PHP Library Version: 1.0 by David González ( http://routecafe.com/ )

Author(s):

Version:

Copyright:

Variables

Constants

Methods


Inherited Variables

Inherited Constants

Inherited Methods



Class Details

Bing API PHP Library Version: 1.0 by David González ( http://routecafe.com/ )

Copyright (c) 2009 David González Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

[ Top ]


Class Variables

$_curlArray

[line 47]

Tags:

  • access - protected

Type: mixed

Overrides:

[ Top ]

$_debugQuery

[line 44]

Tags:

  • access - public

Type: mixed

Overrides:

[ Top ]

$_format

[line 43]

Tags:

  • access - public

Type: mixed

Overrides:

[ Top ]

$_market =  "en-us"

[line 38]

Tags:

  • access - public

Type: mixed

Overrides:

[ Top ]

$_options

[line 42]

Tags:

  • access - public

Type: mixed

Overrides:

[ Top ]

$_sources

[line 40]

Tags:

  • access - public

Type: mixed

Overrides:

[ Top ]

$_version =  "2.0"

[line 37]

Tags:

  • access - public

Type: mixed

Overrides:

[ Top ]


Class Methods

__construct

BingAPI __construct( $appid)

[line 53]

Tags:

  • access - public

Parameters:

  • $appid - Contains the application ID provided by bing.com

[ Top ]

getRequestedQueryURL

string getRequestedQueryURL( )

[line 192]

Returns the whole query in a string and all its parameter, useful in debugging process

ex. http://api.search.live.net/xml.aspx?AppId=APPID&Query=Gimp&Sources=Image

Tags:

  • access - public

Parameters:

[ Top ]

getResults

void getResults( )

[line 196]

Tags:

  • access - public

Parameters:

[ Top ]

query

object query( string $query)

[line 142]

The search term which you will query the server

Tags:

  • access - public

Parameters:

  • string $query -

[ Top ]

resetHighlight

string resetHighlight( string $sources)

[line 178]

resetHighlight reverses the highlight characters, for example if you want the title clear of highlight characters then this will make it possible This also can be used on description if desired. or any text that contains U+E000 or U+E001

Tags:

  • access - public

Parameters:

  • string $sources -

[ Top ]

setCurlArray

void setCurlArray( $args)

[line 121]

Tags:

  • access - public

Parameters:

  • $args -

[ Top ]

setFormat

object setFormat( string $format)

[line 103]

A format is required to get the output, there are three formats currently supported: soap, xml, json

Tags:

  • access - public

Parameters:

  • string $format -

[ Top ]

setHighlightFormat

string setHighlightFormat( string $start, string $end, string $sources)

[line 162]

This function detects and format the Highlight characters(U+E000 and U+E001 private use) bing.com provides

Tags:

  • access - public

Parameters:

  • string $start -
  • string $end -
  • string $sources -

[ Top ]

setOptions

object setOptions( array $options)

[line 92]

Set optional parameters, only accepts array

Tags:

  • access - public

Parameters:

  • array $options -

[ Top ]

setProxy

object setProxy( string $addr)

[line 131]

Deprecated, use curl array

Tags:

  • deprecated -
  • access - public

Parameters:

  • string $addr -

[ Top ]

setSources

void setSources( $sources)

[line 70]

Tags:

  • access - public

Parameters:

  • $sources -

[ Top ]


Class Constants

BINGURL =  "http://api.search.live.net/"

[line 48]

[ Top ]


Documentation generated on Sat, 06 Jun 2009 10:24:13 -0400 by phpDocumentor 1.4.1