pnDBGetConn()
pnDBInit
pnDBInit — inizializza la
connessione al db di Envolution
Sintassi
bool
pnDBInit();
Descrizione
pnDBInit()
inizializza la connessione al db di Envolution
Valori restituiti
Questa funzione ritorna il valore
true
se la connessione è avvenuta con successo, oppure false
se la connessione non è andata a buon fine.
Note
pnDBInit()
è chiamata normalmente da pnInit(),
e perciò non deve essere chiamata dallo sviluppatore.
Vedere anche
pnInit()
pnExceptionFree
pnExceptionFree — reimposta
lo stato delle eccezioni
Sintassi
void
pnExceptionFree();
Descrizione
pnExceptionFree()
reimposta lo stato corrente delle eccezioni.
Valori restituiti
Questa funzione non ha valori di
ritorno
Note
Bisogna sempre chiamare
pnExceptionFree()
quando si usa l’eccezione o si rischia di rimandare
l’eccezione all’istruzione chiamante.
Vedere anche
pnExceptionId()
pnExceptionMajor()
pnExceptionSet()
pnExceptionValue()
pnExceptionId
pnExceptionId — restituisce
l’identificatore dell’eccezione.
Sintassi
string
pnExceptionId();
Descrizione
pnExceptionId()
restituisce la stringa che identifica l’eccezione. La stringa
di caratteri contiene l’ID dell’eccezione (il nome della
classe PHP).
Valori restituiti
Questa funzione restituisce
l’identificatore dell’eccezione corrente. Se chiamata
quando non ci sono eccezioni, ritorna il valore void.
Vedere anche
pnExceptionFree()
pnExceptionMajor()
pnExceptionSet()
pnExceptionValue()
pnExceptionMajor
pnExceptionMajor —
restituisce il numero dell’eccezione
Sintassi
int
pnExceptionMajor();
Descrizione
pnExceptionMajor()
permette alla chiamata di stabilire se è sorta una eccezioni e
di quale tipo. PN_NO_EXCEPTION identifica lo stato senza eccezioni
Valori restituiti
La funzione restituisce uno dei
seguenti valori: PN_NO_EXCEPTION, PN_USER_EXCEPTION oppure
PN_SYSTEM_EXCEPTION.
Vedere anche
pnExceptionFree()
pnExceptionId()
pnExceptionSet()
pnExceptionValue()
pnExceptionSet
pnExceptionSet — causa
un’eccezione
Sintassi
void
pnExceptionSet();
Descrizione
pnExceptionSet()
permette alla funzione di creare un’eccezione. La chiamata deve
fornire un valore per il parametro. Il parametro può assumere
uno dei seguenti valori: PN_NO_EXCEPTION, PN_USER_EXCEPTION, oppure
PN_SYSTEM_EXCEPTION. Il valore assunto dal parametro produce le
seguenti conseguenze negli altri parametri della chiamata:
il parametro principale con valore PN_NO_EXCEPTION è un
normale output dell’operazione. In questo caso, sia
exception_id che param devono essere NULL. Da notare che non è
necessario chiamare pnExceptionSet()
per ottenere un normale output: è la regola se il metodo
termina senza eccezioni
Per gli altri valori assunti dal parametro viene specificata
un’eccezione definita dall’utente o dal sistema. Il
parametro Exception_id è l’identificatore che
rappresenta il tipo di eccezione. Se l’eccezione deve avere dei
membri, sarà il parametro param ad essere la struttura
dell’eccezione (PHP class) contenente i valori membri. Se
l’eccezione non contiene membri, param deve essere NULL.
Valori restituiti
La funzione non ritorna un
valore.
Vedere anche
pnExceptionFree()
pnExceptionId()
pnExceptionMajor()
pnExceptionValue()
pnExceptionValue
pnExceptionValue —
restituisce il valore dell’eccezione corrente
Sintassi
void
pnExceptionValue();
Descrizione
pnExceptionValue()
restituisce un oggetto corrispondente a questa eccezione
Valori restituiti
La funzione restituisce un
oggetto passato come parametro a pnExceptionSet().
Se chiamata senza eccezioni o con un’eccezione senza
informazioni associate, viene restituito il valore void.
Vedere anche
pnExceptionFree()
pnExceptionId()
pnExceptionMajor()
pnExceptionSet()
pnGetBaseURI
pnGetBaseURI — si ottiene
l'URI base di Envolution
Sintassi
string
pnGetBaseURI();
;
Descrizione
pnGetBaseURI() Ritorna l'URI base
di envolution.
Valori restituiti
Questa funzione restituisce l'
URI base di Envolution.
Note
Note URI è la parte di
un'url, per esempio nell'URL
'http://www.Envolution.com/stuff/index.php' L'URI sarebbe
'/stuff/index.php'.
Esempio
|
//
mostra URI base
$path
= pnGetBaseURI();
|
Vedere anche
pnGetBaseURL()
pnGetBaseURL
pnGetBaseURL — si ottiene
l'URL base per questo sito
Sintassi
string
pnGetBaseURL();
Descrizione
pnGetBaseURL() ottiene l'URL base
per il sito. L'URL base è definita come tutta l'URL per il
sito meno tutte le informazioni del file i.e. The base url is defined
as the full URL for the site minus any file information cioè
tutto prima di 'index.php' della vostra pagina.
Valori restituiti
Questa funzione restituisce l'URL
base del sito.
Note
L'ultimo carattere restituito da
pnGetBaseURL() è sempre '/'
pnGetBaseURL() rimpiazza la
vecchia variabile globale nukeurl
pnGetStatusMsg
pnGetStatusMsg — si ottiene
un messaggio di status
Sintassi
string
pnGetStatusMsg();
Descrizione
pnGetStatusMsg() Ottiene l'ultimo
messaggio di status inviato in questa sessione. Il messaggio di
status esiste in una di due variabili di sessione: 'statusmsg 'per un
messaggio di condizione, o 'errormsg 'per un messaggio di errore. Se
un messaggio di errore o di status esiste allora il messaggio di
errore sarà restituito.
Valori restituiti
Questa funzione restituisce il
valore dell'ultimo messaggio di status inviato, o void se non esiste
nessun messaggio di status.
Note
pnGetStatusMsg() è una
funzione distruttiva - essa cancella le due variabili di sessione
'statusmsg' e 'erorrmsg' durante il suo funzioNomento.
Vedere anche
pnSessionSetVar()
pnModAPIFunc
pnModAPIFunc — esegue una
funzione dell'API del modulo
Sintassi
mixed
pnModFunc(modname,
type,
func,
args);
string
modname,
, string type,
, string func,
, array args
;
BAD_PARAM
MODULE_FUNCTION_NOT_EXIST
Descrizione
pnModFunc()chiama
una specifica funzione dell'API del modulo
Parametri
modname
Il ben conosciuto nome del modulo
con cui viene eseguita la funzione
type
type Il tipo di funzione da
eseguire; attualmente 'user' o 'admin'
func
func Il nome della funzione
dell'API del modulo da eseguire
args
Un array associativo di argomenti
da passare alla funzione dell'API del modulo. Il numero esatto e il
tipo di argomenti dipende dalla funzione..
Valori restituiti
Questa funzione restituisce
qualunque valore di ritorno della funzione risultante se ci riesce.
Questa funzione ritorna void se viene incontrata una eccezzione.
Eccezioni
La funzione restituisce
BAD_PARAMse viene passato un parametro non valido. Essa restituisce
MODULE_FUNCTION_NOT_EXIST se il modulo non esiste. Questa funzione
rigetta le eccezioni della funzione del modulo.
Note
Prima di chiamare questa fuzione
tu devi caricare l'API del modulo con pnModAPILoad.
Per maggiori informazioni sui ben
conosciuti nomi dei moduli fai riferimento alla documentazione su
pnModGetVar()
Esempi
|
//
Chiama la funzione getarticles del modulo delle news dell'utente
con l'argomento 'id' settato a '3'
$articles
= pnModAPIFunc('News',
'user',
'getarticles',
array('id' => 3));
if
(!isset($articles)) {
// pnModAPIFunc() fallito
}
elseif ($articles == false)
// getarticles fallito
}
else {
// getarticles successo, dati in $articles
}
//
Chiama la funzione della lista permessi dell'admin senza argomenti
$list
= pnModAPIFunc('Permissions',
'admin',
'list');
if
(!isset($list)) {
// pnModAPIFunc() fallito
}
elseif ($list == false)
// list fallito
}
else {
// list successo, dati in $list
}
|
Vedere anche
pnModGetVar(),
pnModAPILoad(),
pnModFunc()
pnModAPILoad
pnModAPILoad — Carica un
API del modulo
Sintassi
int
pnModAPILoad(modname,
type);
string
modname,
, string type
;
BAD_PARAM
DATABASE_ERROR
MODULE_FILE_NOT_EXIST
MODULE_NOT_EXIST
Descrizione
pnModAPILoad() Carica funzioni
extra nel sistema Envolution per estendere le sue abilità.
Parametri
modname
Il ben conosciuto nome del modulo
da caricare
type
Il tipo di funzione
del modulo da caricare; attualmente 'user' o 'admin'.
Valori restituiti
Questa funzione restituisce true
se il modulo viene caricato con successo. Questa funzione restituisce
void se viene incontrata un'eccezzione.
Eccezioni
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.
Note
L'API di Envolution tiene
traccia di che modulo è stato caricato, perciò chiamate
multiple a pnModAPILoad() con gli stessi parametri restituiranno true
ogni volta.
Questa funzione non carica
automaticamente la funzionalità relativa dell'esposizione per
questo modulo, questo deve essere effettuato da una chiamata separata
a pnModLoad().
Per maggiori informazioni sui ben
conosciuti nomi dei moduli fai riferimento alla documentazione su
pnModGetVar()
Esempi
|
//
guarda se il modulo delle news è disponibile
if
(pnModAvailable('News')) {
// carica l'API utente per il modulo delle news
if (!pnModAPILoad('News', 'user')) {
die('Impossibile caricare API del modulo delle News');
}
}
|
Vedere anche
pnModLoad(),
pnModGetVar()
pnModAvailable
pnModAvailable — Controlla
se un modulo è disponibile
Sintassi
bool
pnModAvailable(modname);
string
modname
;
BAD_PARAM
DATABASE_ERROR
Descrizione
pnModAvailable() conferma se un
modulo è disponibile per essere usato in un sistema
Envolution.
Parametri
modname
Il ben conosciuto nome del modulo
da controllare.
Valori restituiti
Questa funzione restituisce true
se il modulo è disponibile per l'uso. Questa funzione
restituisce void se viene incontrata una eccezione
Eccezioni
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.
Note
Un modulo che è caricato
nel sistema Envolution ma che è inattivo o inizializzato è
disponibile come non disponibile per l'uso.
Per maggiori informazioni sui ben
conosciuti nomi dei moduli fai riferimento alla documentazione su
pnModGetVar()
Esempio
|
//
Controlla se un modulo delle News è disponibile
if
(pnModAvailable('News')) {
// Load the News module
if (!pnModAPILoad('News', 'user')) {
die('Impossibile caricare API del modulo News’);
}
}
|
pnModCallHooks
pnModCallHooks — effettua
l'operazione di agganciamento al modulo
Sintassi
bool
pnModCallHooks(hookobject,
hookaction,
hookid,
extrainfo);
string
hookobject,
string hookaction,
string hookid,
string extrainfo
;
BAD_PARAM
DATABASE_ERROR
MODULE_FILE_NOT_EXIST
MODULE_FUNCTION_NOT_EXIST
MODULE_NOT_EXIST
Descrizione
pnModCallHooks()effettua
l'operazione di agganciamento al modulo
Parametri
hookobject
L'oggetto gancio che richiede o
'item' o 'category'
hookaction
l'azione del gancio è
chiamata per 'create', 'delete', 'transform', o 'display'
hookid
l’id dell’oggetto per
il quale l’aggancio viene chiamato (è specifico del
modulo)
extrainfo
Informazioni extra per il gancio,
dipende dall'azione del gancio
Valori restituiti
Questa ritorna l'output del
gancio come stringa. Questa funzione ritorna void se una eccezzione
viene incontrata.
Eccezioni
La funzione ritorna
DATABASE_ERROR se c’è un errore nell’interrogazione
dei dati. La funzione rigetta le eccezioni restituite dalle altre
funzioni.
Note
Ogni gancio per il modulo è
chiamato alternativamente . Se l'azione è 'display' il
risultato è la concatenazione di ogni output del gancio Dove
l'area del gancio è 'GUI'. Altrimenti il risultato è
extrainfo ritornato restituito dall'ultimo gancio che viene chiamato.
La lista delle azioni dei ganci
viene raffinata costantemente. Controlla il codice sorgente per
vedere se c'è una lista corrente.
Esempi
|
// Fa sapere a tutti i ganci che noi stiamo visualizzando un
articolo. poichè questo è un gancio di mostra
// stiamo passando un'URL come info supplementare, chè è
l'URL che tutti i ganci mostreranno
//
dopo che abbiamo finito il loro lavoro. Esso è normale per
quell'url portare l'utente indietro a questa funzione
$output->SetInputMode(_PNH_VERBATIMINPUT);
$output->Text(pnModCallHooks('item',
'display',
$tid,
pnModURL('Template',
'user',
'display',
array('tid' =>
$tid))));
$output->SetInputMode(_PNH_PARSEINPUT);
|
Vedere anche
pnModRegisterHook()
pnModUnregisterHook()
pnModDBInfoLoad
pnModDBInfoLoad — carica le
informazioni del database per un modulo
Sintassi
bool
pnModDBInfoLoad(module,
directory);
string
module,
string directory
;
BAD_PARAM
DATABASE_ERROR
MODULE_NOT_EXIST
Descrizione
pnModDBInfoLoad() Carica la
tabella di informazioni del database per un modulo. Queste
informazioni sono unite con il modulo
Parametri
module
Il ben conosciuto nome del modulo
che serve a caricare la directory della tabella di informazioni dal
database
directory
La directory nome del
modulo per caricare la tabella delle informazioni del database, se
conosciuta
Valori restituiti
Questa funzione restituisce true.
Questa funzione restituisce void se viene incontrata una funzione.
Eccezioni
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.
Note
Se non è presente la
tabella di informazioni del database allora è presupposto che
il modulo usi le tabelle definite altrove o nessuna tabella del
database affatto, quindi la funzione restituisce sempre true.
Esempio
|
//
Carica la tabella di informazioni per il modulo delle News
pnModDBInfoLoad('News'
//
Ottiene la tabella di informazioni, ora include le tabelle delle
news
$pntable
= pnDBGetTables();
|
pnModDelVar
pnModDelVar — cancella una
variabile del modulo
Sintassi
bool
pnModDelVar(module,
name);
string
module,
string name
;
BAD_PARAM
DATABASE_ERROR
Descrizione
pnModDelVar() Cancella una
variabile specifica del modulo dal sistema Envolution.
Parametri
module
Il nome del modulo per poter
cancellare la variabile
name
Il nome della variabile del
modulo da cancellare
Valori restituiti
Questa funzione restituisce true
se la cancellazione ha successo. Questa funzione ritorna void se
viene incontrata un'eccezzione.
Eccezioni
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.
Note
Per maggiori informazioni sui ben
conosciuti nomi dei moduli fai riferimento alla documentazione su
pnModGetVar()
Esempio
|
//
cancella la variabile numitems da News
if
(!pnModDelVar('News', 'numitems')) {
die(‘Errore nella cancellazione della variabile
numitems da News');
}
|
Vedere anche
pnModGetVar(),
pnModSetVar()
Guida ai Comandi delle API di Envolution 
