WSComun  1.6.5
Web Services Comunes para PHP/GVHidra
Métodos públicos | Métodos públicos estáticos | Campos de datos | Métodos protegidos | Atributos protegidos
Referencia de la Clase WSComunClient

Métodos públicos

 __construct ($v_wsdl, $v_datosCertif, $idAPP=null)
 
 getDebugMode ()
 
 getDebugInfo ()
 
 setDebugMode ($activo)
 
 addDebugInfo ($info)
 
 setKeyFile ($pathKey)
 
 setPassPhrase ($passphrase)
 
 setCertFile ($pathCert)
 
 setWSDLTimeOut ($segs)
 
 getCertificateSerial ()
 
 loadTracertPAI ($vTrazabilidadPAI)
 
 enableWSSecurity ()
 
 disableWSSecurity ()
 
 tratarExcepcionEstandar ($e, $clienteWS)
 
 autenticaUsuarioWS ($user, $pass)
 
 autenticaUsuarioLDAPWS ($user, $pass)
 
 autenticaConFirmaWS ($firmaB64, $codigoEntidad=null)
 
 getInformacionWS ($token)
 
 getInformacionLDAP ($user, $pass)
 
 getInformacionHDFI ($user, $pass)
 
 retornaAutorizacionWS ($usuarioHDFI, $idAplicacion)
 
 retornaTodasAutorizacionesWS ($usuarioHDFI)
 
 retornaTodasAutorizacionesDNIWS ($usuarioDNI, $tipoBusqueda)
 
 firmarCertificadoServer ($idSession, $idCertificado, $docContentB64, $tipoDoc='TF06')
 
 insertarDocumentoGDE ($codApp, $docContentB64, $nombreDoc, $pathDoc='', $vMetadatosENI=null, $vMetadatosPersonalizados=null)
 
 obtenerDocumentoGDE ($codApp, $refDoc, $parcial='1')
 
 eliminarDocumentoGDE ($codApp, $refDoc)
 
 eliminarCarpetaGDE ($codApp, $path)
 
 castellanoValenciano ($texto)
 
 valencianoCastellano ($texto)
 
 __getClient ($tipo)
 
 csv_encodeClaveAcceso ($appID, $nif, $referenciaExterna, $firmante)
 
 obtenerCodigo ($appID, $nif, $referenciaExterna, $firmante, $generarBarCode=null, $tipoBarCode=null, $width=null, $height=null)
 
 asociarCSV ($csv, $appID, $nif, $referenciaExterna, $firmante, $idRepositorio, $refDoc, $hash, $fechaCaducidad=null, $vParametros=null)
 
 invalidarCSV ($csv, $appID, $nif, $referenciaExterna, $firmante)
 
 modificarFechaCaducidadCSV ($csv, $appID, $nif, $referenciaExterna, $firmante, $fechaCaducidad)
 
 insertarDocumentoGDE2 ($codApp, $docContentB64, $nombreDoc, $pathDoc=null, $tipo=null, $vMetadatosENI=null, $vMetadatosPersonalizados=null, $vFirmas=null)
 
 obtenerDocumentoGDE2 ($codApp, $refDoc, $parcial='1')
 
 eliminarDocumentoGDE2 ($codApp, $refDoc)
 
 asociarFirmasGDE2 ($codApp, $refDoc, $vFirmas)
 
 buscarDocCriterioGDE2 ($codApp, $filtroPath=null, $buscarInTree=null, $operacion=null, $coleccionCriterios=null)
 
 buscarDocCriterioPaginadoGDE2 ($codApp, $registrosPagina, $pagina, $filtroPath=null, $buscarInTree=null, $operacion=null, $coleccionCriterios=null)
 
 crearCarpetaGDE2 ($codApp, $path, $tipo=null, $metadatosExpedienteEni=null, $coleccionMetadatosPersonalizados=null)
 
 eliminarCarpetaGDE2 ($codApp, $path)
 
 empaquetarDocumentoENIGDE2 ($codApp, $contenido, $vMetadatosEni, $vFirmas)
 
 establecerMetadatoCarpetasPersonalizadosGDE2 ($codApp, $path, $vColMetadatosPers)
 
 establecerMetadatosCarpetaExpedienteENIGDE2 ($codApp, $path, $vMetadatosExpedienteEni)
 
 establecerMetadatosENIGDE2 ($codApp, $refDoc, $vMetadatosEni)
 
 establecerMetadatosPersonalizadosGDE2 ($codApp, $refDoc, $coleccionMetadatosPersonalizados)
 
 generarIdentificadorENIGDE2 ($codApp)
 
 generarTokenGDE2 ($codApp, $vRefDoc)
 
 insertarDocumentoENIGDE2 ($codApp, $docContentB64, $nombreDoc, $pathDoc=null, $tipo=null, $vMetaENI=null, $vMetaPers=null, $vFirmas=null)
 
 obtenerDocumentoENIGDE2 ($codApp, $refDoc)
 
 obtenerExpedienteENIGDE2 ($codApp, $refDoc, $vMetadatosExpedienteEni, $idCertificadoSafe=null, $idSesionSafe=null)
 
 obtenerExpedienteENIdeCarpetaGDE2 ($codApp, $path, $idCertificadoSafe=null, $idSesionSafe=null)
 
 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)
 
 catastro ($IdPeticion, $NumElementos, $TimeStamp, $CodigoCertificado, $NifEmisor, $NombreEmisor, $CodProcedimiento, $NombreProcedimiento, $NombreCompletoFuncionario, $NifFuncionario, $IdentificadorSolicitante, $NombreSolicitante, $UnidadTramitadora, $Finalidad, $Consentimiento, $IdExpediente, $TipoDocumentacion, $Documentacion, $NombreCompleto, $Nombre, $Apellido1, $Apellido2, $CodigoCertificado, $IdSolicitud, $vDataEspecifico)
 
 catastroBienesPeticion ($IdPeticion, $TimeStamp, $CodigoCertificado, $NifEmisor, $NombreEmisor, $CodProcedimiento, $NombreProcedimiento, $NombreCompletoFuncionario, $NifFuncionario, $IdentificadorSolicitante, $NombreSolicitante, $UnidadTramitadora, $Finalidad, $Consentimiento, $IdExpediente, $TipoDocumentacion, $Documentacion, $NombreCompleto, $Nombre, $Apellido1, $Apellido2, $CodigoCertificado, $IdSolicitud, $vDataEspecifico)
 
 catastroBienesRespuesta ($IdPeticion, $TimeStamp, $CodigoCertificado, $NumElementos)
 
 catastroB ($IdPeticion, $TimeStamp, $CodigoCertificado, $oSolicitud)
 
 catastroBienesPeticionB ($IdPeticion, $TimeStamp, $CodigoCertificado, $vSolicitudes)
 
 catastroBienesRespuestaB ($IdPeticion, $TimeStamp, $CodigoCertificado, $NumElementos)
 

Métodos públicos estáticos

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

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 TIPOBUSQUEDA_USUARIO = 'USUARIO'
 
const TIPOBUSQUEDA_GRUPO = 'GRUPO'
 

Métodos protegidos

 tratarMTOMEstandar ($response, $itemToReturn=null)
 
 array2ObjectTree ($array)
 
 objectTree2array ($obj)
 

Atributos protegidos

 $vTrazabilidad
 
 $enableWSSecurity = true
 

Descripción detallada

Carga de la clase generica para soporte a clientes SOAP WS-Secure 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.

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 52 del archivo WSComunClient.php.

Documentación del constructor y destructor

__construct (   $v_wsdl,
  $v_datosCertif,
  $idAPP = 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_datosCertifArray asociativo [certFile, keyFile, passPhrase]. Los dos primeros son rutas a los ficheros PEM y el tercero una cadena de constraseña
Devuelve
string $idAPP Identificador de la aplicación en la PAI (opcional) public

Definición en la línea 194 del archivo WSComunClient.php.

Documentación de las funciones miembro

__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 1899 del archivo WSComunClient.php.

addDebugInfo (   $info)

Añade información al Debug

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

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

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 1928 del archivo WSComunClient.php.

asociarFirmasGDE2 (   $codApp,
  $refDoc,
  $vFirmas 
)

Permite asociar firmas a un documento (incluyendo CSV)

Parámetros
string$codAppCódigo del espacio de aplicación invocante.
string$refDocReferencia/identificador del Doc en GDE
array$vFirmasArray asociativo con información de la firma

Definición en la línea 2455 del archivo WSComunClient.php.

autenticaConFirmaWS (   $firmaB64,
  $codigoEntidad = null 
)

Permite autenticar a través de una firma realizada en cliente vía certificado digital. (Subpaquete Autenticacion)

Este método realiza la autenticación de un usuario a través de una firma digital, retornando un token generado en servidor en caso de éxito. El WS pertenece al servicio de de Autenticacion (autenticaciónArangi v1.00). Autenticacion

Parámetros
string$firmaFirma realizada en cliente y codificada como cadena en base 64
string$codigoEntidadCódigo de la entidad que representa (opciona)
Devuelve
string Cadena aleatorio (token) generado en el servidor public

Definición en la línea 828 del archivo WSComunClient.php.

autenticaUsuarioLDAPWS (   $user,
  $pass 
)

Permite autenticar vía User/Pass de LDAP. (Subpaquete Autenticacion)

Este método realiza la autenticación de un usuario a través de usuario y password HDFI retornando un token generado en servidor en caso de éxito. El WS pertenece al servicio de de Autenticacion (autenticaciónArangi v1.00). Autenticacion

Parámetros
string$userUsuario (LDAP)
string$passPassword (LDAP)
Devuelve
string Cadena aleatorio (token) generado en el servidor o null si error public

Definición en la línea 772 del archivo WSComunClient.php.

autenticaUsuarioWS (   $user,
  $pass 
)

Permite autenticar vía User/Pass de HDFI. (Subpaquete Autenticacion)

Este método realiza la autenticación de un usuario a través de usuario y password HDFI retornando un token generado en servidor en caso de éxito. El WS pertenece al servicio de de Autenticacion (autenticaciónArangi v1.00). Autenticacion

Parámetros
string$userUsuario (Login HDFI)
string$passPassword
Devuelve
string Cadena aleatorio (token) generado en el servidor public

Definición en la línea 714 del archivo WSComunClient.php.

buscarDocCriterioGDE2 (   $codApp,
  $filtroPath = null,
  $buscarInTree = null,
  $operacion = null,
  $coleccionCriterios = null 
)

Realiza búsqueda de documentos estableciendo diferentes filtros de búsqueda.

En caso de que se sobrepase un límite preestablecido de resultados, se generará un error indicando que se debe restringir más los filtros de búsqueda. En el caso de establecerse más de un filtro se utilizará el campo operación para realizar la consulta. En caso de no devolver ningún documento, se devolverá un array vacío.

Parámetros
string$codAppCódigo del espacio de aplicación invocante.
string$filtroPathPath relativo con respecto al espacio raíz de la aplicación. (Opcional)
string$buscarInTreeBuscar en el subespacio de aplicación (true) o en todo GDE (false)
string$operacionIndica la opertación lógic (AND/OR)
array$coleccionCriteriosColección de criterios de búsqueda

Definición en la línea 2529 del archivo WSComunClient.php.

buscarDocCriterioPaginadoGDE2 (   $codApp,
  $registrosPagina,
  $pagina,
  $filtroPath = null,
  $buscarInTree = null,
  $operacion = null,
  $coleccionCriterios = null 
)

Realiza búsqueda de documentos estableciendo diferentes filtros de búsqueda. En caso de que se sobrepase un límite preestablecido de resultados, se generará un error indicando que se debe restringir más los filtros de búsqueda. En el caso de establecerse más de un filtro se utilizará el campo operación para realizar la consulta. En caso de no devolver ningún documento, se devolverá un array vacío

Parámetros
string$codAppCódigo del espacio de aplicación invocante.
unknown$registrosPaginaNúmero de regitros por página
unknown$paginaPágina a recuperar (empezando por 1)
unknown$filtroPathPath relativo con respecto al espacio raíz de la aplicación. (Opcional)
string$buscarInTreeBuscar en el subespacio de aplicación (true) o en todo GDE (false)
string$operacionIndica la operación lógica (AND/OR)
array$coleccionCriteriosColección de criterios de búsqueda

Definición en la línea 2600 del archivo WSComunClient.php.

castellanoValenciano (   $texto)

Obtiene la traducción del texto pasado como parámetro

Los WS invocados pertenecen al servicio de traducción SALT SALT

Parámetros
string$textoTexto a traducir en Castellano
Devuelve
string texto traducido public

Definición en la línea 1650 del archivo WSComunClient.php.

catastro (   $IdPeticion,
  $NumElementos,
  $TimeStamp,
  $CodigoCertificado,
  $NifEmisor,
  $NombreEmisor,
  $CodProcedimiento,
  $NombreProcedimiento,
  $NombreCompletoFuncionario,
  $NifFuncionario,
  $IdentificadorSolicitante,
  $NombreSolicitante,
  $UnidadTramitadora,
  $Finalidad,
  $Consentimiento,
  $IdExpediente,
  $TipoDocumentacion,
  $Documentacion,
  $NombreCompleto,
  $Nombre,
  $Apellido1,
  $Apellido2,
  $CodigoCertificado,
  $IdSolicitud,
  $vDataEspecifico 
)
Parámetros
unknown$IdPeticion
unknown$NumElementos
unknown$TimeStamp
unknown$CodigoCertificado
unknown$NifEmisor
unknown$NombreEmisor
unknown$CodProcedimiento
unknown$NombreProcedimiento
unknown$NombreCompletoFuncionario
unknown$NifFuncionario
unknown$IdentificadorSolicitante
unknown$NombreSolicitante
unknown$UnidadTramitadora
unknown$Finalidad
unknown$Consentimiento
unknown$IdExpediente
unknown$TipoDocumentacion
unknown$Documentacion
unknown$NombreCompleto
unknown$Nombre
unknown$Apellido1
unknown$Apellido2
unknown$CodigoCertificado
unknown$IdSolicitud
unknown$vDataEspecifico
Devuelve
unknown[]

Definición en la línea 5481 del archivo WSComunClient.php.

catastroBienesPeticion (   $IdPeticion,
  $TimeStamp,
  $CodigoCertificado,
  $NifEmisor,
  $NombreEmisor,
  $CodProcedimiento,
  $NombreProcedimiento,
  $NombreCompletoFuncionario,
  $NifFuncionario,
  $IdentificadorSolicitante,
  $NombreSolicitante,
  $UnidadTramitadora,
  $Finalidad,
  $Consentimiento,
  $IdExpediente,
  $TipoDocumentacion,
  $Documentacion,
  $NombreCompleto,
  $Nombre,
  $Apellido1,
  $Apellido2,
  $CodigoCertificado,
  $IdSolicitud,
  $vDataEspecifico 
)
Parámetros
unknown$IdPeticion
unknown$TimeStamp
unknown$CodigoCertificado
unknown$NifEmisor
unknown$NombreEmisor
unknown$CodProcedimiento
unknown$NombreProcedimiento
unknown$NombreCompletoFuncionario
unknown$NifFuncionario
unknown$IdentificadorSolicitante
unknown$NombreSolicitante
unknown$UnidadTramitadora
unknown$Finalidad
unknown$Consentimiento
unknown$IdExpediente
unknown$TipoDocumentacion
unknown$Documentacion
unknown$NombreCompleto
unknown$Nombre
unknown$Apellido1
unknown$Apellido2
unknown$CodigoCertificado
unknown$IdSolicitud
unknown$vDataEspecifico
Devuelve
unknown[]

Definición en la línea 5627 del archivo WSComunClient.php.

crearCarpetaGDE2 (   $codApp,
  $path,
  $tipo = null,
  $metadatosExpedienteEni = null,
  $coleccionMetadatosPersonalizados = null 
)

Crea una carpeta con el path indicado en el espacio propio del usuario/aplicación de GDE. Opcionalmente pueden indicarse metadatos para la misma

Parámetros
string$codAppCódigo del espacio de aplicación invocante.
string$pathRuta de ubicación de la carpeta
string$tipoTipos básico
array$metadatosExpedienteEni
array$coleccionMetadatosPersonalizados

Definición en la línea 2663 del archivo WSComunClient.php.

disableWSSecurity ( )

Desactiva el uso de WSSecurity public

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

eliminarCarpetaGDE (   $codApp,
  $path 
)

Dado un path relativo al espacio de aplicación, se elimna el mismo

GDE

Parámetros
string$codAppCódigo del espacio de aplicación invocante.
string$pathPAth relatico al espacio de aplicación
Devuelve
boolean TRUE si borrado correcto, o false si no se realiza public

Definición en la línea 1591 del archivo WSComunClient.php.

eliminarCarpetaGDE2 (   $codApp,
  $path 
)

Borra una carpeta vacía y perteneciente a la aplicación propietaria

Parámetros
string$codAppcódigo de aplicación
string$pathRuta de la carpeta a eliminar
Devuelve
stdClass

Definición en la línea 2730 del archivo WSComunClient.php.

eliminarDocumentoGDE (   $codApp,
  $refDoc 
)

Dada una referencia GDE elimina el documento del gestor documental

GDE

Parámetros
string$codAppCódigo del espacio de aplicación invocante.
string$refDocReferencia Alfresco del Doc
Devuelve
boolean TRUE si borrado correcto, o false si no se realiza public

Definición en la línea 1531 del archivo WSComunClient.php.

eliminarDocumentoGDE2 (   $codApp,
  $refDoc 
)

[ORQUESTA] Dada una referencia GDE elimina el documento del gestor documental

GDE

Parámetros
string$codAppCódigo del espacio de aplicación invocante.
string$refDocReferencia/identificador del Doc en GDE
Devuelve
boolean TRUE si borrado correcto, o false si no se realiza public

Definición en la línea 2363 del archivo WSComunClient.php.

empaquetarDocumentoENIGDE2 (   $codApp,
  $contenido,
  $vMetadatosEni,
  $vFirmas 
)

Crea un paquete (documento) ENI a partir del contenido, sus metadatos y las firmas

Parámetros
string$codAppcódigo de aplicación
string$contenidoContenido del DOC
array$vMetadatosEniArray asociativo de metadatos ENI
array$vFirmasArray asociativo de firmas

Definición en la línea 2797 del archivo WSComunClient.php.

enableWSSecurity ( )

Activa el uso de WSSecurity public

Definición en la línea 418 del archivo WSComunClient.php.

establecerMetadatoCarpetasPersonalizadosGDE2 (   $codApp,
  $path,
  $vColMetadatosPers 
)

Asigna o modifica los metadatos personalizados de la carpeta identificada en $path

Parámetros
string$codAppcódigo de aplicación
string$pathRuta a la carpeta
array$vColMetadatosPersArray asociativo de metadatros personalizados
Devuelve
stdClass

Definición en la línea 2861 del archivo WSComunClient.php.

establecerMetadatosCarpetaExpedienteENIGDE2 (   $codApp,
  $path,
  $vMetadatosExpedienteEni 
)

Modifica los metadatos del Exp. Elec. ENI pasados por parámetros a la carpeta identificada por $path.

Parámetros
string$codAppcódigo de aplicación
unknown$path
unknown$vMetadatosExpedienteEni

Definición en la línea 2921 del archivo WSComunClient.php.

establecerMetadatosENIGDE2 (   $codApp,
  $refDoc,
  $vMetadatosEni 
)

Permite modificar los valores de los metadatos ENI del documento

Existe información adicional aquí: http://www.seap.minhap.gob.es/dms/es/publicaciones/centro_de_publicaciones_de_la_sgt/Monografias0/parrafo/Manual_XML/text_es_files/Manual_esquemas-XML-intercambio-doc-exp-elec-INTERNET.pdf

Parámetros
string$codAppcódigo de aplicación
unknown$refDoc
unknown$vMetadatosEni

Definición en la línea 2987 del archivo WSComunClient.php.

establecerMetadatosPersonalizadosGDE2 (   $codApp,
  $refDoc,
  $coleccionMetadatosPersonalizados 
)
Parámetros
atring$codApp
string$refDocreferencia GDE
array$coleccionMetadatosPersonalizados

Definición en la línea 3050 del archivo WSComunClient.php.

firmarCertificadoServer (   $idSession,
  $idCertificado,
  $docContentB64,
  $tipoDoc = 'TF06' 
)

Permite firmar con el cert. de servidor SAFE un documento (con formato concreto).

Los WS invocados pertenecen al servicio deAutorización) (autorizacionArangi v1.00). Autorizacion

Parámetros
string$idSessionIdentificador SAFE de APP/Sesion (ej. TRA)
integer$idCertificadoIdentificador del certificado ubicado en SAFE (ej. 5)
string$docContentB64Array de bytes a firmar (contenido del documento) en base 64
string$tipoDocTipo del documento a firma (PDF por defecto)
Devuelve
binary Devuelve el contenido firmado public

Definición en la línea 1339 del archivo WSComunClient.php.

generarIdentificadorENIGDE2 (   $codApp)

Genera identificador único de documento basado en el formato definido por las normas NTI del ENI.

Parámetros
string$codAppCódigo del espacio de aplicación invocante.

Definición en la línea 3110 del archivo WSComunClient.php.

generarTokenGDE2 (   $codApp,
  $vRefDoc 
)
Parámetros
string$codAppCódigo del espacio de aplicación invocante.
unknown$vRefDoc

Definición en la línea 3167 del archivo WSComunClient.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 378 del archivo WSComunClient.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 277 del archivo WSComunClient.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 265 del archivo WSComunClient.php.

getInformacionHDFI (   $user,
  $pass 
)

Devuelve información del usuario que se pase como parámetro de entrada (si el pass es correcto) (Método de la clase. Subpaquete Autenticacion)

Este método no corresponde con ninguna invocación directa a un WS, sino que es el resultado de dos llamadas independientes. Una a la autenticación HDFI y otra a la obtención de información

Los WS invocados pertenecen al servicio de de Autenticacion (autenticaciónArangi v1.00). Autenticacion

Parámetros
string$userUsuario (LDAP)
string$passPassword (LDAP)
Devuelve
mixed $resultado Vector asociativo con información del ususario o null si error de autenticación public

Definición en la línea 982 del archivo WSComunClient.php.

getInformacionLDAP (   $user,
  $pass 
)

Devuelve información del usuario que se pase como parámetro de entrada (si el pass es correcto) (Método de la clase. Subpaquete Autenticacion)

Este método no corresponde con ninguna invocación directa a un WS, sino que es el resultado de dos llamadas independientes

Los WS invocados pertenecen al servicio de de Autenticacion (autenticaciónArangi v1.00). Autenticacion

Parámetros
string$userUsuario (LDAP)
string$passPassword (LDAP)
Devuelve
mixed $resultado Vector asociativo con información del ususario o null en caso de error public

Definición en la línea 909 del archivo WSComunClient.php.

getInformacionWS (   $token)

Devuelve la información del usuario autenticado relacionado con el token de entrada. (Subpaquete Autenticacion)

Este método obtiene información del ususario autenticado que generó el token de entrada. La información se presenta en un vector asociativo, cuyas claves dependen del si el token fue generado por un usuario autenticado vía certificado o vía user/pass.

Si el token es de un usuario autenticado vía CERTIFICADO, las claves son: [TipoAuth, SerialNumber, SubjectDN, IssuerDN, nombre, apellido1, apellido2, nif, cif, razonSocial, oidCert, tipoCert, email]

Si el token es de un usuario autenticado vía User/pass, las claves son: [TipoAuth, idHDFI, nombre, apellido1, apellido2, nif, cif, razonSocial]

El WS pertenece al servicio de de Autenticacion (autenticaciónArangi v1.00). Autenticacion

Parámetros
string$tokenCadena aleatoria asociada a un ususario autenticado
Devuelve
array array Vector asociativo con información (claves) variable segun origern del token de entrada public

Definición en la línea 868 del archivo WSComunClient.php.

insertarDocumentoENIGDE2 (   $codApp,
  $docContentB64,
  $nombreDoc,
  $pathDoc = null,
  $tipo = null,
  $vMetaENI = null,
  $vMetaPers = null,
  $vFirmas = null 
)

Inserta documento ENI y devuelve referencia al documento.

Parámetros
string$codAppCódigo del espacio de aplicación invocante.
string$docContentB64Contenido en B64 del doc.
string$nombreDocNombre del documento
string$pathDocRutadonde almacenar el doc (dentro de GDE)
string$tipo
string$vMetaENIArray asociativo de metadatos ENI
string$vMetaPersArray asociativo de metadatos personalizados
string$vFirmas
Devuelve
array asociativo con la referencia GDE y el nombre doc

Definición en la línea 3236 del archivo WSComunClient.php.

insertarDocumentoGDE (   $codApp,
  $docContentB64,
  $nombreDoc,
  $pathDoc = '',
  $vMetadatosENI = null,
  $vMetadatosPersonalizados = null 
)

Inserta doc según parámetros recibidos y devuelve referencia al mismo

No se requerirá especificar las firmas, los metadatos del ENI o los metadatos personalizados. Esto permitirá el uso por parte de aplicaciones que no requieran de intercambio de documentos ENI. Si se especifican metadatosEni y el Identificador ENI no viene informado, se generará automáticamente por parte del GDE. Si no se indica el path se almacenará de forma automática. En caso de que se indique path se establecerá en el path indicado. GDE

Parámetros
string$codAppCódigo del espacio de aplicación invocante.
string$docContentB64Contenido del documento en Base64
string$nombreDocNombre Doc.
string$pathDocPath relativo al espacio raíz de la app
array$vMetadatosENIOpcional. Array asociativo con meta información ENI [versionNTI|identificador|tipoDocumental|nombreFormatoorgano|fechaCaptura|estadoElaboracion|origenCiudadanoAdministracion|identificadorDocumentoOrigen]
array$vMetadatosPersonalizadosOpcional. Array asociativo. [idColeccionMetadatosPersonalizados|metadatosPersonalizados|firmas]
Devuelve
array Array asociativo [referenciaDocumento|nombre] public

Definición en la línea 1402 del archivo WSComunClient.php.

insertarDocumentoGDE2 (   $codApp,
  $docContentB64,
  $nombreDoc,
  $pathDoc = null,
  $tipo = null,
  $vMetadatosENI = null,
  $vMetadatosPersonalizados = null,
  $vFirmas = null 
)

Inserta doc según parámetros recibidos y devuelve referencia al mismo

No se requerirá especificar las firmas, los metadatos del ENI o los metadatos personalizados. Esto permitirá el uso por parte de aplicaciones que no requieran de intercambio de documentos ENI. Si se especifican metadatosEni y el Identificador ENI no viene informado, se generará automáticamente por parte del GDE. Si no se indica el path se almacenará de forma automática. En caso de que se indique path se establecerá en el path indicado. GDE

Parámetros
string$codAppCódigo del espacio de aplicación invocante.
string$docContentB64Contenido del documento en Base64
string$nombreDocNombre Doc.
string$pathDocPath relativo al espacio raíz de la app
array$vMetadatosENIOpcional. Array asociativo con meta información ENI [versionNTI|identificador|tipoDocumental|nombreFormatoorgano|fechaCaptura|estadoElaboracion|origenCiudadanoAdministracion|identificadorDocumentoOrigen]
array$vMetadatosPersonalizadosOpcional. Array asociativo. [idColeccionMetadatosPersonalizados|metadatosPersonalizados]
Devuelve
array $vFirmas Opcional. Array asociativo. Firmas public

Definición en la línea 2221 del archivo WSComunClient.php.

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 394 del archivo WSComunClient.php.

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 469 del archivo WSComunClient.php.

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 1962 del archivo WSComunClient.php.

obtenerDocumentoENIGDE2 (   $codApp,
  $refDoc 
)

Obtiene un Documento de un espación GDE a partir de la referencia

Parámetros
string$codAppCódigo del espacio de aplicación invocante (espacio)
string$refDocReferencia/identificador del documento
Devuelve
array Array asociativo con los datos (y el contenido) del Doc

Definición en la línea 3294 del archivo WSComunClient.php.

obtenerDocumentoGDE (   $codApp,
  $refDoc,
  $parcial = '1' 
)

Accede al doc y devuelva la información asocaida al msimo

GDE

Parámetros
string$codAppCódigo del espacio de aplicación invocante.
string$refDocReferencia Alfresco del Doc
string$parcialIndica que datos recuperar (1: Todo, 2: Contenido, 3: Metadatos, 4: Metadatos y Firmas)
Devuelve
array Array asociativo [contenido (b64)|nombre|borrado|metadatosENI|metadatosPersonalizados|firmas] public

Definición en la línea 1469 del archivo WSComunClient.php.

obtenerDocumentoGDE2 (   $codApp,
  $refDoc,
  $parcial = '1' 
)

[ORQUESTA] Accede al doc y devuelva la información asocaida al msimo

GDE

Parámetros
string$codAppCódigo del espacio de aplicación invocante.
string$refDocReferencia Alfresco del Doc
string$parcialIndica que datos recuprar (1: Todo, 2: Contenido, 3: MEtadatos, 4: Metadatos y Firmas)
Devuelve
array Array asociativo [contenido|nombre|borrado|metadatosENI|metadatosPersonalizados|firmas] public

Definición en la línea 2287 del archivo WSComunClient.php.

obtenerExpedienteENIdeCarpetaGDE2 (   $codApp,
  $path,
  $idCertificadoSafe = null,
  $idSesionSafe = null 
)
Parámetros
string$codAppCódigo del espacio de aplicación invocante (espacio)
unknown$path
unknown$idCertificadoSafe
unknown$idSesionSafe
Devuelve
stdClass|mixed|mixed[]|NULL[]

Definición en la línea 3430 del archivo WSComunClient.php.

obtenerExpedienteENIGDE2 (   $codApp,
  $refDoc,
  $vMetadatosExpedienteEni,
  $idCertificadoSafe = null,
  $idSesionSafe = null 
)

Utilizando los documentos y metadatos pasados por parámetro, se genera, tanto el índice del expediente electrónico ENI como su versión visualizable en PDF, se firma el índice, y se construye, según los XSD de la norma, devolviéndose el expediente electrónico ENI, empaquetado en un ZIP. En el caso de que no se le pase el parámetro datosCertificado, el índice se firmará con el que se configure para el usuario/aplicación en el GDE.

Parámetros
string$codAppCódigo del espacio de aplicación invocante (espacio)
string$refDocReferencia/identificador del documento
array$vMetadatosExpedienteEniArray asociativo de metadatos ENI
array$idCertificadoSafe
array$idSesionSafe
Devuelve
array Array asociativo con los datos y metadatos del expediente

Definición en la línea 3367 del archivo WSComunClient.php.

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 5329 del archivo WSComunClient.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 5265 del archivo WSComunClient.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 5082 del archivo WSComunClient.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 5143 del archivo WSComunClient.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 4960 del archivo WSComunClient.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 5394 del archivo WSComunClient.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 5204 del archivo WSComunClient.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 5021 del archivo WSComunClient.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 3532 del archivo WSComunClient.php.

pf_downloadSign (   $username,
  $password,
  $documentId 
)

Permite recuperar el contenido de la firma de un documento 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 con la respuesta del servicio [xxx] public

Definición en la línea 3598 del archivo WSComunClient.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 4401 del archivo WSComunClient.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 4461 del archivo WSComunClient.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 4522 del archivo WSComunClient.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 4584 del archivo WSComunClient.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 4647 del archivo WSComunClient.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 4712 del archivo WSComunClient.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 4898 del archivo WSComunClient.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 4775 del archivo WSComunClient.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 4836 del archivo WSComunClient.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 3664 del archivo WSComunClient.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 4094 del archivo WSComunClient.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 4156 del archivo WSComunClient.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 4217 del archivo WSComunClient.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 4031 del archivo WSComunClient.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 3969 del archivo WSComunClient.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 3725 del archivo WSComunClient.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 3786 del archivo WSComunClient.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 4278 del archivo WSComunClient.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 4339 del archivo WSComunClient.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 3847 del archivo WSComunClient.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 3908 del archivo WSComunClient.php.

retornaAutorizacionWS (   $usuarioHDFI,
  $idAplicacion 
)

Devuelve una matriz de arrays asociativos [idGrupo | permiso], las autorizaciones que posee el ususario para esa aplicación.

Los WS invocados pertenecen al servicio deAutorización) (autorizacionArangi v1.00). Autorizacion

Parámetros
string$usuarioHDFIUsuario HDFI
string$idAplicacionCódigo de la aplicación
Devuelve
array Matriz de arrays asociativo [idGrupo]|[permisos] public

Definición en la línea 1058 del archivo WSComunClient.php.

retornaTodasAutorizacionesDNIWS (   $usuarioDNI,
  $tipoBusqueda 
)

Devuelve una matriz de arrays asociativos [idGrupo|permiso], las autorizaciones que posee el usuario para esa aplicación.

Los WS invocados pertenecen al servicio deAutorización) (autorizacionArangi v1.00). Autorizacion

Parámetros
string$usuarioDNIDNI del usuario
string$tipoBusqueda[USUARIO|GRUPO]
Devuelve
array Matriz de arrays asociativo [usrCodigo][usrTipo][idGrupo][idRol] public

Definición en la línea 1235 del archivo WSComunClient.php.

retornaTodasAutorizacionesWS (   $usuarioHDFI)

Devuelve una matriz de arrays asociativos [usrCodigo|usrTipo|idGrupo|idRol] con las autorizaciones de un ususario. (Subpaquete Autorización)

Los WS invocados pertenecen al servicio de Autorización (autorizacionArangi v1.00). Autorizacion

Parámetros
string$usuarioHDFIUsuario HDFI
Devuelve
array $resultado Vector asociativo con grupos y roles del ususairo en la aplicación o null si error de autenticación public

Definición en la línea 1139 del archivo WSComunClient.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 353 del archivo WSComunClient.php.

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 290 del archivo WSComunClient.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 329 del archivo WSComunClient.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 341 del archivo WSComunClient.php.

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 365 del archivo WSComunClient.php.

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 536 del archivo WSComunClient.php.

valencianoCastellano (   $texto)

Obtiene la traducción del texto pasado como parámetro

Los WS invocados pertenecen al servicio de traducción SALT SALT

Parámetros
string$textoTexto a traducir en Valenciano
Devuelve
string texto traducido public

Definición en la línea 1691 del archivo WSComunClient.php.

Documentación de los campos

const KEYCLIENTE_AUTENTICA = 'autentica'

Constantes para el tipo de cliente

Definición en la línea 57 del archivo WSComunClient.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 74 del archivo WSComunClient.php.


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