Ignore:
Timestamp:
Apr 12, 2010, 5:56:17 PM (15 years ago)
Author:
Pieter Naber
Message:

Adding a lot of checks for the variables in the status and the location file. Added even more comments everywhere

File:
1 edited

Legend:

Unmodified
Added
Removed
  • TabularUnified trunk/src/inc/KMLPlacemark.class.php

    r7692 r7720  
    55 * Purpose: Placemark used in KMLFile
    66 */
     7
     8define('PLACEMARK_GREEN', 'greenArrowIcon');
     9define('PLACEMARK_ORANGE', 'orangeArrowIcon');
     10define('PLACEMARK_RED', 'redArrowIcon');
    711
    812class KMLPlacemark {
     
    4145        /*
    4246         * Function: __construct (constructor)
     47         * Description: Creating a new KMLFile
    4348         * Parameters: -
    44          * Function: Creating a new KMLFile
     49         * Returns: -
    4550         */
    4651        function __construct() {
     
    5459        }
    5560
     61        /*
     62         * Function: setID
     63         * Description: Setting the ID of the placemark
     64         * Parameters: string $newID
     65         * Returns: -
     66         */
    5667        function setID($newID) {
    5768                $this->id = $newID;
    5869        }
    5970
     71        /*
     72         * Function: setName
     73         * Description: Setting the name of the placemark
     74         * Parameters: string $newName
     75         * Returns: -
     76         */
    6077        function setName($newName) {
    6178                $this->name = $newName;
    6279        }
    6380
     81        /*
     82         * Function: getName
     83         * Description: Getting the name of the placemark
     84         * Parameters: -
     85         * Returns: The name of the placemark
     86         */
    6487        function getName() {
    6588                return $this->name;
    6689        }
    6790
     91        /*
     92         * Function: setDescriptionLocation
     93         * Description: Setting the location description of the placemark
     94         * Parameters: string $newDescriptionLocation
     95         * Returns: -
     96         */
    6897        function setDescriptionLocation($newDescriptionLocation) {
    6998                $this->descriptionLocation = (string) $newDescriptionLocation;
    7099        }
    71100
     101        /*
     102         * Function: setDescriptionStatus
     103         * Description: Setting the status description of the placemark
     104         * Parameters: string $newDescriptionStatus
     105         * Returns: -
     106         */
    72107        function setDescriptionStatus($newDescriptionStatus) {
    73108                $this->descriptionStatus = (string) $newDescriptionStatus;
    74109        }
    75110
     111        /*
     112         * Function: setLongitude
     113         * Description: Setting the longitude of the placemark
     114         * Parameters: string $newLongitude
     115         * Returns: -
     116         */
    76117        function setLongitude($newLongitude) {
    77118                $this->longitude = (double) $newLongitude;
    78119        }
    79120
     121        /*
     122         * Function: setLatitude
     123         * Description: Setting the latitude of the placemark
     124         * Parameters: string $newLatitude
     125         * Returns: -
     126         */
    80127        function setLatitude($newLatitude) {
    81128                $this->latitude = (double) $newLatitude;
    82129        }
    83130
     131        /*
     132         * Function: setStyle
     133         * Description: Setting the style of the placemark
     134         * Parameters: string $newStyle
     135         * Returns: -
     136         */
    84137        function setStyle($newStyle) {
    85138                $this->style = (string) $newStyle;
    86139        }
    87140
     141        /*
     142         * Function: toString
     143         * Description: Converts the content of this placemark to a KML valid string
     144         * Parameters: -
     145         * Returns: KML valid string
     146         */
    88147        function toString() {
    89148                $toString = $this->template;
Note: See TracChangeset for help on using the changeset viewer.