Differenze

Queste sono le differenze tra la revisione selezionata e la versione attuale della pagina.

--- geomap [19/05/2010 18:08]
+++ geomap [05/06/2013 17:08] (versione attuale)
@@ Linea 3: / Linea 3: @@
 //class GeomapApiController extends ApiController//\\
 \\
-  * add_map - Aggiunge una nuova mappa nel database e ritorna il suo id nella tabella GeoMap.
+=== _get_css_size ===
-    //Descrizione//:
+Prende un numero o una stringa e la ritorna nel valore in px valido per lo stile css.\\
-    add_map($owner,$owner_id,$boundingBox,$label=NULL,$maptype="NORMAL_MAP")
+Descrizione: //_get_css_sizeo($dim)//\\
+Parametri: $dim - int o string\\
+Return: string
-  * add_shape - Aggiunge una forma (punto, linea, sagoma...) al database, eventualmente associandola ad una mappa.
+=== add_map ===
-    //Descrizione//:
+Aggiunge una nuova mappa nel database e ritorna il suo id nella tabella GeoMap.\\
-    void add_shape($ar_or_shape,$geomap_id=NULL,$options=NULL)
+Descrizione: //add_map($owner,$owner_id,$boundingBox,$label,$maptype)//\\
+Parametri:
+    * $owner - string
+    * $owner_id - int
+    * $boundingBox - mixed, o un GeoPolygon o un array o un paio di valori accettati da <Geopolygon::byBounds>
+    * $label - string, opzionale
+    * $maptype - string, opzionale tra: NORMAL_MAP, SATELLITE_MAP, HYBRID_MAP, PHYSICAL_MAP, MAPNIK, OSMARENDER
+Return: int
-  * prepare_map_rendering - Crea e ritorna un'istanza di Map Helper riferita alla mappa associata, renderizzando una vista provvisoria.
+=== add_shape ===
-    //Descrizione//:
+Aggiunge una forma (punto, linea, sagoma...) al database, eventualmente associandola ad una mappa.\\
-    array prepare_map_rendering($map_id,$js_var_suffixe)
+Descrizione: //add_shape($ar_or_shape,$geomap_id,$options)//\\
+Parametri:
+    * $ar_or_shape
+    * $geomap_id - string
+    * $oprions - string
+Return: void
-  * get_maps - Trova tutte le mappe associate ad $owner.
+=== change_default_maptype ===
-    //Descrizione//:
+Cambia il maptype di una mappa.\\
-    array get_maps($owner,$owner_id)
+Descrizione: //change_default_maptype($map_id,$maptype)//\\
+Parametri:
+    * $map_id - int
+    * $maptype - string, opzionale tra i vari tipi di mappa
+Return: void
-  * get_maps_info - Ritorna le informazioni sulla mappa.
+=== find_map_by_owner ===
-    //Descrizione//:
+Trova la mappa attraverso il suo propriertario.\\
-    array get_maps_info($owner_or_map_id=NULL,$owner_id=NULL)
+Descrizione: //find_map_by_owner($owner,$owner_id)//\\
+Parametri:
+    * $owner - string
+    * $owner_id - string
+Return: void
-  * change_default_maptype - Cambia il maptype di una mappa.
+=== find_shapes ===
-    //Descrizione//:
+Ritorna un array con elencati gli id delle figure associate alle mappe.\\
-    void change_default_maptype($map_id,$maptype)
+Descrizione: //find_shapes($owner_or_map_id,$owner_id,$intersected_with)//\\
+Parametri:
+    * $owner_or_map_id - string
+    * $owner_id - int
+    * $intersected_with - string
+Return: array
-  * find_shapes - Ritorna un array con elencati gli id delle figure associate alle mappe.
+=== get_maps ===
-    //Descrizione//:
+Trova tutte le mappe associate ad $owner.\\
-    find_shapes($owner_or_map_id=NULL,$owner_id=NULL,$intersected_with=NULL)
+Descrizione: //get_maps($owner,$owner_id)//\\
+Parametri:
+    * $owner - string
+    * $owner_id - int
+Return: array
-  * render_edit_map - Renderizza la mappa e i suoi controlli, abilitandone le modifiche.
+=== get_maps_info ===
-    //Descrizione//:
+Ritorna le informazioni sulla mappa.\\
-    void render_edit_map($data,$options=NULL,$js_var_suffix=NULL)
+Descrizione: //get_maps_info($owner_or_map_id,$owner_id)//\\
+Parametri:
+    * $owner_or_map - string
+    * $owner_id - int
+Return: void
-  * _get_css_size - Prende un numero o una stringa e la ritorna nel valore in px valido per lo stile css.
+=== prepare_map_rendering ===
-    //Descrizione//:
+Crea e ritorna un'istanza di Map Helper riferita alla mappa associata, renderizzando una vista provvisoria.\\
-    mixed _get_css_sizeo($dim)
+Descrizione: //prepare_map_rendering($map_id,$js_var_suffixe)//\\
+Parametri:
+    * $map_id - int
+    * $js_var_suffixe - string, opzionale, è il suffisso dato alla variabile map di javascript, che identifica la mappa.
+Return: array
-  * render_show_map - Renderizza una mappa non modificabile.
+=== remove_shape ===
-    //Descrizione//:
+Rimuove le figure presenti nel database.\\
-    void render_show_map($data,$options=NULL,$js_var_suffix=NULL)
+Descrizione: //remove_shape($id_or_owner,$owner_id)//\\
+Parametri:
+    * $id_or_owner - int
+    * $owner_id - int
+Return: void
-  * save_map - Aggiunge o aggiorna una mappa e ne ritorna l'id.
+=== render_edit_map ===
-    //Descrizione//:
+Renderizza la mappa e i suoi controlli, abilitandone le modifiche.\\
-    int save_map($data,$options)
+Descrizione: //render_edit_map($data,$options,$js_var_suffix)//\\
+Parametri:
+    * $data - array
+    * $options - array, opzionale
+    * $js_var_suffix - string, opzionale, suffisso usato in javascript.
+Return: void
-  * save_shapes - Aggiunge o aggiorna le figure all'interno del db.
+=== render_show_map ===
-    //Descrizione//:
+Renderizza una mappa non modificabile.\\
-    void save_shapes($data,$options)
+Descrizione: //render_show_map($data,$options,$js_var_suffix)//\\
+Parametri:
+    * $data - array
+    * $options - array, opzionale
+    * $js_var_suffix - string, opzionale, suffisso usato in javascript.
+Return: void
-  * find_map_by_owner - Trova la mappa attraverso il suo propriertario.
+=== save_map ===
-    //Descrizione//:
+Aggiunge o aggiorna una mappa e ne ritorna l'id.\\
-    void find_map_by_owner($owner,$owner_id)
+Descrizione: //save_map($data,$options)//\\
+Parametri:
+    * $data - array
+    * $options - array, opzionale con le opzioni di permessi e rendering
+Return: int, ovvero l'id della mappa
-  * remove_shape - Rimuove le figure presenti nel database.
+=== save_shapes ===
-    //Descrizione//:
+Aggiunge o aggiorna le figure all'interno del db.\\
-    void remove_shape($id_or_owner,$owner_id=NULL)
+Descrizione: //save_shapes($data,$options)//\\
+Parametri:
+    * $data - array
+    * $options - array, opzionale con le opzioni di permessi e rendering
+Return: void

Documentazione openDCN

Strumenti Utente

Strumenti Sito

Differenze

Strumenti Pagina