WSCOMUN  2.1.2
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 ()
 
 setUserToken ($username, $password)
 
 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()

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

Documentación de las funciones miembro

◆ __doRequest()

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

◆ disablePAITrace()

disablePAITrace ( )

Desactiva el uso de cabeceras de trazabilidad en la PAI public

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

◆ disableWSSecurity()

disableWSSecurity ( )

Desactiva el uso de WSSecurity public

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

◆ enablePAITrace___()

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

◆ enableWSSecurity()

enableWSSecurity ( )

Activa el uso de WSSecurity public

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

◆ getCertFile()

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

◆ getCertificateSerial()

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

◆ getKeyFile()

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

◆ getPassPhrase()

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

◆ isMTOM()

isMTOM ( )

Devuelve si tratamos con un servicio MTOM

Devuelve
string $soapSent Envío SOAP public

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

◆ loadCert()

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

◆ loadTracertPAI()

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 250 del archivo WSSSoapClient.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 174 del archivo WSSSoapClient.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 126 del archivo WSSSoapClient.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 150 del archivo WSSSoapClient.php.

◆ setUserToken()

setUserToken (   $username,
  $password 
)

Establece los datos a utilizar en el UserToken

Parámetros
string$usernameNombre de usuario a emplear en el userToken
string$passwordContraseña a emplear en el userToken public

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


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