Portale v2

Webservice REST

Handler: include/Webservices/CustomerPortal.php

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

RegistrareRegister una nuovonew REST webservice REST

QuestoThis script devemust esserebe eseguitorun in una file all'interno diwithin vtenext (es.e.g. 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);

EstendereExtend unan webserviceexisting REST esistentewebservice

QuestoThis script devemust esserebe eseguitorun in una file all'interno diwithin vtenext (es.e.g. "plugins/script/script.php").

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

CreareCreate una nuovonew file dato posizionareplace all'interno diinside vtenext (es.e.g. "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
	}

}

StrutturaStructure delleof cartelle/filemain principalifolders/files

LaThe cartellaportal delfolder portaleis silocated trovaat: in: VTE_ROOT/portal/v2

LeThe cartelle/filemain principalifolders/files delof nuovothe portalenew sono:portal are:

Request lifecycle

ConfigurazionePortal del portaleconfiguration

IlThe portal configuration file diis configurazione del portale si trovalocated in "config/portal.config.php".

PerTo sovrascrivereoverwrite ithe parametriparameters deve essere utilizzato il filethe "config/sdk.config.php" altrimenti,file must be used otherwise, in casocase diof aggiornamentoupdating dellathe versioneversion diof vtenext, lethe modifichechanges potrebberocould esserebe perse.lost.

EccoHere lais listathe deilist parametriof supportatiparameters dalsupported nuovoby portale:the new portal:

API Reference - Classi,Main metodi,classes, funzionimethods, efunctions variabiliand principalivariables

\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

EsempiExamples

CreazioneCreating dia un nuovonew controller

EccoHere unis esempioan diexample comeof crearehow unto nuovocreate a new controller perto gestiremanage un'azionea custom nelaction nuovoin portalethe clienti.new customer portal.

• ModificareEdit "config/sdk.config.php" inserendoto ilinsert nuovoa new controller

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

• ImplementareImplement la classethe SampleVteController class 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);
	}
	
}

• CreareCreate una nuovonew template in "resources/templates/sdk/SampleVte.tpl"

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

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

• ModificareModify "config/sdk.config.php" indicandoindicating unan sdk file sdkfor perinserting l'inserimentonew dientries nuoviin vocithe nelside menù lateralemenu

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

• ModificareEdit il filethe "sdk/samplevte-menu.php" file

<?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",
		],
	],
];

EstensioneExtending dia un modulomodule

EccoHere unis esempioan diexample comeof estenderehow leto funzionalitàextend dithe unfunctionality moduloof nela nuovoform portalein clienti.the new customer portal.

• ModificareEdit "config/sdk.config.php"

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

• ImplementareImplement la classethe ContactsModule class in "sdk/modules/ContactsModule.php"

<?php

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

	public $formColumns = 2;

	public function canAddComments() {
		return true;
	}
	
}