Indice
pnBlockGetInfo – informazioni sul blocco
pnBlockLoad – carica un blocco
pnBlockShow – imposta la variabile di configurazione
pnConfigGetVar – ritorna la variabile di configurazione
pnConfigSetVar - imposta la variabile di configurazione
pnConfigDelVar – cancella la variabile di configurazione
pnDBGetConn – connessione al database
pnDBGetTables – per le tabelle del database
pnDBInit – iizializza la connessione al database Envolution
pnExceptionFree – reimposta lo stato delle eccezioni
pnExceptionId – ritorna l’identificatore dell’eccezione corrente
pnExceptionMajor - ritorna il numero dell’eccezione corrente
pnExceptionSet – fa sorgere un’eccezione
pnExceptionValue - ritorna il valore dell’eccezione corrente
pnGetBaseURI – fornisce l’URI di Envolution
pnGetBaseURL - fornisce l’URL di Envolution
pnGetStatusMsg – fornisce un messaggio di stato
pnInit – inizializza Envolution
pnModAPIFunc – esegue una funzione del modulo API
pnModAPILoad – carica un modulo API
pnModAvailable – controlla se un modulo è disponibile
pnModCallHooks – fornisce le operazioni di aggancio per i moduli
pnModDBInfoLoad – carica le informazioni del db per il modulo
pnModDelVar – cancella una variabile del modulo
pnModFunc – esegue una funzione del modulo
pnModGetAdminMods – fornisce la lista dei moduli di amministrazione
pnModGetIDFromName – fornisce l’id del modulo dal nome
pnModGetInfo – fisce informazioni sul modulo
pnModGetName – fornisce il nome del modulo del livello più alto correntemente
pnModGetUserMods - fornisce la lista dei moduli utente
pnModGetVar – fornisce le variabili dei moduli
pnModLoad – carica un modulo
pnModRegisterHook – registra una funzione aggancio
pnModSetVar – imposta una variabile del modulo
pnModUnregisterHook – cancella dal registro la variabile del modulo
pnModURL – crea l’URL del modulo
pnRedirect – ridireziona ad un’altra pagina
pnSecAddSchema – aggiunge lo schema di sicurezza
pnSecAuthAction – autorizza le azioni contro intrusioni
pnSessionDelVar – cancella le variabili di sessione
pnSessionGetVar – fornisce le variabili di sessione
pnSessionInit - inizializza la sessione
pnSessionSetup – crea una sessione
pnSessionSetVar – imposta le variabili di sessione
pnThemeLoad – carica il tema da visualizzare
pnUserGetAll – fornisce le informazioni base sugli utenti
pnUserGetLang – fornisce la lingua corrente
pnUserGetTheme – fornisce il tema corrente
pnUserGetVar – fornisce una variabile utente
pnUserGetVars – fornisce tutte le variabili utente
pnUserLoggedIn – controlla se un utente è connesso
pnUserLogIn – connette l’utente
pnUserLogOut – disconnette l’utente
pnUserSetVar – imposta la variabile utente
pnUserValidateVar – convalida le variabili utente
pnVarCensor – cancella le parole censurate dalle variabili
pnVarCleanFromInput – fornisce le variabili del form
pnVarPrepForDisplay – elabora le variabili da visualizzare
pnVarPrepForOS – elabora le variabili per il sistema operativo
pnVarPrepForStore – elabora le variabili per l’archiviazione nel db
pnVarPrepHTMLDisplay - elabora le variabili da visualizzare, preservando alcuni tag HTML
pnVarValidate – convalida una variabile
Le seguenti pagine hanno un riferimento completo dell'API di Envolution. Tutte le funzioni che non sono elencate in questa sezione vanno considerate interne e non dovrebbero essere usate dagli sviluppatori.
pnBlockGetInfo — ottiene le informazioni del blocco
array
pnBlockGetInfo(bid);
int
bid
;
BAD_PARAM
DATABASE_ERROR
ID_NOT_EXIST
pnBlockGetInfo() ritorna un'array di informazioni del blocco.
bid
l'id del blocco nel sistema Envolution
Questa funzione restituisce un array di informazioni del blocco o void se viene incontrata un'eccezione.
Questa funzione restituisce BAD_PARAM se si passa un parametro non valido. Questa funzione restituisce DATABASE_ERROR se c'è un errore nell'interrogare i dati. Questa funzione restituisce ID_NOT_EXIST se il blocco è sconosciuto.
The block information array contains the following items:
bkey
title
Visualizza il titolo del blocco
content
Il container per il contenuto del blocco. Serializzato usando pnBlockVarsFromContent() e pnBlockVarsToContent().
position weight active refresh indica se un blocco è aggiornato. Gli esempi sarebbero blocchi di titoli che prendono regolarmente il contenuto esterno. last_update la data e il tempo dell'ultimo aggiorNomento del blocco. language la lingua del blocco. mid L'ID del modulo a cui il blocco appartiene, '0' vuol dire che il blocco appartiene al core
url
l' URL per i blocchi che dipendono da URLs, come un blocco di titoli rss.
position
la posizione del blocco, attualmente uno di 'l' (sinistra), 'r' (destra), 'm' (centro). Ciò è probabile che cambierà nelle versioni successive per rendere la disposizione più flessibile. weight la larghezza dl blocco, usato per un piazzamento verticale del blocco.
weight
la larghezza dl blocco, usato per un piazzamento verticale del blocco.
active
Lo stato del blocco, '1' per attivo, '0' per inattivo.
refresh
indica se un blocco è aggiornato. Gli esempi sarebbero blocchi di titoli che prendono regolarmente il contenuto esterno.
last_update
la data e il tempo dell'ultimo aggiornamento del blocco.
language
la lingua del blocco.
mid
L'ID del modulo a cui il blocco appartiene, '0' vuol dire che il blocco appartiene al core
|
// avere informazioni sul blocco $blockinfo = pnBlockGetInfo($bid);
|
pnBlockLoad — carica un blocco
bool
pnBlockLoad(modname,
block);
string
modname,
string block
;
BAD_PARAM
DATABASE_ERROR
ID_NOT_EXIST
MODULE_FILE_NOT_EXIST
pnBlockLoad()Carica un blocco nel sistema Envolution.
modNome
Il ben noto nome del modulo per caricare il blocco. Questo parametro può essere lasciato vuoto, o settare a 'Core' per avviare blocchi del core.
block
Il nome del Blocco da caricare.
Questa funzione restituisce true se il blocco viene caricato con successo e void se viene incontrata qualche eccezione.
La funzione ritorna BAD_PARAMse si passa un parametro non valido. La funzione ritorna DATABASE_ERROR se c’è un errore nell’interrogare i dati. La funzione ritorna ID_NOT_EXIST se il blocco è sconosciuto. La funzione ritorna MODULE_FILE_NOT_EXIST se il file del blocco non esiste.
L'API di Envolution tiene traccia di quanti blocchi sono stati caricati, così chiamate multiple a pnBlockLoad() con gli stessi parametri ritorneranno true ogni volta.
Per maggiori informazioni sui nomi dei moduli ben noti fai riferimento alla documentazione per pnModGetVar()
Questa funzione non mostra il blocco automaticamente, questo deve essere effettuato da una chiamata separata a pnBlockShow().
|
// Load the past article block from the News module if (!pnBlockLoad('News', 'past')) { die('Could not load past articles block'); }
|
pnBlockShow()
pnBlockShow — setta una variabile di configurazione
string
pnBlockShow(modname,
block,
blockinfo);
string
modname,
, string block,
, array blockinfo
;
BAD_PARAM
DATABASE_ERROR
ID_NOT_EXIST
MODULE_FILE_NOT_EXIST
pnBlockShow() ottiene l'output di un blocco chiamando la relativa funzione 'block_display'
modname
Il ben noto nome del modulo per visualizzare il blocco. Questo parametro puù essere lasciato vuoto, o settato a 'Core' per visualizzare un blocco del Core.
block
Il nome del blocco da caricare
blockinfo
Un array associativo dei parametri da passare alla funzione di visualizzazione del display. il numero esatto e il tipo di parametri dipende dal blocco.
Un array associativo dei parametri da passare alla fuzione di visualizzazione del display. il numero esatto e il tipo di parametri dipende dal blocco.
La funzione ritorna BAD_PARAM se si passa un parametro non valido. La funzione ritorna DATABASE_ERROR se c’è un errore nell’interrogare i dati. La funzione ritorna ID_NOT_EXIST se il blocco è sconosciuto. La funzione ritorna MODULE_FILE_NOT_EXIST se il file del blocco non esiste.
Da fare: : chiodo giù agli standard del blocco. Nota che gli standard del blocco di evolution chiamati in questo modo devono restituire l'uscita di essi stessi. Specialmente, essi hanno bisogno di implementare la funzione di visualizzazione {$modNome}_{$block}block_display
|
Da farsi
|
pnBlockLoad()
pnConfigGetVar — si ottiene la variabile di configurazione
mixed
pnConfigGetVar(name);
string
name
;
BAD_PARAM
DATABASE_ERROR
Si ottiene una variabile di configurazione dal sistema Envolution.
name
Il nome della variabile di configurazione da ottenere
Questa funzione restituisce la variabile richiesta se la variabile esiste. Se la variabile non esiste allora questa funzione ritornerà void. Questa funzione ritorna void anche quando viene incontrata un'eccezione.
La funzione ritorna BAD_PARAM se si passa un parametro non valido. La funzione ritorna DATABASE_ERROR se c’è un errore nell’interrogare i dati
Le variabili di configurazione disponibili con questa release dell'API sono le seguenti:
debug
. Livello di debugging richiesto. 0 se non debuggato, 1 se normalmente debuggato.
Version_Num
Versione di questo sistema Envolution.
Version_ID
ID di questo sistema Envolution correntemente sempre 'Envolution'.
Version_Sub
Sub-ID di questo sistema Envolution.
startpage
Nome del modulo iniziale da caricare per questo sistema Envolution.
adminmail
indirizzo Email dell'amministratore per questo sistema Envolution.
sitename
Nome di questo sistema Envolution
slogan
Slogan di questo sistema Envolution
timezone_offset
Timezone differenza di questo sistema Envolution, delle ore del GMT-12
seclevel
Il livello di sicurezza di questo sito; 'high', 'medium', oppure 'low'
banners
Flag per dichiarare se si fa pubblicità o no; '0' per no or '1' per si
language
Codice del linguaggio di default per questo sistema Envolution
Locale
Locale per questo sistema Envolution
CensorMode
Flag per dichiarare se la censura è attiva; '0' per no o '1' per si
CensorList
Array di parole che sono censurate da questo sistema Envolution
Altre variabili saranno rese disponibili nelle future release dell'API
|
// ottiene il locale per questo sito locale $locale = pnConfigGetVar('locale');
|
pnConfigSetVar()
pnConfigSetVar — setta una variabile di configurazione
bool
pnConfigSetVar(name,
value);
string
name,
, string value
;
BAD_PARAM
DATABASE_ERROR
pnConfigSetVar() setta una variabile di configurazione per un sistema Envolution.
name
Il nome della variabile di configurazione da settare
value
Il valore da settare nella variabile di configurazione
Questa funzione attualmente restituisce false perchè non è implementata.
La funzione ritorna BAD_PARAM se si passa un parametro non valido. La funzione ritorna DATABASE_ERROR se c’è un errore nell’interrogare i dati
Questa funzione non è attualmente implementata.
|
// Setta locale per questo sito if (!pnConfigSetVar('locale', 'en_GB')) { die('Errore nel settare una variabile di configurazione'); }
|
pnConfigGetVar()
pnConfigDelVar — Cancella una variabile di configurazione
bool
pnConfigDelVar(name);
string
name
;
BAD_PARAM
DATABASE_ERROR
pnConfigDelVar() Cancella una variabile di configurazione da un sistema Envolution.
name
Il nome della variabile di configurazione da cancellare
Questa funzione attualmente restituisce false perchè non ancora implementata.
La funzione ritorna BAD_PARAM se si passa un parametro non valido. La funzione ritorna DATABASE_ERROR se c’è un errore nell’interrogare i dati
Questa funzione non è attualmente implementata.
|
// Rimuove la configurazione locale if (!pnConfigDelVar('locale')) { die('Errore nella configurazione della variabile locale'); }
|
pnConfigGetVar(), pnConfigSetVar()
pnDBGetConn — si ottiene una connessione al database
array pnDBGetConn();
pnDBGetConn() Ottiene gli handles della connessione al database per l'interrogazione diretta del database di Envolution.
Questa funzione restituisce un'array dei valori della connessione al database. Al momento l'unico valore attivo è solo il primo, che dovrebbe essere usato per tutte le interazioni col database.
Le versioni future dell'API di Envolution potranno fornire le informazioni del collegamento supplementari con questa funzione, tenendo conto delle caratteristiche quali replicated o failover databases.
|
// Ottenere una connessione al database list($dbconn) = pnDBGetConn();
|
pnDBGetTables()
pnDBGetTables — ottenere le tabelle del database
array pnDBGetTables();
pnDBGetTables() OTTIENE le informazioni della tabella del database per l'interrogazione diretta del database di Envolution.
Questa funzione restituisce un'arrai di informazioni della tabella del database.
Questa funzione restituisce un'arrai di informazioni della tabella del database.
|
// Ottenere le tabelle del db $pntable = pnDBGetTables();
|