WSComun  1.6.5
Web Services Comunes para PHP/GVHidra
Métodos públicos | Atributos protegidos
Referencia de la Clase WSSSoapClient
Diagrama de herencias de WSSSoapClient

Métodos públicos

 __construct ($wsdl, $vOptions=null)
 
 setKeyFile ($pathKey)
 
 getKeyFile ()
 
 setPassPhrase ($passphrase)
 
 getPassPhrase ()
 
 setCertFile ($pathCert)
 
 getCertFile ()
 
 loadCert ($vCertData)
 
 isMTOM ()
 
 loadTracertPAI ($vTrazabilidadPAI)
 
 enablePAITrace___ ($vTrazabilidadPAI=null)
 
 disablePAITrace ()
 
 enableWSSecurity ()
 
 disableWSSecurity ()
 
 getCertificateSerial ()
 
 __doRequest ($newRequest, $location, $action, $version, $one_way=null)
 

Atributos protegidos

 $keyFile =''
 
 $passPhrase =''
 
 $certFile =''
 
 $nsCert = null
 
 $idApp = null
 
 $mtom = false
 

Descripción detallada

Definición en la línea 32 del archivo WSSSoapClient.php.

Documentación del constructor y destructor

__construct (   $wsdl,
  $vOptions = null 
)

Contructor. Inicializa atributos propios e invoca al constructor padre.

Parámetros
string$wsdlURL asociado a los WSDLs correspondientes a cada servicio [autenticacion, autorizacion, firma]
string$vOptionsArray de opciones del cliente SOAP public

Definición en la línea 82 del archivo WSSSoapClient.php.

Documentación de las funciones miembro

__doRequest (   $newRequest,
  $location,
  $action,
  $version,
  $one_way = null 
)

Sobrecargamos el método __doRequest para que se incluyan las cabeceras del protocolo SOAP WS-security. Ademas se deteca el uo de MTOM y se marca como propiedad.

Parámetros
array$v_wsdlArray asociativo con los WSDLs correspondientes a cada servicio [autenticacion,autorizacion,firma]
string$v_datosCertifArray asociativo con los datos del certificado de aplicación necesarios para acceder. [rutaCert, rutaKey, passphrase].
Devuelve
string Cadena aleatorio (token) generado en el servidor public

Definición en la línea 423 del archivo WSSSoapClient.php.

disablePAITrace ( )

Desactiva el uso de cabeceras de trazabilidad en la PAI public

Definición en la línea 301 del archivo WSSSoapClient.php.

disableWSSecurity ( )

Desactiva el uso de WSSecurity public

Definición en la línea 322 del archivo WSSSoapClient.php.

enablePAITrace___ (   $vTrazabilidadPAI = null)

Activa el uso de cabeceras de trazabilidad en la PAI

Parámetros
array$vTrazabilidadPAIArray asociativo [nsCert|idApp|conTrazabilidadPAI] si se requiera trazabilidad en la invocación public

Definición en la línea 265 del archivo WSSSoapClient.php.

enableWSSecurity ( )

Activa el uso de WSSecurity public

Definición en la línea 312 del archivo WSSSoapClient.php.

getCertFile ( )

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

Devuelve
string $pathCert Ruta al fichero que contiene el certificado public

Definición en la línea 171 del archivo WSSSoapClient.php.

getCertificateSerial ( )

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 335 del archivo WSSSoapClient.php.

getKeyFile ( )

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

Devuelve
string $pathKey Ruta al fichero que contiene la clave public

Definición en la línea 124 del archivo WSSSoapClient.php.

getPassPhrase ( )

Devuelve la frase de paso de la key o null si no tiene

Devuelve
string $pathCert Frase de paso de la key public

Definición en la línea 148 del archivo WSSSoapClient.php.

isMTOM ( )

Devuelve si tratamos con un servicio MTOM

Devuelve
string $soapSent Envío SOAP public

Definición en la línea 220 del archivo WSSSoapClient.php.

loadCert (   $vCertData)

Carga la información del certificado

Parámetros
array$vCertDataArray asociativo {certFile|keyFile|[passPhrase]} con ruta al certificado, ruta al fichero clave y opcionalmente frase de paso public

Definición en la línea 183 del archivo WSSSoapClient.php.

loadTracertPAI (   $vTrazabilidadPAI)

Carga la información para el uso de cabeceras de trazabilidad en la PAI

Parámetros
array$vTrazabilidadPAIArray asociativo {nsCert|idApp|} con num serie del certificado y el ID CATI de la aplicación public

Definición en la línea 236 del archivo WSSSoapClient.php.

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 160 del archivo WSSSoapClient.php.

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 112 del archivo WSSSoapClient.php.

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 136 del archivo WSSSoapClient.php.

Documentación de los campos

$passPhrase =''
protected

de la clave privada

Definición en la línea 42 del archivo WSSSoapClient.php.


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