# SDK 2

# Inserimento di file php/js/css personalizzati

Per inserire del codice php personalizzato (che verrà incluso all’inizio di ogni pagina)  
basta registrare il nuovo file tramite il metodo:

**SDK::setUtil($src);** *$src : percorso del file php da includere*

Per rimuoverlo usare la funzione:

**SDK::unsetUtil($src);**  
*$src : percorso del file php da rimuovere (il file non verrà cancellato). Deve essere lo stesso percorso specificato in setUtil.*

Se invece si vogliono includere file js o css in ogni pagina, è disponibile la funzione:

**Vtiger\_Link::addLink($id, $tipo, 'SDKScript', $file);**  
*$id : id del modulo che registra il file (in questo caso quello di SDK, 31)*  
*$tipo : può essere “HEADERCSS” o “HEADERSCRIPT”*  
*$file : il percorso del file da includere*

Per rimuoverlo usare la funzione:

**Vtiger\_Link::deleteLink($id, $tipo, 'SDKScript', $file);**  
*$id : id del modulo che registra il file (in questo caso quello di SDK, 31)*  
*$tipo : può essere “HEADERCSS” o “HEADERSCRIPT”*  
*$file : il percorso del file*

In generale quando si vogliono includere i file php personalizzati si può chiamare semplicemente SDK::getUtils().

<p class="callout info">**Hooks:**  
include/Webservices/Utils.php  
include/squirrelmail/src/redirect.php  
install/PopulateSeedData.php  
index.php</p>

# Override ed estensioni Javascript

È possibile sostituire o estendere alcune funzioni Javascript di utilizzo comune per modificarne il comportamento. Per far ciò è sufficiente creare una funzione che ha lo stesso nome della funzione da modificare con l’aggiunta di “\_override” o “\_extension” e gli stessi parametri ed includerla in un file Javascript aggiuntivo, caricato nel modo spiegato nel precedente paragrafo. Il comportamento delle due estensioni è il seguente:

<table border="1" id="bkmrk-funzione_override%28%29-" style="border-collapse: collapse; width: 100%;"><tbody><tr><td style="width: 50%;">FUNZIONE\_override()</td><td style="width: 50%;">Se presente, viene chiamata questa funzione invece di  
quella originale. Il valore di ritorno di questa funzione è  
quello restituito.</td></tr><tr><td style="width: 50%;">FUNZIONE\_extension()</td><td style="width: 50%;">Se presente, viene chiamata questa funzione e se  
restituisce **false** o un valore equivalente a false, la  
funzione originale termina restituendo false, mentre se  
restituisce **true** o un valore equivalente, l’esecuzione  
prosegue nella funzione originale.</td></tr></tbody></table>

La differenza è quindi che nel primo caso, la funzione originale viene interamente ignorata, mentre nel secondo, si può decidere se continuare l’esecuzione standard o no. Questo è molto comodo nel caso delle funzioni di validazione, solitamente molto lunghe, in cui si voglia semplicemente aggiungere un controllo, senza ricopiare l’intera funzione per piccoli cambiamenti.  
Le funzioni che supportano queste estensioni sono indicate di seguito:

<table border="1" id="bkmrk-file-funzioni-includ" style="border-collapse: collapse; width: 100%;"><tbody><tr><td style="width: 50%;">**File**</td><td style="width: 50%;">**Funzioni**</td></tr><tr><td style="width: 50%;">include/js/general.js</td><td style="width: 50%;">doformValidation  
startCall  
getFormValidate</td></tr><tr><td style="width: 50%;">include/js/Inventory.js</td><td style="width: 50%;"><span style="font-family: DejaVu Sans, Arial, sans-serif;">settotalnoofrows</span>

<span style="font-family: DejaVu Sans, Arial, sans-serif;">deleteRow</span>

<span style="font-family: DejaVu Sans, Arial, sans-serif;">calcTotal</span>

<span style="font-family: DejaVu Sans, Arial, sans-serif;">calcProductTotal</span>

<span style="font-family: DejaVu Sans, Arial, sans-serif;">calcGrandTotal</span>

<span style="font-family: DejaVu Sans, Arial, sans-serif;">validateInventory</span>

<span style="font-family: DejaVu Sans, Arial, sans-serif;">FindDuplicate</span>

<span style="font-family: DejaVu Sans, Arial, sans-serif;">validateNewTaxType</span>

<span style="font-family: DejaVu Sans, Arial, sans-serif;">validateTaxes</span>

<span style="font-family: DejaVu Sans, Arial, sans-serif;">setDiscount</span>

<span style="font-family: DejaVu Sans, Arial, sans-serif;">callTaxCalc  
</span>

<span style="font-family: DejaVu Sans, Arial, sans-serif;">calcCurrentTax</span>

<span style="font-family: DejaVu Sans, Arial, sans-serif;">calcGroupTax</span>

<span style="font-family: DejaVu Sans, Arial, sans-serif;">calcSHTax</span>

<span style="font-family: DejaVu Sans, Arial, sans-serif;">validateProductDiscounts</span>

<span style="font-family: DejaVu Sans, Arial, sans-serif;">updatePrices</span>

<span style="font-family: DejaVu Sans, Arial, sans-serif;">updatePriceValues</span>

<span style="font-family: DejaVu Sans, Arial, sans-serif;">resetSHandAdjValues</span>

<span style="font-family: DejaVu Sans, Arial, sans-serif;">moveUpDown</span>

<span style="font-family: DejaVu Sans, Arial, sans-serif;">InventorySelectAll</span>

<span style="font-family: DejaVu Sans, Arial, sans-serif;">fnAddProductOrServiceRowNew</span>

</td></tr></tbody></table>

# Sostituzione php standard

Si possono sostituire i file php standard dei moduli, come DetailView.php, EditView.php… , tramite il metodo:

**SDK::setFile($module, $file, $newfile);**  
*$module : il nome del modulo*  
*$file : il valore del parametro “action” da confrontare*  
*$newfile: il nuovo sorgente php, senza estensione e senza percorso*

Il nuovo file deve essere nella stessa cartella del modulo e deve essere specificato senza estensione e senza percorso.  
Nota: se si vuole sostituire la ListView, si deve chiamare setFile due volte, una con $file=”ListView” e una con $file=”index”.

Per de-registrare il file usare:

**SDK::unsetFile($module, $file);**  
*$module : il nome del modulo*  
*$file : il nome del parametro “action” che era stato ridefinito*

<p class="callout info">**<span style="font-family: DejaVu Sans, Arial, sans-serif;">Hooks:  
</span>**<span style="font-family: DejaVu Sans, Arial, sans-serif;">include/Ajax/CommonAjax.php</span><span style="font-family: DejaVu Sans, Arial, sans-serif;">  
index.php</span></p>

# Inclusione di altri files

Per associare ad un modulo dei files o cartelle qualunque, in modo che vengano esportati o importati in modo automatico, sono disponibili i seguenti metodi:

**SDK::setExtraSrc($module, $src);** *$module : il nome del modulo*  
*$src : il percorso del file o della cartella da associare*

Per eliminare l'associazione (ma non i file stessi) usare:

**SDK::unsetExtraSrc($module, $src);**  
*$module : il nome del modulo*  
*$src : il percorso del file*

# Uitypes personalizzati

Si possono aggiungere dei nuovi tipi a quelli già esistenti e gestirli completamente senza modificare altro codice. Per crearne la procedura è:

1. Creare un nuovo campo personalizzato indicando il nuovo uitype con un valore non utilizzato (nnn).
2. Creare i file:  
    a. nnn.php in modules/SDK/examples  
    b. nnn.js in modules/SDK/examples  
    c. nnn.tpl in Smarty/templates/modules/SDK/examples  
    Questi file gestiscono il comportamento del nuovo campo a seconda del contesto (list, detail…)
3. Registrare il nuovo tipo con una chiamata a SDK::setUitype.

Nel file modules/SDK/examples/VTE-SDK-2.php ci sono vari esempi di creazione campi e registrazione uitype.  
In modules/SDK/doc/VTE-SDK-2.pdf alla voce **Uitypes List** è presente la lista dei principali uitype standard.

**SDK::setUitype($uitype, $src\_php, $src\_tpl, $src\_js, $type='', $params='');** *$uitype : il numero del nuovo tipo; deve essere nnn (nome dei files)*  
*$src\_php: percorso di nnn.php*  
*$src\_tpl: percorso di nnn.tpl (senza Smarty/templates/ all’inizio)*  
*$src\_js : percorso di nnn.js*  
*$type : tipo in formato webservice (‘text’, ‘boolean’, ...)*  
*$params : non usato*

Per de-registrare un uitype è disponibile il metodo:

**SDK::unsetUitype($uitype);** *$uitype : è il numero del uitype da rimuovere (non verranno eliminati i files a esso associati)*

Si consiglia di usare uitype con valore maggiore di 2000, per evitare conflitti con futuri rilasci del CRM.  
All’ingresso degli script php sono disponibili varie variabili, la prima è:

*$sdk\_mode : le viste e funzioni che posso personalizzare per il nuovo uitype (“insert”, “detail”, “edit”, “relatedlist”, “list”, “pdfmaker”, “report”, ecc.)*

In base al tipo di $sdk\_mode ho a disposizione diverse variabili che posso leggere e modificare.

**detail**  
per gestire la visualizzazione del campo in DetailView  
*INPUT*  
*$module : modulo corrente*  
*$fieldlabel: etichetta del campo*  
*$fieldname : nome del campo*  
*$col\_fields: (array) valori dei campi*  
*OUTPUT*  
*$label\_fld\[\] : etichetta tradotta*  
*$label\_fld\[\] : valore da visualizzare*

**edit**  
per gestire la visualizzazione del campo in EditView  
*INPUT*  
*$module\_name : modulo corrente*  
*$fieldlabel : etichetta del campo*  
*$value : valore del campo*  
*OUTPUT*  
*$editview\_label\[\] : etichetta tradotta*  
*$fieldvalue\[\] : valore da visualizzare*

**relatedlist, list, pdfmaker**  
per gestire la visualizzazione del campo in ListView, RelatedList e PDFMaker  
*INPUT*  
*$sdk\_value : valore del campo*  
*OUTPUT*  
*$value : valore da visualizzare*

**report**  
per gestire la visualizzazione del campo nei Report  
*INPUT*  
*$sdk\_value : valore del campo*  
*OUTPUT*  
*$fieldvalue : valore da visualizzare*

Se il valore salvato nel database è diverso da quello mostrato da interfaccia (es. numero 1.000,25 che deve essere salvato come 1000.25) allora vanno gestite anche le seguenti modalità per salvare il valore nel formato corretto e ricercarlo.

**insert**  
per convertire il valore nel formato da salvare nel database  
*INPUT*  
*$this-&gt;column\_fields : (array) valori dei campi*  
*$fieldname : nome del campo*  
*OUTPUT*  
*$fldvalue : valore da salvare nel database*

**formatvalue**  
per convertire il valore che arriva dalla $\_REQUEST nel formato salvato nel database (usato nella nuova gestione dei Campi Condizionali)  
*INPUT*  
*$value : valore del campo*  
*OUTPUT*  
*$value : valore convertito nel formato database*

**querygeneratorsearch**  
per convertire il valore cercato dall’utente in lista e filtri  
*INPUT E OUTPUT*  
*$fieldname : nome del campo*  
*$operator : operatore di confronto*  
*$value : valore cercato*

**customviewsearch**  
per gestire la conversione del valore nei filtri dei popup per i campi reference  
*INPUT E OUTPUT*  
*$tablename : tabella del campo*  
*$fieldname : nome del campo*  
*$comparator : operatore di confronto*  
*$value : valore cercato*

**popupbasicsearch**  
per gestire la conversione del valore nella ricerca dei popup per i campi reference  
*INPUT*  
*$table\_name : tabella del campo*  
*$column\_name : colonna del campo*  
*$search\_string : valore cercato*  
*OUTPUT*  
*$where : condizione della query*  
*es. $where = "$table\_name.$column\_name = '".convertToDBFunction($search\_string)."'";*

**popupadvancedsearch**  
per gestire la conversione del valore nella ricerca avanzata dei popup per i campi reference  
*INPUT E OUTPUT*  
*$tab\_col : tabella e colonna del campo*  
*$srch\_cond : operatore di confronto*  
*$srch\_val : valore cercato*

**reportsearch**  
per convertire il valore cercato dall’utente nei report  
*INPUT E OUTPUT*  
*$table : tabella del campo*  
*$column : colonna del campo*  
*$fieldname : nome del campo*  
*$comparator : operatore di confronto*  
*$value : valore cercato*

<p class="callout info">**Hooks**  
data/CRMEntity.php  
include/ListView/ListViewController.php  
include/utils/crmv\_utils.php  
include/utils/EditViewUtils.php  
include/utils/DetailViewUtils.php  
include/utils/ListViewUtils.php  
include/utils/SearchUtils.php  
include/QueryGenerator/QueryGenerator.php  
modules/PDFMaker/InventoryPDF.php  
modules/Reports/ReportRun.php  
modules/Users/Users.php  
modules/CustomView/Save.php  
modules/CustomView/CustomView.php  
Smarty/templates/DisplayFieldsReadonly.tpl  
Smarty/templates/DisplayFieldsHidden.tpl  
Smarty/templates/DetailViewFields.tpl  
Smarty/templates/EditViewUI.tpl  
Smarty/templates/DetailViewUI.tpl</p>

# Template personalizzati (Smarty)

È possibile creare dei template personalizzati, che si sostituiscono a quelli standard (come EditView.tpl …).  
Il nuovo template viene utilizzato se i valori di $\_REQUEST della pagina soddisfano i requisiti. La registrazione di un nuovo template viene fatta tramite il metodo

**SDK::setSmartyTemplate($params, $src);**  
*$params : array associativo con i requisiti (vedere sotto)*  
*$src : percorso del nuovo template*

Per $params è possibile specificare un valore speciale (“$NOTNULL$”) per indicare che tale parametro deve esistere, con qualsiasi valore. I parametri non specificati vengono ignorati.  
Se la regola da inserire esiste già o non è compatibile con quelle esistenti (cioè potrebbe causare ambiguità per alcune $\_REQUEST), l’inserimento fallisce (e viene salvato nel log un messaggio esplicativo).

Per de-registrare un template personalizzato chiamare il metodo:

**SDK::unsetSmartyTemplate($params, $src = NULL);**  
*$params : array con i requisiti*  
*$src : percorso del template (se NULL, include tutti i files)*

Per sostituire completamente tutti i tipi di vista di un modulo servono almeno 7 regole:

<table border="1" id="bkmrk-%24params-note-array%28-" style="border-collapse: collapse; width: 100%;"><tbody><tr><td style="width: 50%;">**$params**</td><td style="width: 50%;">**Note**</td></tr><tr><td style="width: 50%;">array( ‘module’=&gt;’Leads’, ‘action’=&gt;’ListView’)</td><td style="width: 50%;">ListView</td></tr><tr><td style="width: 50%;">array( ‘module’=&gt;’Leads’, ‘action’=&gt;’index’)</td><td style="width: 50%;">ListView</td></tr><tr><td style="width: 50%;">array( ‘module’=&gt;’Leads’, ‘action’=&gt;’DetailView’ , ‘record’=&gt;’$NOTNULL$’)</td><td style="width: 50%;">DetailView</td></tr><tr><td style="width: 50%;">array( ‘module’=&gt;’Leads’, ‘action’=&gt;’EditView’ , ‘record’=&gt;’$NOTNULL$’)</td><td style="width: 50%;">EditView (deve esserci record nella request)</td></tr><tr><td style="width: 50%;">array( ‘module’=&gt;’Leads’, ‘action’=&gt;’EditView’)</td><td style="width: 50%;">Creazione nuovo elemento</td></tr><tr><td style="width: 50%;">array( ‘module’=&gt;’Leads’, ‘action’=&gt;’EditView’, ‘record’=&gt;’$NOTNULL$’, "isDuplicate"=&gt;"true")</td><td style="width: 50%;">Duplicazione</td></tr><tr><td style="width: 50%;">array( ‘module’=&gt;’Leads’, ‘action’=&gt;’LeadsAjax’, ‘record’=&gt;’$NOTNULL$’, 'ajxaction'=&gt;'LOADRELATEDLIST', 'header'=&gt;'Products')</td><td style="width: 50%;">Related List dei Leads che mostra I Prodotti</td></tr></tbody></table>

**NOTA:** Se più regole corrispondono, verrà utilizzata la più specifica; ad esempio, se ci sono 2 regole, una con “$NOTNULL$” e una con il valore “Leads” e la request è “Leads”, verrà usata la seconda regola.

<p class="callout info">**Hooks**  
Smarty\_setup.php</p>

# Gestione dei popup

Per la gestione delle finestre popup sono disponibili due azioni. Si può inserire uno script php prima che venga fatta la query per caricare i dati, in modo da poterne selezionare diversi da quelli standard. Inoltre è possibile inserire un altro script php prima che i dati vengano mostrati, in modo da poter modificare tali dati o il risultato alla sua chiusura.  
Nel primo caso sono disponibili i 2 metodi:

**SDK::setPopupQuery($type, $module, $param, $src, $hidden\_rel\_fields = '');**  
*$type : “field” o “related” per indicare un campo standard o il popup aperto da una related list*  
*$module: il modulo in cui si apre il popup*  
*$param : il nome del campo che apre il popup (deve essere uitype 10) nel caso type = “field”, altrimenti il nome del modulo collegato.*  
*$src : il percorso del file php*  
*$hidden\_rel\_fields : array del tipo array($urlvalue =&gt; $jscode)*  
*$urlvalue : parametro da aggiungere all'url quando si apre un popup*  
*$jscode : codice javascript eseguito quando si apre il popup, il cui valore viene assegnato a $urlvalue*  
  
E per de-registrarlo:  
**SDK::unsetPopupQuery($type, $module, $param, $src);**  
*Stessi parametri di prima*

All’interno dello script php sono disponibili le seguenti variabili:  
*$query : la query che prende i valori da mostrare*  
*$sdk\_show\_all\_button : se true mostra il pulsante per annullare le restrizioni SDK e mostrare tutti i record*

Nel secondo caso invece ci sono i seguenti metodi:

**SDK::setPopupReturnFunction($module, $fieldname, $src);**  
*$module : il modulo che contiene il campo che apre il popup*  
*$fieldname : il nome del campo che apre il popup (solo uitype 10)*  
*$src : il file php*

Per de-registrare la funzione di popup usare il metodo:  
**SDK::unsetPopupReturnFunction($module, $fieldname = NULL, $src = NULL);**

Per ora gli unici campi supportati sono quelli con uitype 10 (a parte per le related list)

<p class="callout info">**Hooks**  
Popup.php  
include/utils/ListViewUtils.php  
include/ListView/SimpleListView.php</p>

**Esempio**

```PHP
<?php
SDK::setPopupQuery('field','Contacts','account_name','modules/SDK/examples/PopupQuery1.php');
SDK::setPopupQuery('related', 'Contacts', 'Products', 'modules/SDK/examples/contacts/PopupRelQuery.php');

SDK::setPopupReturnFunction('Contacts','vendor_id','modules/SDK/examples/ReturnVendorToContact.php');

// you can set a PopupQquery and a PopupReturnFunction to a field in a table field (VTENEXT 24.08)
SDK::setPopupQuery('field', 'Accounts', 'ml1_f4', 'modules/SDK/examples/Contacts/AccountQuery.php');
// here we have a table field (vcf_3) with an account field (vcf_4) and a contact field (vcf_5), I can view only accounts of rating Market Failed, Project Cancelled and Shutdown and only contacts of these accounts. 
$rel_fields = array('processmaker'=>'jQuery("#processmaker").val()','running_process'=>'jQuery("#running_process").val()');
SDK::setPopupQuery('field', 'Processes', 'vcf_3_vcf_4', 'modules/SDK/examples/Contacts/AccountQuery.php', $rel_fields);
$rel_fields['accountid'] = 'jQuery("#vcf_3_vcf_4_"+VTE.EditView.getTableFieldCurrentRow(this)).val()';
SDK::setPopupQuery('field', 'Processes', 'vcf_3_vcf_5', 'modules/SDK/examples/Contacts/ContactsQuery.php', $rel_fields);
?>
```

**AccountQuery.php**

```PHP
<?php
global $table_prefix;

// check the current position in process
if ($_REQUEST['srcmodule'] == 'Processes') {
    $processmaker = 4;
    $elementid = 'Task_0j1yxi6'; // task condition after the dynaform

    $curr_processmaker = RequestHandler::paramGetInt('processmaker');
    $curr_running_process = RequestHandler::paramGetInt('running_process');
    
    if ($curr_processmaker != $processmaker) return;
    
    require_once('modules/Settings/ProcessMaker/ProcessMakerUtils.php');
    $PMU = ProcessMakerUtils::getInstance();
    $curr_elementid = $PMU->getCurrentElementId($curr_running_process, $curr_processmaker);
    if ($curr_elementid != $elementid) return;
}

$sdk_show_all_button = true;
$query .= " and {$table_prefix}_account.rating not in ('Market Failed','Project Cancelled','Shutdown')";
```

**ContactsQuery.php**

```PHP
<?php
global $table_prefix;
$accountid = RequestHandler::paramGetInt('accountid');

// check the current position in process
if ($_REQUEST['srcmodule'] == 'Processes') {
    $processmaker = 4;
    $elementid = 'Task_0j1yxi6'; // task condition after the dynaform
    
    $curr_processmaker = RequestHandler::paramGetInt('processmaker');
    $curr_running_process = RequestHandler::paramGetInt('running_process');
    
    if ($curr_processmaker != $processmaker) return;
    
    require_once('modules/Settings/ProcessMaker/ProcessMakerUtils.php');
    $PMU = ProcessMakerUtils::getInstance();
    $curr_elementid = $PMU->getCurrentElementId($curr_running_process, $curr_processmaker);
    if ($curr_elementid != $elementid) return;
}

$sdk_show_all_button = false;
$query .= " and {$table_prefix}_contactdetails.accountid = $accountid";
```

# Presave

Si può inserire uno script personalizzato anche quando si preme il pulsante “Salva” in modalità EditView. Per registrare uno script di questo tipo usare il metodo:

**SDK::setPreSave($module, $src);** *$module : il nome del modulo*  
*$src : il percorso dello script php*

Per de-registrarlo usare il metodo:

**SD<span lang="en-US">K::unsetPreSave($module,</span> <span lang="en-US">$src</span> <span lang="en-US">=</span> <span lang="en-US">NULL);  
</span>***$module : il nome del modulo*  
*$src : il percorso dello script (se NULL, include tutti gli script registrati per quel modulo)*

All’interno dello script sono disponibili le seguenti variabili:

*$type : tipo di salvataggio (“MassEditSave”, “DetailView”, “EditView”, “createTODO”, “QcEditView”, “ConvertLead”, “createQuickTODO”, “Kanban”)*  
*$values : (array) nuovi valori*  
  
Nota: nel caso MassEditSave, è possibile conoscere i record coinvolti richiamando la funzione getListViewCheck($currentModule);

Nota: nel caso createQuickTODO i campi disponibili in $values sono i seguenti:

<table border="1" id="bkmrk-eventi-todo-module-%3D" style="border-collapse: collapse; width: 100%;"><tbody><tr><td style="width: 50%;">Eventi</td><td style="width: 50%;">TODO</td></tr><tr><td style="width: 50%;">Module =&gt; 'Calendar',CalendarTitle, CalendarStartTime, CalendarEndTime, IsAllDayEvent, timezone, EventType, Description, Location</td><td style="width: 50%;">Module = 'Calendar',  
activity\_mode =&gt; Task,hour, day, month, year, task\_time\_start, task\_subject, task\_description, taskstatus, taskpriority, task\_assigntype, task\_assigned\_user\_id, task\_assigned\_group\_id, starthr, startmin, startfmt, task\_date\_start, task\_due\_date</td></tr></tbody></table>

E possono essere restituite le seguenti:

*$status : (bool) se il salvataggio ha avuto successo o no*  
*$message: (string) se presente viene mostrato un popup con il messaggio*  
*$confirm: (bool) se vero viene mostrato un popup Javascript che chiede conferma per proseguire, mostrando $message. In tal caso non si deve impostare $status.*  
*$focus : (string) in caso di errore, l’elemento che prende il focus (solo se $status = false)*  
*$changes: (array) valori da assegnare ai campi (solo se $status = false)*

Le variabili $focus e $changes sono disponibili solo quando $status è false e $type è uno tra 'EditView', 'createTodo', 'QcEditView', 'ConvertLead'.

<p class="callout info">**Hooks**  
include/js/general.js  
include/js/KanbanView.js  
modules/Calendar/script.js  
modules/Calendar/wdCalendar/sample.php  
modules/Leads/Leads.js  
modules/Users/Forms.php  
modules/VteCore/KanbanAjax.php  
Smarty/templates/Header.tpl  
Smarty/templates/ComposeEmail.tpl  
Smarty/templates/Popup.tpl</p>

# Advanced query

Si può modificare la query eseguita per caricare i dati in modalità ListView, RelatedList e Popup in modo da rendere accessibili o meno alcuni dati. Questo non influenza gli utenti di tipo Administrator, che hanno accesso a tutti i dati; inoltre il modulo deve essere impostato come Privato.

La modifica della query viene fatta tramite una funzione php personalizzata (vedere sotto). In ogni modulo è possibile utilizzare solo una funzione di questo tipo. Per registrare la funzione usare:

**SDK::setAdvancedQuery($module, $func, $src);**  
*$module : il modulo in cui applicare la funzione (Se per il modulo è già registrata una funzione, non viene inserita la nuova)*  
*$func : il nome della funzione php*  
*$src : il file php in cui è contenuta la funzione*

Per de-registrare usare il metodo:

**SDK::unsetAdvancedQuery($module);**  
*$module : il modulo con cui era stata registrata la funzione*

La funzione $func deve essere definita nel seguente modo:

**function f($module)** *$module : il modulo che chiama la funzione*

E restituisce una stringa:

*“” : (stringa vuota) la query non subisce modifiche*  
*? : (stringa non vuota) questa stringa viene aggiunta alla query*

<p class="callout info">**Hooks**  
data/CRMEntity.php</p>

# Advanced Permissions

Unitamente alla modifica della query per il recupero dei dati, si può inserire un controllo dei permessi personalizzato registrando un’ulteriore funzione:

**SDK::setAdvancedPermissionFunction($module, $func, $src);**  
*$module : modulo a cui associare la funzione*  
*$func : nome della funzione da chiamare (da isPermitted())*  
*$src : file php in cui è definita la funzione*

Per de-registrarla c’è il metodo:

**SDK::unsetAdvancedPermissionFunction($module);**  
*$module : il modulo a cui è associata la funzione*

La funzione deve essere definita in questo modo:

**function f($module, $actionname, $record\_id = '')**  
*$module : il modulo da cui è chiamata*  
*$actionname : il nome dell’azione (ListView, DetailView…)*  
*$record\_id : l’ID del record che viene analizzato*

E deve restituire una stringa i cui valori determinano l’esito del controllo:

*"no" : l’accesso al record NON è consentito*  
*"" : (stringa vuota) accesso di default per quel campo*  
*? : (qualsiasi stringa) l’accesso al record è consentito*

<p class="callout info">**Hooks** include/utils/UserInfoUtil.php</p>

# Estensioni di classi

Si possono estendere le classi esistenti al fine di ridefinire o aggiungere attributi e metodi. Si deve innanzi tutto creare un file in cui è definita la nuova classe (ad esempio: class Accounts2 extends Accounts) e registrarla poi con:

**SDK::setClass($extends, $module, $src);**  
*$extends : la classe che viene estesa*  
*$module : il nome della nuova classe*  
*$src : il file in cui $module è definita*

Non è possibile estendere più di una volta la stessa classe. Alcune classi non possono essere estese (Users, Conditionals, Transitions, Calendar, Rss, Activity, Reports). Per de-registrare una sottoclasse:

**SDK::unsetClass($extends);**  
*$extends : la classe che è stata estesa (non la sottoclasse)*

Chiamando unsetClass verranno rimosse a catena anche tutte le sottoclassi di $extends.  
È necessario che tutte le istanziazioni di oggetti avvengano tramite CRMEntity::getInstance($nomemodulo), altrimenti non verranno caricate eventuali classi estese.

<p class="callout info">**Hooks**  
include/utils/VtlibUtils.php  
data/CRMEntity.php</p>

# Header delle pagine

Si può personalizzare l'icona utente, l'icona delle impostazioni o le barre blu in testa alle pagine del VTE per incorporare nuove funzionalità nel VTE. Per ottenere ciò, è sufficiente estendere il metodo **VTEPageHeader::setCustomVars** nel seguente modo:

**SDK::setClass('VTEPageHeader','NewPageHeader','modules/SDK/src/NewPageHeader.php');**

Il file NewPageHeader.php avrà questo contenuto:

```PHP
<?php
require_once('include/utils/PageHeader.php');

class NewPageHeader extends VTEPageHeader {
	
	protected function setCustomVars(&$smarty, $options = array()) {
		$overrides = array(

			// HTML code to be put right after the menu bar
			'post_menu_bar' => null,

			// HTML code right after the second bar
			'post_primary_bar' => null,

			// HTML code after the third bar
			'post_secondary_bar' => null,

			// HTML code that replace the standard user icon
			'user_icon' => null,

			// HTML code that replace the standard settings icon
			'settings_icon' => null,
		);
		// assign these values to a smarty variable
		$smarty->assign("HEADER_OVERRIDE", $overrides);
	}
}
?>
```

# Traduzioni

Si possono personalizzare le stringhe per ogni lingua e modulo installato. Per modificare o inserire una nuova stringa usare il metodo:

**SDK::setLanguageEntry($module, $langid, $label, $newlabel);**  
*$module : il modulo che contiene la stringa*  
*$langid : il codice della lingua (es: “en\_us”, “it\_it”)*  
*$label : l’etichetta della stringa (es: LBL\_TASK\_TITLE)*  
*$newlabel : la nuova stringa*

Se l'etichetta esiste già per il modulo e la lingua scelti, verrà sostituita. Come modulo si può specificare “APP\_STRINGS” per inserire una traduzione globale o “ALERT\_ARR” per rendere la traduzione disponibile nei file JavaScript. Per caricare una stringa contemporaneamente in più lingue è disponibile il metodo:

**SDK::setLanguageEntries($module, $label, $strings);**  
*$module : il modulo*  
*$label : l’etichetta della stringa*  
*$strings : array associativo con le traduzioni ( array( “it\_it”=&gt;str1, …) )*

Per cancellare una stringa usare:

**SDK::deleteLanguageEntry($module, $langid, $label = NULL);**  
*$module : il modulo*  
*$langid : il codice della lingua*  
*$label : l’etichetta (se NULL, tutte le stringhe che corrispondono)*

# Modifica della visibilità dei campi

Si può modificare la visibilità dei vari campi (valore di $readonly) e altre variabili nelle varie modalità (ListView, EditView…). Per registrare una nuova “Vista” usare il metodo:

**SDK::addView($module, $src, $mode, $success);**  
*$module : il modulo in cui applicare la vista*  
*$src : il file php*  
*$mode : la modalità di applicazione della regola (vedere sotto)*  
*$success: cosa fare dopo l’applicazione della regola (vedere sotto)*

Le Viste definite per ogni modulo vengono applicate nell’ordine in cui sono registrate. Quando si registrano, vengono aggiunte in coda a quelle già definite per quel modulo. Il parametro $mode ha senso solo se si modifica la variabile

*$readonly, e ammette i seguenti valori:*  
*“constrain” : forza il valore di $readonly ad assumere il nuovo valore dato nello script.*  
*“restrict” : cambia il valore di $readonly solo verso un valore più restrittivo (da 1 a 99 o 100, da 99 a 100, non viceversa)*

Il parametro $success invece può essere:

*“continue” : dopo l’applicazione della vista, continua con la successiva*  
*“stop” : se la vista restituisce $success = true, non vengono eseguite altre regole*

All’interno degli script sono disponibili le seguenti variabili:

*$sdk\_mode : uno tra “” (create), “edit”, “detail”, “popup\_query”, “list\_related\_query”, “popup”, “related”, “list”, “mass\_edit”*  
*$readonly : il valore di readonly per il campo che si sta per scrivere (1, 99, 100 rispettivamente lettura/scrittura, sola lettura, nascosto)*  
*$col\_fields: valori dei campi, solo per $sdk\_mode = “edit”, “detail” e “”*  
*$fieldname o $fieldName: nome del campo corrente*  
*$current\_user: l’utente corrente*

Ed è possibile restituire la variabile $success con true o false.  
A seconda della modalità (ListView, EditView, …) ci sono diversi modi per modificare le query e diverse variabili disponibili.

<table border="1" id="bkmrk-modalit%C3%A0-valore-di-" style="border-collapse: collapse; width: 100%; height: 276px;"><tbody><tr style="height: 30px;"><td style="width: 25%; height: 30px;">**Modalità**</td><td style="width: 25%; height: 30px;">**Valore di $sdk\_mode**</td><td style="width: 25%; height: 30px;">**Variabili disponibili**</td><td style="width: 25%; height: 30px;">**Note**</td></tr><tr style="height: 31px;"><td style="width: 25%; height: 31px;">CreateView</td><td style="width: 25%; height: 31px;">*""*</td><td rowspan="4" style="width: 25%; height: 101px;">*$col\_fields*  
*$current\_user*  
*$fieldname*  
*$readonly*  
*$success*</td><td style="width: 25%; height: 31px;">1</td></tr><tr style="height: 30px;"><td style="width: 25%; height: 30px;">EditView</td><td style="width: 25%; height: 30px;">*"edit"*</td><td style="width: 25%; height: 30px;"> </td></tr><tr style="height: 10px;"><td style="width: 25%; height: 10px;">DetailView</td><td style="width: 25%; height: 10px;">*"detail"*</td><td style="width: 25%; height: 10px;"> </td></tr><tr style="height: 30px;"><td style="width: 25%; height: 30px;">MassEdit</td><td style="width: 25%; height: 30px;">*"mass\_edit"*</td><td style="width: 25%; height: 30px;"> </td></tr><tr style="height: 25px;"><td style="width: 25%; height: 25px;">PopupQuery</td><td style="width: 25%; height: 25px;">*"popup\_query"*</td><td style="width: 25%; height: 25px;">*$sdk\_columns*  
*$success*</td><td style="width: 25%; height: 25px;">2</td></tr><tr style="height: 30px;"><td style="width: 25%; height: 30px;">List/RelatedQuery</td><td style="width: 25%; height: 30px;">*"list\_related\_query"*</td><td style="width: 25%; height: 30px;">*$sdk\_columns*  
*$success*</td><td style="width: 25%; height: 30px;"> </td></tr><tr style="height: 30px;"><td style="width: 25%; height: 30px;">Popup</td><td style="width: 25%; height: 30px;">*"popup"*</td><td rowspan="3" style="width: 25%; height: 90px;">*$current\_user*  
*$fieldname*  
*$sdk\_columnnames*  
*$sdk\_columnvalues*  
*$readonly*  
*$success*</td><td style="width: 25%; height: 30px;">3</td></tr><tr style="height: 30px;"><td style="width: 25%; height: 30px;">Related</td><td style="width: 25%; height: 30px;">*"related"*</td><td style="width: 25%; height: 30px;">4</td></tr><tr style="height: 30px;"><td style="width: 25%; height: 30px;">List</td><td style="width: 25%; height: 30px;">*"list"*</td><td style="width: 25%; height: 30px;"> </td></tr></tbody></table>

Note:

1. In queste modalità i valori dei campi sono in $col\_fields\[ nomi-dei-campi \]
2. Queste modalità servono per modificare la query in modo da poter prelevare campi aggiuntivi. In $sdk\_columns ci sono le colonne del db da aggiungere alla query. Includere poi il file “modules/SDK/AddColumnsToQueryView.php”
3. Per prelevare valori di altri campi, specificati nelle modalità PopupQuery e ListRelatedQuery, scriverli nell’array $sdk\_columnnames, includere il file “modules/SDK/GetFieldsFromQueryView.php” e prenderli poi da $sdk\_columnvalues
4. Nel caso della related “Storico attività” sono disponibili solo le variabili $recordId e $readonly e si applicano all'intera riga, non al singolo campo.

Per de-registrare la vista usare:

**SDK::deleteView($module, $src);**  
*$module : il modulo associato*  
*$src : il file php*

<p class="callout info">**Hooks**  
include/ListView/ListViewController.php  
include/utils/DetailViewUtils.php  
include/utils/EditViewUtils.php  
include/utils/ListViewUtils.php  
include/QueryGenerator/QueryGenerator.php  
Popup.php</p>

# Gestione blocchi Home

Si possono aggiungere nuovi blocchi alla home del VTE tramite SDK; i nuovi blocchi creati non saranno eliminabili tramite interfaccia. Il metodo per la creazione di un nuovo blocco è:

**SDK::setHomeIframe($size, $url, $title, $userid = null, $useframe = true);**  
*$size : la dimensione orizzontale del blocco (da 1 a 4)*  
*$url : l’indirizzo da mostrare all’interno del blocco. Può avere anche un protocollo all’inizio (es: http://www.sito.com/file )*  
*$title : etichetta per il titolo. Installare la relativa traduzione con setLanguageEntry*  
*$userid : array contenente gli id degli utenti che vedono il blocco. Se si lascia null, il blocco è visibile per tutti gli utenti.*  
*$useframe: se true il contenuto viene messo dentro ad un &lt;iframe&gt; altrimenti viene incluso il file direttamente.*

Gli utenti creati successivamente vedranno tutti i blocchi registrati in precedenza.  
La cancellazione del blocco è possibile tramite 2 metodi:

**SDK::unsetHomeIframe($stuffid);**  
*$stuffid : l’id del blocco*

**SDK::unsetHomeIframeByUrl($url);**  
*$url : l’url specificato durante la registrazione*

I blocchi vengono rimossi per tutti gli utenti.

<p class="callout info">**Hooks**  
modules/Home/HomestuffAjax.php  
modules/Home/HomeWidgetBlockList.php  
modules/Home/HomeBlock.php  
modules/Home/Homestuff.js  
modules/Users/Save.php  
Smarty/templates/Home/MainHomeBlock.tpl</p>

# Bottoni personalizzati

È possibile aggiungere bottoni alla pulsantiera sotto il menu principale. Per inserire un nuovo bottone utilizzare il seguente metodo:

**SDK::setMenuButton($type, $title, $onclick, $image='', $module='', $action='', $condition = '');** *$type : il tipo del pulsante, può essere ‘fixed’ o ‘contestual’; nel primo caso il bottone appare a sinistra ed è sempre visibile, nel secondo caso il bottone viene inserito a destra e sarà visibile solo nel modulo e per l’azione scelta.*  
*$title : il nome del pulsante*  
*$onclick : codice javascript da eseguire. NON è possibile usare i doppi apici (“)*  
*$image : l’immagine per il bottone. Deve essere specificata senza percorso e risiedere in themes/softed/ anche nella versione più piccola (esempio: immagine.png e immagine\_min.png)*  
*$module : se type = ‘contestual’, il modulo in cui il bottone è visibile*  
*$action : se type = ‘contestual’, l’azione (parametro action) in cui il bottone è visibile*  
*$condition : stringa del tipo Nomefunzione:Percorsophp che rappresenta una funzione (nel file Percorsophp) da chiamare prima di mostrare il bottone. Se restituisce false, il pulsante non viene mostrato. La funzione ha un solo parametro di tipo reference ad un array con le informazioni sul bottone.*

Per rimuovere il pulsante usare:

**SDK::unsetMenuButton($type, $id);**  
*$type : il tipo del pulsante*  
*$id : l’ID del bottone*

<p class="callout info">**Hooks**  
Smarty/templates/Buttons\_List.tpl</p>

# Gestore stati

È possibile modificare le opzioni di scelta per le picklist gestite dal gestore stati, nonché aggiungere messaggi al blocco “Gestore stati”, a destra del record. Per registrare tale funzionalità usare il metodo:

**SDK::setTransition($module, $fieldname, $file, $function);**  
*$module : il nome del modulo da gestire*  
*$fieldname : il nome del campo gestito dal gestore stati*  
*$file : percorso del file php che contiene la funzione da chiamare*  
*$function : nome della funzione da chiamare*

E per rimuoverlo:

**SDK::unsetTransition($module, $fieldname);**

La funzione richiamata dal gestore stati ha il seguente formato:

**function ($module, $fieldname, $record, $status, $values)**  
*$module : il modulo corrente*  
*$fieldname : il nome del campo gestito dal gestore stati*  
*$record : id del record visualizzato*  
*$status : valore del campo usato per lo stato del record corrente*  
*$values : array di valori ammissibili per il suddetto campo*

Deve restituire null nel caso non si voglia modificare il comportamento del gestore stati oppure un array con il seguente formato:

*array(*  
*'values' =&gt; array(..) // array con i valori ammissibili per lo stato*  
*'message' =&gt; '' // codice html da includere sotto al blocco gestore stati*  
*);*

<p class="callout info">**Hooks**  
modules/Transitions/Transitions.php  
modules/Transitions/Statusblock.php  
Smarty/templates/modules/Transitions/StatusBlock.tpl</p>

# Funzioni Custom PDFMaker

È possibile aggiungere funzioni custom nel PDFMaker. Per inserirne una usare:

**SDK::setPDFCustomFunction($label, $name, $params);**  
*$label: etichetta per la funzione (viene tradotta all'interno del modulo PDFMaker)*  
*$name: nome della funzione*  
*$params: array con i nomi dei parametri della funzione*

Le funzioni così registrate devono essere salvate all'interno di files php in modules/PDFMaker/functions/

Per rimuovere la funzione basta chiamare:

**SDK::unsetPDFCustomFunction($name);**  
*$name: il nome della funzione*

# Reports personalizzati

Si possono inserire cartelle e report personalizzati usando i seguenti metodi

**SDK::setReportFolder($name, $description);**  
*$name : nome della cartella*  
*$decription : descrizione*

Crea una nuova cartella nella pagina dei report. La cartella creata sarà visibile da tutti gli utenti e non può essere modificata. Il nome e la descrizione possono essere tradotti nel solito modo.  
Le cartelle così create si possono eliminare con

**SDK::unsetReportFolder($name, $delreports = true);**  
*$name : il nome della cartella da cancellare*  
*$delreports : se true elimina anche tutti i reports (creati tramite SDK) in quella cartella (non vengono eliminati files)*

All’interno delle cartelle create via SDK si possono inserire reports personalizzati con:

**SDK::setReport($name, $description, $foldername, $reportrun, $class, $jsfunction = '');**  
*$name : il nome del report (che si può tradurre come sempre)*  
*$description : descrizione del report (traducibile)*  
*$foldername : il nome della cartella (SDK) in cui inserire il report*  
*$reportrun : il percorso del file php che contiene la classe che genera il report*  
*$class : il nome della classe che gestisce il report (dettagli dopo)*  
*$jsfunction : il nome di una funzione Javascript da avviare quando si preme “Genera report” (vedere dattagli dopo)*

Analogamente si possono cancellare con

**SDK::unsetReport($name);**  
*$name : il nome del report da eliminare (non verranno eliminati i files)*

La classe specificata in $class deve rispettare questa struttura, di seguito esempio:

```PHP
<?php
require_once('modules/Reports/ReportRun.php');

class ReportRunAccounts extends ReportRun {
	
	var $enableExportPdf = true;
	var $enableExportXls = true;
	var $enablePrint = true;
	var $hideParamsBlock = true;
	
	function __construct($reportid) {
		$this->reports = Reports::getInstance($reportid); // crmv@172034
		$this->reportid = $reportid;
		$this->primarymodule = 'Accounts';
		$this->reporttype = '';
		$this->reportname = 'Account con sito';
		$this->reportlabel = getTranslatedString($this->reportname, 'Reports');
	}
	
	function getSDKBlock() {
		global $mod_strings;
		$sdkblock = '<p><h2>Questo report mostra le aziende con sito</h2></p>';
		// here I can also add custom inputs to filter the report or any html I need
		return $sdkblock;
	}
	
	// overridden, always hide the summary tab
	function hasSummary() {
		return false;
	}
	
	// overridden, always show the total tab
	function hasTotals() {
		return true;
	}
	
	// generate the report
	function GenerateReport($outputformat = "", $filterlist = null, $directOutput=false) {
		global $adb;
		
		// compatibility, please use set them with the proper methods
		if (!empty($outputformat)) {
			$format = "HTML";
			$tab = "MAIN";
		
			if (strpos($outputformat, 'HTML') !== false) $format = "HTML";
			if (strpos($outputformat, 'PRINT') !== false) $format = "PRINT";
			if (strpos($outputformat, 'PDF') !== false) $format = "PDF";
			if (strpos($outputformat, 'XLS') !== false) $format = "XLS";
			if (strpos($outputformat, 'JSON') !== false) $format = "JSON";
			if (strpos($outputformat, 'CV') !== false) $format = "NULL";
			
			if (strpos($outputformat, 'COUNT') !== false) $tab = "COUNT";
			if (strpos($outputformat, 'TOTAL') !== false) $tab = "TOTAL";
			if (strpos($outputformat, 'CV') !== false) $tab = "CV";
			
			$this->setOutputFormat($format, $directOutput);
			$this->setReportTab($tab);
		} else {
			$format = $this->outputFormat;
			$tab = $this->reportTab;
		}
		
		$format = $this->outputFormat;
		$direct = $this->directOutput;
		$tab = $this->reportTab;

		// prepare the output class
		$output = $this->getOutputClass();
		$output->clearAll();
		
		$return_data = array();
	
		
		if ($tab == 'COUNT' && $this->hasSummary()) {

			// no summary for this custom report
			
		} elseif ($tab == 'CV') {
		
			// no customview for this report
		
		} elseif ($tab == 'MAIN') {

			$sSQL = $this->getReportQuery($outputformat, $filterlist);

			$result = $adb->query($sSQL);
			$this->total_count = $adb->num_rows($result);
			
			$error_msg = $adb->database->ErrorMsg();
			if(!$result && $error_msg!=''){
				// Performance Optimization: If direct output is requried
				if($direct) {
					echo getTranslatedString('LBL_REPORT_GENERATION_FAILED', 'Reports') . "<br>" . $error_msg;
					$error_msg = false;
				}
				// END
				return $error_msg;
			}
			
			if($result) {
			
				$this->generateHeader($result, $output);
			
				while ($row = $adb->fetchByAssoc($result)) {
					$colcount = count($row);
					foreach ($row as $column => $value) {
						$cell = array(
							'value' => $value,
							'column' => $column,
							'class' => 'rptData',
						);
						$output->addCell($cell);
					}
					$output->endCurrentRow();
					
				}
				
				$output->countTotal = $this->total_count;
				$output->countFiltered = $this->total_count;
				
				if ($format == 'XLS') {
					$head = $output->getSimpleHeaderArray();
					$data = $output->getSimpleDataArray();
					foreach ($data as $row) {
						$return_data[] = array_combine($head, $row);
					}
				} else {
					$return_data[] = $output->output(!$direct);
					$return_data[] = $this->total_count;
					$return_data[] = $sSQL;
					$return_data[] = $colcount;
				}
				
			}

		} elseif ($tab == "TOTAL" && $this->hasTotals()) {
			
			$output->addHeader(array('column' => 'fieldname', 'label' => getTranslatedString('Totals')));
			$output->addHeader(array('column' => 'sum', 'label' => getTranslatedString('SUM')));
			$output->addHeader(array('column' => 'avg', 'label' => getTranslatedString('AVG')));
			$output->addHeader(array('column' => 'min', 'label' => getTranslatedString('MIN')));
			$output->addHeader(array('column' => 'max', 'label' => getTranslatedString('MAX')));
			
			// fixed totals
			$rows = array(
				array(
					array('column'=> 'fieldname', 'value' => 'Fatturato totale', 'class' => 'rptData'),
					array('column'=> 'sum', 'value' => 2000, 'class' => 'rptTotal'),
					array('column'=> 'avg', 'value' => null, 'class' => 'rptTotal'),	// not used
					array('column'=> 'min', 'value' => 850, 'class' => 'rptTotal'),
					array('column'=> 'max', 'value' => null, 'class' => 'rptTotal'),	// not used
				),
			);
			
			// add them to the output class
			foreach ($rows as $row) {
				foreach ($row as $cell) {
					$output->addCell($cell);
				}
				$output->endCurrentRow();
			}
			
			// format for xls or html
			if ($format == "XLS") {
				
				// change the output array to match the expected format for XLS export
				$return_data = array();
				$data = $output->getSimpleDataArray();
				$fieldName = '';
				foreach ($data as $row) {
					$nrow = array();
					foreach ($row as $key => $value) {
						if ($key == 'fieldname') {
							$fieldName = $value;
							continue;
						}
						$klabel = $fieldName.'_'.strtoupper($key);
						$nrow[$klabel] = $value;
					}
					$return_data[] = $nrow;
				}
			
			} else {
				$return_data = $output->output(!$direct);
			}

		}
		
		return $return_data;
	}
	
	// generate a fixed header for the report
	function generateHeader($result, $output, $options = array()) {
		global $adb, $table_prefix;
		
		$module = 'Accounts';
		$tabid = getTabid($module);
		$count = $adb->num_fields($result);

		for ($x=0; $x<$count; ++$x) {
			$fld = $adb->field_name($result, $x);
			
			// get the field label from the column (if possible)
			$res = $adb->pquery("SELECT fieldlabel FROM {$table_prefix}_field WHERE columnname = ? and tabid = ?", array($fld->name, $tabid));
			if ($res && $adb->num_rows($res) > 0) {
				$fieldlabel = $adb->query_result_no_html($res, 0, 'fieldlabel');
				$headerLabel =  getTranslatedString($fieldlabel, $module);
			} else {
				$headerLabel = $fld->name;
			}
			$hcell = array(
				'column' => $fld->name,
				'label' => $headerLabel,
				'orderable' => false,
				'searchable' => false,
			);
			$output->addHeader($hcell);
		}
		
	}
	
	// generate the report query
	function getReportQuery($outputformat, $filterlist) {
		global $table_prefix;
		$query = 'SELECT accountid, accountname, website, phone FROM '.$table_prefix.'_account WHERE website <> "" ';
		return $query;
	}
}

```

La funzione Javascript specificata in $jsfunction deve già essere dichiarata e restituisce una stringa da aggiungere alla request

```JavaScript
function preRunReport(id) {
	var params = "";
	var select = getObj('picklist1’);

	if (select) {
		params += "&picklist1="+select.options[select.selectedIndex].value;
	}

	var selectuser = getObj('picklist2’);
	if (selectuser) {
		params += "&picklist2="+selectuser.options[selectuser.selectedIndex].value;
	}
	return params;
}
```

<p class="callout warning">Quando si aggiorna un VTE alla versione 16.09 (o successiva), alcune funzionalità dei report SDK vanno verificate in quanto sono cambiate alcune funzioni.   
Se si aggiorna ad un VTE con revisione minore di 1576 è necessario riportare la patch identificata da crmv@140813 (files ReportRun.php e SDKSaveAndRun.php).</p>

<p class="callout warning">Una delle parti cambiate è la gestione dei filtri temporali, che in precedenza si poteva modificare estendendo le funzioni *getPrimaryStdFilterHTML* e *getSecondaryStdFilterHTML*, che ora non vengono più usate.  
Per ottenere lo stesso risultato bisogna estendere la funzione getStdFilterFields che restituisce un array di campi disponibili, ad esempio:</p>

```PHP
<?php
function getStdFilterFields() {
	// See the method Reports::getStdFilterFields for the standard implementation
	
	// this example just loads standard fields for the Potential module
	$list = $this->reports->getStdFiltersFieldsListForChain(0, array('Potentials'));
	
	return $list;
}
```

Quando il report viene generato, non va più letta la variabile $filterlist, bensì $this-&gt;stdfilters, che contiene il filtro da usare.

Se la query del report è completamente personalizzata, va gestista manualmente anche la generazione del filtro temporale, ad esempio usando una funzione come questa:

```PHP
<?php
function addStdFilters() {
	global $current_user;
	$sql = '';
	
	if (is_array($this->stdfilters)) {
		foreach ($this->stdfilters as $flt) {
			if ($flt['fieldid'] > 0) {
				// get field informations
				$finfo = $this->getFieldInfoById($flt['fieldid']);
				$table = $finfo['tablename'];
				$qgen = QueryGenerator::getInstance($finfo['module'], $current_user);
				$operator = 'BETWEEN';
				if ($flt['value'] == 'custom') {
					$value = array($flt['startdate'], $flt['enddate']);
				} else {
					$cv = CRMEntity::getInstance('CustomView');
					$value = $cv->getDateforStdFilterBytype($flt['value']);
				}
				// adjust for timezone
				$value[0] = $this->fixDateTimeValue(
					$qgen, $finfo['fieldname'], $value[0]
				);
				$value[1] = $this→fixDateTimeValue(
					$qgen, $finfo['fieldname'], $value[1], false
				);
				// add the condition
				$sql .= ' AND '.$table.'.'.$finfo['columnname'].' '.
					$operator.' '.$value[0].' AND '.$value[1];
			}
		}
	}
	
	return $sql;
}
```

<p class="callout info">**Hooks**  
modules/Reports/Listview.php  
modules/SaveAndRun.php  
modules/Reports/Reports.php  
modules/Reports/CreatePDF.php  
modules/Reports/CreateXL.php  
modules/Reports/PrintReport.php  
Smarty/templates/ReportContents.tpl  
Smarty/templates/ReportRunContents.tpl  
Smarty/templates/ReportRun.tpl</p>

# Contatore Turbolift

Quando si modificano i criteri di estrazione standard di una relatedlist, per esempio usando un altro metodo o ridefinendolo estendendo la classe che lo contiene, il contatore del numero di record collegati visibile nel turbolift (colonna a destra con la lista dei moduli in detailview) potrebbe non esser più valido. Va quindi definito un metodo che ritorna il conteggio corretto tramite le seguenti api.  
Definizione di

**SDK::setTurboliftCount($relation\_id, $method);**  
*$relation\_id : id relazione (vedi vte\_relatedlists)*  
*$method : metodo che ritorna il conteggio*  
*I metodo va nella classe che contiene la relazione*  
*(es. nella relazione Contatti collegati ad una Azienda si intende la classe Accounts o eventuali sue estensioni)*

Rimozione:

**SDK::unsetTurboliftCount($relation\_id);**

Il metodo può essere il metodo della relatedlist (colonna name in vte\_relatedlists) oppure un metodo custom che ritorna un intero.

# Processi



# Log di Processo

La modalità di visione dei log è cambiata nelle varie release di VTENEXT e viene riassunta come segue.

- VTENEXT 16.09: Log consultabile tramite accesso al filesystem nella cartella logs/ProcessEngine
- VTENEXT 18.X: In Impostazioni → Business Process Manager → ProcessManager sarà disponibile il tasto ‘LOG’ una volta eseguito il seguente script:

```PHP
<?php
require_once('include/utils/VTEProperties.php');
$VP = VTEProperties::getInstance();
$VP->set('settings.process_manager.show_logs_button', 1);
```

<p class="callout info">Inizialmente viene creato il file 01.log. Quando questo supera i 5MB verrà creato il file 02.log, e così via.  
</p>

- VTENEXT 19.10: Log consultabili in Impostazioni → Altre Impostazioni → Log di Sistema.

# Importazione Processi da script

Dalla versione 18.05 (rev. 1696) è possibile importare da script php dei processi precedentemente esportati nei formati vtebpmn (diagramma + configurazione) o bpmn (solo diagramma) col medoto importFile della classe ProcessMakerUtils.  
Il metodo importFile vuole come primo parametro il percorso del file da installare (.vtebpmn / .bpmn) e come secondo un valore boolean (true/false) a seconda se si vuole attivare automaticamente il processo o lasciarlo in stato disattivo.  
Questo metodo risulta essere utile per installare dei processi al termine dell'installazione di un nuovo modulo: basta includere il file del processo nello zip di installazione ed eseguire l'importazione nel postinstall del metodo vtlib\_handler della classe del modulo.

Esempio

```PHP
require_once('modules/Settings/ProcessMaker/ProcessMakerUtils.php');
$PMUtils = ProcessMakerUtils::getInstance();
$PMUtils->importFile('PATH_FILE/Process1.vtebpmn',true);
$PMUtils->importFile('PATH_FILE/DiagramProcess2.bpmn',false);
```

# SDK

È possibile aggiungere funzioni custom ai processi, clicca [qui](https://usermanual.vtenext.com/books/manuale-dei-processi/chapter/11-sdk-di-processo-installazione-e-configurazione) per maggiori dettagli.

# Portale v2

#### Documentazione tema

---

[https://adminlte.io/docs/3.2/](https://adminlte.io/docs/3.2/)

[https://github.com/ColorlibHQ/AdminLTE](https://github.com/ColorlibHQ/AdminLTE)

[https://adminlte.io/themes/v3/](https://adminlte.io/themes/v3/)

#### Webservice REST

---

**Handler**: include/Webservices/CustomerPortal.php

**Headers:**  
• Authorization: Basic base64\_encode("username:accesskey")  
• Portal-Session-Id: il parametro è opzionale e viene restituito dalla "portal.login". Utilizzare nelle chiamate successive per ottimizzare le performance del portale.  
• Content-Type: application/json

<table border="1" cellpadding="0" cellspacing="0" id="bkmrk-nome-handler-metodo-" style="width: 100%;"><tbody><tr><th class="align-left" style="width: 9.38277%;">**Nome**</th><th class="align-left" style="width: 8.08637%;">**Parametri**</th><th class="align-left" style="width: 15.2469%;">**Descrizione**</th></tr><tr><td style="width: 9.38277%;">portal.info</td><td style="width: 8.08637%;"> </td><td style="width: 15.2469%;">Permette di ottenere le informazioni sulla licenza e i loghi utilizzati dall'installazione di vtenext collegata.</td></tr><tr><td style="width: 9.38277%;">portal.login</td><td style="width: 8.08637%;"><div><div>**Body**</div><div>. username: string (*)</div><div>. password: string (*)</div><div>. language: string</div></div></td><td style="width: 15.2469%;">Permette di eseguire il login nel portale fornendo l'email (username) e la password del contatto. Il servizio restituisce anche i valori dell'accesskey e dell'id di sessione da utilizzare nelle chiamate successive come header (Authorization e Portal-Session-Id)</td></tr><tr><td style="width: 9.38277%;">portal.logout</td><td style="width: 8.08637%;">**Headers**

. Authorization

</td><td style="width: 15.2469%;">Permette di eseguire il logout del contatto dal portale.</td></tr><tr><td style="width: 9.38277%;">portal.send\_mail\_for\_password</td><td style="width: 8.08637%;"><div><div>**Body**</div><div>. email: string (*)</div><div>. language: string</div></div></td><td style="width: 15.2469%;">Permette il recupero della password di un contatto del portale.</td></tr><tr><td style="width: 9.38277%;">portal.modules\_list</td><td style="width: 8.08637%;">**Headers**

. Authorization

<div><div>**Body**</div><div>. language: string (*)</div></div></td><td style="width: 15.2469%;">Permette di ottenere una lista di moduli abilitati per il profilo del contatto.</td></tr><tr><td style="width: 9.38277%;">portal.get\_list</td><td style="width: 8.08637%;">**Headers**

. Authorization

**Body**

. module: string (\*)

. language: string

. folderid: int

. search: array

</td><td style="width: 15.2469%;">Permette di ottenere la lista dei record di un modulo filtrati per la visibilità del profilo del contatto.  
  
Il parametro "folderid" viene utilizzato dal modulo Documents per ottenere i documenti di una cartella specifica.  
  
Il parametro "search" permette di eseguire la paginazione della lista server-side.  
  
Es.  
  
\[  
 'length' =&gt; 50, // Numero di record da restituire  
 'start' =&gt; 0, // Offset della paginazione  
 'search' =&gt; '', // Ricerca globale  
 'search\_columns' =&gt; \[ // Ricerca per colonne  
 \[  
 'index' <span class="s1">=&gt; </span><span class="s2">0</span><span class="s1">, // Indice del campo  
</span><span class="s3"> 'column' </span>=&gt; <span class="s2">''</span>, // Nome del campo

 'search' <span class="s1">=&gt; ''</span><span class="s1">, // Valore del campo  
 \]</span>

 \],  
 'ordering' =&gt; \[ // Ordinamento  
 \[

 'index' <span class="s1">=&gt; </span><span class="s2">0</span><span class="s1">, // Indice del campo  
</span><span class="s3"> 'column' </span>=&gt; <span class="s2">''</span>, // Nome del campo

 'dir' <span class="s1">=&gt; ''</span><span class="s1">, // asc/desc  
 \]</span>

 \],  
\]  
  
Note:  
1\. Tutte le ricerche vengono eseguite SOLO sulle colonne della lista.  
2\. La ricerca per colonna viene eseguita in modalità "LIKE".  
3\. L'ordinamento può essere eseguito solo su una colonna.

</td></tr><tr><td style="width: 9.38277%;">portal.get\_blocks</td><td style="width: 8.08637%;">**Headers**

. Authorization

**Body**

. module: string (\*)

. language: string

. mode: string (edit, create, detail, list) (\*)  
. app\_data: array

</td><td style="width: 15.2469%;">Permette di ottenere la lista dei blocchi e dei campi di un modulo filtrati per la visibilità del profilo del contatto.  
  
Il parametro "app\_data" rappresenta il record che si sta modificando (array con nome campo e valore) ed è utilizzato dalle view SDK per stabilire la visibilità dei campi.  
Questo parametro verrà utilizzato anche in futuro per la gestione dei campi condizionali.</td></tr><tr><td style="width: 9.38277%;">portal.get\_record</td><td style="width: 8.08637%;">**Headers**

. Authorization

**Body**

. module: string (\*)

. id: int (\*)

</td><td style="width: 15.2469%;">Permette di ottenere i dati del record indicato se il contatto ha il permesso di visualizzarlo.

</td></tr><tr><td style="width: 9.38277%;">portal.save\_record</td><td style="width: 8.08637%;">**Headers**

. Authorization

**Body**

. module: string (\*)

. id: int (\*)

. values: encoded (\*)

</td><td style="width: 15.2469%;">Permette il salvataggio del record indicato se il contatto ha il permesso di modificarlo.</td></tr><tr><td style="width: 9.38277%;">portal.delete\_record</td><td style="width: 8.08637%;">**Headers**

. Authorization

**Body**

. module: string (\*)

. id: int (\*)

</td><td style="width: 15.2469%;">Permette l'eliminazione del record indicato se il contatto ha il permesso di cancellarlo.</td></tr><tr><td style="width: 9.38277%;">portal.write\_ticket\_comment</td><td style="width: 8.08637%;">**Headers**

. Authorization

**Body**

. id: int (\*)

. comment: string (\*)

</td><td style="width: 15.2469%;">Permette la scrittura di un commento all'interno del ticket indicato.</td></tr><tr><td style="width: 9.38277%;">portal.get\_attachments</td><td style="width: 8.08637%;">**Headers**

. Authorization

**Body**

. id: int (\*)

</td><td style="width: 15.2469%;">Permette di ottenere la lista dei documenti relazionati al record indicato filtrati per la visibilità del profilo del contatto.</td></tr><tr><td style="width: 9.38277%;">portal.download\_attachment</td><td style="width: 8.08637%;">**Headers**

. Authorization

**Body**

. relid: int (\*)

. docid: int

</td><td style="width: 15.2469%;">Permette il download dell'allegato (relid) se il contatto ha il permesso di visualizzarlo.</td></tr><tr><td style="width: 9.38277%;">portal.upload\_attachment</td><td style="width: 8.08637%;">**Headers**

. Authorization

**Body**

. relid: int (\*)

. title: string (\*)  
**File**

</td><td style="width: 15.2469%;">Permette il caricamento di un allegato relazionato al record specificato (relid). Si può indicare il nome (title) del documento che verrà generato.  
</td></tr><tr><td style="width: 9.38277%;">portal.provide\_confidential\_info</td><td style="width: 8.08637%;">**Headers**

. Authorization

**Body**

. id: int (\*)

. comments: string

. data: string (\*)

. request\_commentid: int (\*)

</td><td style="width: 15.2469%;">Permette di rispondere ad una richiesta di informazioni confidenziali. Il parametro "id" indica l'id del ticket, il parametro "comments" indica il commento non cifrato, il parametro "data" indica la risposta confidenziale e il parametro "request\_commentid" indica l'id del commento a cui fornire la risposta confidenziale.</td></tr><tr><td style="width: 9.38277%;">portal.get\_home\_widgets</td><td style="width: 8.08637%;">**Headers**

. Authorization

**Body**

. language: string

</td><td style="width: 15.2469%;">Permette di ottenere i widget configurati nel profilo del contatto.</td></tr><tr><td style="width: 9.38277%;">portal.save\_authenticate\_cookie</td><td style="width: 8.08637%;">**Headers**

. Authorization

**Body**

. contactid: int (\*)

</td><td style="width: 15.2469%;">Fornisce un hash da memorizzare in un cookie per ricordare l'accesso del contatto.</td></tr><tr><td style="width: 9.38277%;">portal.check\_authenticate\_cookie</td><td style="width: 8.08637%;">**Headers**

. Authorization

**Body**

. contactid: int (\*)

. hash: string (\*)

</td><td style="width: 15.2469%;">Permette di verificare l'hash utilizzato per ricordare l'accesso del contatto.</td></tr><tr><td style="width: 9.38277%;">portal.change\_password</td><td style="width: 8.08637%;">**Headers**

. Authorization

**Body**

. username: string (\*)

. old\_password: string (\*)

. password: string (\*)

. language: string

</td><td style="width: 15.2469%;">Permette di cambiare la password del contatto.</td></tr></tbody></table>

##### Registrare un nuovo webservice REST

Creare un nuovo file ed eseguirlo (es. plugins/script/script.php).

```PHP
<?php
require('../../config.inc.php');
chdir($root_directory);
require_once('include/utils/utils.php');
require_once('vtlib/Vtecrm/Module.php');
$Vtiger_Utils_Log = true;
global $adb, $table_prefix;
VteSession::start();

SDK::setClass('CustomerPortalRestApi', 'CustomerPortalRestApi2', 'modules/SDK/src/CustomerPortalRestApi2.php');

$parameters = ['param1' => 'string', 'param2' => 'encoded', 'param3' => 'encoded'];
$perm = 'read'; // read, write, readwrite
SDK::setRestOperation('portal.foo', 'modules/SDK/src/CustomerPortalRestApi2.php', 'CustomerPortalRestApi2.foo', $parameters, $perm);

```

Creare un nuovo file che contiene la classe estesa CustomerPortalRestApi2 (es. modules/SDK/src/CustomerPortalRestApi2.php).

```PHP
<?php

require_once('include/Webservices/CustomerPortal.php');

class CustomerPortalRestApi2 extends CustomerPortalRestApi {

	public function foo($param1, $param2, $param3) {
		$data = [1, 2, 3, 4, 5];
        // ...
		return $data;
	}

}
```

##### Estendere un webservice REST esistente

Creare un nuovo file ed eseguirlo (es. plugins/script/script.php).

```PHP
<?php
require('../../config.inc.php');
chdir($root_directory);
require_once('include/utils/utils.php');
require_once('vtlib/Vtecrm/Module.php');
$Vtiger_Utils_Log = true;
global $adb, $table_prefix;
VteSession::start();

SDK::setClass('CustomerPortalRestApi', 'CustomerPortalRestApi2', 'modules/SDK/src/CustomerPortalRestApi2.php');
```

Creare un nuovo file che contiene la classe estesa CustomerPortalRestApi2 (es. modules/SDK/src/CustomerPortalRestApi2.php).

```PHP
<?php

require_once('include/Webservices/CustomerPortal.php');

class CustomerPortalRestApi2 extends CustomerPortalRestApi {

	public function get_list($module, $language, $folderid = 0, $search = []) {
		$ret = parent::get_list($module, $language, $folderid, $search);
		// your code here ...
		return $ret;
	}

}
```

#### Struttura delle cartelle/file principali

---

<p class="callout info">La cartella del portale si trova in: **VTE\_ROOT/portal/v2**</p>

Le cartelle/file principali del nuovo portale sono:

<table border="1" id="bkmrk-nome-cartella-descri" style="border-collapse: collapse; width: 100%; height: 469px;"><tbody><tr style="height: 29px;"><td style="width: 50%; height: 29px;">**Nome cartella/file**</td><td style="width: 50%; height: 29px;">**Descrizione**</td></tr><tr style="height: 29px;"><td style="width: 50%; height: 29px;">app</td><td style="width: 50%; height: 29px;">Contiene i file e le logiche per il funzionamento del portale.</td></tr><tr style="height: 46px;"><td style="width: 50%; height: 46px;">app/controllers</td><td style="width: 50%; height: 46px;">Contiene i file che gestiscono le azioni di default del portale (es. Login, Logout, Edit, Detail, ecc.).</td></tr><tr style="height: 29px;"><td style="width: 50%; height: 29px;">app/fields</td><td style="width: 50%; height: 29px;">Contiene i file che gestiscono i campi dei moduli del portale.</td></tr><tr style="height: 29px;"><td style="width: 50%; height: 29px;">app/modules</td><td style="width: 50%; height: 29px;">Contiene delle logiche custom di alcuni moduli di vtenext (es. Documents, Processes, HelpDesk, ecc.).</td></tr><tr style="height: 29px;"><td style="width: 50%; height: 29px;">app/PortalModule.php</td><td style="width: 50%; height: 29px;">Classe che gestisce le azioni dei moduli del portale (es. Create, Detail, Edit, ecc.). La classe può essere estesa per modificare i comportamenti di default di un modulo.</td></tr><tr style="height: 29px;"><td style="width: 50%; height: 29px;">config</td><td style="width: 50%; height: 29px;">Contiene i file di configurazione del portale.</td></tr><tr style="height: 46px;"><td style="width: 50%; height: 46px;">public</td><td style="width: 50%; height: 46px;">Contiene i file pubblici del portale (es. index.php, css, javascript, immagini, ecc.).</td></tr><tr style="height: 29px;"><td style="width: 50%; height: 29px;">resources</td><td style="width: 50%; height: 29px;">Contiene le risorse utilizzate dal portale come i file per le traduzioni (lang) e i template (templates).</td></tr><tr style="height: 29px;"><td style="width: 50%; height: 29px;">sdk</td><td style="width: 50%; height: 29px;">La cartella è utilizzata per inserire nuove personalizzazioni per il cliente.</td></tr><tr style="height: 29px;"><td style="width: 50%; height: 29px;">storage</td><td style="width: 50%; height: 29px;">Contiene i file temporanei (es. cache, logs, ecc.).</td></tr><tr style="height: 29px;"><td style="width: 50%; height: 29px;">vendor</td><td style="width: 50%; height: 29px;">Contiene le librerie esterne utilizzate dal portale.</td></tr></tbody></table>

#### Request lifecycle

---

<div drawio-diagram="4959"><img src="https://usermanual.vtenext.com/uploads/images/drawio/2023-09/drawing-6-1694591374.png" alt=""/></div>


#### Configurazione del portale

---

Il file di configurazione del portale si trova in "config/portal.config.php".

<p class="callout danger">Per **sovrascrivere i parametri** deve essere utilizzato il file "config/sdk.config.php" altrimenti, in caso di aggiornamento della versione di vtenext, le modifiche potrebbero essere perse.</p>

<p class="callout danger">**Come spostare il Business Portal in un'altra macchina/cartella**  
Valorizzare i parametri "portal\_url", "vte\_url" e "csrf\_secret" nel file "config/sdk.config.php".  
Eventualmente cambiare anche il parametro "default\_timezone" se la macchina ha un timezone diverso da quello in cui risiede il vte. Cambiare la prop "portal.url" con il link che punta alla cartella v2. es. https://ticket.vtenext.com/v2​​</p>

Ecco la lista dei parametri supportati dal nuovo portale:

<table border="1" id="bkmrk-parametro-tipo-defau" style="border-collapse: collapse; width: 100%; height: 1403px;"><tbody><tr style="height: 29px;"><td style="width: 22.6544%; height: 29px;">**Parametro**</td><td style="width: 10.9258%; height: 29px;">**Tipo**</td><td style="width: 18.7039%; height: 29px;">**Default**</td><td style="width: 47.716%; height: 29px;">**Descrizione**</td></tr><tr style="height: 80px;"><td style="width: 22.6544%; height: 80px;">portal\_url</td><td style="width: 10.9258%; height: 80px;">String</td><td style="width: 18.7039%; height: 80px;">$PORTAL\_URL  
(config.inc.php)</td><td style="width: 47.716%; height: 80px;">Indica l'URL del portale clienti. Se la cartella del portale si trova all'interno della root directory di vtenext, la variabile verrà impostata con il valore della variabile $PORTAL\_URL impostata nel file config.inc.php.</td></tr><tr style="height: 96px;"><td style="width: 22.6544%; height: 96px;">vte\_url</td><td style="width: 10.9258%; height: 96px;">String</td><td style="width: 18.7039%; height: 96px;">$site\_URL (config.inc.php)</td><td style="width: 47.716%; height: 96px;">Indica l'URL di vtenext e viene utilizzato per ottenere i relativi dati tramite le rest API. Se la cartella del portale si trova all'interno della root directory di vtenext, la variabile verrà impostata con il valore della variabile $site\_URL impostata nel file config.inc.php.</td></tr><tr style="height: 63px;"><td style="width: 22.6544%; height: 63px;"><div><div>default_language</div></div></td><td style="width: 10.9258%; height: 63px;">String</td><td style="width: 18.7039%; height: 63px;"><div><div>it_it</div></div></td><td style="width: 47.716%; height: 63px;">Indica la lingua predefinita utilizzata nel portale clienti. Il valore può essere sostituito con una lingua supportata (vedi parametro "languages").</td></tr><tr style="height: 63px;"><td style="width: 22.6544%; height: 63px;"><div><div>languages</div></div></td><td style="width: 10.9258%; height: 63px;">Array</td><td style="width: 18.7039%; height: 63px;"><div><div>['en_us' =&gt; 'US English', 'it_it' =&gt; 'IT Italiano']</div></div></td><td style="width: 47.716%; height: 63px;">Indica le lingue supportate nel portale clienti.  
Per aggiungere una nuova lingua si deve creare un nuovo file nella cartella resources/lang.</td></tr><tr style="height: 113px;"><td style="width: 22.6544%; height: 113px;"><div><div>production</div></div></td><td style="width: 10.9258%; height: 113px;">Bool</td><td style="width: 18.7039%; height: 113px;">false</td><td style="width: 47.716%; height: 113px;">Questa configurazione indica se gli errori devono essere visualizzati o meno. Se l'ambiente è di produzione, il valore verrà impostato su true per disabilitare la visualizzazione degli errori. Se l'ambiente è di sviluppo, il valore verrà impostato su false per consentire la visualizzazione degli errori.</td></tr><tr style="height: 80px;"><td style="width: 22.6544%; height: 80px;"><div><div>default_module</div></div></td><td style="width: 10.9258%; height: 80px;">String</td><td style="width: 18.7039%; height: 80px;"> </td><td style="width: 47.716%; height: 80px;">Indica il modulo predefinito da caricare dopo l'accesso al portale. Il valore può essere sostituito con il nome del modulo desiderato (deve essere abilitato da profilo). Se il parametro è vuoto, verrà caricata la home del portale.</td></tr><tr style="height: 29px;"><td style="width: 22.6544%; height: 29px;"><div><div>favicon</div></div></td><td style="width: 10.9258%; height: 29px;">String</td><td style="width: 18.7039%; height: 29px;"><div><div>assets/img/VTENEXT_favicon.ico</div></div></td><td style="width: 47.716%; height: 29px;">Indica il percorso della favicon da caricare nel portale clienti. Il valore è relativo alla cartella public.</td></tr><tr style="height: 29px;"><td style="width: 22.6544%; height: 29px;"><div><div>login_logo</div></div></td><td style="width: 10.9258%; height: 29px;">String</td><td style="width: 18.7039%; height: 29px;"><div><div>assets/img/VTENEXT_login.png</div></div></td><td style="width: 47.716%; height: 29px;">Indica il percorso del logo da caricare all'interno della pagina di login. Il valore è relativo alla cartella public.

\[UPDATE\] Il logo deve essere caricato nelle impostazioni di vtenext &gt; Loghi.

</td></tr><tr style="height: 29px;"><td style="width: 22.6544%; height: 29px;"><div><div>login_background</div></div></td><td style="width: 10.9258%; height: 29px;">String</td><td style="width: 18.7039%; height: 29px;"> </td><td style="width: 47.716%; height: 29px;">Indica il percorso dello sfondo da caricare all'interno della pagina di login. Il valore è relativo alla cartella public.</td></tr><tr style="height: 96px;"><td style="width: 22.6544%; height: 96px;"><div><div>header_logo_sm</div></div></td><td style="width: 10.9258%; height: 96px;">String</td><td style="width: 18.7039%; height: 96px;"><div><div>assets/img/VTENEXT_toggle.png</div></div></td><td style="width: 47.716%; height: 96px;">Indica il percorso dell'icona da caricare nella barra laterale minimizzata. Il valore è relativo alla cartella public.  
\[UPDATE\] L'icona deve essere caricata nelle impostazioni di vtenext &gt; Loghi.</td></tr><tr style="height: 80px;"><td style="width: 22.6544%; height: 80px;"><div><div>header_logo_lg</div></div></td><td style="width: 10.9258%; height: 80px;">String</td><td style="width: 18.7039%; height: 80px;"><div><div>assets/img/VTENEXT_header.png</div></div></td><td style="width: 47.716%; height: 80px;">Indica il percorso dell'icona da caricare nella barra laterale allargata. Il valore è relativo alla cartella public.  
\[UPDATE\] L'icona deve essere caricata nelle impostazioni di vtenext &gt; Loghi.</td></tr><tr style="height: 63px;"><td style="width: 22.6544%; height: 63px;"><div><div>helpdesk_logo</div></div></td><td style="width: 10.9258%; height: 63px;">String</td><td style="width: 18.7039%; height: 63px;"><div><div>assets/img/helpdesk.png</div></div></td><td style="width: 47.716%; height: 63px;">Indica il logo utilizzato per visualizzare la risposta data dall'assistenza clienti. Il valore è relativo alla cartella public.</td></tr><tr style="height: 80px;"><td style="width: 22.6544%; height: 80px;"><div><div>sidebar_theme</div></div></td><td style="width: 10.9258%; height: 80px;">String</td><td style="width: 18.7039%; height: 80px;"><div><div>sidebar-dark-primary</div></div></td><td style="width: 47.716%; height: 80px;">Indica la classe della barra laterale principale.  
Può avere una luminosità "dark" o "light".  
Può avere anche una variante di colore, come "primary", "success", "warning", "info", "danger".</td></tr><tr style="height: 29px;"><td style="width: 22.6544%; height: 29px;"><div><div>enable_sidebar_search</div></div></td><td style="width: 10.9258%; height: 29px;">Bool</td><td style="width: 18.7039%; height: 29px;"><div><div>false</div></div></td><td style="width: 47.716%; height: 29px;">Consente di attivare/disattivare la barra di ricerca nella barra laterale principale.</td></tr><tr style="height: 29px;"><td style="width: 22.6544%; height: 29px;"><div><div>csrf_secret</div></div></td><td style="width: 10.9258%; height: 29px;">String</td><td style="width: 18.7039%; height: 29px;"><div><div>$csrf_secret (config.inc.php)</div></div></td><td style="width: 47.716%; height: 29px;">Indica la chiave segreta utilizzata per generare un token csrf. Se la cartella del portale si trova all'interno della root directory di vtenext, la variabile verrà impostata con il valore della variabile $csrf\_secret impostata nel file config.inc.php.</td></tr><tr style="height: 29px;"><td style="width: 22.6544%; height: 29px;"><div><div>upload_dir</div></div></td><td style="width: 10.9258%; height: 29px;">String</td><td style="width: 18.7039%; height: 29px;"> </td><td style="width: 47.716%; height: 29px;">Indica il nome della cartella utilizzata per il caricamento dei file.</td></tr><tr style="height: 29px;"><td style="width: 22.6544%; height: 29px;"><div><div>browser_title_prefix</div></div></td><td style="width: 10.9258%; height: 29px;">String</td><td style="width: 18.7039%; height: 29px;"> </td><td style="width: 47.716%; height: 29px;">Indica l'etichetta del prefisso da utilizzare per il titolo del browser. Il valore può essere sostituito con l'etichetta desiderata.</td></tr><tr style="height: 29px;"><td style="width: 22.6544%; height: 29px;"><div><div>browser_title_suffix</div></div></td><td style="width: 10.9258%; height: 29px;">String</td><td style="width: 18.7039%; height: 29px;"><div><div>customer_portal</div></div></td><td style="width: 47.716%; height: 29px;">Indica l'etichetta del suffisso da utilizzare per il titolo del browser. Il valore può essere sostituito con l'etichetta desiderata.</td></tr><tr style="height: 29px;"><td style="width: 22.6544%; height: 29px;"><div><div>remember_cookie_name</div></div></td><td style="width: 10.9258%; height: 29px;">String</td><td style="width: 18.7039%; height: 29px;"><div><div>portal_login_hash</div></div></td><td style="width: 47.716%; height: 29px;">Indica il nome del cookie utilizzato per ricordare l'autenticazione dell'utente.</td></tr><tr style="height: 29px;"><td style="width: 22.6544%; height: 29px;"><div><div>login_expire_time</div></div></td><td style="width: 10.9258%; height: 29px;">Int</td><td style="width: 18.7039%; height: 29px;"><div><div>2592000 (one month)</div></div></td><td style="width: 47.716%; height: 29px;">Indica la scadenza del cookie utilizzato per ricordare l'autenticazione dell'utente. Il valore può essere sostituito con il numero di secondi desiderato.</td></tr><tr style="height: 29px;"><td style="width: 22.6544%; height: 29px;"><div><div>default_timezone</div></div></td><td style="width: 10.9258%; height: 29px;">String</td><td style="width: 18.7039%; height: 29px;"><div><div>Europe/Rome</div></div></td><td style="width: 47.716%; height: 29px;">Indica il fuso orario predefinito utilizzato nel portale clienti. Questa configurazione deve essere uguale alla variabile $default\_timezone impostata nel file config.inc.php di vtenext.</td></tr><tr style="height: 96px;"><td style="width: 22.6544%; height: 96px;"><div><div><div><div>module_icons</div></div></div></div></td><td style="width: 10.9258%; height: 96px;">Array</td><td style="width: 18.7039%; height: 96px;"><div><div>[]</div></div></td><td style="width: 47.716%; height: 96px;">Con questa configurazione è possibile sovrascrivere le icone predefinite utilizzate per i moduli abilitati nel portale clienti. Le icone predefinite dei moduli si trovano in app/layouts/PortalLayout.php. I nomi delle icone si possono trovare qui https://fonts.google.com/icons.</td></tr><tr style="height: 29px;"><td style="width: 22.6544%; height: 29px;"><div><div><div><div>sdk_languages</div></div></div></div></td><td style="width: 10.9258%; height: 29px;">Array</td><td style="width: 18.7039%; height: 29px;"><div><div>[]</div></div></td><td style="width: 47.716%; height: 29px;">Con questa configurazione si possono aggiungere nuove etichette o modificare quelle esistenti.  
Si deve creare un nuovo file nella cartella sdk.</td></tr><tr style="height: 29px;"><td style="width: 22.6544%; height: 29px;"><div><div><div><div>sdk_global_php</div></div></div></div></td><td style="width: 10.9258%; height: 29px;">Array</td><td style="width: 18.7039%; height: 29px;"><div><div>[]</div></div></td><td style="width: 47.716%; height: 29px;">Con questa configurazione si possono aggiungere file php da caricare in ogni pagina (dovrebbero contenere classi/funzioni).  
Si deve creare un nuovo file nella cartella sdk.</td></tr><tr style="height: 29px;"><td style="width: 22.6544%; height: 29px;"><div><div><div><div>sdk_global_js</div></div></div></div></td><td style="width: 10.9258%; height: 29px;">Array</td><td style="width: 18.7039%; height: 29px;"><div><div>[]</div></div></td><td style="width: 47.716%; height: 29px;">Con questa configurazione si possono aggiungere js da caricare a livello globale.  
Si deve creare un nuovo file nella cartella public/assets/sdk.</td></tr><tr style="height: 29px;"><td style="width: 22.6544%; height: 29px;"><div><div><div><div>sdk_module_js</div></div></div></div></td><td style="width: 10.9258%; height: 29px;">Array</td><td style="width: 18.7039%; height: 29px;"><div><div>[]</div></div></td><td style="width: 47.716%; height: 29px;">Con questa configurazione si possono aggiungere js da caricare per un modulo specifico.  
Si deve creare un nuovo file nella cartella public/assets/sdk.</td></tr><tr style="height: 29px;"><td style="width: 22.6544%; height: 29px;"><div><div><div><div>sdk_global_css</div></div></div></div></td><td style="width: 10.9258%; height: 29px;">Array</td><td style="width: 18.7039%; height: 29px;"><div><div>[]</div></div></td><td style="width: 47.716%; height: 29px;">Con questa configurazione si possono aggiungere css da caricare a livello globale.  
Si deve creare un nuovo file nella cartella public/assets/sdk.</td></tr><tr><td style="width: 22.6544%;"><div><div><div><div><div><div>sdk_controllers</div></div></div></div></div></div></td><td style="width: 10.9258%;">Array</td><td style="width: 18.7039%;"><div><div>[]</div></div></td><td style="width: 47.716%;">Con questa configurazione si possono aggiungere azioni personalizzate (campo "action" nell'url).  
L'array rappresenta un'associazione tra il nome dell'azione e il file che contiene la classe controller per gestire la richiesta.  
Si deve creare un nuovo file nella cartella sdk.</td></tr><tr><td style="width: 22.6544%;"><div><div><div><div><div><div>sdk_module</div></div></div></div></div></div></td><td style="width: 10.9258%;">Array</td><td style="width: 18.7039%;"><div><div>[]</div></div></td><td style="width: 47.716%;">Con questa configurazione si possono aggiungere personalizzazioni su un modulo specifico.  
L'array rappresenta un'associazione tra il nome del modulo e il file che contiene la classe estesa del modulo.  
Si deve creare un nuovo file nella cartella sdk.</td></tr><tr><td style="width: 22.6544%;"><div><div><div><div><div><div>sdk_menu</div></div></div></div></div></div></td><td style="width: 10.9258%;">Array</td><td style="width: 18.7039%;"><div><div>[]</div></div></td><td style="width: 47.716%;">Con questa configurazione si possono aggiungere aggiungere voci di menu personalizzate nella barra laterale.  
Si deve creare un nuovo file nella cartella sdk.</td></tr></tbody></table>

#### API Reference - Classi, metodi, funzioni e variabili principali

---

##### \\app\\Request

<table border="1" id="bkmrk-metodo-descrizione" style="border-collapse: collapse; width: 100%; height: 174px;"><tbody><tr style="height: 29px;"><td style="width: 25%; height: 29px;">**Metodo**</td><td style="width: 25%; height: 29px;">**Argomenti**</td><td style="width: 50%; height: 29px;">**Descrizione**</td></tr><tr style="height: 29px;"><td style="width: 25%; height: 29px;"><div><div>get()</div></div></td><td style="width: 25%; height: 29px;"><div><div>$keys = null, $purify = false</div></div></td><td style="width: 50%; height: 29px;">Permette di ottenere uno o più parametri dalla variabile globale $\_GET. Se il secondo argomento è impostato a "true", i parametri vengono purificati attraverso la libreria HTML Purifier. Esempio:

```PHP
$request->get('foo');
$request->get(['foo', 'bar']);
$request->get('foo', true);
```

</td></tr><tr style="height: 29px;"><td style="width: 25%; height: 29px;"><div><div><div><div>post()</div></div></div></div></td><td style="width: 25%; height: 29px;"><div><div>$keys = null, $purify = false</div></div></td><td style="width: 50%; height: 29px;">Permette di ottenere uno o più parametri dalla variabile globale $\_POST. Se il secondo argomento è impostato a "true", i parametri vengono purificati attraverso la libreria HTML Purifier. Esempio:

```PHP
$request->post('foo');
$request->post(['foo', 'bar']);
$request->post('foo', true);
```

</td></tr><tr style="height: 29px;"><td style="width: 25%; height: 29px;"><div><div><div><div><div><div>files()</div></div></div></div></div></div></td><td style="width: 25%; height: 29px;"><div><div><div><div>$key</div></div></div></div></td><td style="width: 50%; height: 29px;">Permette di ottenere i file caricati attraverso il metodo HTTP POST e organizzati tramite la variabile globale $\_FILES.

```PHP
$request->files('attachments');
```

</td></tr><tr style="height: 29px;"><td style="width: 25%; height: 29px;"><div><div><div><div><div><div><div><div>cookie()</div></div></div></div></div></div></div></div></td><td style="width: 25%; height: 29px;"><div><div>$keys = null, $purify = false</div></div></td><td style="width: 50%; height: 29px;">Permette di ottenere uno o più parametri dalla variabile globale $\_COOKIE. Se il secondo argomento è impostato a "true", i parametri vengono purificati attraverso la libreria HTML Purifier. Esempio:

```PHP
$request->cookie('foo');
```

</td></tr><tr style="height: 29px;"><td style="width: 25%; height: 29px;"><div><div><div><div><div><div><div><div>server()</div></div></div></div></div></div></div></div></td><td style="width: 25%; height: 29px;"><div><div>$keys = null, $purify = false</div></div></td><td style="width: 50%; height: 29px;">Permette di ottenere uno o più parametri dalla variabile globale $\_SERVER. Se il secondo argomento è impostato a "true", i parametri vengono purificati attraverso la libreria HTML Purifier. Esempio:

```PHP
$request->server('');
```

</td></tr><tr><td style="width: 25%;"><div><div>isGet()</div></div></td><td style="width: 25%;"> </td><td style="width: 50%;">Ritorna true se il metodo della richiesta è GET.</td></tr><tr><td style="width: 25%;"><div><div>isPost()</div></div></td><td style="width: 25%;"> </td><td style="width: 50%;">Ritorna true se il metodo della richiesta è POST.</td></tr><tr><td style="width: 25%;"><div><div>isAjax()</div></div></td><td style="width: 25%;"> </td><td style="width: 50%;">Ritorna true se la richiesta è AJAX.​</td></tr><tr><td style="width: 25%;"><div><div>purify()</div></div></td><td style="width: 25%;"><div><div><div><div>$input</div></div></div></div></td><td style="width: 50%;">Purifica la variabile $input attraverso la libreria HTML Purifier.</td></tr></tbody></table>

##### \\app\\Response

<table border="1" id="bkmrk-metodo-argomenti-des" style="border-collapse: collapse; width: 100%; height: 290px;"><tbody><tr style="height: 29px;"><td style="width: 25%; height: 29px;">**Metodo**</td><td style="width: 25%; height: 29px;">**Argomenti**</td><td style="width: 50%; height: 29px;">**Descrizione**</td></tr><tr style="height: 29px;"><td style="width: 25%; height: 29px;"><div><div>__construct()</div></div></td><td style="width: 25%; height: 29px;"><div><div>$content = '', $statusCode = 200, $headers = []</div></div></td><td style="width: 50%; height: 29px;">Inizializza un nuovo oggetto \\app\\Response() con il contenuto della risposta ($content), il codice di ritorno ($statusCode) e gli header di default ($headers).</td></tr><tr style="height: 29px;"><td style="width: 25%; height: 29px;"><div><div>setContent()</div></div></td><td style="width: 25%; height: 29px;"><div><div>$content</div></div></td><td style="width: 50%; height: 29px;">Imposta il contenuto della risposta.</td></tr><tr style="height: 29px;"><td style="width: 25%; height: 29px;"><div><div>setStatusCode()</div></div></td><td style="width: 25%; height: 29px;"><div><div>$statusCode</div></div></td><td style="width: 50%; height: 29px;">Imposta il codice di ritorna della risposta.</td></tr><tr style="height: 29px;"><td style="width: 25%; height: 29px;"><div><div>setHeader()</div></div></td><td style="width: 25%; height: 29px;"><div><div>$header, $replace = true</div></div></td><td style="width: 50%; height: 29px;">Imposta un nuovo header nella risposta. Con il secondo argomento è possibile indicare se l'header deve sostituire oppure no un header precedente già impostato.</td></tr><tr style="height: 29px;"><td style="width: 25%; height: 29px;"><div><div>setMimeType()</div></div></td><td style="width: 25%; height: 29px;"><div><div>$mimeType = 'text/html'</div></div></td><td style="width: 50%; height: 29px;">Imposta il mime del contenuto della risposta.

</td></tr><tr style="height: 29px;"><td style="width: 25%; height: 29px;"><div><div>json()</div></div></td><td style="width: 25%; height: 29px;"><div><div>$data</div></div></td><td style="width: 50%; height: 29px;">Imposta il contenuto della risposta con $data convertito in formato JSON e mime 'application/json'.</td></tr><tr style="height: 29px;"><td style="width: 25%; height: 29px;"><div><div>redirect()</div></div></td><td style="width: 25%; height: 29px;"><div><div>$page</div></div></td><td style="width: 50%; height: 29px;">Esegue un redirect verso $page.</td></tr><tr style="height: 29px;"><td style="width: 25%; height: 29px;"><div><div>downloadFile()</div></div></td><td style="width: 25%; height: 29px;"><div><div>$fullpath</div></div></td><td style="width: 50%; height: 29px;">Permette lo scaricamento di un file posizionato in $fullpath.</td></tr><tr style="height: 29px;"><td style="width: 25%; height: 29px;"><div><div>output()</div></div></td><td style="width: 25%; height: 29px;"> </td><td style="width: 50%; height: 29px;">Esegue l'output del contenuto, del codice di risposta e degli header impostati.</td></tr></tbody></table>

##### \\app\\Session

<table border="1" id="bkmrk-metodo-argomenti-des-0" style="border-collapse: collapse; width: 100%; height: 261px;"><tbody><tr style="height: 29px;"><td style="width: 25%; height: 29px;">**Metodo**</td><td style="width: 25%; height: 29px;">**Argomenti**</td><td style="width: 50%; height: 29px;">**Descrizione**</td></tr><tr style="height: 29px;"><td style="width: 25%; height: 29px;"><div><div>set()</div></div></td><td style="width: 25%; height: 29px;"><div><div>$key, $value = ''</div></div></td><td style="width: 50%; height: 29px;">Imposta il valore $value con chiave $key in $\_SESSION.</td></tr><tr style="height: 29px;"><td style="width: 25%; height: 29px;"><div><div>get()</div></div></td><td style="width: 25%; height: 29px;"><div><div>$key</div></div></td><td style="width: 50%; height: 29px;">Permette di ottenere il valore con chiave $key da $\_SESSION.</td></tr><tr style="height: 29px;"><td style="width: 25%; height: 29px;"><div><div>flash()</div></div></td><td style="width: 25%; height: 29px;">$key</td><td style="width: 50%; height: 29px;">Permette di ottenere il valore con chiave $key da $\_SESSION. Successivamente, la chiave $key verrà eliminata da $\_SESSION.​</td></tr><tr style="height: 29px;"><td style="width: 25%; height: 29px;"><div><div>remove()</div></div></td><td style="width: 25%; height: 29px;">$key</td><td style="width: 50%; height: 29px;">Elimina la chiave $key da $\_SESSION.</td></tr><tr style="height: 29px;"><td style="width: 25%; height: 29px;"><div><div>hasKey()</div></div></td><td style="width: 25%; height: 29px;">$key</td><td style="width: 50%; height: 29px;">Ritorna true se esiste la chiave $key in $\_SESSION.</td></tr><tr style="height: 29px;"><td style="width: 25%; height: 29px;"><div><div>setMulti()</div></div></td><td style="width: 25%; height: 29px;">$keys</td><td style="width: 50%; height: 29px;">Permette di scrivere valori multipli in $\_SESSION.</td></tr><tr style="height: 29px;"><td style="width: 25%; height: 29px;"><div><div>removeMulti()</div></div></td><td style="width: 25%; height: 29px;"><div><div>$keys</div></div></td><td style="width: 50%; height: 29px;">Elimina valori multipli in $\_SESSION.</td></tr><tr style="height: 29px;"><td style="width: 25%; height: 29px;"><div><div>append()</div></div></td><td style="width: 25%; height: 29px;"><div><div>$key, $value = ''</div></div></td><td style="width: 50%; height: 29px;">Imposta la chiave $key come un array in $\_SESSION e il valore $value viene aggiunto a quest'ultimo.</td></tr></tbody></table>

##### \\app\\Config

<table border="1" id="bkmrk-metodo-argomenti-des-1" style="border-collapse: collapse; width: 100%; height: 261px;"><tbody><tr style="height: 29px;"><td style="width: 25%; height: 29px;">**Metodo**</td><td style="width: 25%; height: 29px;">**Argomenti**</td><td style="width: 50%; height: 29px;">**Descrizione**</td></tr><tr style="height: 29px;"><td style="width: 25%; height: 29px;"><div><div>has()</div></div></td><td style="width: 25%; height: 29px;"><div><div>$key</div></div></td><td style="width: 50%; height: 29px;">Ritorna true se esiste la chiave $key nella configurazione globale.</td></tr><tr style="height: 29px;"><td style="width: 25%; height: 29px;"><div><div>get()</div></div></td><td style="width: 25%; height: 29px;"><div><div>$key</div></div></td><td style="width: 50%; height: 29px;">Permette di ottenere il valore con chiave $key dalla configurazione globale.</td></tr><tr style="height: 29px;"><td style="width: 25%; height: 29px;"><div><div>set()</div></div></td><td style="width: 25%; height: 29px;"><div><div>$key, $value</div></div></td><td style="width: 50%; height: 29px;">Imposta il valore $value con chiave $key nella configurazione globale.</td></tr><tr style="height: 29px;"><td style="width: 25%; height: 29px;"><div><div>getAll()</div></div></td><td style="width: 25%; height: 29px;"> </td><td>Permette di ottenere una lista chiave-valore con tutta la configurazione globale.</td></tr><tr><td style="width: 25%;"><div><div>setMulti()</div></div></td><td style="width: 25%;"><div><div>$values</div></div></td><td>Permette di scrivere valori multipli nella configurazione globale.</td></tr><tr><td style="width: 25%;"><div><div><div><div>clear()</div></div></div></div></td><td style="width: 25%;"><div><div><div><div>$key</div></div></div></div></td><td>Elimina la chiave $key dalla configurazione globale.</td></tr><tr><td style="width: 25%;"><div><div><div><div><div><div>clearAll()</div></div></div></div></div></div></td><td style="width: 25%;"> </td><td>Elimina tutti i valori dalla configurazione globale.</td></tr></tbody></table>

##### \\app\\PortalModule

<table border="1" id="bkmrk-variabile-default-de" style="border-collapse: collapse; width: 100%; height: 307px;"><tbody><tr style="height: 29px;"><td style="width: 25%; height: 29px;">**Variabile**</td><td style="width: 25%; height: 29px;">**Default**</td><td style="width: 50%; height: 29px;">**Descrizione**</td></tr><tr style="height: 29px;"><td style="width: 25%; height: 29px;">$hasComments</td><td style="width: 25%; height: 29px;"><div><div>false</div></div></td><td style="width: 50%; height: 29px;">Indica se il modulo supporta il blocco commenti.</td></tr><tr style="height: 29px;"><td style="width: 25%; height: 29px;"><div><div>$hasAttachments</div></div></td><td style="width: 25%; height: 29px;"><div><div>false</div></div></td><td style="width: 50%; height: 29px;">Indica se il modulo supporta gli allegati.</td></tr><tr style="height: 29px;"><td style="width: 25%; height: 29px;"><div><div>$enableEdit</div></div></td><td style="width: 25%; height: 29px;"><div><div>true</div></div></td><td style="width: 50%; height: 29px;">Indica se il modulo può essere modificato (modalità edit).</td></tr><tr style="height: 29px;"><td style="width: 25%; height: 29px;"><div><div>$formColumns</div></div></td><td style="width: 25%; height: 29px;">3</td><td style="height: 29px;">Indica il numero di colonne da utilizzare per la visualizzazione dei campi in Create, Edit e Detail.</td></tr><tr style="height: 29px;"><td style="width: 25%; height: 29px;"><div><div>$listTemplate</div></div></td><td style="width: 25%; height: 29px;"><div><div>List.tpl</div></div></td><td style="height: 29px;">Indica il template utilizzato per la visualizzazione di una lista (action List).</td></tr><tr style="height: 29px;"><td style="width: 25%; height: 29px;">$referenceListTemplate</td><td style="width: 25%; height: 29px;"><div><div>sections/ReferenceList.tpl</div></div></td><td style="height: 29px;">Indica il template utilizzato per la visualizzazione di una lista relazionata (uitype 10).</td></tr><tr style="height: 29px;"><td style="width: 25%; height: 29px;"><div><div>$detailTemplate</div></div></td><td style="width: 25%; height: 29px;"><div><div>Detail.tpl</div></div></td><td style="height: 29px;">Indica il template utilizzato per la visualizzazione del dettaglio di un record (action Detail).</td></tr><tr style="height: 46px;"><td style="width: 25%; height: 46px;"><div><div><div><div>$editTemplate</div></div></div></div></td><td style="width: 25%; height: 46px;"><div><div><div><div>Edit.tpl</div></div></div></div></td><td style="height: 46px;">Indica il template utilizzato per la visualizzazione della modifica di un record (action Edit).</td></tr><tr style="height: 29px;"><td style="width: 25%; height: 29px;"><div><div><div><div><div><div>$notAuthorizedTemplate</div></div></div></div></div></div></td><td style="width: 25%; height: 29px;"><div><div><div><div><div><div>PageNotAuthorized.tpl</div></div></div></div></div></div></td><td style="height: 29px;">Indica il template utilizzato per visualizzare un errore di permesso (es. record non trovato o errori di permessi).</td></tr></tbody></table>

<table border="1" id="bkmrk-metodo-argomenti-des-2" style="width: 100%; border-collapse: collapse; height: 353px;"><tbody><tr style="height: 29px;"><td style="width: 25%; height: 29px;">**Metodo**</td><td style="width: 25%; height: 29px;">**Argomenti**</td><td style="width: 50%; height: 29px;">**Descrizione**</td></tr><tr style="height: 29px;"><td style="width: 25%; height: 29px;"><div><div>__construct()</div></div></td><td style="width: 25%; height: 29px;"><div><div>$module</div></div></td><td style="width: 50%; height: 29px;">$module indica il nome del modulo per ottenere un'instanza della classe. Se il modulo è stato esteso tramite sdk allora verrà ritornata un'istanza della classe estesa.</td></tr><tr style="height: 29px;"><td style="width: 25%; height: 29px;"><div><div>prepareList()</div></div></td><td style="width: 25%; height: 29px;"><div><div>$viewer, $request</div></div></td><td style="width: 50%; height: 29px;">Metodo utilizzato per la visualizzazione di una lista (action List).</td></tr><tr style="height: 29px;"><td style="width: 25%; height: 29px;"><div><div>postProcessList()</div></div></td><td style="width: 25%; height: 29px;">$viewer, $request</td><td style="width: 50%; height: 29px;">Questo metodo può essere utilizzato dalle classi estese per inserire/modificare i dati impostati nella prepareList().</td></tr><tr style="height: 29px;"><td style="width: 25%; height: 29px;"><div><div>prepareEdit()</div></div></td><td style="width: 25%; height: 29px;">$viewer, $request</td><td style="height: 29px;">Metodo utilizzato per la visualizzazione della modifica di un record (action Edit).</td></tr><tr style="height: 29px;"><td style="width: 25%; height: 29px;"><div><div>postProcessEdit()</div></div></td><td style="width: 25%; height: 29px;">$viewer, $request</td><td style="height: 29px;">Questo metodo può essere utilizzato dalle classi estese per inserire/modificare i dati impostati nella prepareEdit().</td></tr><tr style="height: 29px;"><td style="width: 25%; height: 29px;"><div><div>prepareDetail()</div></div></td><td style="width: 25%; height: 29px;"><div><div>$viewer, $request</div></div></td><td style="height: 29px;">Metodo utilizzato per la visualizzazione del dettaglio di un record (action Detail).</td></tr><tr style="height: 29px;"><td style="width: 25%; height: 29px;"><div><div>postProcessDetail()</div></div></td><td style="width: 25%; height: 29px;">$viewer, $request</td><td style="height: 29px;">Questo metodo può essere utilizzato dalle classi estese per inserire/modificare i dati impostati nella prepareDetail().</td></tr><tr style="height: 29px;"><td style="width: 25%; height: 29px;"><div><div>saveRecord()</div></div></td><td style="width: 25%; height: 29px;"><div><div>$request</div></div></td><td style="height: 29px;">Metodo utilizzato per il salvataggio di un record (action Save).</td></tr><tr style="height: 29px;"><td style="width: 25%; height: 29px;"><div><div>postProcessSaveValues()</div></div></td><td style="width: 25%; height: 29px;"><div><div>$request, &amp;$values</div></div></td><td style="height: 29px;">Questo metodo può essere utilizzato dalle classi estese per inserire/modificare i dati impostati nella saveRecord().</td></tr><tr style="height: 63px;"><td style="width: 25%; height: 63px;"><div><div><div><div>isPermitted()</div></div></div></div></td><td style="width: 25%; height: 63px;"><div><div><div><div>$module, $action = self::ACTION_LIST, $recordValues = []</div></div></div></div></td><td style="height: 63px;">Ritorna se il contatto ha il permesso di eseguire una determinata azione.

Lista azioni supportate:

<div><div>. ACTION_LIST</div><div>. ACTION_CREATE</div><div>. ACTION_EDIT</div><div>. ACTION_DETAIL</div><div>. ACTION_DELETE</div><div>. ACTION_SAVE</div><div>. ACTION_ADD_COMMENTS</div><div>. ACTION_UPLOAD_ATTACHMENTS</div><div>. ACTION_CHANGE_PWD</div><div>. ACTION_SOLVE_TICKET</div></div></td></tr></tbody></table>

##### \\app\\clients\\PortalRestClient

<table border="1" id="bkmrk-metodo-argomenti-des-3" style="border-collapse: collapse; width: 100%; height: 266px;"><tbody><tr style="height: 29px;"><td style="width: 25%; height: 29px;">**Metodo**</td><td style="width: 25%; height: 29px;">**Argomenti**</td><td style="width: 50%; height: 29px;">**Descrizione**</td></tr><tr style="height: 29px;"><td style="width: 25%; height: 29px;"><div><div>get()</div></div></td><td style="width: 25%; height: 29px;">$restName, $queryParameters = \[\], $headers = \[\]</td><td style="width: 50%; height: 29px;">Permette di eseguire una richiesta GET verso vtenext.</td></tr><tr style="height: 29px;"><td style="width: 25%; height: 29px;"><div><div>post()</div></div></td><td style="width: 25%; height: 29px;">$restName, $queryParameters = \[\], $bodyParameters = \[\], $headers = \[\]</td><td style="width: 50%; height: 29px;">Permette di eseguire una richiesta POST verso vtenext.</td></tr><tr style="height: 29px;"><td style="width: 25%; height: 29px;"><div><div>postMultipart()</div></div></td><td style="width: 25%; height: 29px;">$restName, $queryParameters = \[\], $bodyParameters = \[\], $fileParameters = \[\], $headers = \[\]</td><td style="width: 50%; height: 29px;">Permette di eseguire una richiesta POST multipart verso vtenext.

</td></tr><tr style="height: 29px;"><td style="width: 25%; height: 29px;"><div><div>patch()</div></div></td><td style="width: 25%; height: 29px;"><div><div>$restName, $queryParameters = [], $bodyParameters = [], $headers = []</div></div></td><td style="height: 29px;">Permette di eseguire una richiesta PATCH verso vtenext.</td></tr><tr style="height: 63px;"><td style="width: 25%; height: 63px;"><div><div>delete()</div></div></td><td style="width: 25%; height: 63px;"><div><div>$restName, $queryParameters = [], $headers = []</div></div></td><td style="height: 63px;">Permette di eseguire una richiesta DELETE verso vtenext.</td></tr><tr style="height: 29px;"><td style="width: 25%; height: 29px;"><div><div>postDownload()</div></div></td><td style="width: 25%; height: 29px;"><div><div>$restName, $queryParameters = [], $bodyParameters = [], $headers = []</div></div></td><td style="height: 29px;">Permette di eseguire una richiesta POST per scaricare un file di vtenext in modalità stream.</td></tr></tbody></table>

##### Helpers

<table border="1" id="bkmrk-funzione-argomenti-d" style="border-collapse: collapse; width: 100%; height: 1310px;"><tbody><tr style="height: 29px;"><td style="width: 25%; height: 29px;">**Funzione**</td><td style="width: 25%; height: 29px;">**Argomenti**</td><td style="width: 50%; height: 29px;">**Descrizione**</td></tr><tr style="height: 29px;"><td style="width: 25%; height: 29px;"><div><div>preprint()</div></div></td><td style="width: 25%; height: 29px;"><div><div>$var</div></div></td><td style="width: 50%; height: 29px;">print\_r formattato con tag &lt;pre&gt;</td></tr><tr style="height: 29px;"><td style="width: 25%; height: 29px;"><div><div>predump()</div></div></td><td style="width: 25%; height: 29px;">$var</td><td style="width: 50%; height: 29px;">var\_dump formattato con tag &lt;pre&gt;</td></tr><tr style="height: 29px;"><td style="width: 25%; height: 29px;"><div><div>encodeForHtml()</div></div></td><td style="width: 25%; height: 29px;"><div><div>$value, $charset = 'UTF-8'</div></div></td><td style="width: 50%; height: 29px;">Codifica il valore $value per essere inserito in una pagina HTML.</td></tr><tr style="height: 29px;"><td style="width: 25%; height: 29px;"><div><div>encodeForHtmlAttr()</div></div></td><td style="width: 25%; height: 29px;"><div><div>$value, $enclosing = '"'</div></div></td><td style="height: 29px;">Codifica il valore $value per essere inserito all'interno di un attributo di un tag HTML.</td></tr><tr style="height: 29px;"><td style="width: 25%; height: 29px;"><div><div>encodeForJs()</div></div></td><td style="width: 25%; height: 29px;"><div><div>$value, $enclosing = '"'</div></div></td><td style="height: 29px;">Codifica il valore $value per essere inserito all'interno di uno &lt;script&gt; javascript.</td></tr><tr style="height: 29px;"><td style="width: 25%; height: 29px;"><div><div>htmlAttr()</div></div></td><td style="width: 25%; height: 29px;"><div><div>$attributes</div></div></td><td style="height: 29px;">Codifica una lista di attributi per essere inseriti all'interno di un tag HTML.</td></tr><tr style="height: 29px;"><td style="width: 25%; height: 29px;"><div><div>config()</div></div></td><td style="width: 25%; height: 29px;"><div><div>$key</div></div></td><td style="height: 29px;">Permette di ottenere il valore con chiave $key dalla configurazione globale.</td></tr><tr style="height: 29px;"><td style="width: 25%; height: 29px;"><div><div><div><div>trans()</div></div></div></div></td><td style="width: 25%; height: 29px;"><div><div><div><div>$key, $args = []</div></div></div></div></td><td style="height: 29px;">Permette la traduzione di un'etichetta $key.</td></tr><tr style="height: 29px;"><td style="width: 25%; height: 29px;"><div><div><div><div><div><div>listUrl()</div></div></div></div></div></div></td><td style="width: 25%; height: 29px;"><div><div><div><div><div><div>$module, $extraParams = []</div></div></div></div></div></div></td><td style="height: 29px;">Genera un link per aprire una lista.</td></tr><tr style="height: 29px;"><td style="width: 25%; height: 29px;"><div><div><div><div><div><div><div><div>createUrl()</div></div></div></div></div></div></div></div></td><td style="width: 25%; height: 29px;"><div><div><div><div><div><div><div><div>$module, $extraParams = []</div></div></div></div></div></div></div></div></td><td style="height: 29px;">Genera un link per aprire la creazione di un record.</td></tr><tr style="height: 29px;"><td style="width: 25%; height: 29px;"><div><div><div><div><div><div><div><div><div><div>createDocUrl()</div></div></div></div></div></div></div></div></div></div></td><td style="width: 25%; height: 29px;"><div><div><div><div><div><div><div><div><div><div>$module, $folderId, $extraParams = []</div></div></div></div></div></div></div></div></div></div></td><td style="height: 29px;">Genera un link per aprire la creazione di un documento.</td></tr><tr style="height: 29px;"><td style="width: 25%; height: 29px;"><div><div><div><div><div><div><div><div><div><div><div><div>detailUrl()</div></div></div></div></div></div></div></div></div></div></div></div></td><td style="width: 25%; height: 29px;"><div><div><div><div><div><div><div><div><div><div><div><div>$module, $record, $extraParams = []</div></div></div></div></div></div></div></div></div></div></div></div></td><td style="height: 29px;">Genera un link per aprire il dettaglio di un record.</td></tr><tr style="height: 29px;"><td style="width: 25%; height: 29px;"><div><div><div><div><div><div><div><div><div><div><div><div><div><div>editUrl()</div></div></div></div></div></div></div></div></div></div></div></div></div></div></td><td style="width: 25%; height: 29px;"><div><div><div><div><div><div><div><div><div><div><div><div>$module, $record, $extraParams = []</div></div></div></div></div></div></div></div></div></div></div></div></td><td style="height: 29px;">Genera un link per aprire la modifica di un record.</td></tr><tr style="height: 29px;"><td style="width: 25%; height: 29px;"><div><div><div><div><div><div><div><div><div><div><div><div><div><div><div><div>downloadUrl()</div></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div></td><td style="width: 25%; height: 29px;"><div><div><div><div><div><div><div><div><div><div><div><div><div><div>$record, $documentId, $extraParams = []</div></div></div></div></div></div></div></div></div></div></div></div></div></div></td><td style="height: 29px;">Genera un link per eseguire il download di un documento.</td></tr><tr style="height: 29px;"><td style="width: 25%; height: 29px;"><div><div><div><div><div><div><div><div><div><div><div><div><div><div><div><div><div><div>docFolderUrl()</div></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div></td><td style="width: 25%; height: 29px;"><div><div><div><div><div><div><div><div><div><div><div><div><div><div><div><div>$module, $folderId, $extraParams = []</div></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div></td><td style="height: 29px;">Genera un link per aprire una cartella specifica nel modulo documenti.</td></tr><tr style="height: 29px;"><td style="width: 25%; height: 29px;"><div><div><div><div><div><div><div><div><div><div><div><div><div><div><div><div><div><div><div><div>returnUrl()</div></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div></td><td style="width: 25%; height: 29px;"><div><div><div><div><div><div><div><div><div><div><div><div><div><div><div><div><div><div>$request</div></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div></td><td style="height: 29px;">Genera un link di ritorno indietro (es. azione "Annulla").</td></tr><tr style="height: 29px;"><td style="width: 25%; height: 29px;"><div><div><div><div><div><div><div><div><div><div><div><div><div><div><div><div><div><div><div><div><div><div>portalLanguage()</div></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div></td><td style="width: 25%; height: 29px;"> </td><td style="height: 29px;">Ritorna la lingua utilizzata nel portale.</td></tr><tr style="height: 29px;"><td style="width: 25%; height: 29px;"><div><div>setPortalLanguage()</div></div></td><td style="width: 25%; height: 29px;"><div><div><div><div><div><div><div><div><div><div><div><div><div><div><div><div><div><div><div><div>$language</div></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div></td><td style="height: 29px;">Imposta la lingua $language nel portale.</td></tr><tr style="height: 29px;"><td style="width: 25%; height: 29px;"><div><div><div><div>getBrowserTitle()</div></div></div></div></td><td style="width: 25%; height: 29px;"><div><div><div><div><div><div><div><div><div><div><div><div><div><div><div><div><div><div><div><div><div><div>$title</div></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div></td><td style="height: 29px;">Ritorna il titolo da impostare in una pagina HTML del portale.</td></tr><tr style="height: 29px;"><td style="width: 25%; height: 29px;"><div><div><div><div><div><div>getModuleLabel()</div></div></div></div></div></div></td><td style="width: 25%; height: 29px;"><div><div><div><div><div><div><div><div><div><div><div><div><div><div><div><div><div><div><div><div><div><div>$module</div></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div></td><td style="height: 29px;">Ritorna la traduzione del modulo $module.</td></tr><tr style="height: 29px;"><td style="width: 25%; height: 29px;"><div><div><div><div><div><div><div><div>getSingleModuleLabel()</div></div></div></div></div></div></div></div></td><td style="width: 25%; height: 29px;"><div><div><div><div><div><div><div><div><div><div><div><div><div><div><div><div><div><div><div><div><div><div>$module</div></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div></td><td style="height: 29px;">Ritorna la traduzione singolare del modulo $module.</td></tr><tr style="height: 29px;"><td style="width: 25%; height: 29px;"><div><div><div><div><div><div><div><div><div><div>getMaxUploadSize()</div></div></div></div></div></div></div></div></div></div></td><td style="width: 25%; height: 29px;"> </td><td style="height: 29px;">Ritorna la dimensione massima di upload nel portale.</td></tr><tr style="height: 63px;"><td style="width: 25%; height: 63px;"><div><div>setPortalCookie()</div></div></td><td style="width: 25%; height: 63px;"><div><div><div><div><div><div><div><div><div><div><div><div><div><div><div><div><div><div><div><div><div><div><div><div>$name, $value = "", $expires_or_options, $httponly = false</div></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div></td><td style="height: 63px;">Imposta un cookie nel portale.</td></tr><tr style="height: 29px;"><td style="width: 25%; height: 29px;"><div><div><div><div>unsetPortalCookie()</div></div></div></div></td><td style="width: 25%; height: 29px;"><div><div><div><div><div><div><div><div><div><div><div><div><div><div><div><div><div><div><div><div><div><div><div><div><div><div>$name, $httponly = false</div></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div></td><td style="height: 29px;">Rimuove un cookie dal portale.</td></tr><tr style="height: 29px;"><td style="width: 25%; height: 29px;"><div><div><div><div><div><div>csrfToken()</div></div></div></div></div></div></td><td style="width: 25%; height: 29px;"> </td><td style="height: 29px;">Ritorna il token csrf.</td></tr><tr style="height: 29px;"><td style="width: 25%; height: 29px;"><div><div>csrfInputName()</div></div></td><td style="width: 25%; height: 29px;"> </td><td style="height: 29px;">Ritorna il nome dell'input per l'invio del token csrf.</td></tr><tr style="height: 29px;"><td style="width: 25%; height: 29px;"><div><div>flashPortalError()</div></div></td><td style="width: 25%; height: 29px;"><div><div><div><div><div><div><div><div><div><div><div><div><div><div><div><div><div><div><div><div><div><div><div><div><div><div><div><div>$error</div></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div></td><td style="height: 29px;">Permette di visualizzare un messaggio di errore temporizzato.</td></tr><tr style="height: 29px;"><td style="width: 25%; height: 29px;"><div><div><div><div>flashPortalMessage()</div></div></div></div></td><td style="width: 25%; height: 29px;"><div><div><div><div><div><div><div><div><div><div><div><div><div><div><div><div><div><div><div><div><div><div><div><div><div><div><div><div><div><div>$message</div></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div></td><td style="height: 29px;">Permette di visualizzare un messaggio temporizzato.</td></tr><tr style="height: 29px;"><td style="width: 25%; height: 29px;"><div><div><div><div><div><div>customerId()</div></div></div></div></div></div></td><td style="width: 25%; height: 29px;"> </td><td style="height: 29px;">Ritorna l'id del contatto autenticato.</td></tr><tr style="height: 29px;"><td style="width: 25%; height: 29px;"><div><div>customerEmail()</div></div></td><td style="width: 25%; height: 29px;"> </td><td style="height: 29px;">Ritorna l'email del contatto autenticato.</td></tr><tr style="height: 29px;"><td style="width: 25%; height: 29px;"><div><div>customerUsername()</div></div></td><td style="width: 25%; height: 29px;"> </td><td style="height: 29px;">Ritorna il nome e cognome del contatto autenticato.</td></tr><tr style="height: 29px;"><td style="width: 25%; height: 29px;"><div><div>resourcever()</div></div></td><td style="width: 25%; height: 29px;"><div><div><div><div><div><div><div><div><div><div><div><div><div><div><div><div><div><div><div><div><div><div><div><div><div><div><div><div><div><div><div><div>$filename</div></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div></td><td style="height: 29px;">Permette il versionamento di file css e javascript.</td></tr><tr style="height: 29px;"><td style="width: 25%; height: 29px;"><div><div>basePath()</div></div></td><td style="width: 25%; height: 29px;"><div><div><div><div><div><div><div><div><div><div><div><div><div><div><div><div><div><div><div><div><div><div><div><div><div><div><div><div><div><div><div><div><div><div>$path = ''</div></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div></td><td style="height: 29px;">Ritorna il percorso della cartella base del portale. Se viene indicato $path viene creato e restituito un percorso a partire dalla cartella base.</td></tr><tr style="height: 29px;"><td style="width: 25%; height: 29px;"><div><div>appPath()</div></div></td><td style="width: 25%; height: 29px;"><div><div><div><div><div><div><div><div><div><div><div><div><div><div><div><div><div><div><div><div><div><div><div><div><div><div><div><div><div><div><div><div><div><div>$path = ''</div></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div></td><td style="height: 29px;">Ritorna il percorso della cartella "app" del portale. Se viene indicato $path viene creato e restituito un percorso a partire dalla cartella "app".</td></tr><tr style="height: 29px;"><td style="width: 25%; height: 29px;"><div><div>configPath()</div></div></td><td style="width: 25%; height: 29px;"><div><div><div><div><div><div><div><div><div><div><div><div><div><div><div><div><div><div><div><div><div><div><div><div><div><div><div><div><div><div><div><div><div><div>$path = ''</div></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div></td><td style="height: 29px;">Ritorna il percorso della cartella "config" del portale. Se viene indicato $path viene creato e restituito un percorso a partire dalla cartella "config".</td></tr><tr style="height: 29px;"><td style="width: 25%; height: 29px;"><div><div>resourcesPath()</div></div></td><td style="width: 25%; height: 29px;"><div><div><div><div><div><div><div><div><div><div><div><div><div><div><div><div><div><div><div><div><div><div><div><div><div><div><div><div><div><div><div><div><div><div>$path = ''</div></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div></td><td style="height: 29px;">Ritorna il percorso della cartella "resources" del portale. Se viene indicato $path viene creato e restituito un percorso a partire dalla cartella "resources".</td></tr><tr style="height: 29px;"><td style="width: 25%; height: 29px;"><div><div>langPath()</div></div></td><td style="width: 25%; height: 29px;"><div><div>$lang</div></div></td><td style="height: 29px;">Ritorna il percorso del file della lingua $lang indicata.</td></tr><tr style="height: 29px;"><td style="width: 25%; height: 29px;"><div><div>storagePath()</div></div></td><td style="width: 25%; height: 29px;"><div><div><div><div><div><div><div><div><div><div><div><div><div><div><div><div><div><div><div><div><div><div><div><div><div><div><div><div><div><div><div><div><div><div>$path = ''</div></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div></td><td style="height: 29px;">Ritorna il percorso della cartella "storage" del portale. Se viene indicato $path viene creato e restituito un percorso a partire dalla cartella "storage".</td></tr><tr style="height: 29px;"><td style="width: 25%; height: 29px;"><div><div>publicPath()</div></div></td><td style="width: 25%; height: 29px;"><div><div><div><div><div><div><div><div><div><div><div><div><div><div><div><div><div><div><div><div><div><div><div><div><div><div><div><div><div><div><div><div><div><div>$path = ''</div></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div></td><td style="height: 29px;">Ritorna il percorso della cartella "public" del portale. Se viene indicato $path viene creato e restituito un percorso a partire dalla cartella "public".</td></tr><tr style="height: 29px;"><td style="width: 25%; height: 29px;"><div><div>vtePath()</div></div></td><td style="width: 25%; height: 29px;"><div><div><div><div><div><div><div><div><div><div><div><div><div><div><div><div><div><div><div><div><div><div><div><div><div><div><div><div><div><div><div><div><div><div>$path = ''</div></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div></td><td style="height: 29px;">Ritorna il percorso della cartella di vtenext. Se viene indicato $path viene creato e restituito un percorso a partire dalla cartella di vtenext.</td></tr><tr style="height: 29px;"><td style="width: 25%; height: 29px;"><div><div>sdkPath()</div></div></td><td style="width: 25%; height: 29px;"><div><div><div><div><div><div><div><div><div><div><div><div><div><div><div><div><div><div><div><div><div><div><div><div><div><div><div><div><div><div><div><div><div><div>$path = ''</div></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div></td><td style="height: 29px;">Ritorna il percorso della cartella "sdk" del portale. Se viene indicato $path viene creato e restituito un percorso a partire dalla cartella "sdk".</td></tr><tr style="height: 29px;"><td style="width: 25%; height: 29px;"><div><div>sdkAssetsPath()</div></div></td><td style="width: 25%; height: 29px;"><div><div><div><div><div><div><div><div><div><div><div><div><div><div><div><div><div><div><div><div><div><div><div><div><div><div><div><div><div><div><div><div><div><div>$path = ''</div></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div></td><td style="height: 29px;">Ritorna il percorso della cartella "public/assets/sdk" del portale. Se viene indicato $path viene creato e restituito un percorso a partire dalla cartella "public/assets/sdk".</td></tr><tr style="height: 29px;"><td style="width: 25%; height: 29px;"><div><div>publicRelPath()</div></div></td><td style="width: 25%; height: 29px;"><div><div>$assetPath</div></div></td><td style="height: 29px;">Ritorna un percorso relativo a partire dalla cartella "public".</td></tr></tbody></table>

#### Esempi

---

##### View SDK

Ecco un esempio di come modificare la visibilità dei campi del portale tramite view SDK.

```PHP
<?php
require('../../config.inc.php');
chdir($root_directory);
require_once('include/utils/utils.php');
require_once('vtlib/Vtecrm/Module.php');
$Vtiger_Utils_Log = true;
global $adb, $table_prefix;
VteSession::start();

$module = '';
$src = '';
$mode = 'constrain';
$success = 'continue';
SDK::addView($module, $src, $mode, $success);
```

```php
<?php

global $sdk_mode, $table_prefix;

switch ($sdk_mode) {
	case 'portal.create':
		$readonly = 100;
		$success = true;
		break;
	case 'portal.edit':
	case 'portal.detail':
		if ($col_fields['field3'] !== 'Open') {
			$readonly = 99;
			$success = true;
		}
		if (in_array($fieldname, ['field1', 'field2'])) {
			$readonly = 100;
			$success = true;
		}
		break;
}

```

##### Creazione di un nuovo controller

Ecco un esempio di come creare un nuovo controller per gestire un'azione custom.

- Modificare "config/sdk.config.php" inserendo il nuovo controller

```PHP
return [
	'sdk_controllers' => [
		'SampleVte' => 'controllers/SampleVteController.php',
	]
];
```

- Implementare la classe SampleVteController in "sdk/controllers/SampleVteController.php"

```PHP
<?php

class SampleVteController extends \app\controllers\BaseController {
	
	public function index($request) {
		return $this->displaySomething($request);
	}

	protected function displaySomething($request) {
		$parameter1 = $request->get('parameter1', true);
		$parameter2 = $request->get('parameter2', true);

		$this->viewer->assign('PARAMETER1', $parameter1);
		$this->viewer->assign('PARAMETER2', $parameter2);

		$layout = \app\LayoutFactory::getPortalLayout($this->viewer, $this->client, $request);
		$output = $this->fetchWithLayout('sdk/SampleVte.tpl', $layout);

		return new \app\Response($output);
	}
	
}

```

- Creare un nuovo template in "resources/templates/sdk/SampleVte.tpl"

```PHP
{extends file='layouts/PortalLayout.tpl'}

{block name=content}
	<h1>Sample Vte</h1>
{/block}
```

- Modificare "config/sdk.config.php" indicando il file sdk per l'inserimento delle nuovi voci nel menù laterale

```PHP
return [
	'sdk_controllers' => [
		'SampleVte' => 'controllers/SampleVteController.php',
	],
  	'sdk_menu' => [
		'samplevte-menu.php',
	]
];
```

- Modificare il file "sdk/samplevte-menu.php"

```PHP
<?php

return [
	[
		'text' => trans('SampleVte'),
		'active' => false,
		'prefix' => [
			'type' => 'icon',
			'icon_style' => 'material',
			'icon_name' => 'pie_chart',
		],
		'action' => [
			'type' => 'link',
			'link_href' => "index.php?action=SampleVte",
		],
	],
];

```

[![image-1694533951130.48.16.png](https://usermanual.vtenext.com/uploads/images/gallery/2023-09/scaled-1680-/image-1694533951130-48-16.png)](https://usermanual.vtenext.com/uploads/images/gallery/2023-09/image-1694533951130-48-16.png)

##### Estensione di un modulo

Ecco un esempio di come estendere le funzionalità di un modulo.

- Modificare "config/sdk.config.php"

```PHP
return [
	'sdk_module' => [
		'Contacts' => 'modules/ContactsModule.php',
	]
];
```

- Implementare la classe ContactsModule in "sdk/modules/ContactsModule.php". In questo esempio viene attivato il blocco per inserire i commenti e viene cambiato il layout passando ad una visualizzazione a due colonne.

```PHP
<?php

class ContactsModule extends \app\PortalModule {
	
	public $hasComments = true;

	public $formColumns = 2;

	public function canAddComments() {
		return true;
	}
	
}

```

[![image-1694596916198.20.03.png](https://usermanual.vtenext.com/uploads/images/gallery/2023-09/scaled-1680-/image-1694596916198-20-03.png)](https://usermanual.vtenext.com/uploads/images/gallery/2023-09/image-1694596916198-20-03.png)