Development

Changeset 16319

You must first sign up to be able to contribute.

Changeset 16319

Show
Ignore:
Timestamp:
03/16/09 01:39:21 (6 years ago)
Author:
laurentb
Message:

Added developers, fixed a lot of phpdoc

Files:

Legend:

Unmodified
Added
Removed
Modified
Copied
Moved
  • plugins/sfEasyGMapPlugin/trunk/lib/GMap.class.php

    r16301 r16319  
    7373  /** 
    7474   * Sets the Google Map API Key using the array_google_keys defined in the app.yml of your application 
    75    * @param String $domain The domaine name 
     75   * @param string $domain The domaine name 
    7676   * @author Fabrice 
    7777   *  
     
    8484  /** 
    8585   * Guesses the GoogleMap key for the current domain 
    86    * @return String $api_key 
     86   * @return string $api_key 
    8787   * @author Fabrice 
    8888   * 
     
    133133  /** 
    134134   * Geocodes an address 
    135    * @param String $address 
     135   * @param string $address 
    136136   * @return GMapGeocodedAddress 
    137137   * @author Fabrice Bernhard 
     
    146146  /** 
    147147   * Geocodes an address and returns additional normalized information 
    148    * @param String $address 
     148   * @param string $address 
    149149   * @return GMapGeocodedAddress 
    150150   * @author Fabrice Bernhard 
     
    159159 
    160160  /** 
    161    * @return String $this->options['js_name'] Javascript name of the googlemap 
     161   * @return string $this->options['js_name'] Javascript name of the googlemap 
    162162   */ 
    163163  public function getJsName() 
     
    169169  /** 
    170170   * Sets the Google Maps API key 
    171    * @param String $key 
     171   * @param string $key 
    172172   */ 
    173173  public function setAPIKey($key) 
     
    177177  /** 
    178178   * Gets the Google Maps API key 
    179    * @return String $key 
     179   * @return string $key 
    180180   */ 
    181181  public function getAPIKey() 
     
    195195  /** 
    196196   * Defines one style of the div container 
    197    * @param String $style_tag name of css tag 
    198    * @param String $style_value value of css tag 
     197   * @param string $style_tag name of css tag 
     198   * @param string $style_value value of css tag 
    199199   */ 
    200200  public function setContainerStyle($style_tag,$style_value) 
     
    213213  /* 
    214214   * Gets one style of the Google Map div 
    215    * @param String $style_tag name of css tag 
     215   * @param string $style_tag name of css tag 
    216216   */ 
    217217  public function getContainerStyle($style_tag) 
     
    230230   * returns the Html for the Google map container 
    231231   * @param Array $options Style options of the HTML container 
    232    * @return String $container 
     232   * @return string $container 
    233233   * @author Fabrice Bernhard 
    234234   */ 
     
    315315  /** 
    316316   * returns the URLS for the google map Javascript file 
    317    * @return String $js_url 
     317   * @return string $js_url 
    318318   */ 
    319319  public function getGoogleJsUrl() 
     
    335335   * Retourne l'objet GMapIcon à partir du nom de l'icone 
    336336   * 
    337    * @param String $name 
     337   * @param string $name 
    338338   * @return GMapIcon 
    339339   *  
     
    381381  /** 
    382382   * Returns the javascript string which defines the icons 
    383    * @return String 
     383   * @return string 
    384384   */ 
    385385  public function getIconsJs() 
     
    395395  /** 
    396396   * Returns the javascript string which defines the markers 
    397    * @return String 
     397   * @return string 
    398398   */ 
    399399  public function getMarkersJs() 
     
    412412  /* 
    413413   * Returns the javascript string which defines events linked to the map 
    414    * @return String 
     414   * @return string 
    415415   */ 
    416416  public function getEventsJs() 
     
    427427  /* 
    428428   * Gets the Code to execute after Js initialization 
    429    * @return String $after_init_js 
     429   * @return string $after_init_js 
    430430   */ 
    431431  public function getAfterInitJs() 
     
    435435  /* 
    436436   * Sets the Code to execute after Js initialization 
    437    * @param String $after_init_js Code to execute 
     437   * @param string $after_init_js Code to execute 
    438438   */ 
    439439  public function addAfterInitJs($after_init_js) 
     
    454454   * Sets the center of the map at the beginning 
    455455   * 
    456    * @param Decimal $lat 
    457    * @param Decimal $lng 
     456   * @param integer $lat 
     457   * @param integer $lng 
    458458   */ 
    459459  public function setCenter($lat=null,$lng=null) 
     
    484484 
    485485  /** 
    486    * Returns the url for a static version of the map (when javascript is not active) 
    487    * Supports only markers and basic parameters: centre, zoom, size 
    488    * 
     486   * Returns the URL of a static version of the map (when JavaScript is not active) 
     487   * Supports only markers and basic parameters: center, zoom, size. 
    489488   * @param string $map_type = 'mobile' 
    490489   * @param string $hl Language (fr, en...) 
    491    * @return string Url of the pictur
     490   * @return string URL of the imag
    492491   * @author Laurent Bachelier 
    493492   */ 
     
    514513  /** 
    515514   * Returns the static code to create markers 
    516    * @return String 
     515   * @return string 
    517516   * @author Laurent Bachelier 
    518517   */ 
  • plugins/sfEasyGMapPlugin/trunk/lib/GMapEvent.class.php

    r11741 r16319  
    1414   
    1515  /** 
    16    * @param String $trigger action that will trigger the event 
    17    * @param String $function the javascript function to be executed 
    18    * @param String $encapsulate_function 
     16   * @param string $trigger action that will trigger the event 
     17   * @param string $function the javascript function to be executed 
     18   * @param string $encapsulate_function 
    1919   * @author Fabrice Bernhard 
    2020   */ 
     
    2727   
    2828  /** 
    29    * @return String $trigger  action that will trigger the event    
     29   * @return string $trigger  action that will trigger the event    
    3030   */ 
    3131  public function getTrigger() 
     
    3535  } 
    3636  /**    
    37    * @return String $function the javascript function to be executed 
     37   * @return string $function the javascript function to be executed 
    3838   */ 
    3939  public function getFunction() 
     
    5454   * returns the javascript code for attaching a Google event to a javascript_object 
    5555   * 
    56    * @param String $js_object_name 
    57    * @return String 
     56   * @param string $js_object_name 
     57   * @return string 
    5858   * @author Fabrice Bernhard 
    5959   */ 
     
    6767   * returns the javascript code for attaching a dom event to a javascript_object 
    6868   * 
    69    * @param String $js_object_name 
    70    * @return String 
     69   * @param string $js_object_name 
     70   * @return string 
    7171   * @author Fabrice Bernhard 
    7272   */ 
  • plugins/sfEasyGMapPlugin/trunk/lib/GMapGeocodedAddress.class.php

    r12104 r16319  
    2222   * Constructs a gMapGeocodedAddress object from a given $raw_address String 
    2323   * 
    24    * @param String $raw_address 
     24   * @param string $raw_address 
    2525   * @author Fabrice Bernhard 
    2626   */ 
     
    3333   * Geocodes the address using the Google Maps CSV webservice 
    3434   * 
    35    * @param String $api_key 
    36    * @return Integer $accuracy 
     35   * @param string $api_key 
     36   * @return integer $accuracy 
    3737   * @author Fabrice Bernhard 
    3838   */ 
     
    5757   * Geocodes the address using the Google Maps XML webservice, which has more information. 
    5858   * Unknown values will be set to NULL. 
    59    * @param String $api_key 
    60    * @return Integer $accuracy 
     59   * @param string $api_key 
     60   * @return integer $accuracy 
    6161   * @author Fabrice Bernhard 
    6262   */ 
     
    104104  /** 
    105105   * Returns the latitude 
    106    * @return Decimal $latitude 
     106   * @return integer $latitude 
    107107   */ 
    108108  public function getLat() 
     
    114114  /** 
    115115   * Returns the longitude 
    116    * @return Decimal $longitude 
     116   * @return integer $longitude 
    117117   */ 
    118118  public function getLng() 
     
    124124  /** 
    125125   * Returns the Geocoding accuracy 
    126    * @return Integer $accuracy 
     126   * @return integer $accuracy 
    127127   */ 
    128128  public function getAccuracy() 
     
    134134  /** 
    135135   * Returns the address normalized by the Google Maps web service 
    136    * @return String $geocoded_address 
     136   * @return string $geocoded_address 
    137137   */ 
    138138  public function getGeocodedAddress() 
     
    144144  /** 
    145145   * Returns the city normalized by the Google Maps web service 
    146    * @return String $geocoded_city 
     146   * @return string $geocoded_city 
    147147   */ 
    148148  public function getGeocodedCity() 
     
    154154  /** 
    155155   * Returns the country code normalized by the Google Maps web service 
    156    * @return String $geocoded_country_code 
     156   * @return string $geocoded_country_code 
    157157   */ 
    158158  public function getGeocodedCountryCode() 
     
    164164  /** 
    165165   * Returns the country normalized by the Google Maps web service 
    166    * @return String $geocoded_country 
     166   * @return string $geocoded_country 
    167167   */ 
    168168  public function getGeocodedCountry() 
     
    174174  /** 
    175175   * Returns the postal code normalized by the Google Maps web service 
    176    * @return String $geocoded_postal_code 
     176   * @return string $geocoded_postal_code 
    177177   */ 
    178178  public function getGeocodedPostalCode() 
     
    184184  /** 
    185185   * Returns the street name normalized by the Google Maps web service 
    186    * @return String $geocoded_country_code 
     186   * @return string $geocoded_country_code 
    187187   */ 
    188188  public function getGeocodedStreet() 
  • plugins/sfEasyGMapPlugin/trunk/lib/GMapIcon.class.php

    r11741 r16319  
    3535  /** 
    3636   * Set Icon's path 
    37    * @param String $icon_src Icon's path 
     37   * @param string $icon_src Icon's path 
    3838   */ 
    3939  public function setIconSrc($icon_src) 
     
    4343  /** 
    4444   * Get Icon's path 
    45    * @return String    
     45   * @return string    
    4646   */ 
    4747  public function getIconSrc() 
     
    5252  /** 
    5353   * Set Shadow's path 
    54    * @param String $shadow_src Shadow's path 
     54   * @param string $shadow_src Shadow's path 
    5555   */ 
    5656  public function setShadowSrc($shadow_src) 
     
    6868  /** 
    6969   * Get Icon's Javascript variable's name 
    70    * @return String $name  
     70   * @return string $name  
    7171   */ 
    7272  public function getName() 
     
    7777  /** 
    7878   * Change Icon's JavaScript name 
    79    * @param String $name 
     79   * @param string $name 
    8080   */ 
    8181  public function setName($name) 
     
    9595   * Returns the javascript code tthat defines an icon 
    9696   * 
    97    * @return String 
     97   * @return string 
    9898   */ 
    9999  public function getIconJs() 
  • plugins/sfEasyGMapPlugin/trunk/lib/GMapMarker.class.php

    r16301 r16319  
    1717   
    1818  /** 
    19    * @param String $js_name Javascript name of the marker 
    20    * @param Decimal $lat Latitude 
    21    * @param Decimal $lng Longitude 
     19   * @param string $js_name Javascript name of the marker 
     20   * @param integer $lat Latitude 
     21   * @param integer $lng Longitude 
    2222   * @param GMapIcon $icon 
    2323   * @param GmapEvent[] array of GoogleMap Events linked to the marker 
     
    3636   * Construct from a GMapGeocodedAddress object 
    3737   * 
    38    * @param String $js_name 
     38   * @param string $js_name 
    3939   * @param GMapGeocodedAddress $gmap_geocoded_address 
    4040   * @return GMapMarker 
     
    5151   
    5252  /** 
    53   * @return String $js_name Javascript name of the marker   
     53  * @return string $js_name Javascript name of the marker   
    5454  */ 
    5555  public function getName() 
     
    6666  } 
    6767  /** 
    68   * @return Decimal $lat Javascript latitude   
     68  * @return integer $lat Javascript latitude   
    6969  */ 
    7070  public function getLat() 
     
    7474  } 
    7575  /** 
    76   * @return Decimal $lng Javascript longitude   
     76  * @return integer $lng Javascript longitude   
    7777  */ 
    7878  public function getLng() 
     
    9393  } 
    9494  /** 
    95   * @return String Javascript code to create the marker 
     95  * @return string Javascript code to create the marker 
    9696  * @author Fabrice Bernhard   
    9797  */ 
     
    133133   * Adds an onlick listener that open a html window with some text  
    134134   * 
    135    * @param String $html_text 
     135   * @param string $html_text 
    136136   * @author fabriceb 
    137137   * @since Feb 20, 2009 fabriceb removed the escape_javascript function which made the plugin incompatible with symfony 1.2  
     
    148148   * Returns the code for the static version of Google Maps 
    149149   * @TODO Add support for color and alpha-char 
    150    * @author laurentb 
     150   * @author Laurent Bachelier 
     151   * @return string 
    151152   */ 
    152153  public function getMarkerStatic() 
     
    167168   * Sets a custom property to the generated javascript object 
    168169   * 
    169    * @param String $name 
    170    * @param String $value 
     170   * @param string $name 
     171   * @param string $value 
    171172   */ 
    172173  public function setCustomProperty($name,$value) 
  • plugins/sfEasyGMapPlugin/trunk/package.xml

    r16304 r16319  
    66 <description>The sfEasyGMap plugin provides helpers and an objet-oriented PHP abstraction to the Google Maps API to ease the process of adding a Google Map and customising it in your symfony projects.</description> 
    77 <lead> 
    8   <name>Fabrice BERNHARD</name> 
     8  <name>Fabrice Bernhard</name> 
    99  <user>fabriceb</user> 
    1010  <email>fabriceb@allomatch.com</email> 
    1111  <active>yes</active> 
    1212 </lead> 
    13  <contributor> 
    14   <name>Laurent BACHELIER</name> 
     13 <developer> 
     14  <name>Vincent Guillon</name> 
     15  <user>vincentg</user> 
     16  <email>vincentg@allomatch</email> 
     17  <active>yes</active> 
     18 </developer> 
     19 <developer> 
     20  <name>Laurent Bachelier</name> 
    1521  <user>laurentb</user> 
    1622  <email>laurent@bachelier.name</email> 
    1723  <active>yes</active>   
    18  </contributor>  
     24 </developer> 
    1925 <date>2009-03-13</date> 
    2026 <time>16:00:00</time>