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

Class: Services_OpenSearch

Source Location: /Services_OpenSearch-0.2.0/OpenSearch.php

Class Overview


Class for accessing and retrieving information from OpenSearch compatible engines.


Author(s):

Methods


Inherited Variables

Inherited Methods


Class Details

[line 44]
Class for accessing and retrieving information from OpenSearch compatible engines.


[ Top ]


Method Detail

Services_OpenSearch (Constructor)   [line 99]

Services_OpenSearch Services_OpenSearch( [string $url = null], [array $pager_param = array()])

Constructor
  • Access: public

Parameters:

string   $url     URI of OpenSearch Description Document
array   $pager_param     

[ Top ]

getAdultContent   [line 436]

string getAdultContent( )

Retrieves AdultContent element value in OpenSearch Description Document.
  • Access: public

[ Top ]

getContact   [line 416]

string getContact( )

Retrieves Contact element value in OpenSearch Description Document.
  • Access: public

[ Top ]

getCount   [line 186]

integer getCount( )

Retrieves the currently set entry count of per page.
  • Access: public

[ Top ]

getDescription   [line 366]

string getDescription( )

Retrieves Description element value in OpenSearch Description Document.
  • Access: public

[ Top ]

getDescriptionUrl   [line 163]

string getDescriptionUrl( )

Retrieves the currently set URI of OpenSearch Description Document.
  • Return: URI of OpenSearch Description Document
  • Access: public

[ Top ]

getDeveloper   [line 406]

string getDeveloper( )

Retrieves Developer element value in OpenSearch Description Document.
  • Access: public

[ Top ]

getFormat   [line 336]

string getFormat( )

Retrieves Format element value in OpenSearch Description Document.
  • Access: public

[ Top ]

getImage   [line 386]

string getImage( )

Retrieves getImage element value in OpenSearch Description Document.
  • Access: public

[ Top ]

getItemsPerPage   [line 256]

integer getItemsPerPage( )

Retrieves the number of items per page.
  • Access: public

[ Top ]

getLongName   [line 356]

string getLongName( )

Retrieves LongName element value in OpenSearch Description Document.
  • Access: public

[ Top ]

getOpenSearchVersion   [line 291]

float getOpenSearchVersion( )

Retrieves OpenSearch specification version.
  • Access: public

[ Top ]

getSampleSearch   [line 396]

string getSampleSearch( )

Retrieves SampleSearch element value in OpenSearch Description Document.
  • Access: public

[ Top ]

getSearchURLfor   [line 504]

array getSearchURLfor( string $query)

Retrieves URL to search query.
  • Access: public

Parameters:

string   $query     keyword

[ Top ]

getShortName   [line 346]

string getShortName( )

Retrieves ShortName element value in OpenSearch Description Document.
  • Access: public

[ Top ]

getStartIndex   [line 206]

integer getStartIndex( )

Retrieves the currently set start index.
  • Access: public

[ Top ]

getStartPage   [line 226]

integer getStartPage( )

Retrieves the currently set start page.
  • Access: public

[ Top ]

getSyndicationRight   [line 426]

string getSyndicationRight( )

Retrieves SyndicationRight element value in OpenSearch Description Document.
  • Access: public

[ Top ]

getTags   [line 376]

string getTags( )

Retrieves Tags element value in OpenSearch Description Document.
  • Access: public

[ Top ]

getTotalResults   [line 246]

integer getTotalResults( )

Retrieves the total number of results.
  • Access: public

[ Top ]

getUrl   [line 311]

array getUrl( )

Retrieves Url element value in OpenSearch Description Document.
  • Access: public

[ Top ]

getUserAgent   [line 139]

string getUserAgent( )

Retrieves the User-Agent name.
  • Access: public

[ Top ]

getVersion   [line 129]

string getVersion( )

Retrieves the version number of this class.
  • Access: public

[ Top ]

search   [line 534]

array search( string $query)

Search keyword on OpenSearch compatible engine.
  • Access: public

Parameters:

string   $query     keyword

[ Top ]

setCount   [line 196]

void setCount( integer $n)

Sets the entry count of per page.
  • Access: public

Parameters:

integer   $n     entry count of per page. positive (non-zero) integer.

[ Top ]

setDescriptionUrl   [line 173]

void setDescriptionUrl( string $url)

Sets the URI of OpenSearch Description Document.
  • Access: public

Parameters:

string   $url     URI of OpenSearch Description Document

[ Top ]

setStartIndex   [line 216]

void setStartIndex( integer $n)

Sets the start index.
  • Access: public

Parameters:

integer   $n     entry count of per page. positive (non-zero) integer.

[ Top ]

setStartPage   [line 236]

void setStartPage( integer $n)

Sets the start page.
  • Access: public

Parameters:

integer   $n     entry count of per page. positive (non-zero) integer.

[ Top ]

setUserAgent   [line 149]

string setUserAgent( [ $ua = null])

Sets the User-Agent name.
  • Access: public

Parameters:

   $ua     

[ Top ]


Documentation generated on Mon, 18 Feb 2008 01:00:09 -0500 by phpDocumentor 1.4.0. PEAR Logo Copyright © PHP Group 2004.