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

Class: Services_OpenStreetMap_Transport_HTTPCached

Source Location: /Services_OpenStreetMap-1.0.0RC2/Services/OpenStreetMap/Transport/HTTPCached.php

Class Overview

Services_OpenStreetMap_Transport_HTTP
   |
   --Services_OpenStreetMap_Transport_HTTPCached

Services_OpenStreetMap_Transport_HTTPCached


Author(s):

Variables

Methods


Inherited Variables

Inherited Methods

Class: Services_OpenStreetMap_Transport_HTTP

Services_OpenStreetMap_Transport_HTTP::__construct()
Constructor
Services_OpenStreetMap_Transport_HTTP::addPostParameters()
Add post parameters to request object
Services_OpenStreetMap_Transport_HTTP::getConfig()
Get current Config object
Services_OpenStreetMap_Transport_HTTP::getObject()
Get object of specified type and id.
Services_OpenStreetMap_Transport_HTTP::getObjects()
Get objects of specified type.
Services_OpenStreetMap_Transport_HTTP::getRequest()
Get HTTP_Request2 instance.
Services_OpenStreetMap_Transport_HTTP::getResponse()
Send request to OSM server and return the response.
Services_OpenStreetMap_Transport_HTTP::searchObjects()
Search objects of specified type for certain criteria.
Services_OpenStreetMap_Transport_HTTP::setConfig()
Set Config object
Services_OpenStreetMap_Transport_HTTP::setHeaders()
Add headers to request
Services_OpenStreetMap_Transport_HTTP::setLog()
Set Log object.
Services_OpenStreetMap_Transport_HTTP::setRequest()
Set the HTTP_Request2 instance and return the Services_OpenStreetMap instance.

Class Details

[line 36]
Services_OpenStreetMap_Transport_HTTPCached


[ Top ]


Class Variables

$cache =

[line 45]

Cache object
  • Access: protected

Type:   Cache


[ Top ]



Method Detail

__construct (Constructor)   [line 52]

Services_OpenStreetMap_Transport_HTTPCached __construct( )

Constructor, setting file Cache object.
  • Access: public

Overrides Services_OpenStreetMap_Transport_HTTP::__construct() (Constructor)
[ Top ]

getResponse   [line 93]

HTTP_Request2_Response getResponse( string $url, [string $method = HTTP_Request2::METHOD_GET], [string $user = null], [string $password = null], [string $body = null], [array $post_data = null], [array $headers = null])

Send request to OSM server and return the response.
  • Todo: Consider just returning the content?
  • Throws: Services_OpenStreetMap_Exception If something unexpected has happened while conversing with the server.
  • Throws: HTTP_Request2_LogicException
  • Throws: HTTP_Request2_MessageException
  • Access: public

Overrides Services_OpenStreetMap_Transport_HTTP::getResponse() (Send request to OSM server and return the response.)

Parameters:

string   $url   —  URL
string   $method   —  GET (default)/POST/PUT
string   $user   —  user (optional for read-only actions)
string   $password   —  password (optional for read-only actions)
string   $body   —  body (optional)
array   $post_data   —  (optional)
array   $headers   —  (optional)

[ Top ]

setCache   [line 66]

Services_OpenStreetMap_Transport_HTTPCached setCache( Cache $cache)

Set the cache object
  • Access: public

Parameters:

Cache   $cache   —  Cache object

[ Top ]


Documentation generated on Tue, 28 May 2019 19:19:07 -0400 by phpDocumentor 1.4.4. PEAR Logo Copyright © PHP Group 2004.