Uno script di interazione utente consente di programmare un'interazione con il titolare del lavoro e di modificare il lavoro in base alla risposta dell'utente. Nello specifico, permette di visualizzare una serie di finestre di dialogo dell'interfaccia utente con domande e pulsanti di azione (SÌ/NO, STAMPA/NO, SÌ/NO/ANNULLA). A seconda della selezione dell'utente, possono essere visualizzate ulteriori finestre di dialogo e possono essere intraprese azioni. Infine, una volta elaborata l’ultima finestra di dialogo, lo script termina e il lavoro viene impostato come ready e può essere rilasciato.
Se è presente uno script di interazione con l’utente, questo deve essere prima eseguito con successo prima che il lavoro possa essere rilasciato. Fino a quel momento, il lavoro rimane forzatamente nello pause stato fino a quel momento.
È possibile utilizzare le funzioni PHP di base e quasi tutte quelle descritte nella Guida di riferimento allo scripting dei lavori. Gli unici due metodi non supportati da questa funzionalità sono $this->job->setPrinted() e $this->job->pause(). Oltre alle classi, ai metodi e alle proprietà comuni, è possibile utilizzare diverse funzioni aggiuntive per comunicare con l’applicazione MyQ Desktop Client.
Come scrivere uno script di interazione utente
Nella scheda MyQ Desktop Client di una coda, nella sezione Interazione con l’utente, inserire lo script nel campo e fare clic su Salva.
Per prima cosa, è necessario definire la main(). Questa funzione stabilisce se la finestra di dialogo deve essere aperta (a quali condizioni) e quale finestra di dialogo deve essere visualizzata.
Successivamente è possibile definire le funzioni al clic con le relative reazioni all’opzione selezionata: onYes(), onNo(), onPrint(), onCancel().
Le proprietà pubbliche vengono mantenute tra una chiamata e l’altra. Infatti, vengono inviate al client e poi restituite.
Struttura dello script
Si veda lo script seguente:
public $hasMoreThan10pages;
// script entry point
function main() {
/** Job object */
$job = $this->job;
$this->hasMoreThan10pages = $job->pageCount > 10;
// Show dialog if the job has more than 10 pages
if ($this->hasMoreThan10pages === true) {
$this->dialogYesNo("Job has more than 10 pages. Do you want to print in duplex?");
}
}
// If yes clicked
function onYes() {
// $this->hasMoreThan10pages is available also here
$this->job->duplex = 'longEdge';
}
// If no clicked
function onNo() {
// nothing. Job will be released.
}
Utilizzando lo script sopra riportato, questa finestra di dialogo viene visualizzata nel MyQ Desktop Client:
Se hai familiarità con il linguaggio PHP, lo script è in realtà il corpo dell'istruzione class UserScript {...} istruzione.
È possibile definire proprietà come $hasMoreThan10pages. Le proprietà sono persistenti tra più esecuzioni dello script per lo stesso lavoro. Utilizzale per memorizzare uno stato tra più finestre di dialogo.
Esiste la main funzione. Viene chiamata una volta all’avvio dello script. Usatela per visualizzare la prima finestra di dialogo.
Poi ci sono le onXXX funzioni. Si tratta dei gestori di azione chiamati quando viene premuto un XXX viene premuto un pulsante. Ad esempio, il Yes pulsante viene gestito tramite la onYes funzione.
Se non viene visualizzata alcuna finestra di dialogo, lo script è terminato.
Riferimento API
Consultare il Riferimento allo scripting dei lavori per sapere come modificare il lavoro e per molte altre operazioni che è possibile eseguire.
Lo script di interazione utente viene eseguito nel contesto della classe User. È possibile accedere al lavoro inviato come $this->job.
È possibile accedere agli oggetti di tutte le classi, ad eccezione della classe "Session", tramite l’oggetto del lavoro, ad esempio il owner $this->job->owner. È possibile accedere agli oggetti della classe "Session" tramite la MyQ() funzione globale; ad esempio: MyQ()->logInfo("This message appears in the MyQ log.");.
Classe UserScript
Lo script di interazione utente costituisce il corpo della UserScript classe, come descritto in precedenza. MyQ fornisce inoltre diversi metodi integrati della classe User, oltre ai metodi definiti dall’utente.
Metodi di creazione delle finestre di dialogo
|
Funzione |
Descrizione |
|---|---|
|
void dialogYesNo(string $text) |
Crea una finestra di dialogo con il |
|
void dialogPrintNo(string $text) |
Crea una finestra di dialogo con |
|
void dialogYesNoCancel(string $text) |
Crea una finestra di dialogo con il testo |
|
void dialog(string $text, Field[] $fields) |
Crea una finestra di dialogo con |
|
FieldButton button(string $title, string $id) |
Crea un pulsante personalizzato che può essere utilizzato nella |
|
FieldList singleSelectList(string $name, array $items) |
Crea un elenco di opzioni tra cui l’utente può sceglierne una sola (gruppo di pulsanti di opzione). Può essere utilizzato nella |
|
FieldMultiSelectList multiSelectList(string $name, array $items) |
Crea un elenco di opzioni tra cui l’utente può selezionarne più di una (caselle di controllo). Può essere utilizzato nella |
Metodo onCancel
onCancel gestisce il pulsante Annulla ed è fornito di default. Chiama terminate(). È possibile fornire una propria implementazione per modificare il comportamento.
Altri metodi
|
Funzione |
Descrizione |
|---|---|
|
void terminate() |
Termina l'elaborazione dello script. Lo script non è stato eseguito correttamente e il lavoro rimane nello |
|
mixed getField(string $name) |
Recupera il valore del campo con il |
Vedi anche: