Capitolo 1: Panoramica

1.1. Cosa sono le API di Envolution?

1.2. Vantaggi delle API

1.3. Svantaggi delle API

1.4. Chi dovrebbe usare queste API?

1.5. Stato delle API

1.6. Questo documento

1.7. Documenti correlati

1.8. Suggerimenti ed aggiornamenti

1.1. Cosa sono le Envolution API?

La Envolution API (Application Program(ming) Interface) é un insieme di funzioni per Envolution che consente agli sviluppatori di accedere alle informazioni chiave e di gestirne i contenuti in modo semplice.

1.2. Vantaggi delle API

Ci sono diversi vantaggi nell'avere una API per Envolution. In primo luogo l'usare una API permette agli sviluppatori di scrivere codice per Envolution e garantire che sia sempre funzionante con le future versioni di Envolution. Questa caratteristica é particolarmente importante per un sistema con Envolution, dove le funzionalità di base del sistema sono ancora in fase di sviluppo e di cambiamento, per adattarsi velocemente alle nuove esigenze che vengono richieste. L'avere una stabile interfaccia col sistema é un modo di garantire agli sviluppatori del Core di poter continuare ad aggiornare e ottimizzare Envolution senza il rischio di corrompere il codice scritto dagli sviluppatori dei Moduli.

Altre ragioni per usare un'API includono la possibilità per lo sviluppatore di iniziare a lavorare con Envolution più velocemente senza bisogno di capire la struttura interna del sistema, l'avere maniere standardizzate di ottenere e manipoare informazioni, e

1.3. Svantaggi delle API

Lo svantaggio principale di avere un'API è quando vuoi fare qualcosa che non ha una funzione adatta. Questo problema viene affrontato con l'incoraggiare gli sviluppatori a proporre suggerimenti per nuove funzioni delle API, e anche le funzioni stesse, per introdurle nel codice (dettagli sulle procedure si trovano di seguito). Una API aggiunge anche del carico su tutto il sistema, ma viene più che ricompensato dai vantaggi in stabilità e in semplicità di sviluppo.

1.4. Chi dovrebbe usare queste API?

L'API di Envolution è indirizzata in primo luogo agli sviluppatori interessati a scrivere dei moduli per Envolution. Inoltre alcuni sviluppatori di temi grafici potrebbero usare queste funzioni per implementare caratteristiche avanzate all'interno dei loro temi.

1.5. Stato delle API

L'API di Envolution è attualmente in versione alfa. Ciò significa che all' API possono ancora essere aggiunte funzioni extra ed altri argomenti. Comunque, tutte le funzioni come evidenziate in questo documento lavoreranno come descritto e continueranno a lavorare così per un periodo futuro prevedibile (????). Tutte le future versioni dell'API annoteranno dove le funzioni sono state sovracedute o disapprovate, e gli sviluppatori avranno almeno sei mesi fra qualunque cambiamento importante nell'API che viene implementato e le vecchie funzioni che vengono rimosse dal core, concedendo il tempo adatto per la migrazione.

1.6. Questo documento

Questo documento dà una descrizione dell'API di Envolution ed inoltre include un riferimento per ogni funzione ufficiale attualmente disponibile agli sviluppatori.

1.7. Documenti correlati

Altri documenti che potrebbero essere utili insieme con questa guida sono la guida di sviluppo dei moduli, la guida di sviluppo dei temi, la guida categorizzata di dati e la guida di funzioni d'uscita (che tuttavia deve essere scritta).

1.8. Suggerimenti ed aggiornamenti

L'API di Envolution è work-in-progress. Ci saranno molte funzioni che mancano dall'API che gli sviluppatori gradirebbero. A questo scopo, se uno sviluppatore ha una richiesta per una funzione particolare allora può presentarla alla lista di richiesta delle caratteristiche di Envolution su ?SourceForge alla homepage di Envolution . Lo stesso sistema può dell'essere usato per inserire gli aggiorNomenti alle le funzioni correnti o nuove funzioni. Se sei uno sviluppatore e attualmente in ogni modo direttamente globale o accedendo a una delle tabelle del core per verificarlo o alle informazioni dell'aggiorNomento allora considera di spedire in una richiesta di feature in modo che il team di Envolution possa sviluppare un'API che possa effettuare preferibilmente tale funzione. Esso si accerterà che il tuo codice sia adatto a continuare a funzionare nelle future versioni di Envolution senza modifiche, questo deve notare che la principale richiesta per l'API del core di Envolution sono stabilità e un'orma relativamente piccola. Detto questo è possibile che la tua richiesta per una funzione nuova o aggiornata otterrà un rifiuto considerando che è troppo specifica o che può essere facilmente costruita da altre funzioni dell'API del core. In tali situazioni il team di Envolution proverà sempre a fornire un'alternativa semplice ma si prega di ricordare che la presentazione di una parte nuova o aggiornata dell'API non garantisce l'inclusione