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


Files:
db-mysql.inc.php
Geocache.inc.php
OCFParser.inc.php
PHPGeocache.inc.php
Waypoint.inc.php

Classes:
Geocache
GeocacheDB
OCFParser
PHPGeocache
Waypoint

Class: Waypoint

Source Location: /Waypoint.inc.php

Class Overview




Defines Waypoint class.









        






Methods
























Class Details



[line 39]

Defines Waypoint class.





[ Top ]








Class Methods




  

	
	
constructor __construct [line 139]

	

    

    

		Waypoint __construct(
)
    

    


	
		The PHP5 constructor





Tags:





  

    since:  1.0
  









	
        
[ Top ]

  

  

	
	
constructor Waypoint [line 131]

	

    

    

		Waypoint Waypoint(
)
    

    


	
		The PHP4 constructor





Tags:





  

    since:  1.0
  









	
        
[ Top ]

  

  

	
	
method free [line 141]

	

    

    

		void free(
)
    

    


	
		



	
        
[ Top ]

  

  

	
	
method getCoordinates [line 322]

	

    

    

		array getCoordinates(
)
    

    


	
		Getter method for the attributes $long and $lat.





Tags:





  

    since:  1.0
  









	
        
[ Top ]

  

  

	
	
method getDescription [line 310]

	

    

    

		string getDescription(
)
    

    


	
		Getter method for the attribute $description.





Tags:





  

    since:  1.0
  









	
        
[ Top ]

  

  

	
	
method getHint [line 346]

	

    

    

		string getHint(
)
    

    


	
		Getter method for the attribute $hint.





Tags:





  

    since:  1.0
  









	
        
[ Top ]

  

  

	
	
method getName [line 286]

	

    

    

		string getName(
)
    

    


	
		Getter method for the attribute $name.





Tags:





  

    since:  1.0
  









	
        
[ Top ]

  

  

	
	
method getPointType [line 274]

	

    

    

		string getPointType(
)
    

    


	
		Getter method for the attribute $pointtype.





Tags:





  

    since:  1.0
  









	
        
[ Top ]

  

  

	
	
method getPublic [line 334]

	

    

    

		bool getPublic(
)
    

    


	
		Getter method for the attribute $public.





Tags:





  

    since:  1.0
  









	
        
[ Top ]

  

  

	
	
method getTitle [line 298]

	

    

    

		string getTitle(
)
    

    


	
		Getter method for the attribute $title.





Tags:





  

    since:  1.0
  









	
        
[ Top ]

  

  

	
	
method setCoordinates [line 226]

	

    

    

		bool setCoordinates(
float
$long, float
$lat)
    

    


	
		Setter method for the attributes $long and $lat  If the given value is invalid the complete object is emptied.





Tags:





  

    since:  1.0
  









	
        
Parameters:

    

    

          

        float  
        $long  
        Longitude of the waypoint.
      

          

        float  
        $lat  
        Latitude of the waypoint.
      

        

    


        
[ Top ]

  

  

	
	
method setDescription [line 211]

	

    

    

		void setDescription(
string
$str)
    

    


	
		Setter method for the attribute $description.





Tags:





  

    since:  1.0
  









	
        
Parameters:

    

    

          

        string  
        $str  
        Sets the description of the waypoint, e.g. "How many stars can you see on the door in front of you?"
      

        

    


        
[ Top ]

  

  

	
	
method setHint [line 262]

	

    

    

		void setHint(
string
$str)
    

    


	
		Setter method for the attribute $hint.





Tags:





  

    since:  1.0
  









	
        
Parameters:

    

    

          

        string  
        $str  
        The optional hint to help the user, e.g. "Look at the stone with the number 567"
      

        

    


        
[ Top ]

  

  

	
	
method setName [line 180]

	

    

    

		bool setName(
string
$str)
    

    


	
		Setter method for the attribute $name.

If the given value is invalid the complete object is emptied.





Tags:





  

    since:  1.0
  









	
        
Parameters:

    

    

          

        string  
        $str  
        The name of the waypoint, 6 characters maximum, e.g. "GH76S3"
      

        

    


        
[ Top ]

  

  

	
	
method setPointType [line 159]

	

    

    

		bool setPointType(
string
$str)
    

    


	
		Setter method for the attribute $pointtype.

If the given value is invalid the complete object is emptied.





Tags:





  

    since:  1.0
  









	
        
Parameters:

    

    

          

        string  
        $str  
        Sets the point type, one of 'cache', 'parking', 'puzzle'
      

        

    


        
[ Top ]

  

  

	
	
method setPublic [line 246]

	

    

    

		void setPublic(
bool
$bool)
    

    


	
		Setter method for the attribute $public.





Tags:





  

    since:  1.0
  









	
        
Parameters:

    

    

          

        bool  
        $bool  
        Whether the coordinates of this waypoint are public, e.g. if the waypoint is a parking waypoint
      

        

    


        
[ Top ]

  

  

	
	
method setTitle [line 199]

	

    

    

		void setTitle(
string
$str)
    

    


	
		Setter method for the attribute $title.





Tags:





  

    since:  1.0
  









	
        
Parameters:

    

    

          

        string  
        $str  
        Sets the title of the waypoint, e.g. "Parking" or "Puzzle #3"
      

        

    


        
[ Top ]

  






        

		    

		    Documentation generated on Mon, 29 May 2006 19:21:53 +0200 by phpDocumentor 1.3.0RC6