Services_Openstreetmap
[ class tree: Services_Openstreetmap ] [ index: Services_Openstreetmap ] [ all elements ]
Packages:
Services_Openstreetmap


Files:
Changeset.php
Changesets.php
Config.php
Criterion.php
Exception.php
Node.php
Nodes.php
Object.php
Objects.php
Openstreetmap.php
Relation.php
Relations.php
Transport.php
User.php
V06.php
Way.php
Ways.php

Classes:
Services_Openstreetmap
Services_Openstreetmap_API_V06
Services_Openstreetmap_Changeset
Services_Openstreetmap_Changesets
Services_Openstreetmap_Config
Services_Openstreetmap_Criterion
Services_Openstreetmap_Exception
Services_Openstreetmap_Node
Services_Openstreetmap_Nodes
Services_Openstreetmap_Object
Services_Openstreetmap_Objects
Services_Openstreetmap_Relation
Services_Openstreetmap_Relations
Services_Openstreetmap_Transport
Services_Openstreetmap_User
Services_Openstreetmap_Way
Services_Openstreetmap_Ways

Class: Services_Openstreetmap_API_V06

Source Location: /Openstreetmap/API/V06.php

Class Overview




Services_Openstreetmap_API_V06




Author(s):






            

        




Variables







Methods
























Class Details



[line 25]

Services_Openstreetmap_API_V06





Tags:





  

    author:  Ken Guest <kguest@php.net>
  

  

    link:  API_V06.php
  

  

    license:  BSD
  










[ Top ]







Class Variables



	
	

	
$config =  null

	
[line 37]

  



Tags:





  

    access:  protected
  






  

	

  

    

      Type:  
      mixed
    

      

	



	
[ Top ]


	
	

	
$elements = array('changeset', 'node', 'relation', 'way')

	
[line 33]

  Elements supported by the API (v0.6).

Used for validation purposes.





Tags:





  

    access:  protected
  






  

	

  

    

      Type:  
      array
    

      

	



	
[ Top ]


	
	

	
$newId =  -1

	
[line 44]

  Counter for assigning IDs to [newly] created objects.





Tags:





  

    access:  protected
  






  

	

  

    

      Type:  
      int
    

      

	



	
[ Top ]


	
	

	
$transport =  null

	
[line 35]

  



Tags:





  

    access:  protected
  






  

	

  

    

      Type:  
      mixed
    

      

	



	
[ Top ]










Class Methods




  

	
	
method createChangeset [line 162]

	

    

    

		Services_Openstreetmap_Changeset createChangeset(
[boolean
$atomic = true])
    

    


	
		Create a changeset, used to transmit changes (creation, updates, deletion)  to the server. Username and password must be set.

  1.  $config = array('user' => 'fred@example.net', 'password' => 'wilma4eva');
    2. 

  2.  $osm = new Services_Openstreetmap($config);
    3. 

  3.  $changeset = $osm->createChangeset();
    4. 






Tags:





  

    see:  Services_Openstreetmap_API_V06::setConfig()
  

  

    access:  public
  









	
        
Parameters:

    

    

          

        boolean  
        $atomic  
        atomic changeset?
      

        

    


        
[ Top ]

  

  

	
	
method createNode [line 206]

	

    

    

		Services_Openstreetmap_Node createNode(
float
$latitude, float
$longitude, [array
$tags = array()])
    

    


	
		Create and return a Services_Openstreetmap_Node

  1.  $node = $osm->createNode($lat, $lon, array('building' => 'yes'));
    2. 






Tags:





  

    access:  public
  









	
        
Parameters:

    

    

          

        float  
        $latitude  
        Latitude of node
      

          

        float  
        $longitude  
        Longitude of node
      

          

        array  
        $tags  
        Array of key->value tag pairs.
      

        

    


        
[ Top ]

  

  

	
	
method getChangeset [line 142]

	

    

    

		string getChangeset(
string
$id, [string
$version = null])
    

    


	
		Get details of specified changeset

  1.  $changeset = $osm->getChangeset(123456);
    2. 






Tags:





  

    access:  public
  









	
        
Parameters:

    

    

          

        string  
        $id  
        numeric ID of changeset
      

          

        string  
        $version  
        optional
      

        

    


        
[ Top ]

  

  

	
	
method getConfig [line 64]

	

    

    

		Services_Openstreetmap_Config getConfig(
)
    

    


	
		Get current Config object





Tags:





  

    access:  public
  









	
        
[ Top ]

  

  

	
	
method getNode [line 339]

	

    

    

		string getNode(
string
$nodeID, [mixed
$version = null])
    

    


	
		Get details of specified node

  1.  $osm = new Services_Openstreetmap();
    2. 

  2.  var_dump($osm->getNode(52245107));
    3. 






Tags:





  

    access:  public
  









	
        
Parameters:

    

    

          

        string  
        $nodeID  
        nodeID
      

          

        mixed  
        $version  
        [optional] version of node
      

        

    


        
[ Top ]

  

  

	
	
method getNodes [line 364]

	

    

    

		Services_Openstreetmap_Nodes getNodes(
)
    

    


	
		Return an array of specified nodes.

  1.  $osm = new Services_Openstreetmap();
    2. 

  2.  var_dump($osm->getNodes(52245107, 52245108));
    3. 

  Or  
  1.  $osm = new Services_Openstreetmap();
    2. 

  2.  var_dump($osm->getNodes(array(52245107, 52245108)));
    3. 






Tags:





  

    access:  public
  









	
        
[ Top ]

  

  

	
	
method getRelation [line 107]

	

    

    

		string getRelation(
mixed
$relationID, [mixed
$version = null])
    

    


	
		Get details of specified relation, optionally specify which version of  the relation to be retrieved.

 $r = $osm->getRelation(1234567);
 $r = $osm->getRelation(1234567, 2);





Tags:





  

    access:  public
  









	
        
Parameters:

    

    

          

        mixed  
        $relationID  
        ID of relation
      

          

        mixed  
        $version  
        [optional] version of relation
      

        

    


        
[ Top ]

  

  

	
	
method getRelations [line 121]

	

    

    

		array getRelations(
)
    

    


	
		Return an array of specified relations

 $relations = $osm->getRelations($relationId, $relation2Id);





Tags:





  

    access:  public
  









	
        
[ Top ]

  

  

	
	
method getTransport [line 87]

	

    

    

		Services_Openstreetmap_Transport. getTransport(
)
    

    


	
		Retrieve the current Transport instance.





Tags:





  

    access:  public
  









	
        
[ Top ]

  

  

	
	
method getUser [line 237]

	

    

    

		Services_Openstreetmap_User getUser(
)
    

    


	
		Get a Services_Openstreetmap_User object for the [current] user.

May return false if the user could not be found for any reason.





Tags:





  

    see:  Services_Openstreetmap_API_V06::setConfig()
  

  

    access:  public
  









	
        
[ Top ]

  

  

	
	
method getWay [line 298]

	

    

    

		string getWay(
mixed
$wayID, [mixed
$version = null])
    

    


	
		Get details of specified way





Tags:





  

    access:  public
  









	
        
Parameters:

    

    

          

        mixed  
        $wayID  
        wayID
      

          

        mixed  
        $version  
        [optional] version of way
      

        

    


        
[ Top ]

  

  

	
	
method getWays [line 317]

	

    

    

		array getWays(
)
    

    


	
		Return an array of specified ways.

 $ways = $osm->getWays($wayId, $way2Id);





Tags:





  

    access:  public
  









	
        
[ Top ]

  

  

	
	
method searchChangesets [line 177]

	

    

    

		Services_Openstreetmap_Changesets searchChangesets(
array
$criteria)
    

    


	
		searchChangesets





Tags:





  

    access:  public
  









	
        
Parameters:

    

    

          

        array  
        $criteria  
        Array of Services_Openstreetmap_Criterion objects.
      

        

    


        
[ Top ]

  

  

	
	
method setConfig [line 53]

	

    

    

		Services_Openstreetmap_API_V06 setConfig(
Services_Openstreetmap_Config
$config)
    

    


	
		Set Config object





Tags:





  

    access:  public
  









	
        
Parameters:

    

    

          

        Services_Openstreetmap_Config  
        $config  
        Config object.
      

        

    


        
[ Top ]

  

  

	
	
method setTransport [line 76]

	

    

    

		Services_Openstreetmap_Config setTransport(
Services_Openstreetmap_Transport
$transport)
    

    


	
		Set the Transport instance.





Tags:





  

    access:  public
  









	
        
Parameters:

    

    

          

        Services_Openstreetmap_Transport  
        $transport  
        Transport instance.
      

        

    


        
[ Top ]

  






        

		    

		    Documentation generated on Wed, 11 Jan 2012 00:37:14 +0000 by phpDocumentor 1.4.4