Portale v2

Webservice REST

Handler: include/Webservices/CustomerPortal.php

Headers:
• Authorization: Basic base64_encode("username:accesskey")
• Content-Type: application/json

Registrare un nuovo webservice REST

Questo script deve essere eseguito in un file all'interno di vtenext (es. plugins/script/script.php).

$parameters = ['param1' => 'string', 'param2' => 'encoded'];
$perm = 'read'; // read, write, readwrite
SDK::setRestOperation('portal.foo', 'include/Webservices/CustomerPortal.php', 'CustomerPortalRestApi.foo', $parameters, $perm);

Estendere un webservice REST esistente

Questo script deve essere eseguito in un file all'interno di vtenext (es. "plugins/script/script.php").

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

Creare un nuovo file da posizionare all'interno di vtenext (es. "modules/SDK/src/CustomerPortalRestApi2.php").

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

class CustomerPortalRestApi2 extends CustomerPortalRestApi {

	function get_list($module, $language, $folderid = 0) {
		// return parent::get_list($module, $language, $folderid);
		// your custom code here
	}

}

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.

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

Creazione di un nuovo controller

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

• 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 un file sdk per l'inserimento di 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 nel nuovo portale clienti.

• Modificare "config/sdk.config.php"

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

• Implementare la classe ContactsModule in "sdk/modules/ContactsModule.php"

<?php

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

	public $formColumns = 2;

	public function canAddComments() {
		return true;
	}
	
}