![]() |
WSCOMUN
2.0.0
Web Services Comunes para PHP/GVHidra
|
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 | makeWSClient ($wsID, $v_wsdl, $v_opciones=null) |
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 | 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 | |
$enableWSSecurity = true | |
$enableTrazabilidadPAI = 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' |
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
Definición en la línea 72 del archivo WSComunFClient.php.
__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.
array | $v_wsdl | Array asociativo [autentica,autoriza,firma] con las URLS a los WSDLs correspondientes a cada servicio |
string | $v_opciones | Array asociativo de opciones [enableWSSecurity, enableTrazabilidadPAI, idAPP, certFile, keyFile, passPhrase]. public |
Definición en la línea 242 del archivo WSComunFClient.php.
|
protected |
Construye una instancia del cliente SOAP correspondiente al tipo recibido por parámetro, o todos si nulo
protected
string | $tipo | Cadena con los valores (autentica, autoriza, firma, GDE) o null si todos |
boolean | $trazabilidadPai | Booleano que indica si se debe incluir o no la trazabilidad de la PAI |
Definición en la línea 781 del archivo WSComunFClient.php.
__getClient | ( | $tipo | ) |
Devuelve la instancia del cliente WSSSoapClient recibido por parámetro, o null si no existe.
private
string | $tipo | Cadena con los valores (autentica, autoriza, firma, GDE) |
Definición en la línea 743 del archivo WSComunFClient.php.
addDebugInfo | ( | $info | ) |
Añade información al Debug
string | $info | Cadena con información de debug public |
Definición en la línea 516 del archivo WSComunFClient.php.
|
protected |
Convierte un array en un arbol de objetos
protected
array | $array | Array a convertir |
Definición en la línea 995 del archivo WSComunFClient.php.
disableTrazabilidadPAI | ( | ) |
Desactiva el uso de la trazabilidad en la PAI public
Definición en la línea 729 del archivo WSComunFClient.php.
disableWSSecurity | ( | ) |
Desactiva el uso de WSSecurity public
Definición en la línea 709 del archivo WSComunFClient.php.
enableTrazabilidadPAI | ( | ) |
Activa el uso de la trazabilidad en la PAI public
Definición en la línea 719 del archivo WSComunFClient.php.
enableWSSecurity | ( | ) |
Activa el uso de WSSecurity public
Definición en la línea 699 del archivo WSComunFClient.php.
|
static |
Devuelve un array asociativo con la información del certificado X509 de acuerdo a su formato
string | Formato [PEM, ] |
Definición en la línea 617 del archivo WSComunFClient.php.
getCertificateSerial | ( | $set = true | ) |
Devuelve el número de serie del certificado leyéndolo del propio fichero PEM
Definición en la línea 582 del archivo WSComunFClient.php.
|
static |
Trata de obtener la IP correcta del cliente
Definición en la línea 1259 del archivo WSComunFClient.php.
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 481 del archivo WSComunFClient.php.
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 469 del archivo WSComunFClient.php.
loadTracertPAI | ( | $vTrazabilidadPAI | ) |
Carga información para cabeceras de trazabilidad en la PAI.
array | $vTrazabilidadPAI | Array 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 676 del archivo WSComunFClient.php.
|
static |
Factoría. Devuelve el cliente del WS especificado. Recibe los parámetros necesarios para poner en marcha el cliente.
El cliente puede llegar a conectarse a múltiples servicios distintos (módulos). Cada uno de ellos tiene su correspondiente WSDL. Las URI de los mismos se pasan como parámetros.
string | $wsID | Identificador del WS solicitado |
array | $v_wsdl | Array asociativo [autentica,autoriza,firma] con las URLS a los WSDLs correspondientes a cada servicio |
string | $v_opciones | Array asociativo con distintos datos [enableWSSecurity, enableTrazabilidadPAI, idAPP, certFile, keyFile, passPhrase]. Los dos primeros son rutas a los ficheros PEM y el tercero una cadena de constraseña |
Definición en la línea 341 del archivo WSComunFClient.php.
|
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
string | $numstring | representación del número (como cadena) |
integer | $frombase | base origen (decimal por defecto) |
integer | $tobase | bse destino (hexadecimal por defecto) |
Definición en la línea 1220 del archivo WSComunFClient.php.
|
protected |
Convierte un objeto en un array asociativo
private
array | $array | Array a convertir |
Definición en la línea 1029 del archivo WSComunFClient.php.
setCertFile | ( | $pathCert | ) |
Recibe la ruta al fichero que contiene el cetificado (unicamente el certificado y en formato PEM)
string | $pathCert | Ruta al fichero que contiene el certificado public |
Definición en la línea 557 del archivo WSComunFClient.php.
setDebugMode | ( | $activo | ) |
Fija el modo debug a TRUE. Implica opciones SoapClient [cache_wsdl = WSDL_CACHE_NONE]
boolean | $activo | true/false para fijar activar el modo o no public |
Definición en la línea 494 del archivo WSComunFClient.php.
setKeyFile | ( | $pathKey | ) |
Recibe la ruta al fichero que contiene la clave (unicamente la clave y en formato PEM)
string | $pathKey | Ruta al fichero que contiene la key public |
Definición en la línea 533 del archivo WSComunFClient.php.
setPassPhrase | ( | $passphrase | ) |
Recibe la frase que permite utilizar la key
string | $passphrase | Frase de paso para utilizar la clave (key) public |
Definición en la línea 545 del archivo WSComunFClient.php.
setWSDLTimeOut | ( | $segs | ) |
Fija el tiempo (segundos) de espera máximo para acceder a WSDL
integer | $segs | Número de segundos public |
Definición en la línea 569 del archivo WSComunFClient.php.
|
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
array | $response | Respuesta original del WSService invocado (con contenido MTOM) |
string | $itemToReturn | Elemento del cuerpo del RESPONSE a partir del cual se debe construir el array de la respuesta |
Definición en la línea 1079 del archivo WSComunFClient.php.
|
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 105 del archivo WSComunFClient.php.
|
staticprotected |
Contantes para los NS
Definición en la línea 114 del archivo WSComunFClient.php.
const KEYCLIENTE_AUTENTICA = 'autentica' |
Constantes para el tipo de cliente
Definición en la línea 77 del archivo WSComunFClient.php.
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 95 del archivo WSComunFClient.php.