pnModFunc — esegue una funzione del modulo
mixed
pnModFunc(modname,
type,
func);
string
modname,
, string type,
, string func
;
BAD_PARAM
MODULE_FUNCTION_NOT_EXIST
pnModFunc() chiama una funzione specifica del modulo
modname
nome del modulo dal quale eseguire la funzione
type
Il tipo di funzione da eseguire; attualmente di tipo 'user' o 'admin'
func
Il nome della funzione del modulo da eseguire
Questa funzione ritorna qualunque valore della funzione risultante se ha successo. Questa funzione ritorna void se viene incontrata un'eccezzione. Si noti che gli standard dello stato dei moduli di Envolution dicono che le funzioni del modulo chiamate in questo modo devono restituire i valori specifici di essi stessi.
Per maggiori informazioni su questo, fai riferimento all'Envolution Module Development Guide.
La funzione restituisce BAD_PARAM se si passza un parametro non valido. Restituisce MODULE_FUNCTION_NOT_EXIST se la funzione del modulo non esiste. Restituisce parametri ritornati dalle funzioni del modulo..
Prima di chiamare questa funzione BISOGNA AVER caricato il modulo con pnModLoad.
Per maggiori informazioni sui nomi dei moduli far riferimento alla documentazione su pnModGetVar()
|
// Mostra le news $return = pnModFunc('News', 'user', 'display');
|
pnModGetVar(), pnModLoad(), pnModAPIFunc()
pnModGetAdminMods — restituisce la lista dei moduli di amministrazione
array pnModGetAdminMods();
DATABASE_ERROR
Restituisce informazioni sui moduli in questo sistema Envolution che sono attivi e hanno un componente amministrativo tra essi.
Questa funzione restituisce un'array di infomazioni dei moduli se i moduli vengono trovati. Questa funzione restituisce void se viene incontrata un'eccezione.
La funzione restituisce DATABASE_ERROR se c’è un errore nell’interrogare i dati .
Ogni array del modulo contiene lo stesso set di articoli come quando chiami pnModGetInfo()
|
// Avere la lista di moduli disponibili con l'interfaccia di amministrazione $modarray = pnModGetAdminMods(); if (!$modarray) { die('Errore creazione lista dei moduli amministrativi'); }
|
pnModGetInfo(), pnModGetUserMods()
pnModGetIDFromName — restituisce l’id del modulo partendo dal nome
int
pnModGetIDFromName(module);
string
module
;
BAD_PARAM
DATABASE_ERROR
MODULE_NOT_EXIST
pnModGetIDFromName()restituisce l’ID del modulo su un sistema Envolution.
module
il nome del modulo per averne l’ID
Questa funzione restituisce l'ID del modulo per il dato modulo. Questa funzione restituisce void se 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. La funzione restituisce MODULE_NOT_EXIST se il modulo è inesistente.
Per maggiori informazioni sui nomi dei moduli fai riferimento alla documentazione su pnModGetVar()
|
// Avere l’ID del modulo News $modid = pnModGetIDFromName('News');
|
pnModGetInfo()
pnModGetInfo —avere informazioni sul modulo
array
pnModGetInfo(modid);
int
modid
;
BAD_PARAM
DATABASE_ERROR
ID_NOT_EXIST
Fornisce informazioni sul modulo in questo sistema Envolution.
modid
L'id di questo modulo nel sistema Envolution.
Questa funzione restituisce un'array di informazioni sul modulo se il modulo viene trovato. Questa funzione restituisce void se 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. La funzione restituisce ID_NOT_EXIST se il modulo è inesistente.
L’array del modulo contienen i seguenti termini::
name
nome del modulo
directory
la cartella del file system in cui si trovano i files del modulo
displayname
Il nome comune di questo modulo
description
Una breve descrizione delle funzionalità di questo modulo
Per maggiori informazioni sui nomi dei moduli fai riferimento alla documentazione su pnModGetVar()
|
// Avere informazioni sul modulo News $modid = pnModGetIDFromName('News'); $modinfo = pnModGetInfo($modid);
|
pnModGetIDFromName(), pnModGetUserMods(), pnModGetAdminMods(), pnModGetVar()
pnModGetName — per avere il nome dell'attuale modulo di livello superiore
string
pnModGetName();
;
pnModGetName()restituisce il nome dell'attuale modulo di livello superiore
Questa funzione attualmente restituisce il nome dell'attuale modulo di livello superiore, false se non in un modulo.
|
// nome del modulo $name = pnModGetName();
|
pnModGetUserMods — avere una lista dei moduli utenti
array pnModGetUserMods();
DATABASE_ERROR
pnModGetUserMods() Ottiene informazioni sui moduli in questo sistema Envolution che sono attivi e hanno un componente dell'utente.
Questa funzione restituisce un'array di array di informazioni dei moduli se il modulo viene trovato. Questa funzione restituisce void se viene incontrata un'eccezione.
La funzione restituisce DATABASE_ERROR se c’è un errore nell’interrogazione dei dati.
Ogni array del modulo contiene lo stesso elenco di termini di una chiamata a pnModGetInfo()
|
// si ottiene una lista di moduli disponibili con un'interfaccia utente $modarray = pnModGetUserMods(); if (!$modarray) { die('Error getting list of user modules'); }
|
pnModGetInfo(), pnModGetAdminMods()
pnModGetVar — si ottiene una variabile del modulo
mixed
pnModGetVar(module,
name);
string
module,
, string name
;
BAD_PARAM
DATABASE_ERROR
pnModGetVar()si ottiene una variabile specifica dal sistema Envolution.
module
Il nome del modulo per ottenere la variabile
name
Il nome della variabile da ottenere
Questa funzione restituisce la variabile richiesta se esiste. Se la variabile non esiste allora sarà resituito void. Questa funzione resituisce void se 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.
Il nome del modulo è l'unico nome con cui viene riconosciuto il modulo nella community di Envolution. Il nome del modulo normalmente corrisponde alla directory in cui si trova il suo codice; le informazioni del modulo possono essere trovate in ogni sistema Envolution andando nella sezione amministrazione.
Esempi di nomi di moduli sono 'News', 'FAQ', e 'Comments'.
Questa funzione non fornisce le informazioni di configurazioni del modulo. Per ottenere le informazioni quali l'ID del modulo o il suo status attuale bisogna usare le altre chiamate all'API disponibili in Envolution.
|
// Per avere la versione del modulo 'News' $newsmodver = pnModGetVar('News', 'Version');
|
pnModSetVar(), pnModDelVar()
pnModLoad — carica il modulo
int
pnModLoad(modname,
type);
string
modname,
, string type
;
BAD_PARAM
DATABASE_ERROR
MODULE_FILE_NOT_EXIST
MODULE_NOT_EXIST
pnModLoad() carica le funzioni di visualizzazione extra del sistema Envolution che estendono le sue funzionalità.
modname
Il nome comune del modulo da caricare
type
Il tipo delle funzioni id modulo da caricare, da ‘utente’ e da ‘admin’
La funzione restituisce true se la funzione è caricata con successo. Restituisce void se 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. La funzione restituisce MODULE_NOT_EXIST se il modulo è inesistente. Restituisce MODULE_FILE_NOT_EXIST se il file del modulo non esiste.
L'API di Envolution tiene traccia di che modulo è stato caricato, perciò multiple chiamate a pnModLoad() con gli stessi parametri restituiranno ogni volta true.
Per maggiori informazioni sui nomi comuni dei moduli fai riferimento alla documentazione su pnModGetVar()
Questa funzione non si carica automaticamente nella relativa funzionalità dell'API per questo modulo, ciò deve essere effettuato con una chiamata separata a pnModAPILoad().
|
// Controllare se il modulo News è disponibile if (pnModAvailable('News')) { // Carica il modulo News if (!pnModLoad('News', 'user')) { die('Modulo News: fallito caricamento'); } }
|
pnModAPILoad(), pnModGetVar()
pnModRegisterHook — Registra una funzione di aggancio
bool
pnModRegisterHook(hookobject,
hookaction,
hookarea,
hookmodule,
hooktype,
hookfunc);
string
hookobject,
string hookaction,
string hookarea,
string hookmodule,
string hooktype,
string hookfunc
;
DATABASE_ERROR
pnModRegisterHook()Registra una funzione di aggancio
hookobject
L’oggetto gancio- sia 'item' che 'category'
hookaction
L’azione per cui è chiamato- 'create', 'delete', 'transform', o 'display'
hookarea
L’ambiente del gancio (sia 'GUI' che 'API')
hookmodule
Il nome del modulo gancio
hooktype
Il nome del tipo di gancio ('user' o 'admin')
hookfunc
Il nome della funzione di gancio
Questa funzione restituisce tue se ha successo. Questa funzione restituisce void se viene incontrata un'eccezione.
La funzione restituisce DATABASE_ERROR se c’è un errore nell’interrogazione dei dati.
La lista di azioni gancio viene costantemente ridefinita. Guardare il codice sorgente per la lista aggiornata.
|
// Imposta un gancio modulo if (!pnModRegisterHook('item', 'display', 'GUI', 'Ratings', 'user', 'display')) { return false; }
|
pnModUnregisterHook()
pnModSetVar — imposta una variabile del modulo
bool
pnModSetVar(module,
name,
value);
string
module,
, string name,
, string value
;
BAD_PARAM
DATABASE_ERROR
pnModSetVar()imposta una variabile specifica del modulo nel sistema Envolution. Se la variabile non esiste essa verrà creata.
module
Il nome comune del modulo nel quale impostare la variabile
name
Il nome della variabile di modulo da settare
value
Il valore da assegnare alla variabile di modulo
Questa funzione restituisce true se l'aggiornamento ha successo. Questa funzione restituisce void se 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.
Per maggiori informazioni sui ben conosciuti nomi dei moduli fai riferimento alla documentazione su pnModGetVar()
|
// Impostare le informazioni di versione per il modulo 'News' pnModSetVar('News', 'Version', 2);
|
pnModGetVar(), pnModDelVar()
pnModUnregisterHook — toglie dal registro una funzione gancio
bool
pnModUnregisterHook(hookobject,
hookaction,
hookarea,
hookmodule,
hooktype,
hookfunc);
string
hookobject,
string hookaction,
string hookarea,
string hookmodule,
string hooktype,
string hookfunc
;
DATABASE_ERROR
pnModUnregisterHook()toglie dal registro una funzione gancio
hookobject
L’oggetto gancio - 'item' o 'category'
hookaction
L’azione del gancio chiamato - 'create', 'delete', 'transform', o 'display'
hookarea
L’ambiente del gancio (‘GUI' o 'API')
hookmodule
Il nome del modulo gancio
hooktype
Il tipo di gancio ('user' o 'admin')
hookfunc
Il nome della funzione di gancio
Questa funzione restituisce true se ha successo. Questa funzione restituisce void se si incontra una eccezione.
La funzione restituisce DATABASE_ERROR se c’è un errore nell’interrogare i dati.
La lista di azioni gancio viene costantemente ridefinita. Guarda il codice sorgente per la lista corrente.
|
// Rimuove un gancio if (!pnModUnregisterHook('item', 'display', 'GUI', 'Ratings', 'user', 'display')) { pnSessionSetVar('errormsg', _RATINGSCOULDNOTUNREGISTER); }
|
pnModRegisterHook()
pnModURL — crea un URL del modulo
string
pnModURL(modname,
type,
func,
args);
string
modname,
, string type,
, string func,
, array args
;
BAD_PARAM
pnModURL()Crea un'url compatibile per una specifica funzione dl modulo.
modname
Il nome comune del modulo del quale creare l’URL
type
Il tipo dei funzione della quale creare l’URL, 'user' o 'admin'
func
La funzione corrente del modulo per la quale creare l’URL
args
Un array associativo di argomenti. Il numero esatto e il tipo di argomenti dipende dalla funzione
Questa funzione restituisce la stringa dell'URL del modulo se ha successo. Questa funzione resituisce void se viene incontrata un'eccezione.
La funzione restituisace BAD_PARAM se si passa un parametro non valido.
Per maggiori informazioni sui ben conosciuti nomi dei moduli fai riferimento alla documentazione su pnModGetVar()
|
// Crea un URL alla funzione 'view' di News con i parametri 'sid' impostati a 3 // e 'index' impostato a '0' $url = pnModURL('News', 'user', 'view', array('sid' => 3, 'index' => 0));
|
pnModGetVar(), pnModFunc()
pnRedirect — redirect to another page
void
pnRedirect(url);
string
url,
;
pnRedirect()crea un'url assoluto a una pagina Envolution e di conseguenza imposta il relativo header HTTP.
url
L’URL a cui si viene diretti. L’URL può avere il parametro GET aggiunto normalmente.
pnRedirect() può trattare sia URL assoluti che relativi. E’ usato insieme a funzioni di generazione-URL quale pnModURL.
pnRedirect() effettua una ridirezione HTTP1.1-compliant. Questa funzione non dovrebbere essere usata quando un'output è già richiesto, poichè l'output non sarà visualizzato.
|
// Ridireziona alla index pnRedirect('index.php'); // Ridireziona a nuova pagina pnRedirect(pnModURL('News', 'user', 'view', array('sid' => 3, 'index' => 0))); // Ridireziona all’esterno del sito pnRedirect('http://www.sitoremoto.com');
|
pnModURL()
pnSecAddSchema — aggiunge uno schema di sicurezza
void
pnSecAddSchema(component,
schema);
string
component,
, string schema
;
pnSecAddSchema()aggiunge uno schema nel sistema Envolution. La lista del componente schema non può essere usata in nessuna parte all'interno di Envolution, ma può essere visualizzata come componente di una funzione della GUI per aiutare nella configurazione del sistema dei permessi di Envolution.
component
Il componente al quale si riferisce lo schema delle autorizzazioni
schema
Lo schema delle autorizzazioni
La funzione restituisce true se lo schema delle autorizzazioni è aggiunto con successo , false se lo schema non è aggiunto con successo (normalmente dovuto a un nome del componente duplicato), e void se c’è un errore interno nelle API mentre viene aggiunto lo schema.
Una descrizione completa del sistema di autorizzazione di Envolution va oltre la portata di questo documento. Per maggiori informazioni sul sistema di autorizzazione e sul relativo uso dei permessi, i componenti e le istanze, fai riferimento alla Envolution Authorisation System documentation. Si noti che questa funzione è stata precedentemente usata come addinstanceschemainfo(). Quel nome è stato disapprovato ma è ancora funzionale in questa versione dell'API di Envolution; e si raccomanda di cambiare tutte le chiamate che attualmente sono fatte con addinstanceschemainfo() con pnSecAddSchema().
|
// Aggiunge uno schema di sicurezza al modulo foo pnSecAddSchema('Foo::', 'Name of foo:Type of foo:foo ID');
|
pnSecAuthAction — autorizza tentativi d’azione
bool
pnSecAuthAction(realm,
component,
instance,
level,
uid(opt));
int
realm,
, string component,
, string instance,
, int level,
int uid(opt)
;
DATABASE_ERROR
pnSecAuthAction() controlla le informazioni sulle autorizzazioni del sistema Envolution per decidere se un livello particolare di autorizzazione può essere permesso.
realm
il permesso a questa autorizzazione, impostato a 0
component
il componente che chiede quest’autorizzazione
instance
l’istanza che chiede quest’autorizzazione
level
Il livello d’accesso richiesto dall’autorizzazione per essere permessa
uid
L’uid dell’utente per controllare l’autorizzazione
Questa funzione restituisce true se il livello di autorizzazione assegnato all'utente per gli argomenti dati è superiore o uguale al livello richiesto, false se il livello di autorizzazione assegnato all'utente per gli argomenti richiesti è minore del livello richiesto. Questa funzione restituisce void se viene incontrata un'eccezione.
La funzione restituisce DATABASE_ERROR se c’è un errore nell’interrogare i dati.
Una descrizione completa del sistema di autorizzazione di Envolution va oltre la portata di questo documento. Per maggiori informazioni sul sistema di autorizzazione e sul relativo uso dei permessi, dei componenti e delle istanze, far riferimento alla Envolution Authorisation System documentation.
Quusta funzione era precedentemente conosciuta come authorised(). Questo nome è disapprovato ma ancora funzionale in questa versione dell'API di Envolution; si suggerisce di cambiare tutte le chiamate che attualmente fanno riferimento ad authorised() a pnSecAuthAction().
|
// Controlla se è autorizzato ad accedere alle funzioni di amministrazione del modulo 'foo' if (pnSecAuthAction(0, 'Foo::', 'My Foo:Foos of the world:4', ACCESS_ADMIN)) { // Yes } else { // No }
|
pnSessionDelVar — cancella una variabile di sessione
bool
pnSessionDelVar(name);
string
name
;
pnSessionDelVar()Cancella una variabile specifica di sessione da un sistema Envolution.
name
Il nome della variabile di sessione da cancellare
Questa fuzione restituisce trie se la variabile viene cancellata con successo, e void se incontra un'errore nell'API durante la cancellazione.
pnSessionGetVar(), pnSessionSetVar()
pnSessionGetVar — si ottiene una variabile di sessione
mixed
pnSessionGetVar(name);
string
name
;
pnSessionGetVar() si ottiene una variabile specifica di sessione da un sistema Envolution.
name
Il nome della variabile di sessione da ottenere
Questa funzione restituisce la variabile richiesta se esiste, false se la variabile non esiste, e void se ci fosse un errore interno di api mentre sta tentando di ottenere la variabile.
L'esistenza delle variabili di sessione non è garantita da un processo che viene fatto funzionare al seguente. Regole interne potrebbero rimuovere le sessioni che sono state inattive per periodi di tempo lunghi, in modo da non usare le variabili di sessione per memorizzare le informazioni di lunga durata.
pnSessionSetVar(), pnSessionDelVar()
pnSessionInit — inizializza la sessione
bool pnSessionInit();
pnSessionInit() inizializza una nuova sessione, impostando i cookie dell’utente come necessario e ricevendo le variabili della sessione corrente.
La funzione restituisce true se la inizializzazione della sessione è andata a buon fine , false in caso contrario, e void se c’è un errore interno delle API durante il tentativo di inizializzazione della sessione.
La funzione viene di solito chiamata da pnInit(), e non dovrebbe mai essere chiamata dai moduli o altri processi dello sviluppatore.
pnInit(), pnSessionSetup()
pnSessionSetup —istituisce una sessione
bool pnSessionSetup();
pnSessionSetup() imposta un certo numero di variabili di configurazioni di PHP che permettono al sistema Envolution di trattare sessioni utente persistenti tra varie connessioni HTTP .
La funzione ritorna true se la sessione va a buon fine, false in caso contrario, e void se c’è un errore interno alle API nel tentativo di iniziare una sessione.
La funzione viene di solito chiamata da pnInit(), e non dovrebbe mai essere chiamata dai moduli o altri processi dello sviluppatore.
pnInit(), pnSessionInit()
pnSessionSetVar — imposta una variabile di sessione
bool
pnSessionSetVar(name,
value);
string
name,
string value
;
pnSessionSetVar()imposta una variabile specifica di sessione nel sistema envolution.Se la variabile non esiste essa viene creata.
name
il nome della variabile di sessione da settare
value
il valore da settare con la variabile di sessione
Questa funzione restituisce true se la variabile viene settata, e void se ci fosse un errore interno di api mentre sta tentando di settare la variabile.
L'esistenza delle variabili di sessione non è garantita da un processo che viene fatto funzionare al seguente. Regole interne potrebbero rimuovere le sessioni che sono state inattive per periodi di tempo lunghi, in modo da non usare le variabili di sessione per memorizzare le informazioni di lunga durata.
pnSessionGetVar(), pnSessionDelVar()
pnThemeLoad — carica un tema di visualizzazione
bool pnThemeLoad();
pnThemeLoad()carica un tema di visualizzazione come specificato dall'utente, e imposta il numero di variabili globali per una compatibilità all'indietro con i vecchi temi di visualizzazione.
Questa funzione restituisce true se il tema viene caricato con successo, e false se il tema non viene caricato con successo.
|
// Carica il tema dell’utente if (!pnThemeLoad()) { die('Problem loading theme'); }
|
pnUserGetAll — per ottenere informazioni base su tutti gli utenti
array pnUserGetAll();
pnUserGetAll() per ottenere un set di informazioni base su tutti gli utenti attivi nel sistema Envolution.
pnUserGetAll()è disapprovato ma ancora funzionale in questa versione dell'API di Envolution. Tu non dovresti usarlo, poiché sarà rimosso quando Envolution raggiungerà la versione 1,0. Invece sei consigliato fortemente a usare la funzione del getall del modulo API degli utenti: $users = pnModAPIFunc('users', 'user', 'getall');
Questa funzione restituisce un'array di array associativi. gli elementi degli array sono riferiti per UID per un veloce accesso alle informazioni su un user specifico. Ogni arry corrisponde a un particolare utente e possiete i seguenti mebri dell'array:
uname
il nome utente
uid
l’ID utente
name
il nome completo dell’utente
l’indirizzo e-mail dell’utente
url
l’URL dell’utente
avatar
l’avatar dell’utente
Solo i campi uname e uid sono garantiti di essere riempiti; gli altri campi potrebbero essere vuoti.
|
// tutti gli utenti $allusers = pnUserGetAll(); // mostra username e uid di ogni utente foreach ($allusers as $user) { echo "User ID $user[uid] has user name $user[uname] "; } // mostra nome dell’utente uid 5 echo "User ID 5 is called {$allusers[5]['name']} ";
|