WSComun  1.6.5
Web Services Comunes para PHP/GVHidra
Métodos públicos
Referencia de la Clase WSClientPortafirmas
Diagrama de herencias de WSClientPortafirmas
WSComunFClient

Métodos públicos

 pf_downloadDocument ($username, $password, $documentId)
 
 pf_downloadSign ($username, $password, $documentId)
 
 pf_queryDocumentTypes ($username, $password, $query)
 
 pf_queryJobs ($username, $password, $query)
 
 pf_queryRequest ($username, $password, $requestId)
 
 pf_queryStates ($username, $password, $query)
 
 pf_queryUsers ($username, $password, $query)
 
 pf_queryImportanceLevels ($username, $password, $query)
 
 pf_queryEnhancedUsers ($username, $password, $queryUser, $querySeat)
 
 pf_queryEnhancedJobs ($username, $password, $queryJob, $querySeat)
 
 pf_queryEnhancedUserJobAssociatedToJob ($username, $password, $jobIdentifier)
 
 pf_queryEnhancedUserJobAssociatedToUser ($username, $password, $userIdentifier)
 
 pf_querySeats ($username, $password, $query)
 
 pf_querySign ($username, $password, $documentId)
 
 pf_mod_createRequest ($username, $password, $request)
 
 pf_mod_deleteDocument ($username, $password, $documentId)
 
 pf_mod_deleteRequest ($username, $password, $requestId)
 
 pf_mod_deleteSigners ($username, $password, $requestId, $signerList)
 
 pf_mod_insertDocument ($username, $password, $requestId, $document)
 
 pf_mod_insertSigners ($username, $password, $requestId, $signLine, $signerList, $signLineType)
 
 pf_mod_sendRequest ($username, $password, $requestId)
 
 pf_mod_updateRequest ($username, $password, $request)
 
 pf_mod_removeRequest ($username, $password, $requestId, $removingMessage)
 
 pf_adm_insertEnhancedUsers ($username, $password, $enhancedUserList)
 
 pf_adm_updateEnhancedUsers ($username, $password, $enhancedUserList)
 
 pf_adm_deleteUsers ($username, $password, $userIdentifierList)
 
 pf_adm_insertEnhancedJobs ($username, $password, $enhancedJobList)
 
 pf_adm_updateEnhancedJobs ($username, $password, $enhancedJobList)
 
 pf_adm_deleteJobs ($username, $password, $jobIdentifierList)
 
 pf_adm_assignJobToUser ($username, $password, $jobIdentifier, $userIdentifier, $fstart, $fend)
 
 pf_adm_separateJobToUser ($username, $password, $jobIdentifier, $userIdentifier)
 
- Métodos públicos heredados desde WSComunFClient
 __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)
 

Otros miembros heredados

- Métodos públicos estáticos heredados desde WSComunFClient
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 heredados desde WSComunFClient
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 heredados desde WSComunFClient
 __clienteOn ($tipo, $trazabilidadPai=true, $opcionesClienteWS=null)
 
 array2ObjectTree ($array)
 
 objectTree2array ($obj)
 
 tratarExcepcionEstandar ($e, $clienteWS)
 
 tratarMTOMEstandar ($response, $itemToReturn=null)
 
 xml_to_array (&$root)
 
- Atributos protegidos heredados desde WSComunFClient
 $v_clienteWS
 
 $passPhrase =null
 
 $vTrazabilidad
 
 $enableWSSecurity = true
 
 $enableTrazabilidadPAI = true
 
- Atributos protegidos estáticos heredados desde WSComunFClient
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'
 

Descripción detallada

Definición en la línea 12 del archivo WSClientPortafirmas.php.

Documentación de las funciones miembro

pf_adm_assignJobToUser (   $username,
  $password,
  $jobIdentifier,
  $userIdentifier,
  $fstart,
  $fend 
)

Asigna un cargo a un usuario para un determinado periodo de tiempo

Parámetros
string$usernameNombre de usuario
string$passwordContraseña del usuario
jobIdentifier$jobIdentifierIdentificador del cargo que se quiere asignar al usuario
userIdentifier$userIdentifierIdentificador del usuario al que se le quiere asignar el cargo
date$fstartFecha de inicio de la asociación usuario-cargo
date$fendFecha de finalización de la asociación
Devuelve
array Array asociativo con la respuesta del servicio [xxx] public

Definición en la línea 1870 del archivo WSClientPortafirmas.php.

pf_adm_deleteJobs (   $username,
  $password,
  $jobIdentifierList 
)

Elimina cargos de la aplicación

Parámetros
string$usernameNombre de usuario
string$passwordContraseña del usuario
jobIdentifierList$jobIdentifierListLista de identificadores de cargos a eliminar
Devuelve
array Array asociativo con la respuesta del servicio [xxx] public

Definición en la línea 1805 del archivo WSClientPortafirmas.php.

pf_adm_deleteUsers (   $username,
  $password,
  $userIdentifierList 
)

Elimina usuarios de la aplicación

Parámetros
string$usernameNombre de usuario
string$passwordContraseña del usuario
userIdentifierList$userIdentifierListLista de identificadores de usuario a eliminar
Devuelve
array Array asociativo con la respuesta del servicio [xxx] public

Definición en la línea 1619 del archivo WSClientPortafirmas.php.

pf_adm_insertEnhancedJobs (   $username,
  $password,
  $enhancedJobList 
)

Crea nuevos cargos en la aplicación

Parámetros
string$usernameNombre de usuario
string$passwordContraseña del usuario
enhancedJobList$enhancedJobListLista de cargos a insertar
Devuelve
array Array asociativo con la respuesta del servicio [xxx] public

Definición en la línea 1681 del archivo WSClientPortafirmas.php.

pf_adm_insertEnhancedUsers (   $username,
  $password,
  $enhancedUserList 
)

Crea nuevos usuarios en la aplicación

Parámetros
string$usernameNombre de usuario
string$passwordContraseña del usuario
enhancedUserList$enhancedUserListLista de usuarios a insertar
Devuelve
array Array asociativo con la respuesta del servicio [xxx] public

Definición en la línea 1495 del archivo WSClientPortafirmas.php.

pf_adm_separateJobToUser (   $username,
  $password,
  $jobIdentifier,
  $userIdentifier 
)

Elimina la relación usuario-cargo

Parámetros
string$usernameNombre de usuario
string$passwordContraseña del usuario
jobIdentifier$jobIdentifierdentificador del cargo del que se quiere eliminar la asociación
userIdentifier$userIdentifierIdentificador del usuario del que se quiere eliminar la asociación
Devuelve
array Array asociativo con la respuesta del servicio [xxx] public

Definición en la línea 1936 del archivo WSClientPortafirmas.php.

pf_adm_updateEnhancedJobs (   $username,
  $password,
  $enhancedJobList 
)

Modifica cargos en la aplicación

Parámetros
string$usernameNombre de usuario
string$passwordContraseña del usuario
enhancedJobList$enhancedJobListLista de cargos a modificar
Devuelve
array Array asociativo con la respuesta del servicio [xxx] public

Definición en la línea 1743 del archivo WSClientPortafirmas.php.

pf_adm_updateEnhancedUsers (   $username,
  $password,
  $enhancedUserList 
)

Modifica usuarios en la aplicación

Parámetros
string$usernameNombre de usuario
string$passwordContraseña del usuario
enhancedUserList$enhancedUserListLista de usuarios a modificar
Devuelve
array Array asociativo con la respuesta del servicio [xxx] public

Definición en la línea 1557 del archivo WSClientPortafirmas.php.

pf_downloadDocument (   $username,
  $password,
  $documentId 
)

Permite recuperar el contenido de un documento (binario y en B64) a partir del id del mismo

Parámetros
string$usernameNombre de usuario
string$passwordContraseña del usuario
string$documentIdIdentificador del documento
Devuelve
array Array asociativo con la respuesta del servicio [documentBinary|documentB64] public

Definición en la línea 47 del archivo WSClientPortafirmas.php.

pf_downloadSign (   $username,
  $password,
  $documentId 
)

Permite recuperar la firma de un documento (array asociativo) a partir del id del documento

Parámetros
string$usernameNombre de usuario
string$passwordContraseña del usuario
string$documentIdIdentificador del documento
Devuelve
array Array asociativo [signature] [[identifier],[sign],[signFormat],[csv],[csvAnulado],[csvNormativa],[content]] public

Definición en la línea 113 del archivo WSClientPortafirmas.php.

pf_mod_createRequest (   $username,
  $password,
  $request 
)

Sirve para crear una petición en el portafirmas

Parámetros
string$usernameNombre de usuario
string$passwordContraseña del usuario
request$requestDatos de la peticion
Devuelve
array Array asociativo con la respuesta del servicio [xxx] public

Definición en la línea 927 del archivo WSClientPortafirmas.php.

pf_mod_deleteDocument (   $username,
  $password,
  $documentId 
)

Permite quitar un documento de una petición que ha sido creada, pero que todavía no ha sido enviada

Parámetros
string$usernameNombre de usuario
string$passwordContraseña del usuario
string$documentIdIdentificador del documento
Devuelve
array Array asociativo con la respuesta del servicio [xxx] public

Definición en la línea 988 del archivo WSClientPortafirmas.php.

pf_mod_deleteRequest (   $username,
  $password,
  $requestId 
)

Permite eliminar una petición que ha sido creada, pero que todavía no ha sido enviada

Parámetros
string$usernameNombre de usuario
string$passwordContraseña del usuario
string$requestIdIdentificador de la peticion
Devuelve
array Array asociativo con la respuesta del servicio [xxx] public

Definición en la línea 1050 del archivo WSClientPortafirmas.php.

pf_mod_deleteSigners (   $username,
  $password,
  $requestId,
  $signerList 
)

Permite eliminar firmantes de una petición que ha sido creada, pero que todavía no ha sido enviada

Parámetros
string$usernameNombre de usuario
string$passwordContraseña del usuario
string$requestIdIdentificador de la peticion
signerList$signerListLista de firmantes
Devuelve
array Array asociativo con la respuesta del servicio [xxx] public

Definición en la línea 1113 del archivo WSClientPortafirmas.php.

pf_mod_insertDocument (   $username,
  $password,
  $requestId,
  $document 
)

Permite añadir un documento a una petición que ha sido creada, pero que todavía no ha sido enviada

Parámetros
string$usernameNombre de usuario
string$passwordContraseña del usuario
string$requestIdIdentificador de la peticion
document$documentDeclaración del documento
Devuelve
array Array asociativo con la respuesta del servicio [xxx] public

Definición en la línea 1177 del archivo WSClientPortafirmas.php.

pf_mod_insertSigners (   $username,
  $password,
  $requestId,
  $signLine,
  $signerList,
  $signLineType 
)

Permite añadir una nueva linea de firma a una petición que ha sido creada, pero que todavía no ha sido enviada

Parámetros
string$usernameNombre de usuario
string$passwordContraseña del usuario
string$requestIdIdentificador de la peticion
int$signLineLinea en la que se inserta la firma
signerList$signerListLista de cargos y usuarios que se quieren quitar de la linea
string$signLineTypeIndica si debe ser firmada o se debe dar el visto bueno [FIRMA|VISTOBUENO]
Devuelve
array Array asociativo con la respuesta del servicio [xxx] public

Definición en la línea 1243 del archivo WSClientPortafirmas.php.

pf_mod_removeRequest (   $username,
  $password,
  $requestId,
  $removingMessage 
)

Permite retirar una petición enviada que no se encuentra en un estado final

Parámetros
string$usernameNombre de usuario
string$passwordContraseña del usuario
string$requestIdIdentificador de la peticion
string$removingMessageMensaje de usuario con el motivo del retiro de la petición
Devuelve
array Array asociativo con la respuesta del servicio [xxx] public

Definición en la línea 1432 del archivo WSClientPortafirmas.php.

pf_mod_sendRequest (   $username,
  $password,
  $requestId 
)

Permite enviar una petición que ha sido creada, pero que todavía no ha sido enviada

Parámetros
string$usernameNombre de usuario
string$passwordContraseña del usuario
string$requestIdIdentificador de la peticion
Devuelve
array Array asociativo con la respuesta del servicio [xxx] public

Definición en la línea 1307 del archivo WSClientPortafirmas.php.

pf_mod_updateRequest (   $username,
  $password,
  $request 
)

Permite actualizar la información una petición que ha sido creada, pero que todavía no ha sido enviada

Parámetros
string$usernameNombre de usuario
string$passwordContraseña del usuario
request$requestElemento complejo que representa una petición
Devuelve
array Array asociativo con la respuesta del servicio [xxx] public

Definición en la línea 1369 del archivo WSClientPortafirmas.php.

pf_queryDocumentTypes (   $username,
  $password,
  $query 
)

Permite recuperar los tipos de documento disponibles

Parámetros
string$usernameNombre de usuario
string$passwordContraseña del usuario
string$queryValor de búsqueda o null
Devuelve
array Array asociativo con la respuesta del servicio [xxx] public

Definición en la línea 180 del archivo WSClientPortafirmas.php.

pf_queryEnhancedJobs (   $username,
  $password,
  $queryJob,
  $querySeat 
)

Permite recuperar una lista de cargos válidos con algo más de información a partir de una consulta

Parámetros
string$usernameNombre de usuario
string$passwordContraseña del usuario
string$queryJobFiltro de cargo / Null
string$querySeatFiltro de sedes / Null
Devuelve
array Array asociativo con la respuesta del servicio [xxx] public

Definición en la línea 617 del archivo WSClientPortafirmas.php.

pf_queryEnhancedUserJobAssociatedToJob (   $username,
  $password,
  $jobIdentifier 
)

Recupera la lista de usuarios asociados a un cargo. Un cargo sólo puede tener asociado a un usuario en un determinado periodo de tiempo

Parámetros
string$usernameNombre de usuario
string$passwordContraseña del usuario
string$jobIdentifierIdentificador del cargo
Devuelve
array Array asociativo con la respuesta del servicio [xxx] public

Definición en la línea 680 del archivo WSClientPortafirmas.php.

pf_queryEnhancedUserJobAssociatedToUser (   $username,
  $password,
  $userIdentifier 
)

Recupera la lista de cargos asociados a un usuario

Parámetros
string$usernameNombre de usuario
string$passwordContraseña del usuario
string$userIdentifierIdentificador del usuario
Devuelve
array Array asociativo con la respuesta del servicio [xxx] public

Definición en la línea 742 del archivo WSClientPortafirmas.php.

pf_queryEnhancedUsers (   $username,
  $password,
  $queryUser,
  $querySeat 
)

Permite recuperar una lista de usuarios válidos con algo más de información a partir de una consulta

Parámetros
string$usernameNombre de usuario
string$passwordContraseña del usuario
string$queryUserFiltro de usuarios / Null
string$querySeatFiltro de sedes / Null
Devuelve
array Array asociativo con la respuesta del servicio [xxx] public

Definición en la línea 553 del archivo WSClientPortafirmas.php.

pf_queryImportanceLevels (   $username,
  $password,
  $query 
)

Permite recuperar los niveles de importancia disponibles

Parámetros
string$usernameNombre de usuario
string$passwordContraseña del usuario
string$queryValor de búsqueda o null
Devuelve
array Array asociativo con la respuesta del servicio [xxx] public

Definición en la línea 490 del archivo WSClientPortafirmas.php.

pf_queryJobs (   $username,
  $password,
  $query 
)

Permite recuperar los cargos disponibles

Parámetros
string$usernameNombre de usuario
string$passwordContraseña del usuario
string$queryValor de búsqueda o null
Devuelve
array Array asociativo con la respuesta del servicio [xxx] public

Definición en la línea 242 del archivo WSClientPortafirmas.php.

pf_queryRequest (   $username,
  $password,
  $requestId 
)

Permite recuperar una petición existente en el servidor

Parámetros
string$usernameNombre de usuario
string$passwordContraseña del usuario
string$requestIdIdentificador de la peticion.
Devuelve
array Array asociativo con la respuesta del servicio [xxx] public

Definición en la línea 304 del archivo WSClientPortafirmas.php.

pf_querySeats (   $username,
  $password,
  $query 
)

Recupera las sedes que cumplen una determinada condición

Parámetros
string$usernameNombre de usuario
string$passwordContraseña del usuario
string$queryValor de búsqueda o null
Devuelve
array Array asociativo con la respuesta del servicio [xxx] public

Definición en la línea 804 del archivo WSClientPortafirmas.php.

pf_querySign (   $username,
  $password,
  $documentId 
)

Permite recuperar la información del Código Seguro de Validación (CSV) asociado al documento así como la referencia del mismo en el sistema GDE

Parámetros
string$usernameNombre de usuario
string$passwordContraseña del usuario
string$queryIdentificador del documento
Devuelve
array Array asociativo con la respuesta del servicio [xxx] public

Definición en la línea 866 del archivo WSClientPortafirmas.php.

pf_queryStates (   $username,
  $password,
  $query 
)

Permite recuperar los estados disponibles

Parámetros
string$usernameNombre de usuario
string$passwordContraseña del usuario
string$queryValor de búsqueda o null
Devuelve
array Array asociativo con la respuesta del servicio [xxx] public

Definición en la línea 366 del archivo WSClientPortafirmas.php.

pf_queryUsers (   $username,
  $password,
  $query 
)

Permite recuperar los usuarios disponibles.

Parámetros
string$usernameNombre de usuario
string$passwordContraseña del usuario
string$queryValor de búsqueda o null
Devuelve
array Array asociativo con la respuesta del servicio [xxx] public

Definición en la línea 428 del archivo WSClientPortafirmas.php.


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