Differenze

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

--- attachments [18/05/2010 17:39]
+++ attachments [05/06/2013 17:08] (versione attuale)
@@ Linea 3: / Linea 3: @@
 //class AttachmentsApiController extends ApiController//\\
 \\
-  * setTempDirectory - Cambia la directory dei file temoranei.
+=== _icon_file ===
-    //Descrizione//:
+Ritorna il nome delle icone partendo dal tipo di file.\\
-    void setTempDirectory(string $dirname)
+Descrizione: //_icon_file($file)//\\
+Parametri: $file - array\\
+Return: $icon - string
-  * setUploadDirectory - Cambia la directory dei file caricati.
+=== _normalize ===
-    //Descrizione//:
+Normalizza i dati all'interno di un array.\\
-    void setUploadDirectory(string $dirname)
+Descrizione: //_normalize(&$data)//\\
+Parametri: &$data - array\\
+Return: void
-  * getAttachmentDirs - ritorna il path degli allegati.
+=== delete  ===
-    //Descrizione//:
+Cancella l'allegato.\\
-    string getAttachmentDirs()
+Descrizione: //delete($id)//\\
+Parametri: $id - int\\
+Return: '-1' se elimina l'allegato
-  * form - renderizza la form degli allegati per l'aupload.
+=== form ===
-    //Descrizione//:
+Renderizza la form degli allegati per l'aupload.\\
-    void form ($res_id = null, $action = 'upload',$res_type="html",$submit_pos="bottom")
+Descrizione: //form ($res_id = null, $action = 'upload', $res_type="html", $submit_pos="bottom")//\\
+Parametri:
+    * $res_id - string, opzionale, è l'identificatore unico del form di upload
+    * $action - string, opzionale, è l'url che riceverà l'upload
+    * $res_type - string, opzionale, tipo di dato ritornato dalla funzione
+    * $submit_pos - string a scelta tra "bottom" e "right" per decidere la posizione del pulsante di submit
+Return: void
-  * save_files - Salva i files nella directory [webroot]/files.
+=== getAttachmentDirs ===
-    //Descrizione//:
+Ritorna il path degli allegati.\\
-    array save_files($formData,$uploadDir,$filePrefix)
+Descrizione: //getAttachmentDirs()//\\
+Parametri: nessun parametro\\
+Return: string $dirs
-  * renderize - stampa un allegato in versione preview.
+=== getFileById ===
-    //Descrizione//:
+Ritorna l'allegato attraverso il suo id.\\
-    void renderize($data, $preview, $permission)
+Descrizione: //getFileById($id)//\\
+Parametri: $id - int\\
+Return: boolean 'false' se non esiste il file oppure il file in array
-  * renderPreview - ritorna ...
+=== renderPreview ===
-    //Descrizione//:
+Renderizza la preview dei file caricati.\\
-    renderPreview($resources, $res_num)
+Descrizione: //renderPreview($resources, $res_num)//\\
+Parametri:
+    * $resources - array
+    * $res_num - int\\
+Return: void
-  * save -Salva i files caricati.
+=== renderize ===
-    //Descrizione//:
+Stampa un allegato in versione preview.\\
-    void save($resource, $resource_id)
+Descrizione: //renderize($data, $preview, $permission)//\\
+Parametri:
+    * $data e $permission - array
+    * $preview - boolean
+Return: void
-  * delete - Cancella l'allegato.
+=== save ===
-    //Descrizione//:
+Salva i files caricati.\\
-    void delete($id)
+Descrizione: //save($resource, $resource_id)//\\
+Parametri:
+    * $resource - arrayy
+    * $resource_id - int
+Return: void
-  * validateObject - Convalida i dati dell'allegato.
+=== save_files ===
-    //Descrizione//:
+Salva i files nella directory [webroot]/files.\\
-    void validateObject()
+Descrizione: //save_files($formData,$uploadDir,$filePrefix)//\\
+Parametri:
+    * $formData - array, dati del form
+    * $uploadDir - string, nome della directory in cui verranno salvati i files
+    * $filePrefix - string, prefisso dei file
+Return: array
-  * submit -
+=== setTempDirectory ===
-    //Descrizione//:
+Cambia la directory dei file temoranei.\\
-    void submit()
+Descrizione: //setTempDirectory($dirname)//\\
+Parametri: $dirname - string, nome della directory\\
+Return: void
-  * tab_title - ritorna il titolo dell'allegato.
+=== setUploadDirectory ===
-    //Descrizione//:
+Cambia la directory dei file caricati.\\
-    string tab_title()
+Descrizione: //setUploadDirectory($dirname)//\\
+Parametri: $dirname - string, nome della directory\\
+Return: void
-  * _normalize - normalizza i dati all'interno di un array.
+=== submit ===
-    //Descrizione//:
+...\\
-    void _normalize(array &$data)
+Descrizione: //submit()//\\
+Parametri: nessun parametro\\
+Return: void
-  * _icon_file - ritorna il nome delle icone partendo dal tipo di file.
+=== tab_title ===
-    //Descrizione//:
+Ritorna il titolo dell'allegato.\\
-    string _icon_file(array $file)
+Descrizione: //tab_title()//\\
+Parametri: nessun parametro\\
-  * getFileById - ritorna l'allegato attraverso il suo id.
+Return: string
-    //Descrizione//:
-    array getFileById($id)
+=== validateObject ===
+Convalida i dati dell'allegato.\\
+Descrizione: //validateObject()//\\
+Parametri: nessun parametro\\
+Return: void

Documentazione openDCN

Strumenti Utente

Strumenti Sito

Differenze

Strumenti Pagina