WSCOMUN  2.1.2
Web Services Comunes para PHP/GVHidra
Métodos públicos | Métodos públicos estáticos | Campos de datos | Métodos protegidos | Atributos protegidos | Atributos protegidos estáticos
Referencia de la Clase WSComunFClient
Diagrama de herencias de WSComunFClient
WSClientAutentica WSClientAutoriza WSClientFirma WSClientCatastro WSClientCSV WSClientConductorVehiculos WSClientDatosVehiculo WSClientGDE WSClientGDE2 WSClientGVLogin WSClientPortafirmas WSClientRegDepartamental WSClientSALT

Métodos públicos

 __construct ($v_wsdl, $v_opciones=null)
 
 getDebugMode ()
 
 getDebugInfo ()
 
 setDebugMode ($activo)
 
 addDebugInfo ($info)
 
 setKeyFile ($pathKey)
 
 setPassPhrase ($passphrase)
 
 setCertFile ($pathCert)
 
 setWSDLTimeOut ($segs)
 
 getCertificateSerial ($set=true)
 
 loadTracertPAI ($vTrazabilidadPAI)
 
 enableWSSecurity ()
 
 disableWSSecurity ()
 
 enableTrazabilidadPAI ()
 
 disableTrazabilidadPAI ()
 
 __getClient ($tipo)
 

Métodos públicos estáticos

static getCertificateInfo ($ruta, $formato=null)
 
static numberBaseConvert ($numstring, $frombase=10, $tobase=16)
 
static getClientIP ()
 

Campos de datos

const KEYCLIENTE_AUTENTICA = 'autentica'
 
const KEYCLIENTE_AUTORIZA = 'autoriza'
 
const KEYCLIENTE_FIRMA = 'firma'
 
const KEYCLIENTE_GDE = 'gde'
 
const KEYCLIENTE_SALT = 'salt'
 
const KEYCLIENTE_CSV = 'csv'
 
const KEYCLIENTE_CATASTRO = 'catastro'
 
const KEYCLIENTE_CATASTRO_BIENES = 'catbienes'
 
const KEYCLIENTE_GDE2 = 'gde2'
 
const KEYCLIENTE_PF = 'pfcons'
 
const KEYCLIENTE_PF_MOD = 'pfmod'
 
const KEYCLIENTE_PF_ADM = 'pfadm'
 
const KEYCLIENTE_GVLOGIN = 'gvlogin'
 
const KEYCLIENTE_REGDEPARTAMENTAL = 'regdepartamental'
 
const KEYCLIENTE_DGT_CONDUCTORVEHICULOS = 'dgt_conductorvehiculos'
 
const KEYCLIENTE_DGT_DATOSVEHICULO = 'dgt_datosvehiculo'
 
const TIPOBUSQUEDA_USUARIO = 'USUARIO'
 
const TIPOBUSQUEDA_GRUPO = 'GRUPO'
 

Métodos protegidos

 __clienteOn ($tipo, $trazabilidadPai=true, $opcionesClienteWS=null)
 
 array2ObjectTree ($array)
 
 objectTree2array ($obj)
 
 tratarExcepcionEstandar ($e, $clienteWS)
 
 tratarMTOMEstandar ($response, $itemToReturn=null)
 
 xml_to_array (&$root)
 

Atributos protegidos

 $v_clienteWS
 
 $passPhrase =null
 
 $vTrazabilidad
 
 $userToken = ''
 
 $passUserToken = ''
 
 $enableTrazabilidadPAI = true
 
 $enableWSSecurity = true
 

Atributos protegidos estáticos

static $MYSOAPOP_TRACE = true
 
static $MYSOAPOP_WSDL_CACHE = WSDL_CACHE_BOTH
 
static $MYSOAPOP_SOAP_VERSION = SOAP_1_1
 
static $NAMESPACE_GVA = 'http://dgm.gva.es/ayf/war/schemas/v2_00'
 
static $NAMESPACE_GDE = 'urn:es:gva:dgm:tra:gde:vista:model'
 
static $NAMESPACE_SALT = 'http://salt.ws.edu.gva.es/'
 
static $NAMESPACE_CSVGVA = 'urn:es:gva:dgm:tra:csvgva'
 
static $NAMESPACE_GDE2 = 'urn:es:gva:dgm:tra:gde:vista:v2:model'
 
static $NAMESPACE_CAT_ESP = 'http://intermediacion.redsara.es/scsp/esquemas/datosespecificos'
 
static $NAMESPACE_CAT_PET = 'http://intermediacion.redsara.es/scsp/esquemas/V3/peticion'
 
static $NAMESPACE_CAT_SR = 'http://intermediacion.redsara.es/scsp/esquemas/V3/solicitudRespuesta'
 
static $NAMESPACE_PF = null
 
static $NAMESPACE_PF_MOD = null
 
static $NAMESPACE_PF_ADM = null
 
static $NAMESPACE_LOGIN = 'urn:es:gva:gvlogin:sso:model'
 
static $NAMESPACE_REGDEPARTAMENTAL = 'urn:es:gva:mastin:departamental:model'
 
static $NAMESPACE_DGT_CONDUCTORVEHICULOS = 'http://intermediacion.redsara.es/scsp/esquemas/datosespecificos'
 
static $NAMESPACE_DGT_DATOSVEHICULO = 'http://intermediacion.redsara.es/scsp/esquemas/datosespecificos'
 

Descripción detallada

Carga de la clase generica para soporte a clientes SOAP WS-Secure Paquetes para gestion MTOM Clase cliente que permite el consumo los WS seguros del proyecto e-Sirca

La clase siguiente accede a los WS seguros ofrecidos por la PAI (Plataforma Aut. de Intermediación) englobada dentro del proyecto e-SIRCA. Esta clase se organiza como una factoría, para instanciar subclases de cada servicio

El cliente se conecta a tres servicios SOAP-WS, cada uno de ellos con su WDSL de descripción La documentación de los mismos puede encontrarse en el proyecto e-SIRCA. Dividiremos por tanto nuestro paquete en varios módulos o subpaquetes: Módulo o servicio de Autenticacion Módulo o servicio de Autorización Módulo o servicio de Firma Módulo o servicio del Gestor Documental electrónico (GDE) Módulo o servicio del Portafirmas Módulo o servicio de Catastro

Para la implementación en PHP se ha utilizado la extensión SOAP

Autor
David Pascual pascu.nosp@m.al_d.nosp@m.av@ex.nosp@m.tern.nosp@m.osgva.nosp@m..es
Pablo Belenguer belen.nosp@m.guer.nosp@m._pab@.nosp@m.exte.nosp@m.rnos..nosp@m.gva..nosp@m.es
Jorge Belenguer belen.nosp@m.guer.nosp@m._jor@.nosp@m.exte.nosp@m.rnosg.nosp@m.va.e.nosp@m.s
Ver también
SoapClient,
Desde
Class disponible desde Release 1.0.0

Definición en la línea 75 del archivo WSComunFClient.php.

Documentación del constructor y destructor

◆ __construct()

__construct (   $v_wsdl,
  $v_opciones = null 
)

Contructor. Recibe los parámetros necesarios para poner en marcha el cliente.

El cliente puede llegar a conectarse a tres servicios distintos (módulos), autenticación, autorización y firma. Cada uno de ellos tiene su correspondiente WSDL. Las URI de los msimos se pasan como parámetros.

Parámetros
array$v_wsdlArray asociativo [autentica,autoriza,firma] con las URLS a los WSDLs correspondientes a cada servicio
string$v_opcionesArray asociativo de opciones [enableWSSecurity, enableTrazabilidadPAI, idAPP, certFile, keyFile, passPhrase]. public

Definición en la línea 266 del archivo WSComunFClient.php.

Documentación de las funciones miembro

◆ __clienteOn()

__clienteOn (   $tipo,
  $trazabilidadPai = true,
  $opcionesClienteWS = null 
)
protected

Construye una instancia del cliente SOAP correspondiente al tipo recibido por parámetro, o todos si nulo

protected

Parámetros
string$tipoCadena con los valores (autentica, autoriza, firma, GDE) o null si todos
boolean$trazabilidadPaiBooleano que indica si se debe incluir o no la trazabilidad de la PAI

Definición en la línea 857 del archivo WSComunFClient.php.

◆ __getClient()

__getClient (   $tipo)

Devuelve la instancia del cliente WSSSoapClient recibido por parámetro, o null si no existe.

private

Parámetros
string$tipoCadena con los valores (autentica, autoriza, firma, GDE)
Devuelve
WSSSoapClient Devuelve el objeto o null si error

Definición en la línea 819 del archivo WSComunFClient.php.

◆ addDebugInfo()

addDebugInfo (   $info)

Añade información al Debug

Parámetros
string$infoCadena con información de debug public

Definición en la línea 592 del archivo WSComunFClient.php.

◆ array2ObjectTree()

array2ObjectTree (   $array)
protected

Convierte un array en un arbol de objetos

protected

Parámetros
array$arrayArray a convertir
Devuelve
stdClass Devuelve el objeto equivalente

Definición en la línea 1051 del archivo WSComunFClient.php.

◆ disableTrazabilidadPAI()

disableTrazabilidadPAI ( )

Desactiva el uso de la trazabilidad en la PAI public

Definición en la línea 805 del archivo WSComunFClient.php.

◆ disableWSSecurity()

disableWSSecurity ( )

Desactiva el uso de WSSecurity public

Definición en la línea 785 del archivo WSComunFClient.php.

◆ enableTrazabilidadPAI()

enableTrazabilidadPAI ( )

Activa el uso de la trazabilidad en la PAI public

Definición en la línea 795 del archivo WSComunFClient.php.

◆ enableWSSecurity()

enableWSSecurity ( )

Activa el uso de WSSecurity public

Definición en la línea 775 del archivo WSComunFClient.php.

◆ getCertificateInfo()

static getCertificateInfo (   $ruta,
  $formato = null 
)
static

Devuelve un array asociativo con la información del certificado X509 de acuerdo a su formato

Parámetros
stringFormato [PEM, ]
Devuelve
array Array asociativo con la información extraída del certificado public

Definición en la línea 693 del archivo WSComunFClient.php.

◆ getCertificateSerial()

getCertificateSerial (   $set = true)

Devuelve el número de serie del certificado leyéndolo del propio fichero PEM

Devuelve
string EL número de serie del certificado como cadena (en hexadecimal) public

Definición en la línea 658 del archivo WSComunFClient.php.

◆ getClientIP()

static getClientIP ( )
static

Trata de obtener la IP correcta del cliente

Devuelve
string

Definición en la línea 1315 del archivo WSComunFClient.php.

◆ getDebugInfo()

getDebugInfo ( )

Devuelve el array que contiene las trazas del DEBUG

$return array Array de cadenas (XML o no) con la informacion de traza public

Definición en la línea 557 del archivo WSComunFClient.php.

◆ getDebugMode()

getDebugMode ( )

Devuelve si está activado el modo DEBUG o no

$return boolean true si activo, falso en otro caso public

Definición en la línea 545 del archivo WSComunFClient.php.

◆ loadTracertPAI()

loadTracertPAI (   $vTrazabilidadPAI)

Carga información para cabeceras de trazabilidad en la PAI.

Parámetros
array$vTrazabilidadPAIArray asociativo {idApp|[nsCert]} con el ID CATI de la aplicación y el número de serie (opcional) public

Definición en la línea 752 del archivo WSComunFClient.php.

◆ numberBaseConvert()

static numberBaseConvert (   $numstring,
  $frombase = 10,
  $tobase = 16 
)
static

Recibe un string que representa un número, la base en la que se expresa y la base destino

Utilizado debido a las limitaciones en ciertos entorno trabajando con números grandes y donde puede no estar disponible la librería BC Math

Parámetros
string$numstringrepresentación del número (como cadena)
integer$frombasebase origen (decimal por defecto)
integer$tobasebse destino (hexadecimal por defecto)
Devuelve
string

Definición en la línea 1276 del archivo WSComunFClient.php.

◆ objectTree2array()

objectTree2array (   $obj)
protected

Convierte un objeto en un array asociativo

private

Parámetros
array$arrayArray a convertir
Devuelve
stdClass Devuelve el objeto equivalente

Definición en la línea 1085 del archivo WSComunFClient.php.

◆ setCertFile()

setCertFile (   $pathCert)

Recibe la ruta al fichero que contiene el cetificado (unicamente el certificado y en formato PEM)

Parámetros
string$pathCertRuta al fichero que contiene el certificado public

Definición en la línea 633 del archivo WSComunFClient.php.

◆ setDebugMode()

setDebugMode (   $activo)

Fija el modo debug a TRUE. Implica opciones SoapClient [cache_wsdl = WSDL_CACHE_NONE]

Parámetros
boolean$activotrue/false para fijar activar el modo o no public

Definición en la línea 570 del archivo WSComunFClient.php.

◆ setKeyFile()

setKeyFile (   $pathKey)

Recibe la ruta al fichero que contiene la clave (unicamente la clave y en formato PEM)

Parámetros
string$pathKeyRuta al fichero que contiene la key public

Definición en la línea 609 del archivo WSComunFClient.php.

◆ setPassPhrase()

setPassPhrase (   $passphrase)

Recibe la frase que permite utilizar la key

Parámetros
string$passphraseFrase de paso para utilizar la clave (key) public

Definición en la línea 621 del archivo WSComunFClient.php.

◆ setWSDLTimeOut()

setWSDLTimeOut (   $segs)

Fija el tiempo (segundos) de espera máximo para acceder a WSDL

Parámetros
integer$segsNúmero de segundos public

Definición en la línea 645 del archivo WSComunFClient.php.

◆ tratarMTOMEstandar()

tratarMTOMEstandar (   $response,
  $itemToReturn = null 
)
protected

Trata los mensajes MTOM y reconvierte la respuesta a fomato NO MOTOM. Si tiene anexos los codifica como B64

Limitación. El SoapClient de PHP no permite ver la cabecera HTTP original, sino solo la cabecera SOAP. Esto limita la forma de detectar contenido MTOM, que sigue el estandar Multipart

Parámetros
array$responseRespuesta original del WSService invocado (con contenido MTOM)
string$itemToReturnElemento del cuerpo del RESPONSE a partir del cual se debe construir el array de la respuesta
Devuelve
array Array asociativo de respuesta reconstrida a formato no MTOM

Definición en la línea 1135 del archivo WSComunFClient.php.

Documentación de los campos

◆ $MYSOAPOP_TRACE

$MYSOAPOP_TRACE = true
staticprotected

Constantes para el control de opciones del cliente SOAP sólo hay que variarlas para desarrollo, relacionadas con el modo DEBUG a true

Definición en la línea 111 del archivo WSComunFClient.php.

◆ $NAMESPACE_GVA

$NAMESPACE_GVA = 'http://dgm.gva.es/ayf/war/schemas/v2_00'
staticprotected

Contantes para los NS

Definición en la línea 120 del archivo WSComunFClient.php.

◆ KEYCLIENTE_AUTENTICA

const KEYCLIENTE_AUTENTICA = 'autentica'

Constantes para el tipo de cliente

Definición en la línea 80 del archivo WSComunFClient.php.

◆ TIPOBUSQUEDA_USUARIO

const TIPOBUSQUEDA_USUARIO = 'USUARIO'

Constantes para el parámetro tipo de búsqueda en el módulo de autorización

Definición en la línea 101 del archivo WSComunFClient.php.


La documentación para esta clase fue generada a partir del siguiente fichero: