Portale v2

Documentazione tema

https://adminlte.io/docs/3.2/

https://github.com/ColorlibHQ/AdminLTE

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

Registrare un nuovo webservice REST

Creare un nuovo file ed eseguirlo (es. plugins/script/script.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

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
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

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

La cartella del portale si trova in: VTE_ROOT/portal/v2

Le cartelle/file principali del nuovo portale sono:

Request lifecycle

Configurazione del portale

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

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.

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​​

Ecco la lista dei parametri supportati dal nuovo portale:

API Reference - Classi, metodi, funzioni e variabili principali

\app\Request

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

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

$request->files('attachments');

$request->cookie('foo');

$request->server('');

\app\Response

\app\Session

\app\Config

\app\PortalModule

\app\clients\PortalRestClient

Helpers

Esempi

View SDK

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

<?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

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

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

• Implementare la classe SampleVteController in "sdk/controllers/SampleVteController.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"

{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

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

• Modificare il file "sdk/samplevte-menu.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",
		],
	],
];

Estensione di un modulo

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

• Modificare "config/sdk.config.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

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

	public $formColumns = 2;

	public function canAddComments() {
		return true;
	}
	
}