Differenze

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

--- agenda [26/05/2010 11:18]
+++ agenda [05/06/2013 17:08] (versione attuale)
@@ Linea 3: / Linea 3: @@
 //class AgendaApiController extends ApiController//\\
 \\
-=== blocksMaps ===
-Ritorna un array con le caratteristiche dell'ultima agenda.\\
-Descrizione: //array blockMaps()//
-=== blockAgendaRender ===
-Controlla le agende attive all'interno del modulo e ne renderizza la vista.\\
-Descrizione: //void blockAgendaRender(string $id)//
 === blockAgendaCreate ===
 Renderizza la vista del form utile alla creazione di un'agenda.\\
-Descrizione: //void blockAgendaCreate()//
+Descrizione: //blockAgendaCreate()//\\
+Parametri: nessun parametro\\
+Return: void
 === blockAgendaEdit ===
 Renderizza la vista del form utile alla modifica di un'agenda.\\
-Descrizione : //void blockAgendaEdit(string $id)//
+Descrizione : //blockAgendaEdit($id)//\\
+Parametri: $id - int (10)\\
+Return: void
+=== blockAgendaRender ===
+Controlla le agende attive all'interno del modulo e ne renderizza la vista.\\
+Descrizione: //blockAgendaRender($id)//\\
+Parametri: $id - int (10)\\
+Return: void
 === blockAgendaSave ===
 Convalida l'agenda.\\
-Descrizione : //void blockAgendaSave()//
+Descrizione : //blockAgendaSave()//\\
+Parametri: nessun parametro\\
+Return: Se la validazione va a buon fine ritorna un array altrimenti false
 === blockAgendaUpdate ===
 Aggiorna l'agenda.\\
-Descrizione : //void blockAgendaUpdate(string $id)//
+Descrizione : //blockAgendaUpdate($id)//\\
+Parametri: $id - int(10)\\
+Return: Se l'aggiornamento va a buon fine ritorna un array altrimenti false
-=== permissionsGetObjects ===
+=== blocksMaps ===
-Ritorna un array contenente gli oggetti prodotti dall'agenda.\\
+Ritorna un array con le caratteristiche dell'ultima agenda.\\
-Descrizione : //array permissionsGetObjects()//
+Descrizione: //blockMaps()//\\
+Parametri: nessun parametro\\
+Return: array
+=== dateToKey ===
+Riformatta la data.\\
+Descrizione : //dateToKey($date)//\\
+Parametri: $date - string\\
+Return: data in formato string: annoMeseGiorno
+=== getDays ===
+Ritorna i giorni tra due date in formato SQML.\\
+Descrizione : //getDays($start, $end)//\\
+Parametri:
+    * $start - string datetime "YYYY-MM-DD HH:MM:SS",\\
+    * $end - string datetime "YYYY-MM-DD HH:MM:SS"
+Return: int
+=== locationInfoWindow ===
+...
+Descrizione : //locationInfoWindow($data)//\\
+Parametri: $data - array\\
+Return: void
+=== locationLegenda ===
+Ritorna un array con la legenda dell'agenda.\\
+Descrizione : //locationLegenda()//\\
+Parametri: nessun parametro\\
+Return: array
 === permissionsGetActions ===
 Ritorna un array contenente le azioni prodotte dall'agenda.\\
-Descrizione : //array permissionsGetActions()//
+Descrizione : //permissionsGetActions()//\\
+Parametri: nessun parametro\\
+Return: array
+=== permissionsGetObjects ===
+Ritorna un array contenente gli oggetti prodotti dall'agenda.\\
+Descrizione : //permissionsGetObjects()//\\
+Parametri: nessun parametro\\
+Return: array
 === permissionsGetRoles ===
 Ritorna un array contenente i ruoli attivi per quell'agenda.\\
-Descrizione : //array permissionsGetRoles()//
+Descrizione : //permissionsGetRoles()//\\
+Parametri: nessun parametro\\
-=== whoIsMyParent ===
+Return: array
-Ritorna un array contenente i dati del modulo contenitore.\\
-Descrizione : //array whoIsMyParent(array $data)//
-=== locationInfoWindow ===
-Descrizione : //void locationInfoWindow($data)//
-=== showLocationKml ===
-Descrizione : //int showLocationKml()//
 === showLocation ===
 Ritorna un array con le coordinate dell'agenda.\\
-Descrizione : //array showLocation()//
+Descrizione : //showLocation()//\\
+Parametri: nessun parametro\\
+Return: array
-=== locationLegenda ===
+=== showLocationKml ===
-Ritorna un array con la legenda dell'agenda.\\
+...
-Descrizione : //array locationLegenda()//
+Descrizione : //showLocationKml()//\\
+Parametri: nessun parametro\\
-=== getDays ===
+Return: array
-Ritorna i giorni tra due date in formato SQML.\\
-Descrizione : //int, array getDays(string $start, string $end)//
-=== dateToKey ===
-Riformatta la data.\\
-Descrizione : //void dateToKey($date)//
 === toolGetResources ===
 Ritorna le risorse di una determinata agenda, utili per i tools.\\
-Descrizione: //array toolGetResources($id)//
+Descrizione: //toolGetResources($id)//\\
+Parametri: id dell'agenda: $id - int(10)\\
+Return: array
 === toolGetWiki ===
-\\
+...
-Descrizione: //toolGetWiki($id)//
+Descrizione: //toolGetWiki($id)//\\
+Parametri: id della discussione informata: $id - int(10)\\
+Return: void
 === whoAreMySiblings ===
-\\
+...
-Descrizione: //array whoAreMySiblings(array $data)//
+Descrizione: //whoAreMySiblings($data)//\\
+Parametri: $data - array\\
+Return: array
+=== whoIsMyParent ===
+Ritorna un array contenente i dati del modulo contenitore.\\
+Descrizione : //whoIsMyParent($data)//\\
+Parametri: $data - array\\
+Return: array
 === whoIsOfASpecies ===
 Ritorna un array con gli id di tutti gli strumenti di un certo tipo presenti nel container agenda.\\
-Descrizione: //array whoIsOfASpecies(array $data)//
+Descrizione: //whoIsOfASpecies($data)//\\
+Parametri: $data - array\\
+Return: array

Documentazione openDCN

Strumenti Utente

Strumenti Sito

Differenze

Strumenti Pagina