Queste sono le differenze tra la revisione selezionata e la versione attuale della pagina.
| Both sides previous revision Previous revision Next revision | Previous revision | ||
|
le_api [05/05/2010 16:25] |
le_api [05/06/2013 17:08] (versione attuale) |
||
|---|---|---|---|
| Linea 1: | Linea 1: | ||
| ====== Le API ====== | ====== Le API ====== | ||
| \\ | \\ | ||
| - | In questa parte del manuale analizzeremo la struttura delle API di openDCN e le funzioni contenute in ognuna di queste.\\ | + | Per permettere che tutti i moduli presenti in openDCN si possano interfacciare tra loro, sono state create delle API che mettono a disposizione alcune funzioni a servizio di altri moduli. \\ |
| + | Ad oggi, non sono stati ancora implementate API che permettano alla piattaforma di interagire con Sistemi esterni.\\ | ||
| + | Le API sono situate nella struttura della piattaforma all’interno della directory home/app/apis, dove troviamo le API di ogni controller, organizzate per cartelle che prendono il nome del controller relativo (es. home/app/apis/agenda).\\ | ||
| \\ | \\ | ||
| - | Le Api sono situate nella cartella //home\app\apis//, dove troviamo il file //events_controller.xml// (che serve per definire a livello di sistema gli eventi disponibili e i parametri di cui necessitano) assieme alle api di ogni controller, organizzate all’interno delle cartelle degli stessi (es. //home\app\apis\agenda//).\\ | + | Infine, all’interno della directory di ogni controller (es app/apis/agenda), dove necessario, è presente anche la cartella “view” che contiene le funzioni che gestiscono il template delle API di quel controller.\\ |
| \\ | \\ | ||
| - | Infine, per ogni controller, dove necessario, è presente anche la cartella “view” che contiene le funzioni che gestiscono il template di quel controller.\\ | + | **Esempio struttura**: //HOME/APP/APIS/AGENDA/VIEWS///\\ |
| \\ | \\ | ||
| - | Tutte le Api dei controller sono estensioni del file //api_controller.php// situato in //home\app\apis\core//.\\ | + | Tutte le Api sono estensioni del file //api_controller.php//, //api_view.php// e //basics.php// che si occupano rispettivamente di: definire le proprietà delle api di cakePHP potendole usare nelle api interne (//api_controller.php//), eseguire poi lo stesso lavoro a livello delle viste (//api_view.php//) e di gestire la comunicazione tra api interne ed esterne (//basics.php//).\\ |
| + | \\ | ||
| + | Di seguito la struttura di tutte le API interne, divise per controller.\\ | ||
| + | \\ | ||
| + | * [[agenda]]\\ | ||
| + | * [[anonymous]]\\ | ||
| + | * [[attachments]]\\ | ||
| + | * [[blockset]]\\ | ||
| + | * [[content]]\\ | ||
| + | * [[core]]\\ | ||
| + | * [[geomap]]\\ | ||
| + | * [[groups]]\\ | ||
| + | * [[infodiscs]]\\ | ||
| + | * [[legenda]]\\ | ||
| + | * [[light_polls]]\\ | ||
| + | * [[links]]\\ | ||
| + | * [[locations]]\\ | ||
| + | * [[logs]]\\ | ||
| + | * [[markerset]]\\ | ||
| + | * [[meeting]]\\ | ||
| + | * [[menu]]\\ | ||
| + | * [[notifications]]\\ | ||
| + | * [[permissions]]\\ | ||
| + | * [[polls]]\\ | ||
| + | * [[posts]]\\ | ||
| + | * [[rating]]\\ | ||
| + | * [[resources]]\\ | ||
| + | * [[templates]]\\ | ||
| + | * [[texts]]\\ | ||
| + | * [[users]]\\ | ||
| + | * [[variables]]\\ | ||
| + | * [[videos]]\\ | ||
| + | * [[wikitool]]\\ | ||
| + | \\ | ||
| + | \\ | ||
| + | \\ | ||
| + | \\ | ||
| + | [[gli eventi | indietro]] - [[le stringhe | avanti]] | ||
| \\ | \\ | ||
| - | ---- | ||
| \\ | \\ | ||
| - | **Agenda** – //home\app\apis\agenda\agenda_api_controllers.php//\\ | ||
| - | (class AgendaApiController extends ApiController)\\ | ||
| \\ | \\ | ||
| - | ^ FUNZIONE ^ DESCRIZIONE ^ | ||
| - | | blocksMap()| | | ||
| - | | blockAgendaRender($id)| Controlla le Agende attive | | ||
| - | | blockAgendaCreate()| Crea il form per contere l’Agenda | | ||
| - | | blockAgendaEdit($id)| | | ||
| - | | blockAgendaSave() | | | ||
| - | | blockAgendaUpdate($id)| | | ||
| - | | permissionsGetObjects() | Produce un array di stringhe contenenti tutti gli oggetti prodotti dal modulo Agenda. | | ||
| - | | permissionsGetActions() | Produce un array di stringhe contenenti tutte le azioni prodotte dal modulo Agenda. | | ||
| - | | permissionsGetRoles() | Definisce i ruoli di un’Agenda. | | ||
| - | | whoIsMyParent($data) | Definisce le generalità dell’Agenda. | | ||
| - | | locationInfoWindow($data) | | | ||
| - | | showLocationKml() | | | ||
| - | | showLocation() | | | ||
| - | | locationLegenda() | | | ||
| - | | getDays($start, $end) | | | ||
| - | | dateToKey($date) | | | ||
| - | | toolGetResources($id) | | | ||
| - | | toolGetWiki($id) | | | ||
| - | |||