Queste sono le differenze tra la revisione selezionata e la versione attuale della pagina.
attachments [29/06/2010 18:02] |
attachments [05/06/2013 17:08] |
||
---|---|---|---|
Linea 1: | Linea 1: | ||
- | ====== API Attachments ====== | ||
- | home/app/apis/attachments/attachments_api_controllers.php\\ | ||
- | //class AttachmentsApiController extends ApiController//\\ | ||
- | \\ | ||
- | === _icon_file === | ||
- | Ritorna il nome delle icone partendo dal tipo di file.\\ | ||
- | Descrizione: //_icon_file($file)//\\ | ||
- | Parametri: $file - array\\ | ||
- | Return: $icon - string | ||
- | |||
- | === _normalize === | ||
- | Normalizza i dati all'interno di un array.\\ | ||
- | Descrizione: //_normalize(&$data)//\\ | ||
- | Parametri: &$data - array\\ | ||
- | Return: void | ||
- | |||
- | === delete === | ||
- | Cancella l'allegato.\\ | ||
- | Descrizione: //delete($id)//\\ | ||
- | Parametri: $id - int\\ | ||
- | Return: '-1' se elimina l'allegato | ||
- | |||
- | === form === | ||
- | Renderizza la form degli allegati per l'aupload.\\ | ||
- | 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 | ||
- | |||
- | === getAttachmentDirs === | ||
- | Ritorna il path degli allegati.\\ | ||
- | Descrizione: //getAttachmentDirs()//\\ | ||
- | Parametri: nessun parametro\\ | ||
- | Return: string $dirs | ||
- | |||
- | === getFileById === | ||
- | Ritorna l'allegato attraverso il suo id.\\ | ||
- | Descrizione: //getFileById($id)//\\ | ||
- | Parametri: $id - int\\ | ||
- | Return: boolean 'false' se non esiste il file oppure il file in array | ||
- | |||
- | === renderPreview === | ||
- | Renderizza la preview dei file caricati.\\ | ||
- | Descrizione: //renderPreview($resources, $res_num)//\\ | ||
- | Parametri: | ||
- | * $resources - array | ||
- | * $res_num - int\\ | ||
- | Return: void | ||
- | |||
- | === renderize === | ||
- | Stampa un allegato in versione preview.\\ | ||
- | Descrizione: //renderize($data, $preview, $permission)//\\ | ||
- | Parametri: | ||
- | * $data e $permission - array | ||
- | * $preview - boolean | ||
- | Return: void | ||
- | |||
- | === save === | ||
- | Salva i files caricati.\\ | ||
- | Descrizione: //save($resource, $resource_id)//\\ | ||
- | Parametri: | ||
- | * $resource - arrayy | ||
- | * $resource_id - int | ||
- | Return: void | ||
- | |||
- | === save_files === | ||
- | Salva i files nella directory [webroot]/files.\\ | ||
- | 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 | ||
- | |||
- | === setTempDirectory === | ||
- | Cambia la directory dei file temoranei.\\ | ||
- | Descrizione: //setTempDirectory($dirname)//\\ | ||
- | Parametri: $dirname - string, nome della directory\\ | ||
- | Return: void | ||
- | |||
- | === setUploadDirectory === | ||
- | Cambia la directory dei file caricati.\\ | ||
- | Descrizione: //setUploadDirectory($dirname)//\\ | ||
- | Parametri: $dirname - string, nome della directory\\ | ||
- | Return: void | ||
- | |||
- | === submit === | ||
- | ...\\ | ||
- | Descrizione: //submit()//\\ | ||
- | Parametri: nessun parametro\\ | ||
- | Return: void | ||
- | |||
- | === tab_title === | ||
- | Ritorna il titolo dell'allegato.\\ | ||
- | Descrizione: //tab_title()//\\ | ||
- | Parametri: nessun parametro\\ | ||
- | Return: string | ||
- | |||
- | === validateObject === | ||
- | Convalida i dati dell'allegato.\\ | ||
- | Descrizione: //validateObject()//\\ | ||
- | Parametri: nessun parametro\\ | ||
- | Return: void | ||